Skip to content

M10-02 Technical Documentation Pack

Milestone: M10 — Deployment / Go-Live and Handover SOW Reference: Deliverable D6 Requirement Clarity: ✅ Clear Dev Status: 🟡 Partially prototyped — architecture and API docs already exist; deployment runbook still placeholder-level

Overview

Assemble the full documentation pack required at handover: solution architecture, high-level design, deployment architecture, integration specs, data model, API docs, security architecture.

Tasks

  • Confirm docs/Curo-REC-Technical-Architecture-Document.md covers all required sections and is current as of go-live
  • Confirm Swagger/OpenAPI docs (auto-generated at /api/docs) are complete and accurate
  • Finalise the deployment/configuration/environment guide — REC_Platform_CICD_Deployment_Strategies.md currently compares options without committing to one; needs to become a definitive runbook once the AWS hosting decision (M4-01) is made
  • Write backup and recovery procedures (feeds from M9-10)
  • Confirm data model documentation matches the actual TypeORM migrations, not just the planning-level database-schema.md

Dependencies

Acceptance Criteria

  • Documentation complete for agreed audience and purpose (Appendix 3, D6)
  • Repository contains appropriate README, build instructions, deployment instructions, configuration guidance

Existing Reference Material

  • docs/Curo-REC-Technical-Architecture-Document.md (kept in place — not moved, as it's a large, actively cross-referenced document)
  • REC_Platform_CICD_Deployment_Strategies.md

Blockers & Risks

  • Deployment guide finalisation is blocked on the AWS hosting decision, same as several M3/M4/M9 tasks.