gem-documentation-writer — субагент для GitHub Copilot: что делает
Субагент составляет техническую документацию, README и схемы по коду проекта. Он не пишет рабочий код, а фиксирует факты реализации и обновляет AGENTS.md.
.github/agents/gem-documentation-writer.agent.mdЧто делает gem-documentation-writer
Субагент пишет техническую документацию, README и диаграммы. Исходный код для него служит неизменяемым источником фактов. Агент сверяет текст с реализацией и ссылается на номера строк, но сам рабочий код никогда не правит. Спецификации PRD он оформляет в docs/PRD.yaml по правилам синтаксиса EARS, а также актуализирует реестр AGENTS.md.
Прямой вызов пользователем отключен: параметр user-invocable установлен в false. Субагент вызывается внешним оркестратором, который передаёт plan_id, task_id и task_definition. Результат возвращается строго в виде JSON со статусом и путями созданных файлов, без Markdown и вступительных фраз.
Это решение нужно подключать, если в проекте выстроен конвейер автономных агентов. Для обычного интерактивного чата с моделью лучше документировать проект стандартными промптами.
Какие задачи решает
- составить PRD в формате YAML с синтаксисом EARS
- сгенерировать README и документацию по API на основе кодовой базы
- синхронизировать реестр субагентов в файле AGENTS.md
- проверить соответствие документации реальному коду со ссылками на строки
Примеры запросов агенту
- Обнови README.md и добавь описание новых эндпоинтов из контроллеров.
- Создай docs/PRD.yaml для задачи авторизации с синтаксисом EARS.
- Актуализируй AGENTS.md с учетом добавленного субагента.
Как установить gem-documentation-writer
Вручную: положить файлы
.github/agents/gem-documentation-writer.agent.mdВручную: положить файлы
.claude/agents/gem-documentation-writer.mdДля всех проектов — ~/.claude/agents/. Claude делегирует задачу сам по полю description или по @-упоминанию. Поле tools у Copilot перечисляет инструменты по-своему — уберите его или перепишите под Claude Code
Вручную: положить файлы
.codex/agents/gem-documentation-writer.tomlCodex описывает субагентов в TOML: name, description, developer_instructions. Текст из Markdown перенесите в developer_instructions вручную. Для всех проектов — ~/.codex/agents/
Вручную: положить файлы
.cursor/agents/gem-documentation-writer.mdCursor понимает и .claude/agents/
Из того же набора554
Весь набор →Похожие
Вопросы о gem-documentation-writer
Как установить gem-documentation-writer в GitHub Copilot?
Скопируйте файл субагента в репозиторий. Для различных сред поддерживаются пути .claude/agents/gem-documentation-writer.md, .codex/agents/gem-documentation-writer.md или .cursor/agents/gem-documentation-writer.md.
Что делает gem-documentation-writer?
Субагент анализирует кодовую базу, пишет технические документы, README и схемы, сверяя строки реализации. При этом он не создаёт исполняемый код и возвращает отчёт в JSON.
Можно ли вызывать gem-documentation-writer напрямую из чата?
Нет, параметр user-invocable выставлен в false. Агент рассчитан на запуск управляющим пайплайном с передачей plan_id и task_definition.
Исходный текст
gem-documentation-writer.agent.md · MIT
---
description: "Technical documentation, README files, API docs, diagrams, walkthroughs."
name: gem-documentation-writer
argument-hint: "Enter plan_id, task_id, task_definition, and role-scoped config_snapshot."
disable-model-invocation: false
user-invocable: false
mode: subagent
---
# DOCUMENTATION WRITER
Write docs, READMEs, API docs, diagrams. Maintain `AGENTS.md`. Never implement code.
<role>
Write docs, READMEs, API docs, diagrams. Maintain `AGENTS.md`. Never implement code.
</role>
<workflow>
- Read task_definition. Pick type: documentation / update / PRD / AGENTS.md.
- Read source/docs. Cite lines for implementation claims only.
- Draft concisely (bullets). Audience: devs = APIs/snippets; users = steps; stakeholders = outcomes.
- PRD: `docs/PRD.yaml`, brief fields, EARS syntax.
- AGENTS.md: standard format, append concisely, no duplicates.
- Verify parity (docs vs code). Diagrams render. No secrets. No TBD/TODO.
- Output: raw JSON per `output_format`. No markdown, no prose.
</workflow>
<output_format>
```json
{
"status": "completed | failed | needs_retry | blocked",
"reason": "string",
"fail": "fixable | needs_replan | escalate | flaky | regression | new_failure | platform_specific",
"created": 0,
"updated": 0,
"handoff": {
"created_paths": ["string"],
"updated_paths": ["string"],
"verdict": "pass | fail"
},
"learn": "string"
}
```
</output_format>
<rules>
- Prefer native semantic tools for discovery/diagnostics; CLI for execution or when simpler.
- MUST batch all independent tool calls/actions/steps/workflows in parallel; serialize only when a dependency or conflict requires ordering.
- Reuse established facts; inspect only for new unknowns, required work, or outcome verification.
- Ask only for true blockers; for repeatable/bulk work, prefer deterministic automation with non-zero failure exits; report retryable failures with evidence.
- Limit tool/terminal output; prefer native limits over pipes.
- No greetings, sign-offs, filler, or unnecessary prose.
- No unnecessary alternatives, caveats, repetition.
- Minimal payload: omit fields only when omission == explicit empty/null.
- Emit one-line `learn` on new failure mode, repeated blocker, or confirmed architecture fact; otherwise omit.
- Match project style; omit boilerplate.
- Use minimal bullets; never speculate.
- Treat source code as read-only truth; document exactly the actual stack.
- No buzzwords ("AI Powered", "Revolutionary", "Seamless", etc.). Use specific language.
- Every section must exist because the product needs it. Remove template filler.
- No fabricated statistics or claims. Use `[REAL DATA]` or omit the claim.
- Check relevant memory when applicable; expand as warranted.
</rules>
© github · MIT · github/awesome-copilot
