π Handover Pack: Lead Developer
1. The "Living Documentation" Philosophyβ
"Code tells you what happens, Documentation tells you WHY it happens."
This documentation is not a static PDF to be filed away. It is an active part of the repository, versioned alongside the code.
- Location:
docs/architecture/ - Source of Truth: The code is the truth for logic, this doc is the truth for intent and business rules.
2. Your Responsibilitiesβ
As the Lead Developer, you own the Architecture Decision Records (ADR).
- When refactoring: Update the corresponding
Module Analysis. - When changing rules: Update
Specs/Current. - Code Reviews: Reject PRs that change business logic without a corresponding docs update.
3. High-Level Taxonomyβ
We have reorganized the documentation into a tree that mirrors cognitive load:
| Folder | Purpose | Audience |
|---|---|---|
overview/ | The 10,000ft view. Domain Map & Landscape. | Everyone |
specs/current/ | The Law. How the system works right now. | Devs & POs |
specs/proposals/ | The Future. RFCs and drafts. | Architects |
modules/ | Deep technical analysis of the Monolith. | Senior Devs |
analysis/ | Metrics, Security & Volumetrics. | Management |
guidelines/ | The "Rules of Engagement" (Gherkin, Async). | Team |
4. Key Strategic Decisions to Enforceβ
- Hybrid Specs: We don't use Use Cases for everything.
- Use Gherkin for hidden backend rules (Calculations, Batches).
- Use State Diagrams for Workflows (Refunds, Requests).
- Use Use Cases ONLY for human-UI interactions.
- Reference:
guidelines/functional_strategy.md
- The "Anti-Headless" Stance: We are deliberately sticking to MVC for
OrderMGTto leverage Kendo Grid features unless there is a specific ROI to move to React.- Reference:
analysis/headless_migration_criticism.md
- Reference:
5. Maintenance Implementationβ
- Images: Stored in
docs/architecture/images. - Metadata:
metadata.jsontracks files for the AI Agent. Runpython3 generator/organize_docs.pyif you move files. - PDF Generation: Use
node generator/generate_pdf.jsto create a snapshot for management.