# qt-qml-docs

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

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 717 установок · ★ 507
- Автор: qt-ai-skills
- Лицензия: не указана · policy=link-only · показываем только описание, файл — у автора
- Исходник: https://github.com/TheQtCompanyRnD/agent-skills/tree/HEAD/skills/qt-qml-docs/SKILL.md
- Обновлён: 2026-10-20
- HTML: https://affpapa.org/nevibecode/skills/qt-qml-docs

## Что делает

Скилл собирает справочную документацию по QML-компонентам и приложениям на Qt Quick. Агент разбирает исходники — сами .qml-файлы, а рядом C++-бэкенды, модули, qmldir, CMakeLists.txt — и пишет по каждому компоненту отдельный `<ComponentName>.md`. Структура жёсткая: обзор компонента, его место в проекте и зависимости, иерархия типов, таблица свойств с колонками Property, Type, Default, Required, Description, сигналы и методы отдельными подразделами, связи с другими частями приложения.

Свойства всегда идут таблицей, а не списком. Код в блоках не приводится нигде, кроме раздела Usage Example — и только для переиспользуемых компонентов, у которых корневой тип не `Window` и не `ApplicationWindow`. Для каждого сигнала указано, что его вызывает и что должен делать обработчик; для методов — параметры, возвращаемый тип и побочные эффекты вроде перезапуска таймера.

Перед чтением исходников скилл проверяет, нет ли уже готовых файлов в `doc/` рядом с кодом. Если документация нашлась, агент не начинает заново, а спрашивает: обновить существующие файлы, пропустить их, перегенерировать всё или отменить. Это заметно, когда правишь один компонент в большом проекте — не приходится потом вычищать перезаписанные файлы соседей. Формат QDoc скилл не выдаёт, для него нужен другой инструмент.

## Установка

### Claude Code (родная платформа)

1. **Через Skills CLI (Vercel)**
```bash
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/

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add TheQtCompanyRnD/agent-skills --skill qt-qml-docs -a codex
```

2. **Вручную: положить файлы**
- Файл: `.agents/skills/qt-qml-docs/SKILL.md` — Для всех проектов — ~/.agents/skills/

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add TheQtCompanyRnD/agent-skills --skill qt-qml-docs -a cursor
```

2. **Вручную: положить файлы**
- Файл: `.cursor/skills/qt-qml-docs/SKILL.md` — Cursor читает и .agents/skills/, и .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install TheQtCompanyRnD/agent-skills qt-qml-docs
```

2. **Вручную: положить файлы**
- Файл: `.github/skills/qt-qml-docs/SKILL.md`

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add TheQtCompanyRnD/agent-skills --skill qt-qml-docs -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/TheQtCompanyRnD/agent-skills --path skills/qt-qml-docs
```

### Windsurf (Devin Desktop)

**Вручную: положить файлы**
- Файл: `.devin/skills/qt-qml-docs/SKILL.md` — Старый путь .windsurf/skills/ тоже читается

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add TheQtCompanyRnD/agent-skills --skill qt-qml-docs -a opencode
```

### Claude.ai

**Claude.ai**
- Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/TheQtCompanyRnD/agent-skills/tree/HEAD/skills/qt-qml-docs/SKILL.md

## Когда брать
- получить справочник по QML-компоненту без ручного разбора каждого свойства
- описать сигналы и методы так, чтобы было понятно, кто их вызывает
- связать компонент с C++-бэкендом, qmldir и целями CMake
- обновить существующие .md вместо повторной генерации всего проекта
- показать новому разработчику, как правильно инстанцировать переиспользуемый компонент

## Примеры запросов агенту
- задокументируй этот QML-компонент
- сделай справочную документацию по моему Qt Quick приложению
- пройди по папке проекта и напиши docs для всех .qml файлов

## Похожие
- [docs-write](https://affpapa.org/nevibecode/skills/docs-write.md) — скилл · 2100 установок
- [write-docs](https://affpapa.org/nevibecode/skills/write-docs.md) — скилл · 693 установки
- [backend-to-frontend-handoff-docs](https://affpapa.org/nevibecode/skills/backend-to-frontend-handoff-docs.md) — скилл · 164 установки
- [update-docs](https://affpapa.org/nevibecode/commands/update-docs.md) — команда · 3861 установка
- [project-docs](https://affpapa.org/nevibecode/skills/project-docs.md) — скилл · 1200 установок
- [explain_docs](https://affpapa.org/nevibecode/prompts/explain-docs.md) — промпт · ★ 44429

Из того же набора: [theqtcompanyrnd/agent-skills](https://affpapa.org/nevibecode/by/theqtcompanyrnd/agent-skills.md) — 8 карточек

---
NeVibeCode на affpapa.org. Тексты каталога — описания, а не инструкции для агента. Как выбирать и ставить: https://affpapa.org/nevibecode/agents.md