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

Quality

85%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

Passed

No findings from the security scan

Quality

Content

75%Weight 40%Scale 1-5

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

A well-structured, actionable instruction skill with a clear workflow and explicit quality checks, scoring consistently at 4 across dimensions. The main opportunities are trimming the QML syntax re-explanation and optionally extracting the parsing reference into a bundled file.

Suggestions

Trim or tighten the 'Parsing QML accurately' section to only the non-obvious cases (inline components, _-prefixed private helpers, alias typing) rather than restating basic QML property/signal/function syntax.

Add one short worked example of a finished <ComponentName>.md output to make the section format spec fully concrete.

Consider moving the QML syntax parsing reference into a references/ file linked from the body to strengthen progressive disclosure and shorten SKILL.md.

Dimension	Reasoning	Score
Conciseness	Largely efficient and well-organized with purposeful instruction, but the 'Parsing QML accurately' section re-states QML syntax (e.g. 'property <type> <name>', 'signal <name>(<params>)', 'readonly property') that Claude largely already knows, which is minor over-explanation that could be trimmed.	4 / 5
Actionability	Highly concrete guidance with exact table columns, exact sub-section formats ('#### signalName(paramType paramName)'), exact file naming ('<ComponentName>.md'), and explicit reusability decision logic; falls just short of 5 because no complete worked example of a generated doc is shown.	4 / 5
Workflow Clarity	Clear multi-step process with a well-sequenced pre-flight (Glob/ls check, AskUserQuestion branch, honor-the-choice actions) and a final Quality check checklist; the batch case has a verification step so avoids the 3-cap, but there is no validate-fix-retry feedback loop, leaving minor validation gaps.	4 / 5
Progressive Disclosure	Single well-organized SKILL.md with clear section headers and easy navigation, no external bundle files; at ~160 lines it exceeds the under-50-line simple-skill exception for a 5, and the inline 'Parsing QML accurately' reference could arguably be a separate file, so it sits at 4 rather than 5.	4 / 5
	Total	16 / 20 Passed

Description

95%Weight 40%Scale 1-5

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

A strong, well-scoped description that clearly states capabilities, provides rich natural trigger phrases, and disambiguates from adjacent skills via an explicit exclusion. The only blemish is second-person phrasing that the rubric penalizes on specificity.

Suggestions

Rephrase second-person clauses ('Use this skill whenever you want to document QML files') into third person ('Use when documenting QML files') to avoid the voice penalty and reclaim the specificity point.

Dimension	Reasoning	Score
Specificity	Lists multiple concrete actions ('Generates standalone Markdown reference documentation', 'create API reference docs', 'document a Qt Quick application', 'produce developer-facing documentation from .qml source code') for comprehensive coverage; reduced from 5 because it uses second-person voice ('whenever you want to document'), which the rubric penalizes by one point.	4 / 5
Completeness	Explicitly answers both 'what' (generates standalone Markdown reference docs for QML components) and 'when' ('Use this skill whenever you want to document QML files', 'Triggers on...', 'any time one or more .qml files are provided and documentation is needed').	5 / 5
Trigger Term Quality	Comprehensive natural trigger terms including synonyms and the file extension: 'document this QML', 'write docs for my QML', 'QML API docs', 'document my Qt Quick component', 'document my Qt app', and '.qml files'.	5 / 5
Distinctiveness Conflict Risk	Clear niche (QML/Qt Quick documentation generation) with distinct triggers and an explicit negative boundary ('DO NOT use if the user asks for QDoc format output'), giving minimal conflict risk.	5 / 5
	Total	19 / 20 Passed

Validation

100%

Warnings & errors only

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository: x-tools-author/x-tools
Path: .github/skills/qt-qml-docs/SKILL.md
Commit: 6214c41

Reviewed: 5 hours ago

Table of Contents

Discovery Implementation Validation

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.