Skip to content

Latest commit

 

History

History

README.md

Documentation Map

This directory documents Architecture Advisor across the software development lifecycle (SDLC), so the flow of work is explicit and traceable from idea to maintenance. All documentation is written in English; the product itself targets both Indonesian and English.

Development lifecycle

flowchart LR
    P1["1 · Discovery<br/>& Planning"] --> P2["2 · Requirement<br/>Analysis"] --> P3["3 · Blueprint<br/>(Design)"] --> P4["4 · Development"] --> P5["5 · Testing<br/>/ QA"] --> P6["6 · Deployment<br/>/ Release"] --> P7["7 · Maintenance<br/>& Iteration"]
    P7 -. feedback .-> P2
Loading

Each phase lives in its own numbered folder, and each produces a concrete deliverable:

# Phase Folder Key output Status
1 Discovery & Planning 01-discovery-and-planning/ Project charter / product vision ✅ Complete
2 Requirement Analysis 02-requirement-analysis/ SRS (functional + non-functional) 🔬 In progress — draft
3 Blueprint (Design) 03-blueprint/ Design spec + the model docs (data sheet, scoring algorithm, formulation, option content) + UI prototype 🔬 In progress
4 Development 04-development/ Source code (src/, scoring engine, components) ✅ v1.0 implemented
5 Testing / QA 05-testing-qa/ Test plan — 62 Vitest + Playwright E2E + 3 guards; CI gates size/audit; 14/16 AC automated 🔬 In progress
6 Deployment / Release 06-deployment/ Live on GitHub Pages via deploy.yml ✅ Live
7 Maintenance & Iteration 07-maintenance/ Changelog, Dependabot, issue/PR templates, security policy 🔄 Ongoing

Cross-cutting references

Placement rule: a document tied to one phase lives in that phase's folder (e.g. the deployment guide in 06-deployment/); only documents spanning multiple phases live here:

Folder Document Summary
specs/ Build Spec v3 The complete technical specification the app is built from (feeds phases 2–5)
guides/ UI/UX Execution Playbook 9 usability factors for technical users as executable tasks (phases 3–4)
guides/ Feature-Maturity Playbook UX/technical/analyst factors as concrete, verifiable tasks (phases 4–7)
adr/ Architecture Decision Records The model-decision log (e.g. the D4/D5 fit & preset ratifications), per charter governance

Reading paths