前端开发

qt-qml-docs

theqtcompanyrnd/agent-skills

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.

  • 736 次安装
  • 515 星标
  • 收录于

安装命令

npx skills add https://github.com/theqtcompanyrnd/agent-skills --skill qt-qml-docs

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

Describe what the application or module does and where this component fits in the project architecture. Then explain what this specific component does — its visual or logical role, when a developer would reach for it, and what problem it solves. Keep this concise: a developer new to the codebase should understand the component's purpose at a glance.