Files
OSIT-AE-App-Svelte/documentation/PROJECT__Documentation_Refresh_and_Archive_Plan_2026.md

3.6 KiB

Project: Documentation Refresh and Archive Plan (2026)

Last Updated: 2026-06-12

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.
  • Moved PROPOSAL__IDAA_UI_UX_Roadmap_2026.md -> archive/PROPOSAL__IDAA_Recovery_Meetings_UI_UX_Roadmap_2026.md.
  • Renamed MODULE__AE Journals_config_map.md -> MODULE__AE_Journals_Config_Map.md.
  • Renamed PROJECT__AE_UI_Journals_module_update_2026.md -> PROJECT__AE_UI_Journals_Module_Update_2026.md.
  • Renamed AE_Docker_CI_cache_policy.md -> AE__Docker_CI_Cache_Policy.md.
  • Archived PROJECT__AE_Style_Review.md -> archive/PROJECT__AE_Style_Review_2026-03.md (active style source is GUIDE__AE_UI_Style_Guidelines.md).
  • Clarified scope split: GUIDE__AE_Events_Badges_Onsite.md = deep badge-print reference, GUIDE__AE_Events_Onsite_Runbook.md = cross-module onsite operations runbook.
  • Validated all documentation/*.md references in active docs; no missing targets remain.
  • Added ownership and review-trigger metadata to the bootstrap, task list, and docs index.
  • Reviewed active project docs for archive eligibility. Object Field Editor and Site Passcode Security remain active and were added to the docs index.

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 one PROJECT__ file now overlap heavily.

4) Review Cadence

Monthly lightweight review:

  1. Verify BOOTSTRAP__AI_Agent_Quickstart.md links still resolve and reflect active work.
  2. Verify each active module has one current MODULE__ anchor doc.
  3. Move stale proposals and completed projects into archive.
  4. Update REFERENCE__Common_Agent_Mistakes.md keep/archive sections.

5) Immediate Follow-Up Tasks

  1. Run a quarterly archive review: identify stale PROJECT__ docs with no TODO or index linkage and move them to documentation/archive/.
  2. Review AE__* reference docs for overlap, outdated stack assumptions, and inconsistent naming.
  3. Review module docs against current routes and store names rather than relying only on filename/header freshness.
  4. Add a lightweight reusable link-check script if manual path validation becomes frequent.