2.4 KiB
2.4 KiB
Project: Documentation Refresh and Archive Plan (2026)
Goal: Keep onboarding docs fast and current while preserving historical context in archive.
1) Naming Standard
Use one of these prefixes consistently:
BOOTSTRAP__for first-read onboarding.GUIDE__for cross-module technical guides.MODULE__for module-specific docs.PROJECT__for active, time-bounded workstreams.PROPOSAL__for design proposals not yet adopted.REFERENCE__for evergreen troubleshooting/reference catalogs.
2) Module Coverage Baseline (Active)
Minimum one module doc per active module family:
- Events Presentation Management ->
MODULE__AE_Events_Presentation_Management.md - Events Launcher ->
MODULE__AE_Events_Launcher.md - Events Launcher Native ->
MODULE__AE_Events_Launcher_Native.md - Events Badges ->
MODULE__AE_Events_Badges.md - Events Leads ->
MODULE__AE_Events_Leads.md - Journals ->
MODULE__AE_Journals.md - IDAA Archives ->
MODULE__AE_IDAA_Archives.md - IDAA Bulletin Board ->
MODULE__AE_IDAA_Bulletin_Board.md - IDAA Recovery Meetings ->
MODULE__AE_IDAA_Recovery_Meetings.md - IDAA Video Conferences ->
MODULE__AE_IDAA_Video_Conferences.md
3) Archive Strategy
Archive docs that are superseded, duplicate, or no longer operationally used.
Do not delete historical context; move to documentation/archive/ with clear names.
Completed in this pass
- Moved
MODULE__AE_Events_Launcher_Config_Menu_new.md->archive/PROPOSAL__AE_Events_Launcher_Config_Menu_Unified_Vision_v3_1.md.
Next archive candidates (review + approve)
- Older style-review snapshots once current style guide references are centralized.
- Closed project docs where TODO/archive already capture final status.
- Duplicate docs where one
MODULE__file and onePROJECT__file now overlap heavily.
4) Review Cadence
Monthly lightweight review:
- Verify
BOOTSTRAP__AI_Agent_Quickstart.mdlinks still resolve and reflect active work. - Verify each active module has one current
MODULE__anchor doc. - Move stale proposals and completed projects into archive.
- Update
REFERENCE__Common_Agent_Mistakes.mdkeep/archive sections.
5) Immediate Follow-Up Tasks
- Add a single docs index (
documentation/README__Docs_Index.md) with routing by task type. - Normalize any remaining filenames with spaces or inconsistent separators.
- Add
Last Updatedmetadata lines to allMODULE__docs. - Run a link-check pass across documentation files.