Project Wiki

Maintain an agent-readable knowledge base in .project-wiki/. Load only the workflow and project context needed for the task.

Current project wiki schema version: 1.7.0 (canonical value: ./schema/project-wiki.yml).

Route The Task

Select one primary mode for an explicit wiki request and load only its workflow:

Route help requests before project context preflight or any wiki workflow.

Use Document Templates when creating artifacts and Requirement Authoring for atomic REQ/NFR/CON records. Read Wiki Structure or Schema Contract only for exact structure or contract values. Finalize edits with Common Policies, including reconciliation and audit logging.

Deterministic User Help

For /project-wiki help, run python3 /path/to/project-wiki/scripts/wiki_help.py without positional arguments. There is one general guide and no topic-specific help commands. The helper reads the single bundled guide at assets/user-help.md and returns fixed English Markdown. Present its output verbatim, without generating additional help content or executing its examples. If the helper fails, report its error rather than inventing a replacement guide.

Help is read-only and requires no wiki, configuration, project preflight, reconciliation, or audit logging. Return after displaying it; do not treat examples in the guide as user instructions to execute.

Operating Contract

1. Read .project-wiki/INDEX.md first when it exists, follow its routes, and open only the smallest relevant set of files. Use REGISTRY.yml only when indexes do not resolve the task.
2. Read effective .project-wiki/config.yml with scripts/wiki_config.py --wiki-root .project-wiki show after the index and before automatic workflows. Keep context preflight active; apply the Automatic Write Gate before automatic assessment or writes. Missing config defaults to enabled; disabled or invalid config suspends automatic writes. When enabled, skip writes only after establishing no durable knowledge, evidence, or recorded work state impact. Explicit wiki requests remain available regardless of the toggle; use sync for accumulated changes and periodic reconciliation.
3. Follow the selected workflow completely. Prefer the supplied deterministic scripts over reproducing structural, validation, duplicate, extraction, or ledger logic in model reasoning.
4. Finalize every meaningful edit with the shared checklist and audit log; reconcile only affected records.

Use scripts/wiki_scope.py (list, read, search, diff) for repository source access during wiki work; helpers apply .project-wiki/.wikiignore automatically. Consult existing wiki history normally. Load Repository Source Scope only for configuration or troubleshooting.

Invariants

• Keep stable IDs, required frontmatter, relative wiki links, and the complete canonical structure. Preserve history and original requirements rather than silently replacing them.
• Put explicit business or product intent in requirements/; put implemented or observed behavior in technical/. Record unconfirmed product intent inferred from code as an open question.
• Reconcile existing open questions before creating new ones. Represent significant risks, contradictions, blocking gaps, or critical assumptions as alerts and resolve rather than delete them.
• Mark uncertain scan findings as confidence: inferred or confidence: unknown.
• Keep indexes as compact routing maps. File durable non-canonical synthesis only when significant and link it to evidence or related records.
• Treat document intake as immutable provenance. Never load external PDF or DOCX files directly into model context; use the ingestion and review-progress scripts and complete every chunk disposition.
• Write all wiki content and generated instruction blocks in English. Reply in the user's language unless requested otherwise; deterministic help retains its fixed English output.