Documentation stage
The document stage updates the host project's docs so a shipped change is discoverable and consistent with the existing documentation system.
When it runs
The feature preset enables documentation by default. bug and brainstorm disable it by default, but the user can enable it in JOB.md → ## Stages.
What it reads
app.md → Documentation conventions.
- The host project's canonical documentation index named in
app.md.
- The implementation diff and prior artifacts, especially
03_plan/PLAN.md and 04_execution/notes.md.
- Nearby docs so tone, structure, and depth match the project.
What it writes
- Host-project documentation files, following the host conventions.
06_document/notes.md inside the job folder.
How to request docs in a job
For a new job, use the feature preset or explicitly list document under intake stages. For an existing job, use extend and include the slug plus add document, validate in the request.
Extend a job to add docs
_processes/_operations/extend/extend.prompt.md
Rule of thumb — If a user, operator, or future maintainer must know about the changed behavior, enable the document stage. If the change is invisible internal cleanup, leave it disabled unless it changes a documented pattern.
The documentation action layer (0.10, D-48)
Beyond the in-pipeline document stage above, 0.10 adds two action-layer documentation request types. Each runs its own orchestrator under _processes/03_action/ — it does not run the clarify → … → validate pipeline — and resolves the documentation UI kit reference from the committed pointer _processes/03_action/_shared/documentation-webkit.json (D-55, revising D-48(d); the kit is intrinsic to the doc HTML agents, no longer read from app.md).
doc_upkeep — govern an existing HTML docs folder
Validate and update an existing HTML documentation folder against the codebase and the project's documentation UI kit: a read-only survey (docs-vs-code drift + webkit conformance + page structure), then confined updates in apply mode, then a report. Requires a mandatory TargetFolder; UpdateMode defaults to apply (report_only for a dry run).
Copy this path
_processes/03_action/doc_upkeep/doc_upkeep.prompt.md
doc_create — generate new HTML docs
Generate new documentation for a section or the full application using the project's documentation UI kit. full_app runs an internal page/nav plan first, then fans out page authors and assembles a shared shell. Requires a mandatory TargetFolder + CreationScope (section | full_app).
Copy this path
_processes/03_action/doc_create/doc_create.prompt.md
Stage vs action — the document stage (above) keeps a shipped change's docs in sync as part of a pipeline job. The doc_upkeep / doc_create action types are standalone: run them directly when the task is the documentation, independent of a feature/bug job. doc_upkeep is the read-write, webkit-aware superset of audit Kind: doc_drift (which stays read-only).
Related: doc_revalidate — doc_revalidate is the whole-landscape, all-format pipeline type for documentation revalidation: discover the docs, validate them against the code, fix drift, and draft missing first-pass docs. It is distinct from the HTML-folder action types above.