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.6.0 (canonical value: ./schema/project-wiki.yml).
Route The Task
Select one primary mode for an explicit wiki request and load only its workflow:
| Trigger |
Load |
init - Initialize an empty project wiki |
Init Workflow |
scan - Scan an existing repository |
Scan Existing Project Workflow |
update - Process notes, requirements, meetings, or durable analysis |
Update Workflow |
update - Ingest PDF, DOCX, text, or Markdown sources |
Document Intake Workflow, then Document Ingestion |
sync - Reconcile code changed outside the current agent task |
Sync Workflow |
maintain - Validate, migrate, repair, or semantically lint a wiki |
Maintain Workflow |
Before implementing, modifying, debugging, refactoring, testing, documenting, or planning code when .project-wiki/INDEX.md exists |
Automatic Context Preflight |
| After agent-made source changes |
Automatic Post-Implementation Wiki Update |
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.
Operating Contract
- 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.
- Run the automatic workflows around code work when the wiki exists; reserve
sync for external or manual changes.
- Follow the selected workflow completely. Prefer the supplied deterministic scripts over reproducing structural, validation, duplicate, extraction, or ledger logic in model reasoning.
- 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.
1---2name: project-wiki3description: Create, scan, update, sync, and maintain .project-wiki/ project knowledge bases, including requirements, document intake, and traceability. Consult and update an existing project wiki during coding tasks.4---56# Project Wiki78Maintain an agent-readable knowledge base in `.project-wiki/`. Load only the workflow and project context needed for the task.910Current project wiki schema version: `1.6.0` (canonical value: `./schema/project-wiki.yml`).1112## Route The Task1314Select one primary mode for an explicit wiki request and load only its workflow:1516| Trigger | Load |17| --- | --- |18| `init` - Initialize an empty project wiki | [Init Workflow](./references/initialization-workflows.md#init-workflow) |19| `scan` - Scan an existing repository | [Scan Existing Project Workflow](./references/initialization-workflows.md#scan-existing-project-workflow) |20| `update` - Process notes, requirements, meetings, or durable analysis | [Update Workflow](./references/update-workflows.md#update-workflow) |21| `update` - Ingest PDF, DOCX, text, or Markdown sources | [Document Intake Workflow](./references/update-workflows.md#document-intake-workflow), then [Document Ingestion](./references/document-ingestion.md) |22| `sync` - Reconcile code changed outside the current agent task | [Sync Workflow](./references/synchronization-workflow.md#sync-workflow) |23| `maintain` - Validate, migrate, repair, or semantically lint a wiki | [Maintain Workflow](./references/maintenance-workflows.md#maintain-workflow) |24| Before implementing, modifying, debugging, refactoring, testing, documenting, or planning code when `.project-wiki/INDEX.md` exists | [Automatic Context Preflight](./references/automatic-workflows.md#automatic-context-preflight) |25| After agent-made source changes | [Automatic Post-Implementation Wiki Update](./references/automatic-workflows.md#automatic-post-implementation-wiki-update) |2627Use [Document Templates](./assets/document-templates.md) when creating artifacts and [Requirement Authoring](./assets/requirements-change-templates.md#requirements-topic-scaling) for atomic REQ/NFR/CON records. Read [Wiki Structure](./references/wiki-structure.md) or [Schema Contract](./schema/project-wiki.yml) only for exact structure or contract values. Finalize edits with [Common Policies](./references/common-policies.md), including reconciliation and audit logging.2829## Operating Contract30311. 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.322. Run the automatic workflows around code work when the wiki exists; reserve `sync` for external or manual changes.333. Follow the selected workflow completely. Prefer the supplied deterministic scripts over reproducing structural, validation, duplicate, extraction, or ledger logic in model reasoning.344. Finalize every meaningful edit with the shared checklist and audit log; reconcile only affected records.3536Use `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](./references/repository-scope.md) only for configuration or troubleshooting.3738## Invariants3940- Keep stable IDs, required frontmatter, relative wiki links, and the complete canonical structure. Preserve history and original requirements rather than silently replacing them.41- 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.42- 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.43- Mark uncertain scan findings as `confidence: inferred` or `confidence: unknown`.44- Keep indexes as compact routing maps. File durable non-canonical synthesis only when significant and link it to evidence or related records.45- 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.46- Write all wiki content and generated instruction blocks in English. Reply in the user's language unless requested otherwise.
giodra96