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-code

Installs 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

More from theqtcompanyrnd/agent-skills

All 11
1aradotso avatarawesome-marketing-science-guidearadotso/marketing-skillsawesome marketing science guide793skills.sh installs
2sickn33 avatarplan-writingsickn33/antigravity-awesome-skillsplan writing772skills.sh installs
3kagurananaga avatarofficial-document-writingkagurananaga/official-document-writing-skill专业的党政机关公文写作指南。当用户需要撰写、修改或审核党政机关公文(如请示、通知、函、总结、纪要等)时使用。提供GB/T 9704-2012格式规范指导、常用公文模板、语言规范建议和公文质量检查。适用于以下场景:(1) 撰写新公文,(2) 修改完善公文,(3) 检查公文格式规范,(4) 提供公文写作指导,(5) 审核公754skills.sh installs
4aradotso avatarlearn-docker-k8s-gamearadotso/trending-skillslearn docker k8s game746skills.sh installs
5alirezarezvani avatardemo-videoalirezarezvani/claude-skillsUse when the user asks to create a demo video, product walkthrough, feature showcase, animated presentation, marketing video, or GIF from screenshots or scene d736skills.sh installs
6sickn33 avatarwriting-planssickn33/antigravity-awesome-skillswriting plans735skills.sh installs