154 lines
5.5 KiB
Markdown
154 lines
5.5 KiB
Markdown
# SMOA Documentation Structure
|
|
|
|
**Last Updated:** 2024-12-20
|
|
**Status:** ✅ **FULLY ORGANIZED**
|
|
|
|
---
|
|
|
|
## 📚 Documentation Organization
|
|
|
|
The SMOA documentation is organized into clear categories for easy navigation and maintenance.
|
|
|
|
---
|
|
|
|
## Directory Structure
|
|
|
|
```
|
|
docs/
|
|
├── reports/ # All project reports
|
|
│ └── completion/ # Completion and progress reports (16 files)
|
|
│
|
|
├── reference/ # Core reference documents
|
|
│ ├── SPECIFICATION.md # Application specification
|
|
│ ├── COMPLIANCE_MATRIX.md # Compliance status matrix
|
|
│ ├── COMPLIANCE_EVALUATION.md # Detailed compliance assessment
|
|
│ └── IMPLEMENTATION_REQUIREMENTS.md # Technical requirements
|
|
│
|
|
├── status/ # Implementation status
|
|
│ └── IMPLEMENTATION_STATUS.md # Current implementation status (consolidated)
|
|
│
|
|
├── standards/ # Documentation standards and planning
|
|
│ ├── DOCUMENTATION_PLAN.md
|
|
│ ├── DOCUMENTATION_IMPLEMENTATION_STEPS.md
|
|
│ ├── DOCUMENTATION_CHECKLIST.md
|
|
│ └── DOCUMENTATION_EXECUTIVE_SUMMARY.md
|
|
│
|
|
├── admin/ # Administrator documentation
|
|
├── api/ # API documentation
|
|
├── architecture/ # Architecture documentation
|
|
├── compliance/ # Compliance documentation
|
|
├── completion/ # Module/phase completion reports
|
|
├── database/ # Database documentation
|
|
├── integrations/ # Integration documentation
|
|
├── operations/ # Operations documentation
|
|
├── security/ # Security documentation
|
|
├── templates/ # Documentation templates
|
|
├── testing/ # Testing documentation
|
|
├── training/ # Training materials
|
|
└── user/ # User documentation
|
|
```
|
|
|
|
---
|
|
|
|
## Quick Navigation
|
|
|
|
### Getting Started
|
|
- [Project README](../README.md) - Project overview
|
|
- [Documentation Index](README.md) - Complete documentation index
|
|
- [Specification](reference/SPECIFICATION.md) - Application specification
|
|
|
|
### Current Status
|
|
- [Implementation Status](status/IMPLEMENTATION_STATUS.md) - Current implementation status
|
|
- [Completion Reports](reports/completion/) - All completion and progress reports
|
|
|
|
### Reference Documents
|
|
- [Specification](reference/SPECIFICATION.md) - Application specification
|
|
- [Compliance Matrix](reference/COMPLIANCE_MATRIX.md) - Compliance status
|
|
- [Compliance Evaluation](reference/COMPLIANCE_EVALUATION.md) - Detailed assessment
|
|
- [Implementation Requirements](reference/IMPLEMENTATION_REQUIREMENTS.md) - Technical requirements
|
|
|
|
### Reports
|
|
- [Completion Reports](reports/completion/) - All completion and progress reports
|
|
- [Weekly Reports](reports/weekly/) - Weekly status updates
|
|
- [Monthly Reports](reports/monthly/) - Monthly progress summaries
|
|
- [Quarterly Reports](reports/quarterly/) - Quarterly reports
|
|
- [Sprint Reports](reports/sprints/) - Sprint/iteration reports
|
|
|
|
### Standards
|
|
- [Documentation Plan](standards/DOCUMENTATION_PLAN.md) - Comprehensive plan
|
|
- [Documentation Standards](standards/) - All documentation standards
|
|
|
|
---
|
|
|
|
## Document Categories
|
|
|
|
### Reports (`docs/reports/`)
|
|
All project reports including completion, progress, weekly, monthly, quarterly, and sprint reports.
|
|
|
|
### Reference (`docs/reference/`)
|
|
Core reference documents that serve as authoritative sources for the project:
|
|
- Specification
|
|
- Compliance documentation
|
|
- Implementation requirements
|
|
|
|
### Status (`docs/status/`)
|
|
Current implementation and project status documents.
|
|
|
|
### Standards (`docs/standards/`)
|
|
Documentation standards, planning, and guidelines.
|
|
|
|
### Other Categories
|
|
- `admin/` - Administrator guides
|
|
- `api/` - API documentation
|
|
- `architecture/` - Architecture documentation
|
|
- `compliance/` - Compliance evidence and certification
|
|
- `completion/` - Module and phase completion reports
|
|
- `database/` - Database documentation
|
|
- `integrations/` - Integration documentation
|
|
- `operations/` - Operations documentation
|
|
- `security/` - Security documentation
|
|
- `templates/` - Documentation templates
|
|
- `testing/` - Testing documentation
|
|
- `training/` - Training materials
|
|
- `user/` - User documentation
|
|
|
|
---
|
|
|
|
## Finding Documentation
|
|
|
|
### By Role
|
|
- **End Users:** See `user/` directory
|
|
- **Administrators:** See `admin/` directory
|
|
- **Developers:** See `reference/`, `architecture/`, `api/` directories
|
|
- **Project Managers:** See `reports/` directory
|
|
- **Compliance Officers:** See `reference/` and `compliance/` directories
|
|
|
|
### By Topic
|
|
- **Getting Started:** See [Documentation Index](README.md)
|
|
- **Specification:** See `reference/SPECIFICATION.md`
|
|
- **Compliance:** See `reference/COMPLIANCE_*.md` and `compliance/`
|
|
- **Implementation Status:** See `status/IMPLEMENTATION_STATUS.md`
|
|
- **Completion Reports:** See `reports/completion/`
|
|
|
|
---
|
|
|
|
## Documentation Maintenance
|
|
|
|
### Update Frequency
|
|
- **Status Reports:** Weekly/Monthly/Quarterly (as scheduled)
|
|
- **Reference Documents:** Updated with major changes
|
|
- **Status Documents:** Updated with implementation progress
|
|
- **Standards:** Reviewed quarterly
|
|
|
|
### Contributing
|
|
1. Follow [Documentation Style Guide](standards/DOCUMENTATION_STYLE_GUIDE.md)
|
|
2. Use appropriate [templates](templates/)
|
|
3. Review using [Review Checklist](standards/DOCUMENTATION_REVIEW_CHECKLIST.md)
|
|
4. Get approval per [RACI Matrix](standards/DOCUMENTATION_RACI_MATRIX.md)
|
|
|
|
---
|
|
|
|
**Last Updated:** 2024-12-20
|
|
**Status:** Fully Organized
|
|
|