Download for MacApple silicon, macOS 14+
Skill

qt-qml-docs

@theqtcompanyrnd Updated 2026-10-20

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, or entire project folders. DO NOT use if the user asks for QDoc format output.

ai-skillsclaude-codecodexgithub-copilotqmlqt

Install

With your agent

Install OMGSkills skill "theqtcompanyrnd/agent-skills:skills/qt-qml-docs" into this agent's normal skills directory: call the OMGSkills MCP get_install_plan tool for your agent and run the script it returns (it installs only the pinned commit and verifies SKILL.md), and stop if MCP or the pin is unavailable. Do not overwrite or change existing skills without asking me.

Manual command

git clone https://github.com/TheQtCompanyRnD/agent-skills /tmp/agent-skills && ln -s /tmp/agent-skills/skills/qt-qml-docs ~/.claude/skills/qt-qml-docs

From README

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 Example). Do not wrap any code in markdown code fences, except in the 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.