499 lines
19 KiB
Markdown
499 lines
19 KiB
Markdown
|
# Documentation Reorganization Plan
|
||
|
|
|
||
|
|
## Executive Summary
|
||
|
|
|
||
|
|
This plan addresses significant duplication, disorganization, and structural issues in the `docs/` directory. The current structure has **106+ markdown files** with substantial overlap, especially in `reports/` (40+ files) and `deployment/` (20+ files).
|
||
|
|
|
||
|
|
## Current State Analysis
|
||
|
|
|
||
|
|
### Directory Structure
|
||
|
|
```
|
||
|
|
docs/
|
||
|
|
├── api/ (1 file)
|
||
|
|
├── architecture/ (2 files)
|
||
|
|
├── configuration/ (1 file)
|
||
|
|
├── deployment/ (20+ files) ⚠️ HIGH DUPLICATION
|
||
|
|
├── design/ (1 file)
|
||
|
|
├── governance/ (20+ files)
|
||
|
|
├── integrations/ (7 files)
|
||
|
|
├── legal/ (8 files)
|
||
|
|
├── operations/ (1 file)
|
||
|
|
├── product/ (1 file)
|
||
|
|
├── reports/ (40+ files) ⚠️ HIGH DUPLICATION
|
||
|
|
├── training/ (1 file)
|
||
|
|
└── [root level] (5 files) ⚠️ SHOULD BE ORGANIZED
|
||
|
|
```
|
||
|
|
|
||
|
|
### Key Issues Identified
|
||
|
|
|
||
|
|
#### 1. **Reports Directory - Major Duplication**
|
||
|
|
- Multiple "completion" files: `COMPLETION_STATUS.md`, `COMPLETION_SUMMARY.md`, `TASK_COMPLETION_SUMMARY.md`
|
||
|
|
- Multiple "remaining tasks" files: `REMAINING_TASKS.md`, `REMAINING_TODOS.md`, `REMAINING_TODOS_QUICK_REFERENCE.md`, `ALL_REMAINING_TASKS.md`
|
||
|
|
- Multiple "gaps" files: `GAPS_SUMMARY.md`, `GAPS_AND_PLACEHOLDERS.md`
|
||
|
|
- Multiple "frontend" files: `FRONTEND_COMPLETE.md`, `FRONTEND_COMPONENTS_VERIFICATION.md`
|
||
|
|
- Multiple "deprecation" files: `DEPRECATION_FIXES_COMPLETE.md`, `DEPRECATION_FIXES_RECOMMENDATIONS.md`, `FINAL_DEPRECATION_STATUS.md`
|
||
|
|
- Multiple "todo" files: `COMPLETE_TODO_LIST.md`, `TODOS_AND_PLACEHOLDERS.md`, `TODO_RECOMMENDATIONS.md`
|
||
|
|
|
||
|
|
#### 2. **Deployment Directory - Duplication**
|
||
|
|
- Multiple Azure CDN files: `AZURE_CDN_SETUP.md`, `AZURE_CDN_COMPLETE.md`, `AZURE_CDN_STATUS.md`, `AZURE_CDN_FINAL_STATUS.md`, `AZURE_CDN_QUICK_START.md`, `AZURE_CDN_SETUP_COMPLETE.md`
|
||
|
|
- Multiple Entra files: `ENTRA_COMPLETE_SUMMARY.md`, `ENTRA_VERIFIEDID_DEPLOYMENT_CHECKLIST.md`, `ENTRA_VERIFIEDID_NEXT_STEPS.md`
|
||
|
|
- Multiple automation files: `AUTOMATION_COMPLETE.md`, `AUTOMATION_SUMMARY.md`, `SEAL_DEPLOYMENT_AUTOMATION.md`
|
||
|
|
- Multiple completion files: `ALL_TODOS_COMPLETE.md`, `COMPLETE_TODO_STATUS.md`
|
||
|
|
|
||
|
|
#### 3. **Root Level Files - Should Be Organized**
|
||
|
|
- `FRONTEND_COMPLETION_SUMMARY.md` → Should be in `reports/` or `product/`
|
||
|
|
- `FRONTEND_IMPLEMENTATION_PROGRESS.md` → Should be in `reports/` or `product/`
|
||
|
|
- `INTEGRATION_COMPLETE.md` → Should be in `reports/` or `integrations/`
|
||
|
|
- `WEB_UI_COVERAGE_ANALYSIS.md` → Should be in `reports/` or `product/`
|
||
|
|
- `GITHUB_SETUP.md` → Should be in `deployment/` or `operations/`
|
||
|
|
- `eresidency-integration-summary.md` → Should be in `integrations/`
|
||
|
|
|
||
|
|
#### 4. **Missing Structure**
|
||
|
|
- No clear separation between "current status" and "historical/archived"
|
||
|
|
- No versioning strategy for documentation
|
||
|
|
- No clear "getting started" or "quick start" guide
|
||
|
|
- No index/navigation structure
|
||
|
|
|
||
|
|
## Proposed Reorganization
|
||
|
|
|
||
|
|
### New Structure
|
||
|
|
|
||
|
|
```
|
||
|
|
docs/
|
||
|
|
├── README.md # Main index with navigation
|
||
|
|
├── GETTING_STARTED.md # Quick start guide
|
||
|
|
│
|
||
|
|
├── guides/ # User-facing guides
|
||
|
|
│ ├── README.md
|
||
|
|
│ ├── quick-start.md
|
||
|
|
│ ├── development-setup.md
|
||
|
|
│ └── deployment-guide.md
|
||
|
|
│
|
||
|
|
├── architecture/ # Architecture docs (keep)
|
||
|
|
│ ├── README.md
|
||
|
|
│ └── adrs/
|
||
|
|
│
|
||
|
|
├── api/ # API documentation
|
||
|
|
│ ├── README.md
|
||
|
|
│ ├── identity-service.md
|
||
|
|
│ └── legal-documents-service.md # New: from legal/API_DOCUMENTATION.md
|
||
|
|
│
|
||
|
|
├── configuration/ # Configuration docs (keep)
|
||
|
|
│ └── ENVIRONMENT_VARIABLES.md
|
||
|
|
│
|
||
|
|
├── deployment/ # DEPLOYMENT DOCS (consolidated)
|
||
|
|
│ ├── README.md # Main deployment index
|
||
|
|
│ ├── overview.md # Consolidated from multiple files
|
||
|
|
│ ├── azure/
|
||
|
|
│ │ ├── README.md
|
||
|
|
│ │ ├── cdn-setup.md # Consolidated from 6+ Azure CDN files
|
||
|
|
│ │ ├── entra-verifiedid.md # Consolidated from 3+ Entra files
|
||
|
|
│ │ └── prerequisites.md
|
||
|
|
│ ├── kubernetes/
|
||
|
|
│ │ └── README.md
|
||
|
|
│ ├── terraform/
|
||
|
|
│ │ └── README.md
|
||
|
|
│ └── automation/
|
||
|
|
│ ├── README.md
|
||
|
|
│ └── seal-deployment.md
|
||
|
|
│
|
||
|
|
├── design/ # Design docs (keep)
|
||
|
|
│ └── ORDER_SEALS_DESIGN_GUIDE.md
|
||
|
|
│
|
||
|
|
├── governance/ # Governance docs (keep, minor cleanup)
|
||
|
|
│ ├── README.md
|
||
|
|
│ ├── policies/
|
||
|
|
│ │ ├── ABAC_POLICY.md
|
||
|
|
│ │ ├── SECURITY.md
|
||
|
|
│ │ └── CONTRIBUTING.md
|
||
|
|
│ ├── procedures/
|
||
|
|
│ │ ├── root-key-ceremony-runbook.md
|
||
|
|
│ │ ├── kyc-aml-sop.md
|
||
|
|
│ │ └── security-audit-checklist.md
|
||
|
|
│ └── frameworks/
|
||
|
|
│ ├── trust-framework-policy.md
|
||
|
|
│ ├── privacy-pack.md
|
||
|
|
│ └── threat-model.md
|
||
|
|
│
|
||
|
|
├── integrations/ # Integration docs (consolidated)
|
||
|
|
│ ├── README.md
|
||
|
|
│ ├── entra-verifiedid/
|
||
|
|
│ │ ├── README.md # Main integration guide
|
||
|
|
│ │ ├── setup.md # Consolidated from multiple files
|
||
|
|
│ │ ├── credential-images.md
|
||
|
|
│ │ ├── best-practices.md
|
||
|
|
│ │ └── json-content-readiness.md
|
||
|
|
│ ├── eu-laissez-passer/
|
||
|
|
│ │ └── specification.md
|
||
|
|
│ └── eresidency/
|
||
|
|
│ └── integration-summary.md
|
||
|
|
│
|
||
|
|
├── legal/ # Legal & document management
|
||
|
|
│ ├── README.md
|
||
|
|
│ ├── policies/
|
||
|
|
│ │ └── ABAC_POLICY.md
|
||
|
|
│ └── document-management/
|
||
|
|
│ ├── README.md
|
||
|
|
│ ├── user-guide.md
|
||
|
|
│ ├── api-reference.md
|
||
|
|
│ └── implementation/
|
||
|
|
│ ├── overview.md
|
||
|
|
│ └── gaps-analysis.md
|
||
|
|
│
|
||
|
|
├── operations/ # Operations runbooks
|
||
|
|
│ ├── README.md
|
||
|
|
│ └── entra-verifiedid-runbook.md
|
||
|
|
│
|
||
|
|
├── product/ # Product documentation
|
||
|
|
│ ├── README.md
|
||
|
|
│ ├── features/
|
||
|
|
│ │ └── frontend-coverage.md
|
||
|
|
│ └── roadmaps/
|
||
|
|
│ └── README.md
|
||
|
|
│
|
||
|
|
├── training/ # Training materials (keep)
|
||
|
|
│ └── entra-verifiedid-training.md
|
||
|
|
│
|
||
|
|
└── archive/ # ARCHIVED/SUPERSEDED DOCS
|
||
|
|
├── README.md # Explains what's archived and why
|
||
|
|
├── reports/ # All old reports/ files
|
||
|
|
│ ├── completion-status-2024-12.md
|
||
|
|
│ ├── remaining-tasks-2024-12.md
|
||
|
|
│ └── [other historical reports]
|
||
|
|
└── deployment/ # Superseded deployment docs
|
||
|
|
└── [old deployment files]
|
||
|
|
```
|
||
|
|
|
||
|
|
## Detailed Reorganization Steps
|
||
|
|
|
||
|
|
### Phase 1: Create New Structure
|
||
|
|
|
||
|
|
1. **Create new directories:**
|
||
|
|
```bash
|
||
|
|
mkdir -p docs/guides
|
||
|
|
mkdir -p docs/deployment/azure
|
||
|
|
mkdir -p docs/deployment/kubernetes
|
||
|
|
mkdir -p docs/deployment/terraform
|
||
|
|
mkdir -p docs/deployment/automation
|
||
|
|
mkdir -p docs/integrations/entra-verifiedid
|
||
|
|
mkdir -p docs/integrations/eu-laissez-passer
|
||
|
|
mkdir -p docs/integrations/eresidency
|
||
|
|
mkdir -p docs/governance/policies
|
||
|
|
mkdir -p docs/governance/procedures
|
||
|
|
mkdir -p docs/governance/frameworks
|
||
|
|
mkdir -p docs/legal/policies
|
||
|
|
mkdir -p docs/legal/document-management
|
||
|
|
mkdir -p docs/legal/document-management/implementation
|
||
|
|
mkdir -p docs/product/features
|
||
|
|
mkdir -p docs/product/roadmaps
|
||
|
|
mkdir -p docs/archive/reports
|
||
|
|
mkdir -p docs/archive/deployment
|
||
|
|
```
|
||
|
|
|
||
|
|
### Phase 2: Consolidate Reports Directory
|
||
|
|
|
||
|
|
**Action:** Move all `reports/` files to `archive/reports/` and create consolidated summaries.
|
||
|
|
|
||
|
|
**Files to Archive:**
|
||
|
|
- All completion/status files → Create single `docs/reports/current-status.md`
|
||
|
|
- All remaining tasks files → Create single `docs/reports/active-tasks.md`
|
||
|
|
- All gap analysis files → Merge into `docs/legal/document-management/implementation/gaps-analysis.md`
|
||
|
|
- All deprecation files → Archive (historical)
|
||
|
|
- All frontend files → Move to `docs/product/features/frontend-coverage.md`
|
||
|
|
|
||
|
|
**New Consolidated Files:**
|
||
|
|
1. `docs/reports/current-status.md` - Single source of truth for project status
|
||
|
|
2. `docs/reports/active-tasks.md` - Current active tasks (updated regularly)
|
||
|
|
3. `docs/reports/testing-checklist.md` - Keep (still useful)
|
||
|
|
|
||
|
|
### Phase 3: Consolidate Deployment Directory
|
||
|
|
|
||
|
|
**Azure CDN Files (6 files → 1 file):**
|
||
|
|
- Merge: `AZURE_CDN_SETUP.md`, `AZURE_CDN_COMPLETE.md`, `AZURE_CDN_STATUS.md`, `AZURE_CDN_FINAL_STATUS.md`, `AZURE_CDN_QUICK_START.md`, `AZURE_CDN_SETUP_COMPLETE.md`
|
||
|
|
- Create: `docs/deployment/azure/cdn-setup.md` (single comprehensive guide)
|
||
|
|
|
||
|
|
**Entra VerifiedID Files (3 files → 1 file):**
|
||
|
|
- Merge: `ENTRA_COMPLETE_SUMMARY.md`, `ENTRA_VERIFIEDID_DEPLOYMENT_CHECKLIST.md`, `ENTRA_VERIFIEDID_NEXT_STEPS.md`
|
||
|
|
- Create: `docs/deployment/azure/entra-verifiedid.md` (single deployment guide)
|
||
|
|
|
||
|
|
**Automation Files (3 files → 1 file):**
|
||
|
|
- Merge: `AUTOMATION_COMPLETE.md`, `AUTOMATION_SUMMARY.md`, `SEAL_DEPLOYMENT_AUTOMATION.md`
|
||
|
|
- Create: `docs/deployment/automation/seal-deployment.md`
|
||
|
|
|
||
|
|
**Keep:**
|
||
|
|
- `DEPLOYMENT_GUIDE.md` → Rename to `docs/deployment/overview.md`
|
||
|
|
- `DEPLOYMENT_QUICK_REFERENCE.md` → Keep as `docs/deployment/quick-reference.md`
|
||
|
|
- `CDN_CONFIGURATION.md` → Move to `docs/deployment/azure/cdn-configuration.md`
|
||
|
|
|
||
|
|
### Phase 4: Consolidate Integrations Directory
|
||
|
|
|
||
|
|
**Entra VerifiedID Files (4 files → organized structure):**
|
||
|
|
- `MICROSOFT_ENTRA_VERIFIEDID.md` → `docs/integrations/entra-verifiedid/README.md`
|
||
|
|
- `ENTRA_CREDENTIAL_IMAGES.md` → `docs/integrations/entra-verifiedid/credential-images.md`
|
||
|
|
- `ENTRA_BEST_PRACTICES_IMPLEMENTATION.md` → `docs/integrations/entra-verifiedid/best-practices.md`
|
||
|
|
- `ENTRA_JSON_CONTENT_READINESS.md` → `docs/integrations/entra-verifiedid/json-content-readiness.md`
|
||
|
|
- Create: `docs/integrations/entra-verifiedid/setup.md` (from deployment docs)
|
||
|
|
|
||
|
|
**Other Integrations:**
|
||
|
|
- `EU_LAISSEZ_PASSER_SPECIFICATION.md` → `docs/integrations/eu-laissez-passer/specification.md`
|
||
|
|
- `eresidency-integration-summary.md` (root) → `docs/integrations/eresidency/integration-summary.md`
|
||
|
|
|
||
|
|
### Phase 5: Organize Root Level Files
|
||
|
|
|
||
|
|
**Move to appropriate locations:**
|
||
|
|
- `FRONTEND_COMPLETION_SUMMARY.md` → `docs/product/features/frontend-completion.md`
|
||
|
|
- `FRONTEND_IMPLEMENTATION_PROGRESS.md` → Archive (historical)
|
||
|
|
- `INTEGRATION_COMPLETE.md` → Archive (historical)
|
||
|
|
- `WEB_UI_COVERAGE_ANALYSIS.md` → `docs/product/features/web-ui-coverage.md`
|
||
|
|
- `GITHUB_SETUP.md` → `docs/deployment/github-setup.md`
|
||
|
|
|
||
|
|
### Phase 6: Reorganize Governance Directory
|
||
|
|
|
||
|
|
**Current:** Flat structure with 20+ files
|
||
|
|
**Proposed:** Organized by type
|
||
|
|
|
||
|
|
**Policies:**
|
||
|
|
- `SECURITY.md` → `docs/governance/policies/security.md`
|
||
|
|
- `CONTRIBUTING.md` → `docs/governance/policies/contributing.md`
|
||
|
|
- `ABAC_POLICY.md` → Keep in `docs/legal/policies/` (legal policy)
|
||
|
|
|
||
|
|
**Procedures:**
|
||
|
|
- `root-key-ceremony-runbook.md` → `docs/governance/procedures/root-key-ceremony.md`
|
||
|
|
- `kyc-aml-sop.md` → `docs/governance/procedures/kyc-aml.md`
|
||
|
|
- `SECURITY_AUDIT_CHECKLIST.md` → `docs/governance/procedures/security-audit.md`
|
||
|
|
|
||
|
|
**Frameworks:**
|
||
|
|
- `trust-framework-policy.md` → `docs/governance/frameworks/trust-framework.md`
|
||
|
|
- `privacy-pack.md` → `docs/governance/frameworks/privacy.md`
|
||
|
|
- `THREAT_MODEL.md` → `docs/governance/frameworks/threat-model.md`
|
||
|
|
|
||
|
|
**Keep as-is:**
|
||
|
|
- `README.md`
|
||
|
|
- `statute-book-v1.md`
|
||
|
|
- `charter-draft.md`
|
||
|
|
- `30-day-program-plan.md`
|
||
|
|
- `TASK_TRACKER.md`
|
||
|
|
- `TECHNICAL_INTEGRATION.md`
|
||
|
|
- `TRANSITION_BLUEPRINT.md`
|
||
|
|
- `NAMING_CONVENTION.md`
|
||
|
|
- `NAMING_IMPLEMENTATION_SUMMARY.md`
|
||
|
|
- `eresidency-ecitizenship-task-map.md`
|
||
|
|
|
||
|
|
### Phase 7: Reorganize Legal Directory
|
||
|
|
|
||
|
|
**Current:** Mix of legal policies and document management
|
||
|
|
**Proposed:** Separate concerns
|
||
|
|
|
||
|
|
**Legal Policies:**
|
||
|
|
- `ABAC_POLICY.md` → `docs/legal/policies/abac.md`
|
||
|
|
|
||
|
|
**Document Management:**
|
||
|
|
- `USER_GUIDE.md` → `docs/legal/document-management/user-guide.md`
|
||
|
|
- `API_DOCUMENTATION.md` → `docs/legal/document-management/api-reference.md`
|
||
|
|
- `DOCUMENT_MANAGEMENT_GAPS.md` → `docs/legal/document-management/implementation/gaps-analysis.md`
|
||
|
|
- `DOCUMENT_MANAGEMENT_IMPLEMENTATION_PLAN.md` → `docs/legal/document-management/implementation/plan.md`
|
||
|
|
- `IMPLEMENTATION_COMPLETE.md` → `docs/legal/document-management/implementation/complete.md`
|
||
|
|
- `ALL_REMAINING_STEPS.md` → Archive (superseded by implementation/complete.md)
|
||
|
|
- `REMAINING_STEPS_SUMMARY.md` → Archive (superseded by implementation/complete.md)
|
||
|
|
|
||
|
|
### Phase 8: Create Navigation Structure
|
||
|
|
|
||
|
|
**Create main README.md:**
|
||
|
|
```markdown
|
||
|
|
# The Order Documentation
|
||
|
|
|
||
|
|
## Quick Start
|
||
|
|
- [Getting Started](GETTING_STARTED.md)
|
||
|
|
- [Development Setup](guides/development-setup.md)
|
||
|
|
- [Deployment Guide](deployment/README.md)
|
||
|
|
|
||
|
|
## Documentation by Category
|
||
|
|
|
||
|
|
### For Developers
|
||
|
|
- [Architecture](architecture/README.md)
|
||
|
|
- [API Reference](api/README.md)
|
||
|
|
- [Configuration](configuration/ENVIRONMENT_VARIABLES.md)
|
||
|
|
|
||
|
|
### For Operators
|
||
|
|
- [Operations Runbooks](operations/README.md)
|
||
|
|
- [Deployment Guides](deployment/README.md)
|
||
|
|
- [Training Materials](training/README.md)
|
||
|
|
|
||
|
|
### For Product/Management
|
||
|
|
- [Product Documentation](product/README.md)
|
||
|
|
- [Governance](governance/README.md)
|
||
|
|
- [Legal Policies](legal/README.md)
|
||
|
|
|
||
|
|
### Integrations
|
||
|
|
- [Entra VerifiedID](integrations/entra-verifiedid/README.md)
|
||
|
|
- [EU Laissez-Passer](integrations/eu-laissez-passer/specification.md)
|
||
|
|
- [eResidency](integrations/eresidency/integration-summary.md)
|
||
|
|
```
|
||
|
|
|
||
|
|
## Deduplication Strategy
|
||
|
|
|
||
|
|
### 1. Content Analysis
|
||
|
|
For each set of duplicate files:
|
||
|
|
1. Identify the most complete/up-to-date version
|
||
|
|
2. Extract unique content from others
|
||
|
|
3. Merge into single authoritative file
|
||
|
|
4. Archive originals with note about what was merged
|
||
|
|
|
||
|
|
### 2. Merge Rules
|
||
|
|
|
||
|
|
**Status/Completion Files:**
|
||
|
|
- Keep most recent date
|
||
|
|
- Merge all unique information
|
||
|
|
- Create single "current status" file
|
||
|
|
- Archive old versions with dates
|
||
|
|
|
||
|
|
**Task Lists:**
|
||
|
|
- Consolidate into single active tasks file
|
||
|
|
- Remove completed items
|
||
|
|
- Archive historical task lists
|
||
|
|
|
||
|
|
**Setup/Deployment Files:**
|
||
|
|
- Create single comprehensive guide
|
||
|
|
- Include all steps from all versions
|
||
|
|
- Remove redundant information
|
||
|
|
- Keep troubleshooting from all versions
|
||
|
|
|
||
|
|
### 3. Archive Strategy
|
||
|
|
|
||
|
|
**Archive Directory Structure:**
|
||
|
|
```
|
||
|
|
docs/archive/
|
||
|
|
├── README.md # Explains archive purpose
|
||
|
|
├── reports/ # Historical reports
|
||
|
|
│ └── 2024-12/ # By date
|
||
|
|
│ ├── completion-status.md
|
||
|
|
│ └── remaining-tasks.md
|
||
|
|
└── deployment/ # Superseded deployment docs
|
||
|
|
└── azure-cdn/ # Old Azure CDN docs
|
||
|
|
```
|
||
|
|
|
||
|
|
## Implementation Plan
|
||
|
|
|
||
|
|
### Step 1: Preparation (1-2 hours)
|
||
|
|
1. Create backup of current docs/
|
||
|
|
2. Create new directory structure
|
||
|
|
3. Document current file locations
|
||
|
|
|
||
|
|
### Step 2: Consolidation (4-6 hours)
|
||
|
|
1. Consolidate reports/ files
|
||
|
|
2. Consolidate deployment/ files
|
||
|
|
3. Consolidate integrations/ files
|
||
|
|
4. Reorganize governance/ files
|
||
|
|
5. Reorganize legal/ files
|
||
|
|
|
||
|
|
### Step 3: Content Merging (6-8 hours)
|
||
|
|
1. Merge duplicate Azure CDN files
|
||
|
|
2. Merge duplicate Entra files
|
||
|
|
3. Merge duplicate completion/status files
|
||
|
|
4. Merge duplicate task lists
|
||
|
|
5. Create consolidated guides
|
||
|
|
|
||
|
|
### Step 4: Navigation (2-3 hours)
|
||
|
|
1. Create main README.md
|
||
|
|
2. Create README.md for each major directory
|
||
|
|
3. Add cross-references
|
||
|
|
4. Create getting started guide
|
||
|
|
|
||
|
|
### Step 5: Archive (1-2 hours)
|
||
|
|
1. Move superseded files to archive/
|
||
|
|
2. Add archive README explaining what's archived
|
||
|
|
3. Add notes about what was merged
|
||
|
|
|
||
|
|
### Step 6: Validation (2-3 hours)
|
||
|
|
1. Verify all links work
|
||
|
|
2. Check for broken references
|
||
|
|
3. Ensure no content lost
|
||
|
|
4. Test navigation structure
|
||
|
|
|
||
|
|
**Total Estimated Time: 16-24 hours**
|
||
|
|
|
||
|
|
## File Mapping Reference
|
||
|
|
|
||
|
|
### Reports Directory Consolidation
|
||
|
|
|
||
|
|
| Current File | Action | New Location |
|
||
|
|
|-------------|--------|--------------|
|
||
|
|
| `COMPLETION_STATUS.md` | Merge | `archive/reports/` + `reports/current-status.md` |
|
||
|
|
| `COMPLETION_SUMMARY.md` | Merge | `archive/reports/` + `reports/current-status.md` |
|
||
|
|
| `TASK_COMPLETION_SUMMARY.md` | Merge | `archive/reports/` + `reports/current-status.md` |
|
||
|
|
| `REMAINING_TASKS.md` | Merge | `archive/reports/` + `reports/active-tasks.md` |
|
||
|
|
| `REMAINING_TODOS.md` | Merge | `archive/reports/` + `reports/active-tasks.md` |
|
||
|
|
| `ALL_REMAINING_TASKS.md` | Merge | `archive/reports/` + `reports/active-tasks.md` |
|
||
|
|
| `GAPS_SUMMARY.md` | Move | `legal/document-management/implementation/gaps-analysis.md` |
|
||
|
|
| `FRONTEND_COMPLETE.md` | Move | `product/features/frontend-coverage.md` |
|
||
|
|
| `TESTING_CHECKLIST.md` | Keep | `reports/testing-checklist.md` |
|
||
|
|
|
||
|
|
### Deployment Directory Consolidation
|
||
|
|
|
||
|
|
| Current File | Action | New Location |
|
||
|
|
|-------------|--------|--------------|
|
||
|
|
| `AZURE_CDN_SETUP.md` | Merge | `deployment/azure/cdn-setup.md` |
|
||
|
|
| `AZURE_CDN_COMPLETE.md` | Merge | `deployment/azure/cdn-setup.md` |
|
||
|
|
| `AZURE_CDN_STATUS.md` | Archive | `archive/deployment/azure-cdn/` |
|
||
|
|
| `AZURE_CDN_FINAL_STATUS.md` | Archive | `archive/deployment/azure-cdn/` |
|
||
|
|
| `AZURE_CDN_QUICK_START.md` | Merge | `deployment/azure/cdn-setup.md` |
|
||
|
|
| `AZURE_CDN_SETUP_COMPLETE.md` | Archive | `archive/deployment/azure-cdn/` |
|
||
|
|
| `ENTRA_COMPLETE_SUMMARY.md` | Merge | `deployment/azure/entra-verifiedid.md` |
|
||
|
|
| `ENTRA_VERIFIEDID_DEPLOYMENT_CHECKLIST.md` | Merge | `deployment/azure/entra-verifiedid.md` |
|
||
|
|
| `ENTRA_VERIFIEDID_NEXT_STEPS.md` | Merge | `deployment/azure/entra-verifiedid.md` |
|
||
|
|
| `DEPLOYMENT_GUIDE.md` | Rename | `deployment/overview.md` |
|
||
|
|
|
||
|
|
## Quality Standards
|
||
|
|
|
||
|
|
### After Reorganization, Each File Should:
|
||
|
|
1. Have a clear, descriptive name
|
||
|
|
2. Be in the correct directory
|
||
|
|
3. Have a clear purpose (no duplicates)
|
||
|
|
4. Include last updated date
|
||
|
|
5. Link to related documents
|
||
|
|
6. Be searchable and findable
|
||
|
|
|
||
|
|
### Directory README Files Should:
|
||
|
|
1. Explain the directory's purpose
|
||
|
|
2. List key files with brief descriptions
|
||
|
|
3. Link to related directories
|
||
|
|
4. Include navigation to subdirectories
|
||
|
|
|
||
|
|
## Success Criteria
|
||
|
|
|
||
|
|
✅ **Deduplication:**
|
||
|
|
- No duplicate content across files
|
||
|
|
- Single source of truth for each topic
|
||
|
|
- Historical versions archived, not deleted
|
||
|
|
|
||
|
|
✅ **Organization:**
|
||
|
|
- Clear directory structure
|
||
|
|
- Logical grouping of related content
|
||
|
|
- Easy to find information
|
||
|
|
|
||
|
|
✅ **Navigation:**
|
||
|
|
- Main README with clear navigation
|
||
|
|
- Directory READMEs explain contents
|
||
|
|
- Cross-references work correctly
|
||
|
|
|
||
|
|
✅ **Maintainability:**
|
||
|
|
- Clear structure for adding new docs
|
||
|
|
- Archive strategy for old docs
|
||
|
|
- Versioning approach defined
|
||
|
|
|
||
|
|
## Next Steps
|
||
|
|
|
||
|
|
1. **Review this plan** with team
|
||
|
|
2. **Approve structure** and approach
|
||
|
|
3. **Execute reorganization** following phases
|
||
|
|
4. **Update all references** in code/docs
|
||
|
|
5. **Communicate changes** to team
|
||
|
|
6. **Establish maintenance** process
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
**Created**: [Current Date]
|
||
|
|
**Status**: Draft - Pending Review
|
||
|
|
**Estimated Implementation**: 16-24 hours
|
||
|
|
|