Skip to main content
subagent CX Codex

documentation-engineer · voltagent/awesome-codex-subagents — Codex subagent: docs that track code and workflows

documentation-engineer — a subagent for technical documentation that stays faithful to actual code and operator workflows. Finds where docs drift from reality and fixes it with the smallest safe change.

MIT ★ 6,505 updated 2026-10-05

Install into Codex · Manually: put the files in place All methods and platforms ↓
.codex/agents/documentation-engineer.toml
Open on GitHub

What documentation-engineer does

documentation-engineer treats technical documentation as engineering work, not checklist completion. It maps workflow boundaries, identifies concrete friction or failure points, and distinguishes evidence-backed root causes from symptoms. Then it delivers the smallest coherent change that reduces friction and preserves safety.

Every recommendation comes with three validation paths: one normal workflow, one failure recovery, and one integration edge. The subagent checks versions, permissions, environment assumptions, example accuracy, and rollback guidance. It confirms that commands in docs match current repository state and that error-prone steps include recovery instructions.

The output is exact: the workflow boundary analyzed, the primary friction source and supporting evidence, the smallest safe change and its tradeoffs, validations performed and what still needs runtime checks, residual risk and follow-up priorities.

What it helps with

  • align documentation with current code and tooling behavior
  • diagnose why examples in docs fail for new users
  • verify version and permission prerequisites are complete
  • reduce risk when upgrading workflows or breaking behavior
  • identify where documentation requires maintainability restructuring

Example prompts for the agent

  • Verify that CLI commands in the setup guide match the actual repository state and deployment workflow.
  • Find out why the API example in the docs does not run against the current version.
  • Check what needs updating in the runbook after migrating to a new database schema.

How to install documentation-engineer

Manually: put the files in place

.codex/agents/documentation-engineer.toml

Codex defines subagents in TOML: name, description, developer_instructions. Move the Markdown text into developer_instructions by hand. For all projects use ~/.codex/agents/

Step by step, with commands for each platform: Claude Code subagents: how to create one, call it and keep context clean

Questions about documentation-engineer

How do I install documentation-engineer in Codex?

Create .codex/agents/documentation-engineer.toml in your project root. Codex will load the subagent on next run.

What does documentation-engineer do?

It treats technical documentation as an engineering task: maps workflow boundaries, finds where docs diverge from code or tooling, diagnoses the root friction, proposes the smallest coherent fix, and validates across normal paths, failure recovery, and integration edges.

Does it invent undocumented behavior?

No. documentation-engineer works only with facts that can be verified in code, commands, and logs. It does not invent operational guarantees or reverse-engineer undocumented behavior.

Source text

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

Similar subagents

All subagents for Writing and docs →

documentation-engineer by other authors comes first.

documentation-engineer VoltAgent Community documentation-engineer is a Claude Code subagent that generates and maintains developer documentation, API references, and architecture guides, identifying gaps between code and docs. CX Codex 735installs documentation official anthropics documentation — a skill for technical writing that drafts READMEs, API references, runbooks, architecture docs and onboarding guides. Useful when the code exists but the description does not. CX Codex +1 10,800installs writing-documentation-with-diataxis sammcj writing-documentation-with-diataxis — a skill that sorts technical documentation into the four Diataxis types and helps you write or review each one. CX Codex +1 648installs code-documentation-docs-architect Seth Hobson The code-documentation-docs-architect subagent for Claude Code, Codex, and Cursor analyzes a codebase and produces long-form technical documentation, from architecture decisions to security. CX Codex ★ 42,780repo stars documentation-expert qdhenry documentation-expert is a Claude Code subagent for creating and maintaining software documentation. It can handle requests for API references, user guides, and documentation structure. CX Codex ★ 1,357repo stars documentation-writer official github documentation-writer — a skill that turns the agent into a technical writer following the Diátaxis framework: tutorials, how-to guides, reference, and explanation. Proposes structure before writing. CX Codex +1 27,757installs code-documentation-analyzer Jeremy Longshore Auto-activating skill for auditing code documentation: API references, user guides, architecture docs. Triggers on phrases like "code documentation analyzer" or "code analyzer". CX Codex +1 1installs

From the same set176

The whole set →
mcp-developer The mcp-developer subagent handles MCP servers, clients, tool wiring, and protocol-aware integrations. Use it when contract behavior and failure handling need a close review. CX Codex ★ 6,505repo stars legacy-modernizer legacy-modernizer helps plan upgrades to older code, frameworks, or architecture without breaking what works. Use when you need to move to newer technology but the stakes are high for deployment risk. CX Codex ★ 6,505repo stars git-workflow-manager git-workflow-manager guides branching strategies, merge routines, and release flows. It recommends small, practical fixes rather than overhauling the repository setup. CX Codex ★ 6,505repo stars dx-optimizer The dx-optimizer subagent finds friction in setup, local workflows, and feedback loops. It recommends small changes and checks both normal and failing paths. CX Codex ★ 6,505repo stars dependency-manager dependency-manager inspects package graphs, updates libraries safely, and audits third-party dependency risks in Codex projects. CX Codex ★ 6,505repo stars cli-developer cli-developer — a Codex subagent that treats CLI development as workflow engineering, not checklist ticking. Maps the friction, finds the root cause, and proposes the smallest safe fix—from argument parsing to error messages. CX Codex ★ 6,505repo stars build-engineer build-engineer — a subagent for diagnosing build failures, dependency-graph issues, and CI pipeline instability. Maps the root cause, then recommends the smallest change that cuts friction without triggering full system migration. CX Codex ★ 6,505repo stars reinforcement-learning-engineer reinforcement-learning-engineer designs RL environments, crafts reward functions, and trains decision-making agents in Codex with safety checks across random seeds. CX Codex ★ 6,505repo stars

Project sponsors

Companies that keep this analytics open