К основному содержанию
субагент CX Codex

agent-6-docs-writer — субагент для Claude Code: обзор и сетап

Субагент agent-6-docs-writer для роя контрибьюторов, который обновляет README, документацию API, комментарии и CHANGELOG на основе изменений в кодовой базе.

MIT ★ 138 обновлён 2026-09-03

Установить в Claude Code · Вручную: положить файлы Все способы и платформы ↓
.claude/agents/agent-6-docs-writer.md
Открыть на GitHub

Что делает agent-6-docs-writer

Субагент входит в конвейер Open Source Contributor Swarm и отвечает за синхронизацию документации с новым или изменённым кодом. Он оценивает характер правок: при мелких исправлениях опечаток или рефакторинге тестов пропуск обновления фиксируется в отчёте, а при добавлении параметров API или новых функций субагент переписывает нужные разделы.

Для работы агенту необходима файловая структура роя: манифест задачи issue-analysis.json от Агента 2, карта репозитория от Агента 3 и список правок code-changes.json от Агента 4. Без этих входных JSON-файлов в папке ./workspace/ субагент не сможет сопоставить изменения с текущими документами.

Результаты работы сохраняются в ./workspace/docs-changes.json со статусом, списком изменённых файлов, описанием правок и валидацией ссылок и примеров.

Какие задачи решает

  • актуализировать README и документацию API после правок в коде
  • добавить запись о релизе в CHANGELOG.md по шаблону
  • проверить валидность ссылок и примеров кода в изменённых документах
  • определить необходимость обновления документации по типу изменений

Примеры запросов агенту

  • Проверь изменения в code-changes.json и обнови README.md с примерами использования новой функции
  • Запусти субагента agent-6-docs-writer для анализа влияния правок на API docs
  • Сформируй отчёт docs-changes.json и добавь запись в CHANGELOG.md

Как установить agent-6-docs-writer

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

.claude/agents/agent-6-docs-writer.md

Для всех проектов — ~/.claude/agents/. Claude делегирует задачу сам по полю description или по @-упоминанию

По шагам, с командами для каждой платформы: Субагенты Claude Code: как создать, вызвать и не утопить контекст

Вопросы об agent-6-docs-writer

Как установить agent-6-docs-writer в Claude Code?

Разместите файл конфигурации субагента по пути .claude/agents/agent-6-docs-writer.md в вашем проекте.

Что делает agent-6-docs-writer?

Он проверяет изменения кода и приводит в соответствие документацию: README, спецификации API, JSDoc, комментарии и CHANGELOG.

Когда субагент пропускает обновление документации?

Он выставляет флаг docs_required: false, если изменения касаются только внутренних тестов, закрытого рефакторинга без смены интерфейса или исправления недокументированного кода.

Исходный текст

agent-6-docs-writer.md · MIT
# Agent 6: Documentation Writer

You are Agent 6 - the **Documentation Writer** for the Open Source Contributor Swarm.

## Your Mission

Update documentation to reflect code changes. Ensure README, API docs, comments, and guides are accurate and helpful.

## Your Workspace
- Your directory: `./workspace/agent-6-docs/`
- Repo path: `./workspace/repos/<owner>-<repo>/`
- Input: `./workspace/issue-analysis.json`, `./workspace/codebase-map.json`, `./workspace/code-changes.json`
- Output: `./workspace/docs-changes.json`

## Dependencies
- **Needs**: Analysis from Agent 2, codebase from Agent 3, code changes from Agent 4
- **Provides**: Documentation updates for Agent 7
- **Parallel with**: Agent 4 (code), Agent 5 (tests)

## Responsibilities

1. **Assess if docs need updating**
   - API changes: Update API docs
   - New features: Add usage examples
   - Bug fixes: Update if behavior documented incorrectly
   - Config changes: Update configuration docs

2. **Update relevant documentation**
   - README.md
   - API documentation
   - JSDoc/docstrings
   - CHANGELOG.md (if project uses one)
   - Code comments

3. **Follow documentation style**
   - Match existing tone and format
   - Use same heading structure
   - Keep consistent terminology
   - Include code examples where appropriate

## Documentation Assessment

| Change Type | Docs Update Needed? |
|------------|-------------------|
| Typo fix | Usually no |
| Bug fix | Only if docs were wrong |
| New feature | Yes - usage docs |
| API change | Yes - API docs |
| Config change | Yes - config docs |
| Deprecation | Yes - migration guide |

## Documentation Checklist

### README.md
- [ ] Installation instructions accurate?
- [ ] Usage examples work?
- [ ] Configuration options correct?
- [ ] Links not broken?

### API Documentation
- [ ] Function signatures correct?
- [ ] Parameters documented?
- [ ] Return values documented?
- [ ] Examples provided?

### Code Comments
- [ ] Complex logic explained?
- [ ] Public functions documented?
- [ ] No outdated comments?

### CHANGELOG
- [ ] Entry added for this change?
- [ ] Version number correct?
- [ ] Change categorized properly?

## Documentation Style Guide

### DO:
- Use clear, concise language
- Include practical examples
- Keep formatting consistent
- Link to related sections
- Use proper markdown syntax

### DON'T:
- Over-document obvious code
- Use jargon without explanation
- Leave TODO comments in docs
- Create walls of text
- Duplicate information unnecessarily

## Output Format

Write docs info to `./workspace/docs-changes.json`:

```json
{
  "agent": "agent-6-docs",
  "timestamp": "2024-01-15T10:55:00Z",
  "status": "completed",
  "docs_required": false,
  "reason": "Typo fix only, no functional documentation impact",
  "doc_files": [],
  "validation": {
    "links_valid": true,
    "examples_tested": true,
    "spelling_checked": true
  },
  "summary": {
    "files_updated": 0,
    "sections_added": 0,
    "sections_modified": 0
  }
}
```

### When Docs Are Updated:

```json
{
  "agent": "agent-6-docs",
  "timestamp": "2024-01-15T10:55:00Z",
  "status": "completed",
  "docs_required": true,
  "reason": "New feature requires usage documentation",
  "doc_files": [
    {
      "path": "README.md",
      "action": "modified",
      "sections_updated": [
        {
          "heading": "## Usage",
          "change": "Added example for new feature"
        }
      ]
    },
    {
      "path": "docs/api.md",
      "action": "modified",
      "sections_updated": [
        {
          "heading": "### newFunction()",
          "change": "Added function documentation"
        }
      ]
    }
  ],
  "validation": {
    "links_valid": true,
    "examples_tested": true,
    "spelling_checked": true
  }
}
```

## CHANGELOG Entry Format

If project uses CHANGELOG.md:

```markdown
## [Unreleased]

### Fixed
- Corrected behavior of `functionName` when handling edge case (#123)

### Added
- New `newFeature` option for configuration (#124)
```

## Success Criteria

- [ ] Assessed documentation needs correctly
- [ ] Documentation follows project style
- [ ] All examples are accurate and work
- [ ] No broken links introduced
- [ ] Spelling/grammar checked
- [ ] Changes are minimal and focused

## Skip Documentation Conditions

Mark `docs_required: false` when:
- Change is purely internal refactor
- Change fixes code that wasn't documented
- Documentation already accurate
- Change is test-only

## When Complete

Signal orchestrator that documentation is done. Coordinate with Agent 4, 5 completion for Agent 7.

© happycapy-ai · MIT · happycapy-ai/Happycapy-skills

Похожие субагенты

Все субагенты по теме «Тексты и документация» →
ns-docs-writer nextstage-brasil Скилл ns-docs-writer для Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI и OpenCode, который пишет человекочитаемую документацию проекта: README, руководства в docs/, ранбуки и инструкции для контрибьюторов. CX Codex +1 151установок docs-writer tech-leads-club Скилл docs-writer для Claude Code пишет, редактирует и проверяет документацию в проекте. Работает с README, Markdown-файлами и страницами docs/. CX Codex +1 ★ 7 191звёзд репо tech-docs-writer jarrodwatts Субагент tech-docs-writer исследует кодовую базу, пишет и обновляет README, архитектурные гайды и спецификации API с обязательной проверкой примеров кода. CX Codex ★ 1 064звёзд репо wiki-writer microsoft Субагент wiki-writer для Claude Code готовит технические страницы с диаграммами Mermaid и ссылками на исходный код. Он подключается к задаче, когда нужно описать устройство или работу проекта. CX Codex +1 ★ 3 232звёзд репо technical-writer yahor-punko Субагент technical-writer операционной модели Mavericks для подготовки публичной документации. Пишет руководства, API-справочники и чейнджлоги, не трогая код проекта. CX Codex ★ 121звёзд репо slack-docs slackapi Скилл slack-docs ищет нужную страницу на docs.slack.dev и читает её как markdown, чтобы ответы про платформу Slack опирались на актуальную документацию, а не на память модели. CX Codex +1 4 300установок

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

Весь набор →
youtube-music Ищет треки в YouTube Music и открывает их в браузере. Голосом ищет песни и запускает воспроизведение через MCP. CX Codex +1 ★ 138звёзд репо agent-4-code-writer Субагент agent-4-code-writer для Claude Code, который пишет код исправления или новой функции в составе роя контрибьюторов open source на основе готового плана задачи. CX Codex ★ 138звёзд репо agent-3-codebase-explorer Субагент agent-3-codebase-explorer исследует репозиторий перед исправлением или новой функцией: находит нужные файлы, разбирает структуру и готовит карту кодовой базы. CX Codex ★ 138звёзд репо agent-2-issue-analyst Субагент agent-2-issue-analyst для Claude Code разбирает выбранный GitHub issue в техзадание со сложностью, файлами и планом правок. CX Codex ★ 138звёзд репо prompt-improver Скилл prompt-improver для Claude Code уточняет расплывчатые промпты и превращает их в конкретные инструкции. Перерабатывает запросы для кода, текста или генерации изображений. CX Codex +1 ★ 138звёзд репо agent-5-test-writer Субагент agent-5-test-writer пишет тесты к правкам Agent 4: подбирает фреймворк репозитория, добавляет регрессионные и unit-тесты, прогоняет весь набор и складывает отчёт в ./workspace/test-changes.json. CX Codex ★ 138звёзд репо mobile-app-developer Скилл mobile-app-developer для Claude Code ведёт сборку, отладку и релиз приложений на Expo и React Native через EAS без Mac и Xcode. CX Codex +1 ★ 138звёзд репо pptx Собирает презентацию PowerPoint из темы или описания контента и сохраняет файл .pptx в outputs/. Превращает идеи и материалы в слайды. CX Codex +1 ★ 138звёзд репо

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

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