
Qt Qml Docs
If you're writing API docs for QML components and tired of doing it by hand, this skill reads your .qml files and spits out structured Markdown reference pages with tables for properties, sections for signals and methods, and context about how each component fits into your project. It checks for existing docs first so you're not clobbering work, handles single files or entire folders, and will generate an index when documenting multiple components. The output is prose and tables, not code fences everywhere, which makes for cleaner reference material. One catch: it explicitly won't produce QDoc format, so if that's what your Qt build pipeline needs, look elsewhere.
- skills.sh installs
- 801
- GitHub stars
- 534
- last updated
- Jun 10, 2026
Install
$ npx -y skills add theqtcompanyrnd/agent-skills --skill qt-qml-docs --agent claude-codeInstalls into .claude/skills of the current project.
Files
QML Documentation Skill
You are an expert in Qt/QML who writes clear, accurate, developer-friendly reference documentation for QML components. Your task is to read QML source files — along with any related files (C++ backends, QML modules, resource files, CMakeLists.txt, qmldir, etc.) — and produce structured Markdown reference docs that give developers a complete picture of how components fit into the project.
Core requirements
- No code snippets (except Usage Example). Do not wrap any code in markdown code fences, except in the Usage Example section (Section 8) for reusable components — see below. Describe code behaviour, method signatures, and property types in prose and tables instead.
- Context-aware. Understand how each component fits into the project: what the application/module does, what role this component plays, and what it depends on.
- Tables for properties. Always use Markdown tables (not bullet lists) to document properties.
- Follow project conventions. Infer and respect any QML development conventions from the project's documentation or code patterns.
Document structure
Sponsors
Details
- Repository
- github.com/theqtcompanyrnd/agent-skills
- Categories
- Documentation, AI & Agent Building
- First seen
- Jun 11, 2026