# Project Documenter

Анализирует кодовую базу любого репозитория, формирует архитектурные схемы draw.io и собирает итоговый отчёт в формате Word с картинками.

- субагент · `type=agent` · GitHub Copilot · ★ 40451
- Автор: github · официальный репозиторий GitHub
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/github/awesome-copilot/tree/HEAD/agents/project-documenter.agent.md
- Обновлён: 2026-10-23
- HTML: https://affpapa.org/nevibecode/agents/project-documenter

## Что делает

Субагент сканирует дерево проекта, манифесты пакетов и конфигурационные файлы без привязки к конкретному стеку. На основе кода он строит обзор архитектуры по модели C4, описывает конвейеры обработки данных и связи между компонентами, создавая исходник `docs/project-summary.md`. При этом исходный код проекта субагент не меняет.

В каталоге `docs/diagrams/` агент генерирует XML-диаграммы `*.drawio` и экспортирует их в PNG. Итоговый результат собирается в файл `docs/project-summary.docx` с внедрёнными изображениями. Вся структура документа опирается на принципы Diátaxis: технические справочные данные об устройстве системы и пояснения, почему архитектура устроена именно так.

Для генерации отчёта субагенту нужен доступ к терминалу и средствам поиска по коду через инструменты GitHub Copilot. Если в корне репозитория лежат `Agents.md`, `README.md` или `.github/copilot-instructions.md`, агент прочитает их в первую очередь и учтёт как контракт проекта.

## Установка

### GitHub Copilot (родная платформа)

**Вручную: положить файлы**
- Файл: `.github/agents/project-documenter.agent.md`

### Claude Code

**Вручную: положить файлы**
- Файл: `.claude/agents/project-documenter.md` — Для всех проектов — ~/.claude/agents/. Claude делегирует задачу сам по полю description или по @-упоминанию. Поле tools у Copilot перечисляет инструменты по-своему — уберите его или перепишите под Claude Code

### Codex

**Вручную: положить файлы**
- Файл: `.codex/agents/project-documenter.toml` — Codex описывает субагентов в TOML: name, description, developer_instructions. Текст из Markdown перенесите в developer_instructions вручную. Для всех проектов — ~/.codex/agents/

### Cursor

**Вручную: положить файлы**
- Файл: `.cursor/agents/project-documenter.md` — Cursor понимает и .claude/agents/

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/github/awesome-copilot/tree/HEAD/agents/project-documenter.agent.md

## Когда брать
- составить техническое описание репозитория с нуля
- нарисовать архитектурные схемы draw.io по уровням C4
- собрать единый документ Word со встроенными диаграммами
- подготовить структурированные материалы для онбординга инженеров

## Примеры запросов агенту
- Изучи кодовую базу и сгенерируй проектную документацию в docs/project-summary.docx
- Построй архитектурные диаграммы draw.io и обнови описание сервиса
- Проанализируй стек репозитория и подготовь обзор архитектуры по модели C4

## Похожие
- [convert-documents-to-markdown](https://affpapa.org/nevibecode/skills/convert-documents-to-markdown.md) — скилл · 12600 установок
- [create-architecture-documentation](https://affpapa.org/nevibecode/commands/create-architecture-documentation.md) — команда · 6136 установок
- [prompt-engineer](https://affpapa.org/nevibecode/agents/voltagent-community-prompt-engineer.md) — субагент · 16078 установок
- [context-manager](https://affpapa.org/nevibecode/agents/context-manager.md) — субагент · 10638 установок
- [code-explorer](https://affpapa.org/nevibecode/agents/code-explorer.md) — субагент · 1172 установки
- [search-specialist](https://affpapa.org/nevibecode/agents/search-specialist.md) — субагент · 6886 установок
- [api-documenter](https://affpapa.org/nevibecode/agents/api-documenter.md) — субагент · 6451 установка
- [technical-writer](https://affpapa.org/nevibecode/agents/technical-writer.md) — субагент · 4345 установок

Из того же набора: [github/awesome-copilot](https://affpapa.org/nevibecode/by/github/awesome-copilot.md) — 949 карточек

_Часть страницы не вошла по размеру — она есть в HTML-версии._

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