- Add Cloud for Sovereignty landing zone architecture and deployment - Implement complete legal document management system - Reorganize documentation with improved navigation - Add infrastructure improvements (Dockerfiles, K8s, monitoring) - Add operational improvements (graceful shutdown, rate limiting, caching) - Create comprehensive project structure documentation - Add Azure deployment automation scripts - Improve repository navigation and organization
4.4 KiB
4.4 KiB
Documentation Reorganization - Quick Reference
Current Problems
🔴 Critical Issues
-
40+ files in
reports/- Massive duplication- 5+ "completion" files
- 4+ "remaining tasks" files
- 3+ "gaps" files
- 3+ "deprecation" files
-
20+ files in
deployment/- Overlapping content- 6 Azure CDN files (all covering same topic)
- 3 Entra VerifiedID files (all covering same topic)
- Multiple "complete" status files
-
5 root-level files - Should be organized
- Frontend files →
product/ - Integration files →
integrations/ - Setup files →
deployment/
- Frontend files →
Proposed Solution
✅ New Structure (Simplified)
docs/
├── README.md # Main navigation
├── GETTING_STARTED.md # Quick start
│
├── guides/ # User guides
├── architecture/ # Keep (good structure)
├── api/ # Keep (good structure)
├── configuration/ # Keep (good structure)
│
├── deployment/ # REORGANIZED
│ ├── README.md
│ ├── overview.md # Main guide
│ ├── azure/
│ │ ├── cdn-setup.md # ← 6 files merged
│ │ └── entra-verifiedid.md # ← 3 files merged
│ └── automation/
│
├── integrations/ # REORGANIZED
│ └── entra-verifiedid/ # ← 4 files organized
│
├── governance/ # REORGANIZED
│ ├── policies/ # ← Policies grouped
│ ├── procedures/ # ← Procedures grouped
│ └── frameworks/ # ← Frameworks grouped
│
├── legal/ # REORGANIZED
│ ├── policies/ # Legal policies
│ └── document-management/ # DMS docs
│
├── product/ # NEW
│ └── features/ # Frontend/product docs
│
└── archive/ # NEW
├── reports/ # Historical reports
└── deployment/ # Superseded deployment docs
Consolidation Targets
Reports → 3-4 Files
- 40+ files → 3-4 files
- Create:
reports/current-status.md(merged from 5+ files) - Create:
reports/active-tasks.md(merged from 4+ files) - Keep:
reports/testing-checklist.md - Archive: All others
Deployment → Organized Structure
- 20+ files → ~10 organized files
- Azure CDN: 6 files → 1 file
- Entra VerifiedID: 3 files → 1 file
- Automation: 3 files → 1 file
Integrations → Organized Structure
- 7 files → Organized by integration
- Entra VerifiedID: 4 files → Organized subdirectory
File Count Reduction
| Category | Current | Proposed | Reduction |
|---|---|---|---|
| Reports | 40+ | 3-4 | ~90% |
| Deployment | 20+ | ~10 | ~50% |
| Root Level | 6 | 0 | 100% |
| Total | 106+ | ~60 | ~43% |
Implementation Priority
Phase 1: High Impact (Do First)
- ✅ Consolidate
reports/directory (40+ → 3-4 files) - ✅ Consolidate
deployment/Azure files (9 → 2 files) - ✅ Move root-level files to proper locations
Phase 2: Organization (Do Second)
- ✅ Reorganize
governance/by type - ✅ Reorganize
legal/by concern - ✅ Organize
integrations/by integration
Phase 3: Navigation (Do Third)
- ✅ Create main README.md
- ✅ Create directory READMEs
- ✅ Add cross-references
Phase 4: Archive (Do Last)
- ✅ Move superseded files to archive/
- ✅ Add archive README
- ✅ Document what was merged
Key Benefits
✅ Findability: Clear structure, easy to find docs ✅ Maintainability: Single source of truth per topic ✅ Navigation: Clear READMEs and cross-references ✅ History: Archived, not deleted ✅ Reduction: ~43% fewer files to maintain
Quick Actions
Immediate Wins (1-2 hours)
# 1. Create archive structure
mkdir -p docs/archive/{reports,deployment}
# 2. Move obvious duplicates to archive
mv docs/reports/COMPLETION_*.md docs/archive/reports/
mv docs/reports/REMAINING_*.md docs/archive/reports/
# 3. Create consolidated files
# (See full plan for details)
Full Implementation (16-24 hours)
See docs/DOCUMENTATION_REORGANIZATION_PLAN.md for complete step-by-step plan.
Status: Plan Ready for Review
Next Step: Review plan, then execute Phase 1