Archive

Living documentation

Always in sync with code. Facts only — no plans, no interpretation.

• README.md — users: what it is, who for, how to use; links to tech-spec
• docs/tech-spec.md — developers/agents: current system state (see format below)
• docs/specs/*.md — split-out details when tech-spec grows too large; referenced by path
• docs/ROADMAP.md — direction (exists when ≥3 milestones or long-term)

Project artifacts — not merged into living docs:

• CHANGELOG.md — version history (ship maintains)
• docs/decisions/ — architectural decisions, append-only

tech-spec format

Declarations only.

purpose:      <what problem this solves — one sentence>
user:         <who uses this>
use-case:     <key scenarios, one line each>
architecture: <structural shape — one line, or see docs/architecture.md>
stack:        <language, runtime, frameworks, key deps>
entry:        <where execution starts>
contract:     <public APIs / interfaces that must not break>
flow:         <name>: <trigger> → <steps> → <output>
              (complex — branching/async/multi-actor: one-line summary here, diagram in docs/specs/<flow>.md)
invariant:    <what must always hold>
constraint:   <limits, warnings from code>
convention:   <naming, file structure, test patterns>
milestone:    <current milestone> (see docs/ROADMAP.md)

Archive

<gate>Before proceeding: (1) verify tdd/subagents have completed all tasks listed in the plan; (2) confirm the user has provided explicit written approval.</gate>

1. Merge staging spec (minus roadmap) into living doc. Not copy-paste — integrate, preserve existing structure.

2. Roadmap (if spec contains ## Roadmap): do not re-copy — roadmap updates independently.

3. Decisions (if spec or working notes contain a knowledge artifact — protocol spec, RE findings, architectural rationale): save to docs/decisions/YYYY-MM-DD-<topic>.md as context / choice / ruled-out.

<gate> confirm the merged content with the user before deleting staging spec and plan. </gate>

4. Delete docs/staging/specs/YYYY-MM-DD-<topic>.md — content absorbed; Git has the history.
5. Delete docs/staging/plans/YYYY-MM-DD-<topic>.md — plans don't belong on main.

Source: hashgraph-online/awesome-codex-plugins → plugins/ouonet/praxis/skills/archive/SKILL.md