Documentation

Documentation

Run after QA passes for a PROJ-X. The goal is not a short changelog; the goal is curated documentation a human can use to understand:

• what the app does and which features exist
• how the main user workflows behave
• which technology choices matter
• how the data model, integrations, and data flows work
• what future agents must remember

Update only what needs updating, but do not keep the docs shallow when the feature or architecture needs explanation.

Output Files

No per-feature documentation files by default. The PRDs under specs/PROJ-<X>-<theme>/2_PRDs/ remain the detailed requirement source; link to them instead of copying acceptance criteria.

Mandatory Delegation Contract

When Codex subagents are available and permitted, workers own all product-source, test, defect-fix, and human-documentation edits this workflow requires. The lead owns decomposition, dispatch, integration, deterministic verification, gates, and operational records. Dispatch independent tasks with disjoint file ownership in parallel; serialize dependent or overlapping work. Send integration corrections to a follow-up worker. The lead may edit covered files locally only when delegation is unavailable or prohibited, and must report the reason explicitly.

Decomposed PROJ Handling

Documentation updates the completed PROJ while preserving the larger decomposition map:

• docs/PROJECT.md should show how this PROJ fits sibling PROJs when the concept has Decomposition Context.
• Refresh only the current PROJ's detailed section; keep sibling sections intact.
• If this PROJ introduces or consumes shared design language, document the canonical design file and which sibling PROJs it applies to.
• docs/TECHNICAL.md should document cross-PROJ contracts only when they are source-backed by concept, architecture, plans, or implementation.
• Do not describe unbuilt sibling PROJs as shipped capabilities.

Input

Read in this priority order. Structured data first; raw reconstruction only as fallback.

Structured inputs, filled by Skills 4/5/6:

1. specs/PROJ-<X>-<theme>/5_progress/PROJ-<X>-progress.md
   • ### Wave N Gate - PASSED blocks: authoritative wave completion proof
   • ## QA Results: QA summary and residual risk
   • ## PROJ Retrospective: implementation lessons and durable observations
   • ## AGENTS.md Candidates: proposed durable agent rules awaiting approval
2. specs/PROJ-<X>-<theme>/1_brainstorm/PROJ-<X>-concept.md
   • app/feature purpose, target user, in-scope/out-of-scope boundaries
3. specs/PROJ-<X>-<theme>/2_PRDs/*.md
   • user stories, feature names, acceptance criteria, edge cases
4. specs/PROJ-<X>-<theme>/3-4_plan/PROJ-<X>-architecture.md
   • architecture, data model, data flows, cross-cutting decisions
5. specs/PROJ-<X>-<theme>/3-4_plan/PROJ-<X>-wave-*-plan.md
   • shipped user-story scope per wave
6. src/features/*/agent.md
   • non-obvious gotchas surfaced during implementation
7. package.json at BASE_SHA and HEAD
   • dependency and script deltas for setup/technical docs

Fallback only if structured inputs are absent:

8. git log --oneline --grep="PROJ-<X>" --reverse
9. focused code structure scan

Do not re-derive what structured inputs already provide. If a Wave PASSED block lists shipped stories, treat that as canonical.

Codex Adaptation

This skill was imported from a Claude workflow. In Codex, follow these overrides:

• Use project-root AGENTS.md for durable agent context.
• Keep project-root CLAUDE.md pointer-only if it exists or Claude compatibility is expected. It must reference AGENTS.md as required reading and must not contain curated rules.
• Do not use /compact, Claude Agent syntax, Claude interactive helpers, run_in_background, or Claude permission modes.
• Ask the user directly before merging any AGENTS.md candidate unless the current user request explicitly authorizes automatic merging.
• Apply the mandatory delegation contract whenever the active Codex instructions allow delegation.
• Keep documentation edits scoped to triggered files.

Documentation Standard

Write for a human maintainer or product owner who did not implement the feature.

• Curated, not exhaustive: explain the current truth of the app; link to PRDs for detailed acceptance criteria.
• Feature-first: PROJECT.md should answer "what can users do now?" before it talks about implementation.
• Technical clarity: TECHNICAL.md should explain architecture, technology choices, data model, data flows, deployment, and operational gotchas.
• Diagrams when useful: use Mermaid diagrams for system context, data model, state transitions, and critical data flows when the source material supports them.
• Source-backed: never invent entities, tables, services, queues, permissions, or flows. If a fact is inferred from code, say so briefly.
• Incremental curation: update stale sections, remove contradicted statements, and keep sibling PROJs intact.

Context Economy

Documentation arrives late in the chain. Keep the main context focused on progress.md, the current doc diff, and any user approvals.

• Read progress.md first to decide which outputs are triggered.
• Load concept, PRDs, architecture, wave plans, and source files only for the triggered output that needs them.
• If delegation is allowed, assign independent harvest tasks to subagents; otherwise do focused local reads.
• Keep long PRDs, architecture files, screenshots, and raw logs out of the final answer.

Workflow

1. Collect documentation inputs

Start with 5_progress/PROJ-<X>-progress.md. Then collect only the extra inputs needed for triggered outputs:

1. Feature purpose and boundaries: read the concept file if PROJECT.md or README.md needs human-facing purpose/scope text.
2. Shipped stories: parse Wave PASSED blocks first; fall back to 3-4_plan/PROJ-<X>-wave-*-plan.md headings matching ## PROJ-<X>-PRD-<Y>-US-<Z>:.
3. Feature behavior: read PRDs only to summarize capabilities, user workflows, edge cases, and links. Do not paste acceptance criteria.
4. Technical structure: read architecture and relevant agent.md files when TECHNICAL.md triggers.
5. Dependency delta: compare package.json at BASE_SHA to HEAD using structured JSON over dependencies and devDependencies.
6. Runtime/deployment facts: inspect package scripts, config files, env examples, and deployment notes only when README or TECHNICAL needs them.

Trigger evaluation:

• PROJECT.md: always true after QA passes
• README.md: first PROJ, dependency/setup/deployment delta, missing README, or explicit request
• TECHNICAL.md: architecture/data-flow/data-model/integration/dependency/agent-note change, missing technical doc, or explicit request
• AGENTS.md: ## AGENTS.md Candidates has at least one [PROPOSED] entry
• CLAUDE.md: missing when Claude compatibility is expected, or contains durable rules instead of only a pointer to AGENTS.md

Missing-sections fallback: if ## PROJ Retrospective or ## AGENTS.md Candidates is absent, proceed anyway and note the degraded input path in the final summary.

Only proceed to sections whose trigger fires.

2. Update docs/PROJECT.md

Always runs. This is the human feature guide, not a terse release log.

Required structure:

# Project - Features

**Last updated:** YYYY-MM-DD
**Features implemented:** <count>

---

## PROJ-<X>: <theme>

**Status:** <development | QA-passed | production>
**Purpose:** <one-sentence user/business goal from concept>
**Scope:** <what is included and intentionally excluded>

### Capabilities

- <user-facing thing the app can now do>
- <another capability>

### Primary Workflow

1. <human workflow step>
2. <human workflow step>
3. <outcome>

```mermaid
flowchart LR
  A[Start] --> B[Key user action]
  B --> C[System response]
  C --> D[Result]
```

### User Stories Implemented

- PROJ-<X>-PRD-1-US-1: <title>
- PROJ-<X>-PRD-1-US-2: <title>

### Notes

- **PRDs:** [PRD-1](../specs/PROJ-<X>-<theme>/2_PRDs/PROJ-<X>-PRD-1-<desc>.md)
- **QA:** <pass/bugs/residual-risk summary from QA Results>
- **Known limits:** <only if source-backed>

Guidelines:

• New PROJs append. Existing PROJs get only their own section refreshed.
• Include a Mermaid workflow only for meaningful multi-step behavior; skip it for trivial backend or setup-only changes.
• Keep feature text understandable to non-engineers.
• Do not duplicate detailed acceptance criteria, edge-case lists, or implementation plans.

3. Update README.md

Runs conditionally. README is the front door, not the technical deep dive.

Required structure:

# <Project Name>

> <one-sentence app purpose>

## What It Does

- <top-level capability>
- <top-level capability>
- <top-level capability>

## Quick Start

```bash
<install command>
<dev command>
```

## Tech Stack

- <framework> - <one-line purpose>
- <database/auth/styling/deployment> - <one-line purpose>

## Documentation

- [Features](docs/PROJECT.md) - human feature guide and workflows
- [Technical](docs/TECHNICAL.md) - architecture, data model, data flows, deployment, gotchas
- [AGENTS.md](./AGENTS.md) - durable conventions for AI-pair coding

Guidelines:

• Keep it short enough to scan.
• Mention setup requirements, env files, and scripts only at the level needed to run the app locally.
• Avoid duplicating TECHNICAL.md; link to it for architecture/data details.

4. Update docs/TECHNICAL.md

Runs conditionally. This is the maintainers' technical map of the app.

Required structure:

# Technical Reference

**Last updated:** YYYY-MM-DD

## System Overview

<short explanation of runtime shape and major modules>

```mermaid
flowchart LR
  User[User] --> App[App/UI]
  App --> API[API or server actions]
  API --> DB[(Database)]
```

## Architecture

<high-level architecture from PROJ architecture files>

## Technology Choices

| Area | Choice | Why it matters |
|---|---|---|
| Frontend | <tool> | <reason> |
| Data | <tool> | <reason> |

## Data Model

<entities, relationships, ownership, important constraints>

```mermaid
erDiagram
  USER ||--o{ ITEM : owns
```

## Data Flows

### <Flow Name>

<when this flow happens and why>

```mermaid
sequenceDiagram
  actor User
  participant App
  participant API
  participant DB
  User->>App: Action
  App->>API: Request
  API->>DB: Read/write
  API-->>App: Response
```

## Integrations and External Services

<APIs, auth providers, storage, payment, queues, model providers, email, analytics>

## Directory Structure

```text
src/
  app/       - <what lives here>
  features/  - <what lives here>
  lib/       - <what lives here>
```

## Dependencies

<runtime and dev dependencies with purpose, especially newly introduced ones>

## Deployment and Runtime

<provider, build command, env-var overview, persistence/runtime constraints>

## Operational Notes and Gotchas

<source-backed notes from agent.md, QA, post-wave notes, and retrospective>

Guidelines:

• Prefer Mermaid diagrams over prose when they reduce ambiguity.
• Include at least one diagram when TECHNICAL.md is created from scratch and architecture/data-flow information exists.
• Use flowchart, sequenceDiagram, erDiagram, or stateDiagram-v2 according to the source material.
• Do not create fake diagrams from guesses. If the data model is absent, write "No persistent data model documented yet" rather than inventing one.
• Update stale diagrams when the underlying architecture changes.
• Keep technology explanations practical: what it is used for, why it matters, and where to find it in the repo.

5. AGENTS.md merge

Runs only if ## AGENTS.md Candidates in progress.md has [PROPOSED] entries.

Algorithm:

1. Parse every [PROPOSED] line from progress.md's candidates section. Each line has a stable ID, such as AGENTS-PROJ1-QA-003.
2. For each candidate, ask the user directly:
   • Approve
   • Reject
   • Approve with edit
   • Skip
3. For each approved or edited candidate:
   • Append it to project-root AGENTS.md under an appropriate short heading.
   • Prefix the line with its ID as a comment anchor: <!-- AGENTS-PROJ1-QA-003 -->.
   • In progress.md, flip [PROPOSED] to [MERGED] by ID. Never delete the candidate line.
4. Enforce the 40-line hard cap on AGENTS.md.
   • Count non-blank lines, including headings.
   • If over 40, ask the user which old entries to remove. Do not delete automatically.
5. Rejected candidates are marked [REJECTED] in progress.md to prevent re-proposal.

Never edit AGENTS.md without explicit approval per entry. The user owns this file; Skill 7 only facilitates.

Autonomous mode (CODEX_AUTONOMOUS_LEVEL=balanced set):

• balanced: auto-merge a candidate only if high-confidence: two or more persona sources flagged the same rule, or the source is Dr. Sarah Chen (Security) or a DB-schema/RLS finding. Everything else is marked [REJECTED-BY-POLICY].
• conservative: reject all candidates for later user review.
• aggressive: auto-merge everything.

On 40-line overflow, balanced and aggressive evict oldest merged entries until within cap; conservative halts for user pruning. Log every auto-decision to 5_progress/PROJ-<X>-autonomous-log.md.

6. CLAUDE.md pointer

Runs if CLAUDE.md is missing while Claude compatibility is expected, or if it contains durable rules.

CLAUDE.md must stay a tiny pointer file. It should not be curated, should not receive QA candidates, and should not duplicate AGENTS.md.

Allowed content:

# Claude Instructions

Must read and follow [AGENTS.md](./AGENTS.md) before making changes. All durable agent instructions are curated in AGENTS.md only.

If an existing CLAUDE.md contains additional durable rules, move proposed durable rules through the normal AGENTS.md candidate flow instead of preserving them in CLAUDE.md.

7. Curated-context curation + P7 gates (framework runs)

Runs only in framework runs — specs/PROJ-<X>-<theme>/state.json exists and P7 is the running phase. Standalone documentation requests skip this section and the seal in section 8.

This is the curation step of CONCEPT.md §4 P7: the curated docs under docs/ (PRODUCT, ARCHITECTURE, GUIDELINES, DESIGN-SYSTEM, components — created by the intake baseline) are injected into every future implementer. They are updated HERE, gated on form and truth, and nowhere else. If no intake baseline exists yet, curate only the files that do exist — curation-caps.sh warns on missing baseline files instead of failing.

7a. Curate the long-lived docs (judgment first, gates after):

1. Merge surviving decisions from specs/.../architecture-delta.md and decisions.md entries with lasting value into docs/ARCHITECTURE.md. Document deviations as "planned X, built Y, because ..." — never silently overwrite the baseline.
2. Migrate ground-file assumptions this PROJ validated into docs/ARCHITECTURE.md/docs/GUIDELINES.md and DELETE them from ground-file.md — the ground file holds ONLY what docs/ does not (redundancy rule §5).
3. Update docs/PRODUCT.md for new user-facing scope or terms.
4. Update docs/GUIDELINES.md; durable project-wide rules still go through the AGENTS.md candidate pipeline (section 5), never directly.
5. Register new components in docs/components.md.
6. Curate src/**/agent.md: keep what this PROJ confirmed, delete what it outdated, promote project-wide entries to AGENTS.md candidates.

7b. Record authorship — the truth gate must know who curated:

bash scripts/state.sh set <X> <theme> '.authorship["docs-delta"]' \
  '{"author_provider":"<claude|codex>","author_model":"<model>"}'

7c. FORM gate: bash scripts/curation-caps.sh — exit != 0 means a cap is breached (PRODUCT <= 30 non-blank lines, ARCHITECTURE <= 200 lines, each agent.md <= 100 lines, AGENTS.md <= 40 non-blank lines). Shrink by curating — move detail into docs/architecture/, delete stale statements — and re-run until exit 0. Never delete true load-bearing statements just to fit the cap: the truth gate flags cap-gaming.

7d. TRUTH gate (BLOCKING):

The artifact list is EVERY doc-layer file this PROJ touched — curated baseline, generated docs, AGENTS.md, and curated agent.md files — not a fixed subset. Anything skipped here enters future context bundles unchecked.

BASE_SHA="$(bash scripts/state.sh get <X> <theme> .base_sha)"
ARTIFACTS="$(git diff --name-only "$BASE_SHA"..HEAD -- \
  docs/ AGENTS.md README.md 'src/**/agent.md' | tr '\n' ' ')"
# fallback when nothing doc-layer changed but curation ran anyway:
[ -n "$ARTIFACTS" ] || ARTIFACTS="docs/ARCHITECTURE.md docs/PRODUCT.md docs/GUIDELINES.md docs/components.md"
bash scripts/cross-review.sh docs <X> <theme> \
  --artifacts $ARTIFACTS \
  --author-key docs-delta \
  --diff-base "$BASE_SHA" \
  --diff-paths . ':(exclude)specs/**' ':(exclude)**/*.test.*' \
    ':(exclude)**/*.spec.*' ':(exclude)tests/**' ':(exclude)e2e/**' \
  --round 1

• No findings and exit 0 → proceed to section 8.
• Findings of any severity → fix the docs within approved scope, mark each fix (node scripts/ledger.mjs set-status <X> <theme> <id> fixed <commit> — an unmarked fix keeps blocking; a false "fixed" is reopened on re-report), re-run 7c, then automatically run --round 2 and, if findings remain, --round 3. Follow cross-review's three-round automatic limit; exit 0 with Medium/Low findings still triggers the next available round.
• After round 3 → remaining Critical/High findings stop the phase: escalate unresolved IDs. Defer remaining Medium/Low as debt and proceed to section 8 only when no blockers remain.
• exit 1 → infrastructure failure: also a stop condition — the truth gate did not run, the phase must not seal without it.

The runner independently re-verifies both gates after the seal — including that a docs cross-review actually RAN during this P7 (a skipped review is not a clean review); sealing past a red gate parks the run.

8. Git commit + P7 seal

One commit for the documentation update:

docs(PROJ-<X>): Update project documentation

If AGENTS.md was merged or CLAUDE.md was normalized to the pointer, include those changes in the same commit. Curated docs/ changes from section 7 belong in the same commit — they are part of the PR's "doc changes" section.

Framework runs: seal the phase afterwards — bash scripts/state.sh transition <X> <theme> P7 done. Never seal while 7c or 7d is red.

Content Ownership

Rules

• English for all generated docs, even if the conversation is German.
• Human-readable first; implementation details only where they explain behavior or maintenance.
• Do not duplicate PRDs, architecture plans, or QA logs; summarize and link.
• Prefer source-backed statements over confident reconstruction.
• Keep diagrams valid Mermaid and small enough to read.
• No emojis unless the user explicitly asks.
• Do not fabricate setup commands, environment variables, tables, queues, services, or integrations.

When to Run

• After Step 6 QA passes for a PROJ-X.
• When the user explicitly asks for documentation, feature docs, technical docs, diagrams, data model explanation, or data-flow explanation.

Legacy Folder Layout

PROJ folders created before the layout rename use different subfolder names. Mapping, old → current:

2_visual-companion/ → 1b_visual-companion/ · 4_design/ → 1c_design/ · 5_mockups/ → 1d_mockups/ · 3_PRDs/ → 2_PRDs/ · 8_handoff/ → 2b_handoff/ · 6_plan/ → 3-4_plan/ · 7_progress/ → 5_progress/

If an expected folder is missing but its legacy twin exists, read from the legacy one and keep writing where the existing files already are. Never create a second folder next to it — a split PROJ is worse than an old name. Say it once, then continue either way:

"This PROJ uses the old folder layout (<old>). Rename the folders to the current names, or continue with the existing layout?"

Renaming is a git mv per folder plus a search for the old paths in the PROJ's own documents. It is never a precondition for this skill.