Skip to content

Documenter

Documenter helps people understand and use the change. It updates user guides, project documentation, comments, docstrings, and project-specific agent instructions outside the framework’s managed sections.

Run Documenter in DOCUMENTING during a standard cycle. With the default FULL_DELIVERABLE policy, it follows implementation review. With IMPLEMENTATION_REVIEWED, it runs only through recovery for required documentation corrections. The shorter policy does not waive documentation required by the current scope. Expedited cycles skip this role; requiring its work means moving to the standard workflow.

For a new documentation-only assignment in an existing project, invoke Documenter while no cycle is active. It starts DOCUMENTATION at Auditor, then Scoper and Architect establish context before Documenter edits. Final Reviewer and Synchronizer remain mandatory. The route can create missing guides and is not available in Greenfield. See Updating Documentation on Its Own.

Codex: $documenter Continue from .standards/STATE.md.
Claude Code: /documenter Continue from .standards/STATE.md.

Documenter reads the requirements, design, relevant project context, code, verification and review results, and existing documentation. It checks what the project actually does before describing it. In documentation cycles, it uses current scope, existing technical contracts, Auditor context and source evidence; no current-cycle Developer, Tester, or implementation-review record is required.

Alongside the updated documentation, it saves a documentation record at .standards/docs/documentation/<Active Work.Id>.md. This records what was inspected and changed, checks performed, limitations, remaining work, and your collaboration choices. Reviewer and Synchronizer use it to assess the documentation later.

You can switch modes or resume later without losing those choices.

The default. Documenter edits and checks the documentation without a separate plan-approval step.

Documenter gives you one edit to copy and paste at a time. After you apply it, Documenter inspects the saved result before continuing. It still saves its own progress and workflow records.

You can select a file, a folder, one feature across its related documents, or all documentation affected by the current change. These are called FILE, FOLDER, VERTICAL_SLICE, and ACTIVE_CHANGE; the last is the default.

For example, while the workflow is in DOCUMENTING:

$documenter Update docs/usage.md.
$documenter Use GUIDED mode for docs/usage.md.
$documenter Document the export feature as a VERTICAL_SLICE.

Use /documenter in Claude Code. A file request defaults to autonomous editing unless you choose guided work. Explicit choices in the standalone request remain saved through the earlier roles and are reused when Documenter creates its record.

Documenter respects your editing boundary. If other required documentation remains outside it, it records that work and asks how to proceed. Finishing one selected file does not automatically complete the cycle’s documentation.

Documenter follows shared guidance for plain language, accurate examples, and consistent terms, plus relevant language-specific documentation conventions. You can explicitly select a user style you keep at .standards/user-styles/documenter/<name>.md; none is selected by default.

For example, Use user style tony selects .standards/user-styles/documenter/tony.md. If that file asks for NumPy-style Python docstrings, Documenter applies it to the docstrings it writes or substantially updates, not to unrelated guides. The record saves the selection, and Documenter reloads it when it resumes.

You may change or clear Documenter’s user style during the cycle. The choice is separate from Developer’s locked coding style and cannot override correctness or project requirements.

Documenter finishes when all required documentation for the change has been assessed, saved where changes are needed, and checked with sufficient evidence. It can also conclude that no changes are needed after checking the existing documentation. Pending guided edits or missing important evidence prevent completion.

Sometimes an earlier role needs a documentation fix before it can continue. The protocol allows a limited corrective return: Documenter verifies that fix and returns while recording documentation that must wait for the unfinished work. Its record stays incomplete. This cannot excuse unrelated defects or work that is already possible.

Normal FULL_DELIVERABLE completion goes to final Reviewer in a fresh chat separate from the authoring conversations. Corrections follow the saved recovery route. Under IMPLEMENTATION_REVIEWED, even a complete documentation record follows that return route rather than starting normal final review. Changed evidence for early completion must return to implementation Reviewer for reassessment before sign-off.

In DOCUMENTATION, full completion likewise goes to independent final Reviewer, then Synchronizer. Corrective returns stay among included roles and cannot skip full gates before readiness. An implementation or formal-testing requirement blocks for your decision; the agent does not change behavior or convert the cycle to satisfy it.

Documenter sends code, test, design, and other problems to their owners. It updates the source of generated documentation rather than patching generated copies, and leaves managed framework instructions and installation files to their owners.