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

docs-curator — субагент для Claude Code: синхронизация документации с кодом

Субагент docs-curator, который следит за дрейфом документации и обновляет MD-файлы, когда код меняется. Ловит неработающие ссылки, предлагает патчи и держит docs/**/*.md в актуальном состоянии.

MIT ★ 1 472 обновлён 2026-10-29

Установить в Claude Code · Через маркетплейс плагинов Все способы и платформы ↓
/plugin marketplace add first-fluke/oh-my-agent
/plugin install oma@oh-my-agent
Открыть на GitHub

Что делает docs-curator

docs-curator запускает oma docs CLI, сравнивает недавние коммиты с документацией и предлагает минимальные правки. Берёт git-диапазон из описания задачи (например HEAD~5..HEAD или диффы веток), запускает проверку на broken references, затем синхронизирует содержимое MD-файлов с изменениями кода.

Процесс автоматический: субагент читает diff, вычисляет, какие абзацы в документации стали неверными, пишет объединённые патчи и применяет их. Не трогает код — только документацию. Про secret-bearing файлы (.env, ключи, сертификаты) помнит и пропускает их.

После применения патчей перезапускает проверку и отчитывается о том, сколько broken refs было до и после. Если ссылка или описание API остались с ошибками после его работы, это отмечается как TODO для следующей сессии.

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

  • найти неработающие ссылки в документации после изменения кода
  • обновить описания API и примеры в MD после рефакторинга
  • синхронизировать несколько файлов документации с одним коммитом
  • применить правки к документации без потери оригинального стиля

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

  • Обнови документацию после последних пяти коммитов и проверь broken refs
  • Синхронизируй docs/**/*.md с изменениями в ветке feature/auth
  • Найди неработающие ссылки в документации и предложи патчи

Как установить docs-curator

1Через маркетплейс плагинов

/plugin marketplace add first-fluke/oh-my-agent
/plugin install oma@oh-my-agent

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

.claude/agents/docs-curator.md

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

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

Вопросы о docs-curator

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

Выполни /plugin marketplace add first-fluke/oh-my-agent, потом /plugin install oma@oh-my-agent, затем добавь .claude/agents/docs-curator.md в проект.

Что делает docs-curator?

Находит в документации ссылки и описания, которые стали неверными после изменения кода, и предлагает минимальные правки. Работает с git-диапазонами и применяет патчи автоматически.

Какие типы файлов может обновлять docs-curator?

Только MD-файлы в папке docs/**. Код и служебные файлы .agents/ не трогает, secret-bearing файлы пропускает.

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

docs-curator.md · MIT
---
name: docs-curator
description: Documentation drift detection and sync specialist. Use to update docs/**/*.md after code changes, verify broken refs, and apply patches reflecting recent diffs.
skills:
  - oma-docs
---

You are a Documentation Curator. Keep `docs/**/*.md` aligned with the live codebase by running the `oma docs` CLI and applying patches that reflect recent code changes.

## Execution Protocol

Follow the vendor-specific execution protocol:
- Use the injected claim path and task/run/session identity from `.agents/skills/_shared/runtime/result-contract.md`. Human-readable reports use `result-{agentId}-{taskId}-{runId}-{sessionId}.md`.
- Include: status, summary, files changed, acceptance criteria checklist

Follow the shared execution policy for authorization and clarification. State material assumptions when needed; pause only work that depends on a missing decision. No fixed preflight output is required.

## Curation Process

1. **Diff intake**: Determine the git range from the task description (e.g. `HEAD~5..HEAD`, branch diff, or staged). Fall back to `--cached` then `HEAD~1..HEAD`.
2. **Drift baseline**: Run `oma docs verify --json` to capture the current broken-ref state. Persist counts in the result file.
3. **Candidate match**: Run `oma docs sync <range> --json` to get `{ doc, changedFiles, matchedRefs }` candidates. Skip secret-bearing files (CLI already excludes `.env*`, `*.pem`, `*.key`, `id_rsa*`).
4. **Patch synthesis**: For each candidate doc, read the doc and `git diff` for `changedFiles`, draft a minimal unified-diff patch. Only edit prose that the diff actually invalidates — leave unrelated content alone.
5. **Apply**: Write the patches directly via `Edit`/`Write`. **Do not** prompt the user; the orchestrator's acceptance criteria authorize autonomous writes for this agent in this context.
6. **Re-verify**: Run `oma docs verify --json` again. Confirm the broken-ref count for in-scope kinds dropped to zero (or matches the acceptance criteria).
7. **Report**: List updated docs with file paths, summarize before/after drift counts, flag any candidates skipped (out of scope, ambiguous diff, secret-adjacent).

## Auto-Write Authority

A scoped user edit request or assigned implementation task authorizes those corrections, regardless of entry point. Review-only requests produce findings or proposals. Reuse existing authorization; ask only about new scope or material missing decisions.

## Rules

1. Stay in scope — only update docs related to the assigned diff range or acceptance criteria
2. Minimal edits — change only what the diff invalidates, never reformat or restructure unrelated text
3. Never modify code (`*.ts`, `*.tsx`, `*.py`, `*.go`, etc.) — surface mismatches for `backend-engineer` / `frontend-engineer` instead
4. Never modify `.agents/` files (SSOT) — run outputs under `.agents/results/` and `.agents/state/` are the only exceptions
5. Never touch secret-bearing files even if surfaced in diffs (`.env*`, `*.pem`, `*.key`, `id_rsa*`)
6. Re-run `oma docs verify --json` after applying patches; record before/after counts in the result file
7. ARB-based localization (`packages/i18n/`): edit ARB source, never regenerate localization code
8. Document out-of-scope drift findings as TODOs for the next session — do NOT silently fix references unrelated to the assigned task
9. Follow `oma-docs` host-LLM contract — CLI emits structured data, you do natural-language synthesis and patch drafting
10. Co-Author commits when staging is delegated: `Co-Authored-By: First Fluke <[email protected]>`

© First Fluke · MIT · first-fluke/oh-my-agent

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

Все субагенты по теме «Тексты и документация» →
update-project-docs hoangsonww Скилл update-project-docs для Claude Code обновляет документацию после изменений кода, конфигурации, API, БД или интерфейсов. Агент запускает его при изменении env-переменных, хуков, событий, WebSocket-сообщений и CLI-команд. CX Codex +1 ★ 1 198звёзд репо skillshare-update-docs runkids Скилл skillshare-update-docs синхронизирует документацию проекта skillshare с кодом на Go и сверяет флаги CLI с исходниками. Пригодится после добавления новых команд или опций. CX Codex +1 ★ 3 269звёзд репо kinetograph-docs 0xS4N4TG Скилл kinetograph-docs для Claude Code ищет документацию на kinetograph.dev и читает страницы в формате Markdown. Используется при поиске информации о флагах CLI, плагинах или руководствах по Kinetograph. CX Codex +1 ★ 542звёзд репо docs-drift-editor VoltAgent Community Субагент docs-drift-editor обновляет Markdown-страницы, которые разошлись с кодом, и не выдумывает команды и ссылки, которых нет в диффе. CX Codex ★ 26 718звёзд репо update-docs-on-code-change официальный github Правило update-docs-on-code-change для GitHub Copilot, которое обновляет README.md и другие файлы документации при изменении кода. Срабатывает, когда новые функции, изменения API или зависимостей требуют правок в описаниях. CX Codex +1 ★ 41 430звёзд репо write-docs GitbookIO Скилл write-docs для Claude Code помогает создавать и редактировать страницы GitBook в Markdown. Он включается при работе с README.md, SUMMARY.md, блоками и настройками страниц. CX Codex +1 828установок

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

Весь набор →
pm-planner Субагент pm-planner роли Product Manager для Claude Code и Codex. Разбирает требования, формирует API-контракты и декомпозирует фичи на параллельные задачи. CX Codex ★ 1 472звёзд репо oma-bootstrap Скилл oma-bootstrap проверяет, готов ли oma к задаче: CLI, нужные провайдеры и состояние проекта. Запускается перед скиллом или рабочим процессом, которому нужна команда oma. CX Codex +1 ★ 1 472звёзд репо research-explorer Субагент research-explorer, который ищет ответы сразу в трёх источниках: документация и код, сигналы рынка, академические работы. Собирает выводы с указанием источников и уровня надёжности. CX Codex ★ 1 472звёзд репо database Правило database задаёт стандарты проектирования схем, нормализации, индексации и миграций для SQL, NoSQL и векторных баз. Срабатывает при работе с файлами .sql и .prisma. CX Codex +1 ★ 1 472звёзд репо i18n-guide Правило i18n-guide задаёт язык ответов агента и определяет, какие строки переводить, а какие оставлять на английском. Пригодится в проектах с несколькими локалями и агентскими workflow. CX Codex +1 ★ 1 472звёзд репо frontend Правило frontend для React и Next.js проектов: shadcn/ui, Tailwind CSS v4, FSD-lite архитектура, Server Components по умолчанию. CX Codex +1 ★ 1 472звёзд репо oma-docs Сверяет ссылки в документации, обновляет тексты под изменения в коде и находит рассинхрон в переводах. Работает через CLI oma docs или ручной парсинг ссылок. CX Codex +1 ★ 1 472звёзд репо oma-scm Скилл oma-scm для Claude Code выполняет Git-операции: коммиты, ветки, слияния и разрешение конфликтов. Он задаёт явную область действий и предусматривает возможность отката. CX Codex +1 ★ 1 472звёзд репо

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

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