Qt Qml Docs

Generates standalone Markdown reference documentation for QML components and applications. Use this skill whenever you want to document QML files, create API reference docs for a QML component or module, document a Qt Quick application, or produce developer-facing documentation from .qml source code. Triggers on: "document this QML", "write docs for my QML", "create reference docs", "document QML component", "QML API docs", "document my Qt Quick component", "document my Qt app", or any time one or more .qml files are provided and documentation is needed. Works with single files, pasted code, o

551 stars 56 forksWriting & Content Plugin marketplace

Install

Claude Code plugin
/plugin marketplace add TheQtCompanyRnD/agent-skills

The repo is a Claude Code plugin marketplace. Run /plugin afterwards to pick the plugin that includes this skill.

skills CLI (Claude Code, Cursor, Codex and more)
npx skills add TheQtCompanyRnD/agent-skills --skill qt-qml-docs
Manual install
git clone --depth 1 https://github.com/TheQtCompanyRnD/agent-skills.git /tmp/agent-skills
mkdir -p ~/.claude/skills
cp -r /tmp/agent-skills/skills/qt-qml-docs ~/.claude/skills/qt-qml-docs

Personal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.

From the SKILL.md

# 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

For each QML component, generate a Markdown file named `<ComponentName>.md` with the following sections (omit any section that has no content):

### 1. Component Overview
Read the full skill on GitHub

Details

Skill name
qt-qml-docs
Path
skills/qt-qml-docs/SKILL.md
Repo updated
9 November 2026

FAQ

What does the Qt Qml Docs skill do?

Generates standalone Markdown reference documentation for QML components and applications. Use this skill whenever you want to document QML files, create API reference docs for a QML component or module, document a Qt Quick application, or produce developer-facing documentation from .qml source code. Triggers on: "document this QML", "write docs for my QML", "create reference docs", "document QML component", "QML API docs", "document my Qt Quick component", "document my Qt app", or any time one or more .qml files are provided and documentation is needed. Works with single files, pasted code, o

How do I install the Qt Qml Docs skill?

Claude Code plugin: /plugin marketplace add TheQtCompanyRnD/agent-skills. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.

Is Qt Qml Docs popular?

It lives in TheQtCompanyRnD/agent-skills, which has 551 GitHub stars and 56 forks.

Related skills

Qt Canvas2d

551

TheQtCompanyRnD/agent-skills

Applies Qt Canvas2D (QtCanvas2D / Qt Canvas Painter, Qt 6.12+) best practices when producing or working with Canvas2D QML source code. Use whenever Canvas2D, Canvas2DContext, path2d, boxshadow2d, boxgradient2d, gridpattern2d, conicalgradient2d or transform2d is the subject: writing, reviewing, fixing, optimizing, or porting Qt Quick Canvas / HTML5 canvas drawing code to Canvas2D. Also use for GPU-accelerated imperative 2D drawing in QML — gauges, dials, charts, waveforms, oscilloscopes, clocks, freehand drawing — including choosing between Canvas2D and Shape/ShapePath when the renderer has not

Frontend & Design56

Qt Cmake Project

551

TheQtCompanyRnD/agent-skills

Use to generate or update Qt 6 CMake projects or edit CMakeLists.txt, add sources/resources or define targets (executable, QML module, library).

Finance & Crypto56

Qt Cpp Docs

551

TheQtCompanyRnD/agent-skills

Generates standalone Markdown reference documentation for any Qt/C++ source files — Qt Widgets classes, Qt Quick backends, Qt/C++ modules, plain C++ utilities, structs, free-function headers, and entry points like main.cpp. Use this skill to document any .h or .cpp file: Qt classes, plain C++ code, utility helpers, or application startup files. Triggers on: "document this class", "write docs for my C++", "document main.cpp", "C++ API docs", "document my Qt app", or whenever C++ or header files are provided and documentation is needed. Works with single files, pasted code, or entire project fol

Writing & Content56

Creative Data Storytelling

489

VisActor/skills

将数据、文本档案或研究发现制作成面向公众的交互式数据故事。围绕读者追问组织证据与叙事,设计数据关系的可视化表达及前后衔接,结合连续舞台、自然阅读和按需探索,完成数据故事的研究、设计、实现与修订。

Writing & Content89

Editorial Magazine

489

VisActor/skills

用 HTML/CSS 制作小红书、抖音的杂志图文,支持新闻资讯、人物生平、穿搭解析、旅行攻略、时序故事、观点解读与概念科普。按场景模板生成可编辑 HTML 与 PNG;穿搭优先使用用户照片,制作统一中性背景的多套组合与单套拆解组图。

Writing & Content89

Network Scan

463

proficientlyjobs/proficiently-claude-skills

Scan your LinkedIn contacts' companies for matching job openings

Writing & Content76

Browse the most popular Claude skills, all writing & content skills, or write your own with the skills generator.