56 lines
3.2 KiB
Markdown
56 lines
3.2 KiB
Markdown
# Documentation Catalog and Truth Audit Plan
|
|
|
|
**Task:** DOCS-IA-002
|
|
**Internal reference:** `TASKS:DOCS-IA-002`
|
|
**Goal:** Catalog the existing Mosaic Stack documentation, identify its intended destination in the new structure, and audit validity/truthfulness against repository evidence before moving or rewriting content.
|
|
|
|
## Scope
|
|
|
|
- Current root-level documentation and newly established structure files.
|
|
- All Markdown and relevant YAML/API artifacts under `docs/_old_structure/`.
|
|
- Repository references from source, tests, scripts, guides, and root README files.
|
|
- Static truth checks for paths, commands, package names, environment variables, API artifacts, and explicit document status.
|
|
|
|
## Non-goals
|
|
|
|
- Do not move, delete, or rewrite documentation.
|
|
- Do not decide product requirements that belong in `docs/PRD.md`.
|
|
- Do not mark a claim true solely because it appears in a document.
|
|
- Do not modify active `docs/TASKS.md` because it has a single-writer orchestrator policy.
|
|
|
|
## Parallel discovery lanes
|
|
|
|
1. **File catalog:** path, title, type, size, line count, current/archive location, last repository change.
|
|
2. **Navigation audit:** Markdown and Obsidian links, target resolution, broken-link clusters, source references.
|
|
3. **Code-surface audit:** package names, scripts, entry points, referenced docs, paths used by tests and source.
|
|
4. **Truth triage:** compare current claims against executable code/config/tests and label evidence strength.
|
|
|
|
Parallel lanes produce findings only. The coordinator reconciles them into one report so truth labels remain consistent.
|
|
|
|
## Evidence statuses
|
|
|
|
- `verified`: directly supported by current source/config/tests or a reproducible command.
|
|
- `partially-verified`: some claims are supported, but the page contains unverified or time-sensitive claims.
|
|
- `contradicted`: current repository evidence conflicts with a material claim.
|
|
- `stale`: formerly meaningful but no longer aligned with current paths, APIs, or state.
|
|
- `historical`: intentionally retained record of past state; not a current instruction.
|
|
- `draft`: normative proposal or requirement, not a statement of shipped behavior.
|
|
- `unverified`: not yet checked or insufficient evidence exists.
|
|
- `incomplete`: empty or structurally insufficient for its stated role.
|
|
|
|
## Deliverables
|
|
|
|
- `docs/reports/documentation/2026-08-10-docs-catalog-audit.md` — human-readable catalog, findings, evidence, and migration recommendations.
|
|
- `docs/scratchpads/DOCS-IA-002-catalog-audit.md` — task progress and command evidence.
|
|
|
|
A machine-readable intermediate inventory may remain under `/tmp`; it is not canonical unless explicitly copied into the report.
|
|
|
|
## Acceptance criteria
|
|
|
|
- Every current documentation file and every archived documentation file is counted and assigned a preliminary disposition.
|
|
- Broken internal links and repository references are enumerated with evidence.
|
|
- Truth labels distinguish current behavior, normative intent, historical evidence, and unresolved claims.
|
|
- High-risk contradictions and source/test dependencies are called out before any migration.
|
|
- The report recommends migration order and identifies pages requiring human/product-owner validation.
|
|
- No existing documentation or unrelated working-tree state is modified.
|