qt-qml-docs — скилл для Claude Code: документация QML-компонентов
Скилл читает .qml-файлы и связанный код, а на выходе даёт Markdown-справочник по компоненту: свойства, сигналы, методы, зависимости.
npx skills add TheQtCompanyRnD/agent-skills --skill qt-qml-docs -a claude-codeЧто делает qt-qml-docs
Скилл собирает справочную документацию по QML-компонентам и приложениям на Qt Quick. Агент разбирает исходники — сами .qml-файлы, а рядом C++-бэкенды, модули, qmldir, CMakeLists.txt — и пишет по каждому компоненту отдельный <ComponentName>.md. Структура жёсткая: обзор компонента, его место в проекте и зависимости, иерархия типов, таблица свойств с колонками Property, Type, Default, Required, Description, сигналы и методы отдельными подразделами, связи с другими частями приложения.
Свойства всегда идут таблицей, а не списком. Код в блоках не приводится нигде, кроме раздела Usage Example — и только для переиспользуемых компонентов, у которых корневой тип не Window и не ApplicationWindow. Для каждого сигнала указано, что его вызывает и что должен делать обработчик; для методов — параметры, возвращаемый тип и побочные эффекты вроде перезапуска таймера.
Перед чтением исходников скилл проверяет, нет ли уже готовых файлов в doc/ рядом с кодом. Если документация нашлась, агент не начинает заново, а спрашивает: обновить существующие файлы, пропустить их, перегенерировать всё или отменить. Это заметно, когда правишь один компонент в большом проекте — не приходится потом вычищать перезаписанные файлы соседей. Формат QDoc скилл не выдаёт, для него нужен другой инструмент.
Какие задачи решает
- получить справочник по QML-компоненту без ручного разбора каждого свойства
- описать сигналы и методы так, чтобы было понятно, кто их вызывает
- связать компонент с C++-бэкендом, qmldir и целями CMake
- обновить существующие .md вместо повторной генерации всего проекта
- показать новому разработчику, как правильно инстанцировать переиспользуемый компонент
Примеры запросов агенту
- задокументируй этот QML-компонент
- сделай справочную документацию по моему Qt Quick приложению
- пройди по папке проекта и напиши docs для всех .qml файлов
Как установить qt-qml-docs
1Через Skills CLI (Vercel)
npx skills add TheQtCompanyRnD/agent-skills --skill qt-qml-docs -a claude-code2Вручную: положить файлы
~/.claude/skills/qt-qml-docs/SKILL.mdПапка скилла целиком; для одного проекта — .claude/skills/qt-qml-docs/
1Через Skills CLI (Vercel)
npx skills add TheQtCompanyRnD/agent-skills --skill qt-qml-docs -a codex2Вручную: положить файлы
.agents/skills/qt-qml-docs/SKILL.mdДля всех проектов — ~/.agents/skills/
1Через Skills CLI (Vercel)
npx skills add TheQtCompanyRnD/agent-skills --skill qt-qml-docs -a cursor2Вручную: положить файлы
.cursor/skills/qt-qml-docs/SKILL.mdCursor читает и .agents/skills/, и .claude/skills/
1GitHub CLI
gh skill install TheQtCompanyRnD/agent-skills qt-qml-docs2Вручную: положить файлы
.github/skills/qt-qml-docs/SKILL.md1Через Skills CLI (Vercel)
npx skills add TheQtCompanyRnD/agent-skills --skill qt-qml-docs -a gemini-cli2Командой платформы
gemini skills install https://github.com/TheQtCompanyRnD/agent-skills --path skills/qt-qml-docsВручную: положить файлы
.devin/skills/qt-qml-docs/SKILL.mdСтарый путь .windsurf/skills/ тоже читается
Через Skills CLI (Vercel)
npx skills add TheQtCompanyRnD/agent-skills --skill qt-qml-docs -a opencodeClaude.ai
Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills
По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов
Вопросы о qt-qml-docs
Как установить qt-qml-docs в Claude?
Выполните npx skills add TheQtCompanyRnD/agent-skills --skill qt-qml-docs -a claude-code. После этого файл скилла лежит в ~/.claude/skills/qt-qml-docs/SKILL.md.
Что делает qt-qml-docs?
Читает QML-исходники и связанные файлы проекта, а затем пишет Markdown-справочник по каждому компоненту: обзор, зависимости, иерархию, таблицу свойств, сигналы, методы и связи с другими компонентами.
Можно ли получить вывод в формате QDoc?
Нет. Скилл рассчитан на Markdown и не используется, если нужен QDoc.