docs consolidation work
This commit is contained in:
77
docs/implplan/archived/implementation-plans/README.md
Normal file
77
docs/implplan/archived/implementation-plans/README.md
Normal file
@@ -0,0 +1,77 @@
|
||||
# Implementation Plans Archive
|
||||
|
||||
This directory contains archived implementation_plan.md files from module documentation.
|
||||
|
||||
## Archive Date: 2025-12-25
|
||||
|
||||
Implementation plans have been consolidated into the respective module README.md files under an "Implementation Status" section. The original implementation_plan.md files have been archived here for reference.
|
||||
|
||||
## Archived Files
|
||||
|
||||
### Modules Consolidated (2025-12-25 - Final Batch)
|
||||
- orchestrator-implementation-plan.md
|
||||
- platform-implementation-plan.md
|
||||
- policy-implementation-plan.md
|
||||
- registry-implementation-plan.md
|
||||
- scanner-implementation-plan.md
|
||||
- scheduler-implementation-plan.md
|
||||
- signer-implementation-plan.md
|
||||
- telemetry-implementation-plan.md
|
||||
- ui-implementation-plan.md
|
||||
- vex-lens-implementation-plan.md
|
||||
- vuln-explorer-implementation-plan.md
|
||||
- zastava-implementation-plan.md
|
||||
|
||||
### Previously Archived Modules
|
||||
- advisory-ai-implementation-plan.md
|
||||
- attestor-implementation-plan.md
|
||||
- authority-implementation-plan.md
|
||||
- ci-implementation-plan.md
|
||||
- cli-implementation-plan.md
|
||||
- concelier-implementation-plan.md
|
||||
- devops-implementation-plan.md
|
||||
- excititor-implementation-plan.md
|
||||
- export-center-implementation-plan.md
|
||||
- findings-ledger-implementation-plan.md
|
||||
- graph-implementation-plan.md
|
||||
- notify-implementation-plan.md
|
||||
|
||||
## What Was Consolidated
|
||||
|
||||
For each module, the following content was extracted from implementation_plan.md and added to README.md:
|
||||
|
||||
### Included in Implementation Status:
|
||||
- High-level delivery phases with status (Complete/In Progress/Planned/Not Started)
|
||||
- Key acceptance criteria (5-10 bullets max)
|
||||
- Technical decisions and risk mitigations (5-10 bullets max)
|
||||
- Epic alignments and milestones
|
||||
- Current workstreams and blocking items (where applicable)
|
||||
- Recent updates and operational assets
|
||||
|
||||
### Excluded from README.md:
|
||||
- Detailed task IDs and sprint tables
|
||||
- TODO/DOING/DONE status columns
|
||||
- Execution logs and sprint trackers
|
||||
- Granular work breakdown structures
|
||||
- Detailed test strategies (unit/integration/performance specifics)
|
||||
- Sprint readiness tracker tables
|
||||
|
||||
## Finding Current Status
|
||||
|
||||
For current implementation status, see:
|
||||
- Module-specific README.md: `docs/modules/{module}/README.md`
|
||||
- Sprint files: `docs/implplan/SPRINT_*.md`
|
||||
- Module task trackers: `docs/modules/{module}/TASKS.md` or `src/{Module}/**/TASKS.md`
|
||||
|
||||
## Rationale
|
||||
|
||||
Implementation plans contained extensive sprint-level detail that:
|
||||
1. Duplicated information in sprint trackers and TASKS.md files
|
||||
2. Created maintenance burden across multiple files
|
||||
3. Obscured high-level status for newcomers and operators
|
||||
|
||||
The consolidation provides:
|
||||
1. Single source of truth for high-level status in README.md
|
||||
2. Detailed sprint/task tracking remains in dedicated TASKS.md and sprint files
|
||||
3. Improved discoverability of module status and epic alignment
|
||||
4. Reduced documentation drift across files
|
||||
Reference in New Issue
Block a user