Skip to content

Commit 7cb90b9

Browse files
[docs](scope): put a basic C4 stub in v1.0; defer generated C4 to v2.x (closes OI-3)
Owner decision on OI-3, resolved the same way as the config import/export question so it stays charter-consistent: - A **basic** C4-style Mermaid diagram stub (reflecting the chosen D1 style) is in the MVP — matches Build Spec v3 Phase 5 and FR-OUT-5 (Could-priority). - **Richer auto-generated** C4 diagrams remain deferred to v2.x (Charter Section 5 / roadmap Section 15.6). Updates: Charter v1.7 (In-MVP adds the basic stub; Deferred reworded to "richer auto-generated C4 — the basic stub is in the MVP"), SRS v0.8 (FR-OUT-5 clarified, OI-3 closed), design spec v0.6 (DI-5 resolved, Definition-of-Ready C4 item checked). Cross-document version pointers synced; both guards pass; all links resolve. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 3cd7713 commit 7cb90b9

5 files changed

Lines changed: 19 additions & 14 deletions

File tree

docs/01-discovery-and-planning/discovery-and-planning.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
| Field | Detail |
66
|---|---|
77
| **Document type** | Project Charter / Product Vision |
8-
| **Version** | 1.6 |
8+
| **Version** | 1.7 |
99
| **Date** | 2026-06-12 |
1010
| **Status** | Approved — execution baseline |
1111
| **Author / Owner** | Faqih Pratama Muhti, B.Sc. Computer Science |
@@ -23,6 +23,7 @@
2323
| 1.4 | 2026-06-11 | Scope clarification: a basic custom-configuration import/export (JSON) is in the MVP (matching Build Spec v3); the richer organization-level config import/export remains deferred to v2.0. Resolves a charter↔Build Spec↔SRS mismatch |
2424
| 1.5 | 2026-06-12 | Reference hardening (editorial, no scope change): added peer-reviewed and SEI sources [16][24] (ADD technical report, SUS and its acceptability threshold, architectural design decisions, technical debt, GQM, Strangler Fig, MADR) and cited them inline where claims rely on them |
2525
| 1.6 | 2026-06-13 | Editorial: clarified the ADR decision-log path to `docs/adr/` (Section 14.5), where the model-decision records now live |
26+
| 1.7 | 2026-06-13 | Scope clarification (resolves OI-3): a basic C4-style Mermaid diagram stub is in the MVP (matching Build Spec v3); richer auto-generated C4 diagrams remain deferred to v2.x |
2627

2728
---
2829

@@ -174,7 +175,8 @@ recommendation → export), Guided & Expert modes; ≥12 factors; 12 quality att
174175
an interactive trade-off radar + ranking; *close-call* detection; sensitivity analysis; a risk
175176
register; fitness functions; anti-pattern detection; a migration path (brownfield, Strangler Fig [23]); presets; a
176177
glossary; a "How scoring works" panel; ADR export (MADR — Markdown ADR — format [24]) & reports;
177-
share-via-URL; a **basic custom-configuration import/export (JSON)** for extensibility; ID/EN
178+
share-via-URL; a **basic custom-configuration import/export (JSON)** for extensibility; a
179+
**basic C4-style architecture diagram stub** (Mermaid) reflecting the chosen deployment style; ID/EN
178180
internationalization (i18n); dark mode; WCAG (Web Content Accessibility Guidelines) AA [11];
179181
mature UI states (skeleton, 3-layer error + retry, undo, save-state, empty state).
180182

@@ -196,7 +198,8 @@ layer, and the chosen combination is then checked for anti-patterns.
196198
197199
**Deferred (see the evolution roadmap, Section 15):** multi-stakeholder collaboration; saved
198200
multi-project comparison; **organization-level** configuration import/export (the richer,
199-
shareable org config — the basic per-user JSON is in the MVP above); generated C4 diagrams; an
201+
shareable org config — the basic per-user JSON is in the MVP above); **richer auto-generated C4
202+
diagrams** (the basic stub is in the MVP above); an
200203
empirical validation study.
201204

202205
**Non-goals:** a replacement for human judgment / full ATAM; a code / Infrastructure-as-Code

docs/02-requirement-analysis/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
88
## Deliverable
99

10-
➡️ **[Software Requirements Specification (SRS)](software-requirements-specification.md)** — draft v0.7.
10+
➡️ **[Software Requirements Specification (SRS)](software-requirements-specification.md)** — draft v0.8.
1111

1212
It translates the charter and [Build Spec v3](../specs/build-spec-v3.md) into discrete, testable,
1313
traceable requirements (ISO/IEC/IEEE 29148 structure), covering:

docs/02-requirement-analysis/software-requirements-specification.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
| Field | Detail |
66
|---|---|
77
| **Document type** | Software Requirements Specification (SRS) |
8-
| **Version** | 0.7 |
8+
| **Version** | 0.8 |
99
| **Date** | 2026-06-13 |
1010
| **Status** | Draft — review-ready |
1111
| **Author / Owner** | Faqih Pratama Muhti, B.Sc. Computer Science |
1212
| **Audience** | Engineers, architects, analysts, reviewers |
13-
| **Derived from** | [Discovery & Planning charter](../01-discovery-and-planning/discovery-and-planning.md) v1.6 · [Build Spec v3](../specs/build-spec-v3.md) |
13+
| **Derived from** | [Discovery & Planning charter](../01-discovery-and-planning/discovery-and-planning.md) v1.7 · [Build Spec v3](../specs/build-spec-v3.md) |
1414
| **License** | [CC BY 4.0](../../LICENSE-docs.md) |
1515

1616
**Document history**
@@ -24,6 +24,7 @@
2424
| 0.5 | 2026-06-12 | Reference hardening: added peer-reviewed and standard sources (SUS and its acceptability threshold, MADR, Strangler Fig, additive multi-attribute value model, ADD technical report) and cited them inline at NFR-USE-1, FR-OUT-1, FR-REC-12/13, and Section 5.1 |
2525
| 0.6 | 2026-06-13 | Calibration-stability review: widened the e-commerce and IoT D4 targets to Hexagonal / Clean (the pair differs only on interoperability and ties exactly whenever that weight is 0); margins for every preset target are now machine-measured (Scoring Algorithm Section 9.4) |
2626
| 0.7 | 2026-06-13 | Closed OI-2 and OI-4: the preset calibration and the D4/D5 `qaFit` vectors are interim-ratified ([ADR-0002](../adr/0002-ratify-preset-calibration.md), [ADR-0001](../adr/0001-ratify-d4-d5-qafit.md)) |
27+
| 0.8 | 2026-06-13 | Closed OI-3: a basic C4-style stub is in v1.0 (FR-OUT-5, Could); richer auto-generated C4 deferred to v2.x. Charter pointer → v1.7 |
2728

2829
---
2930

@@ -92,7 +93,7 @@ decision records. The authoritative scope (in/deferred/non-goals) is the charter
9293

9394
### 1.4 References
9495

95-
1. [Discovery & Planning charter](../01-discovery-and-planning/discovery-and-planning.md) (v1.6) — problem, scope, KPIs, risks, governance.
96+
1. [Discovery & Planning charter](../01-discovery-and-planning/discovery-and-planning.md) (v1.7) — problem, scope, KPIs, risks, governance.
9697
2. [Build Spec v3](../specs/build-spec-v3.md) — technical specification and model definitions.
9798
3. [UI/UX Execution Playbook](../guides/uiux-execution-playbook.md) — usability requirements for technical users.
9899
4. ISO/IEC/IEEE 29148:2018 — Requirements engineering.
@@ -249,7 +250,7 @@ v1.0:
249250
| FR-OUT-2 | Export a **full report** (Markdown + print stylesheet). | Must | Build Spec Section 12 | T |
250251
| FR-OUT-3 | Export **scores as CSV** and the **assessment as JSON**. | Should | Build Spec Section 12 | T |
251252
| FR-OUT-4 | Provide a **share-via-URL** link that round-trips to identical state. | Must | Build Spec Section 14.14 | T |
252-
| FR-OUT-5 | Render a **C4-style Mermaid diagram stub** reflecting the chosen D1 style. | Could | Build Spec Section 12 | D |
253+
| FR-OUT-5 | Render a **basic C4-style Mermaid diagram stub** reflecting the chosen D1 style (richer auto-generated C4 is deferred to v2.x). | Could | Build Spec Section 12; Charter Section 5 | D |
253254
| FR-OUT-6 | Support **import/export of a basic custom-configuration JSON** for extensibility (per-user; organization-level config is deferred to v2.0). | Should | Build Spec Section 12; Charter Section 5 | T |
254255

255256
### 3.6 State, Persistence & Reproducibility
@@ -483,7 +484,7 @@ all UX-quality criteria met; KPIs K3 and K5 met at beta; no critical defects.
483484
|---|---|---|---|---|
484485
| OI-1 | ~~Final factor count~~**Resolved: fixed at 14** (Build Spec Section 4 / [Model Data Sheet](../03-blueprint/model-data-sheet.md) Section 2) | Owner | Closed (2026-06-12) | Grouping also fixed in the Model Data Sheet |
485486
| OI-2 | ~~Preset factor-level values~~**Resolved: interim-ratified** ([ADR-0002](../adr/0002-ratify-preset-calibration.md)) | Owner | Closed (2026-06-13) | Levels in [Model Data Sheet](../03-blueprint/model-data-sheet.md) Section 6; all 25 targets machine-verified; independent Domain Advisor may revise |
486-
| OI-3 | Whether the C4 Mermaid stub (FR-OUT-5) is in v1.0 or deferred | Owner | M1 | Currently **Could**-priority |
487+
| OI-3 | ~~C4 stub in v1.0 or deferred~~**Resolved: in v1.0 as a basic stub** (FR-OUT-5, Could) | Owner | Closed (2026-06-13) | Richer auto-generated C4 deferred to v2.x (Charter Section 5, Section 15.6) |
487488
| OI-4 | ~~D4/D5 `qaFit` values~~**Resolved: interim-ratified** ([ADR-0001](../adr/0001-ratify-d4-d5-qafit.md)) | Owner | Closed (2026-06-13) | Values in [Model Data Sheet](../03-blueprint/model-data-sheet.md) Section 4; independent Domain Advisor / empirical study (v3.0) may revise |
488489
| OI-5 | Confirm/ratify the quantitative performance budgets in NFR-PERF-3 (bundle size, FCP, p95 interaction) | Engineer | M2 (Phase 3 design) | Interim targets already set in NFR-PERF-3; ratify against the real bundle |
489490
| OI-6 | Empirical-validation study design (deferred per Charter Section 5) | Owner | v3.0 | Out of MVP scope; tracked for v3.0 |

docs/03-blueprint/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
88
## Deliverables
99

10-
➡️ **[Design Specification (Blueprint)](design-specification.md)** — draft v0.5: architecture
10+
➡️ **[Design Specification (Blueprint)](design-specification.md)** — draft v0.6: architecture
1111
overview, module & code structure, the decision-model data schema, state & persistence (with a
1212
resilience & edge-case design), the design system & tokens, UX patterns, the key design decisions
1313
(ADRs), and a Definition-of-Ready gate for development.

docs/03-blueprint/design-specification.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
| Field | Detail |
66
|---|---|
77
| **Document type** | Design Specification / Software Design Document (SDD) |
8-
| **Version** | 0.5 |
8+
| **Version** | 0.6 |
99
| **Date** | 2026-06-12 |
1010
| **Status** | Draft |
1111
| **Author / Owner** | Faqih Pratama Muhti, B.Sc. Computer Science |
1212
| **Audience** | Engineers, architects, designers |
13-
| **Derived from** | [SRS](../02-requirement-analysis/software-requirements-specification.md) v0.7 · [Build Spec v3](../specs/build-spec-v3.md) · [Charter](../01-discovery-and-planning/discovery-and-planning.md) v1.6 · [UI prototype](prototype/index.html) |
13+
| **Derived from** | [SRS](../02-requirement-analysis/software-requirements-specification.md) v0.8 · [Build Spec v3](../specs/build-spec-v3.md) · [Charter](../01-discovery-and-planning/discovery-and-planning.md) v1.7 · [UI prototype](prototype/index.html) |
1414
| **License** | [CC BY 4.0](../../LICENSE-docs.md) |
1515

1616
**Document history**
@@ -22,6 +22,7 @@
2222
| 0.3 | 2026-06-12 | Build-readiness: linked the new [Model Data Sheet](model-data-sheet.md) (frozen numeric model values), added a Definition-of-Ready gate (Section 11), and updated DI-1 to the recorded baseline |
2323
| 0.4 | 2026-06-12 | Computation precision: linked the [Scoring Algorithm Specification](scoring-algorithm.md) as the exact contract for `lib/scoring.ts`/`lib/sensitivity.ts`; Definition of Ready updated — scoring computation pinned and preset calibration machine-verified |
2424
| 0.5 | 2026-06-13 | Definition of Ready: D4/D5 `qaFit` and preset calibration interim-ratified ([ADR-0001](../adr/0001-ratify-d4-d5-qafit.md), [ADR-0002](../adr/0002-ratify-preset-calibration.md)); DI-1 closed |
25+
| 0.6 | 2026-06-13 | Resolved DI-5 / SRS OI-3: a basic C4 Mermaid stub is in v1.0 (richer auto-generated C4 deferred to v2.x); Definition-of-Ready C4 item checked |
2526

2627
---
2728

@@ -312,7 +313,7 @@ These app-level decisions are recorded here; model-value changes follow the ADR
312313
| DI-2 | Whether URL-hash state needs a compression library | Decide against a size budget (DI-4) |
313314
| DI-3 | Final design-token values vs the prototype | Promote the prototype `:root` blocks to the token source of truth |
314315
| DI-4 | Ratify the performance budgets against the real bundle | Interim targets already set in SRS NFR-PERF-3 (≤ 300 KB gzip, FCP ≤ 2 s, p95 ≤ 100 ms); inherits SRS OI-5 |
315-
| DI-5 | C4 Mermaid stub (FR-OUT-5) — in v1.0 or deferred | Inherits SRS OI-3 (Could-priority) |
316+
| DI-5 | ~~C4 Mermaid stub — in v1.0 or deferred~~**Resolved** | In v1.0 as a basic stub (FR-OUT-5, Could; SRS OI-3 closed); richer auto-generated C4 deferred to v2.x |
316317

317318
---
318319

@@ -330,7 +331,7 @@ free of guesswork — each line is either fixed or has a usable baseline.
330331
- [x] **D4/D5 `qaFit` interim-ratified** by the Owner ([ADR-0001](../adr/0001-ratify-d4-d5-qafit.md), closes SRS OI-4); an independent Domain Advisor / the v3.0 study may still revise the values.
331332
- [x] **Factor content authored (EN/ID)**: labels, level labels, and help for all 14 factors — [Model Data Sheet Section 2.1](model-data-sheet.md) (Translator review pending).
332333
- [x] **Option & message content authored (EN/ID)**: educational metadata for all 21 options, the 7 anti-pattern messages, and the 12 fitness-function templates — [Option Content Sheet](option-content-sheet.md) (Translator & Domain-Advisor review pending).
333-
- [ ] **C4 stub** scoped in or out of v1.0 (SRS OI-3).
334+
- [x] **C4 stub** scoped: in v1.0 as a basic Mermaid stub (FR-OUT-5, Could); richer auto-generated C4 deferred to v2.x (SRS OI-3 closed).
334335
- [ ] **Performance budgets ratified** against the real bundle (SRS OI-5 / DI-4).
335336

336337
Checked items are done. The unchecked items all have **baseline values recorded in the Model Data

0 commit comments

Comments
 (0)