К основному содержанию
скилл CX Codex

qt-qml-docs — скилл для Claude Code: документация QML-компонентов

Скилл читает .qml-файлы и связанный код, а на выходе даёт Markdown-справочник по компоненту: свойства, сигналы, методы, зависимости.

Установить в Claude Code · Через Skills CLI (Vercel) Все способы и платформы ↓
npx skills add TheQtCompanyRnD/agent-skills --skill qt-qml-docs -a claude-code
Открыть на GitHub

Что делает 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-code

2Вручную: положить файлы

~/.claude/skills/qt-qml-docs/SKILL.md

Папка скилла целиком; для одного проекта — .claude/skills/qt-qml-docs/

По шагам, с командами для каждой платформы: Как установить скилл в 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.

Похожие скиллы

Всё по теме «Тексты и документация» →
docs-write metabase Скилл помогает писать и редактировать Markdown и MDX в стиле Metabase. Он пригодится для рабочих инструкций, описаний функций и другой документации. CX Codex +1 2 100установок write-docs GitbookIO Скилл для правки документации GitBook прямо в файлах: markdown-страницы, SUMMARY.md, блоки hint и tabs, переменные. Пригодится, когда сайт документации синхронизирован с Git, а не редактируется в веб-интерфейсе. CX Codex +1 693установок backend-to-frontend-handoff-docs davila7 Скилл собирает API-хендофф-документ для фронтенд-разработчиков: эндпоинты, DTO, валидация и граничные случаи в одном markdown-файле. 164установок update-docs davila7 Слэш-команда проходит по specs/, CLAUDE.md и README.md, отмечает выполненное и обновляет проценты готовности проекта. 3 861установок project-docs jezweb Скилл сканирует репозиторий и создаёт актуальные файлы ARCHITECTURE.md, API_ENDPOINTS.md и DATABASE_SCHEMA.md. Он полезен при онбординге новичков или после масштабного рефакторинга. CX Codex +1 1 200установок explain_docs danielmiessler Промпт переписывает инструкцию к инструменту в понятный текст: обзор, синтаксис, частые сценарии и важные опции. ★ 44 429звёзд репо

Из того же набора8

qt-qml Скилл внедряет стандарты оформления кода на QML при написании компонентов, рефакторинге и ревью. Пригодится разработчикам интерфейсов на Qt 6. CX Codex +1 1 100установок qt-cpp-review Скилл проводит статический аудит C++ кода на Qt6 перед коммитом. Запускает детерминированный линтер и анализирует владение объектами, потокобезопасность и контракты моделей. CX Codex +1 1 000установок qt-cpp-docs Скилл читает заголовки и исходники C++ в проекте Qt и пишет по ним справочные Markdown-файлы. Пригодится, когда API нужно задокументировать, а не пересказывать вручную. CX Codex +1 782установок qt-qml-test Создаёт файлы юнит-тестов Qt Quick Test для компонентов QML. Пригодится для проверки свойств элементов и отправки сигналов в Qt 6. CX Codex +1 587установок qt-qml-test-run Собирает проект на Qt 6 и запускает тесты Qt Quick Test через qmltestrunner или CTest, после чего формирует отчёт в Markdown. Пригодится для проверки компонентов QML в проектах на CMake. CX Codex +1 569установок qt-cmake-project Скилл собирает и правит CMake для проектов на Qt 6: цели, QML-модули, ресурсы. Пригодится, когда агент путает команды Qt 5 и Qt 6. CX Codex +1 530установок qt-figma-component-generation Читает компоненты Figma через MCP и пишет по ним QML-контролы на Qt Quick Controls 2. Нужен на шаге генерации компонентов в воркфлоу дизайн-системы. CX Codex +1 435установок

Спонсоры проекта

Компании, которые помогают держать аналитику открытой