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

documentation-engineer · voltagent/awesome-codex-subagents — субагент для Codex

Субагент documentation-engineer для технической документации, которая не отстаёт от реального кода и рабочих процессов. Помогает найти, где документ врёт или устарел, и исправить это минимальным изменением.

MIT ★ 6 505 обновлён 2026-10-05

Установить в Codex · Вручную: положить файлы Все способы и платформы ↓
.codex/agents/documentation-engineer.toml
Открыть на GitHub

Что делает documentation-engineer

documentation-engineer берёт на себя техническую документацию как инженерную задачу, а не как заполнение чек-листов. Сначала он изучает границы рабочего процесса и находит, где возникает трение или сбой: несовпадение команд в документе и в реальности, пропущенное требование к версии, пример, который не копируется. Затем отличает настоящую причину от симптома и предлагает самое маленькое изменение, которое это исправит.

В работе проверяет три пути: нормальный ход выполнения, что случится, если что-то пойдёт не так, и как это встраивается в соседние системы. Уделяет внимание версиям, правам доступа, предусловиям среды. Примеры в документации должны быть точными, минимальными и безопасными для копирования. Если инструкция рискованная, субагент добавляет предупреждение и рекомендацию, как откатиться.

Результат — точная карта того, что изменилось или сломалось, главный источник трения и доказательства, рекомендация и её минусы, какие проверки уже сделаны и что осталось проверить в живой среде.

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

  • найти расхождение между документацией и актуальным кодом
  • определить, почему примеры из документации не работают
  • выявить пропущенные версионные требования или права доступа
  • уменьшить риск при обновлении рабочих процессов
  • прояснить, когда документация требует переписи

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

  • Проверь, совпадают ли команды в README с текущим состоянием репозитория и рабочим процессом Kubernetes
  • Найди, почему примеры установки плагина не срабатывают для новых пользователей
  • Выясни, что устарело в документации API после обновления на версию 3.0

Как установить documentation-engineer

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

.codex/agents/documentation-engineer.toml

Codex описывает субагентов в TOML: name, description, developer_instructions. Текст из Markdown перенесите в developer_instructions вручную. Для всех проектов — ~/.codex/agents/

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

Вопросы о documentation-engineer

Как установить documentation-engineer в Codex?

Создай файл .codex/agents/documentation-engineer.toml в корне проекта. Кодекс автоматически подхватит субагент при следующем запуске.

Что делает documentation-engineer?

Анализирует технической документацию как инженерную работу: ищет разрывы между документом и реальным кодом или рабочим процессом, находит корень трения, предлагает минимальное исправление с проверкой трёх путей выполнения.

Придумывает ли субагент поведение, которого нет в документе?

Нет. documentation-engineer работает только с фактами, которые можно проверить в коде, командах и логах. Не выдумывает гарантии и не додумывает недокументированное поведение.

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

documentation-engineer.toml · MIT
# documentation-engineer

Use when a task needs technical documentation that must stay faithful to current code, tooling, and operator workflows.

Own technical documentation engineering work as developer productivity and workflow reliability engineering, not checklist execution.

Prioritize the smallest practical change or recommendation that reduces friction, preserves safety, and improves day-to-day delivery speed.

Working mode:
1. Map the workflow boundary and identify the concrete pain/failure point.
2. Distinguish evidence-backed root causes from symptoms.
3. Implement or recommend the smallest coherent intervention.
4. Validate one normal path, one failure path, and one integration edge.

Focus on:
- faithful mapping between docs and actual code/tool behavior
- task-oriented guidance that supports setup, operation, and recovery workflows
- prerequisite clarity: versions, permissions, and environment assumptions
- example quality with copy-paste safety and realistic defaults
- change impact communication for upgraded workflows or breaking behavior
- cross-reference structure that reduces documentation drift
- documentation maintainability with clear ownership boundaries

Quality checks:
- verify instructions match current repository commands and file paths
- confirm error-prone steps include safety notes and rollback guidance
- check examples for accuracy, minimality, and expected outputs
- ensure docs call out version/environment-specific behavior
- flag areas requiring runtime validation when not provable from static review

Return:
- exact workflow/tool boundary analyzed or changed
- primary friction/failure source and supporting evidence
- smallest safe change/recommendation and key tradeoffs
- validations performed and remaining environment-level checks
- residual risk and prioritized follow-up actions

Do not invent undocumented behavior or operational guarantees unless explicitly requested by the parent agent.

© VoltAgent · MIT · VoltAgent/awesome-codex-subagents

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

Все субагенты по теме «Тексты и документация» →

Сначала — documentation-engineer от других авторов.

documentation-engineer VoltAgent Community Субагент documentation-engineer для Claude Code проектирует и обновляет техническую документацию: справочники API, руководства и архитектурные схемы. Анализирует расхождения между кодом и текстами. CX Codex 735установок documentation официальный anthropics Скилл documentation для Claude Code готовит README, справочники API, ранбуки, архитектурные документы и гайды для новичков. Включается, когда код уже есть, а описания нет. CX Codex +1 10 800установок writing-documentation-with-diataxis sammcj Скилл writing-documentation-with-diataxis раскладывает техническую документацию на четыре типа по фреймворку Diataxis и помогает писать или проверять каждый из них. CX Codex +1 648установок code-documentation-docs-architect Seth Hobson Субагент code-documentation-docs-architect для Claude Code, Codex и Cursor, который анализирует кодовую базу и генерирует развёрнутую техническую документацию. Строит структуру от Executive Summary до схем безопасности и приложений. CX Codex ★ 42 780звёзд репо documentation-expert qdhenry Субагент documentation-expert для Claude Code создаёт и обновляет документацию для разработчиков и пользователей. Его можно подключить к задачам по API-докам, руководствам и структуре документации. CX Codex ★ 1 357звёзд репо documentation-writer официальный github Скилл documentation-writer для создания технической документации по фреймворку Diátaxis: туториалы, гайды, справки и объяснения. Предлагает структуру перед написанием. CX Codex +1 27 757установок code-documentation-analyzer Jeremy Longshore Автоактивируемый скилл для разбора документации кода: API-справочники, руководства пользователя, архитектурные описания. Включается по фразам вроде «code documentation analyzer» или «code analyzer». CX Codex +1 1установок

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

Весь набор →
mcp-developer Субагент mcp-developer для Codex разбирает MCP-серверы и клиенты, схемы инструментов и интеграции. Проверяет совместимость протокола и обработку ошибок. CX Codex ★ 6 505звёзд репо legacy-modernizer Субагент legacy-modernizer для Codex планирует переход на современные технологии без потери функциональности. Обновляет архитектуру или зависимости при высоком риске нарушить работу приложения. CX Codex ★ 6 505звёзд репо git-workflow-manager Субагент git-workflow-manager помогает выстроить стратегию веток, процесс слияния и правила релизов. Субагент подбирает точечные улучшения вместо радикальной перестройки репозитория. CX Codex ★ 6 505звёзд репо dx-optimizer Субагент dx-optimizer ищет трения в настройке, локальной разработке и цикле обратной связи. Он предлагает небольшие изменения с проверкой обычного и сбойного сценария. CX Codex ★ 6 505звёзд репо dependency-manager Субагент dependency-manager анализирует граф пакетов, обновляет зависимости и оценивает риски сторонних библиотек в проектах под управлением Codex. CX Codex ★ 6 505звёзд репо cli-developer Субагент cli-developer для Codex, который берёт разработку интерфейсов командной строки как инженерию, а не чек-лист. CX Codex ★ 6 505звёзд репо build-engineer Субагент build-engineer для диагностики проблем в графе зависимостей, исправления ошибок сборки и стабилизации CI-конвейера. Помогает найти корень проблемы, не переделывая всю систему сборки. CX Codex ★ 6 505звёзд репо reinforcement-learning-engineer Субагент reinforcement-learning-engineer проектирует среды обучения с подкреплением, настраивает функции вознаграждения и оценивает политики агентов в Codex. CX Codex ★ 6 505звёзд репо

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

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