create-project-arch 1.2.0 → 1.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +15 -2
- package/README.md +136 -10
- package/dist/cli.js +151 -0
- package/dist/cli.test.js +191 -0
- package/package.json +5 -5
- package/templates/arch-ui/eslint.config.js +2 -2
- package/templates/architecture-specs/SPEC_TEMPLATE.md +49 -0
- package/templates/architecture-specs/example-system.md +42 -0
- package/templates/concept-map/concept-map.json +67 -0
- package/templates/decisions/DECISION_TEMPLATE.md +53 -0
- package/templates/decisions/README.md +19 -0
- package/templates/decisions/example-decision.md +45 -0
- package/templates/domains/DOMAIN_TEMPLATE.md +43 -0
- package/templates/domains/README.md +18 -0
- package/templates/domains/api.md +33 -0
- package/templates/domains/core.md +33 -0
- package/templates/domains/domains.json +19 -0
- package/templates/domains/ui.md +34 -0
- package/templates/foundation/goals.md +35 -0
- package/templates/foundation/project-overview.md +35 -0
- package/templates/foundation/prompt.md +23 -0
- package/templates/foundation/scope.md +35 -0
- package/templates/foundation/user-journey.md +37 -0
- package/templates/gap-closure/GAP_CLOSURE_TEMPLATE.md +50 -0
- package/templates/gap-closure/README.md +19 -0
- package/templates/gap-closure/example-gap-closure.md +43 -0
- package/templates/validation-hooks/.githooks/pre-commit +4 -0
- package/templates/validation-hooks/README.md +20 -0
- package/templates/validation-hooks/scripts/validate.sh +9 -0
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Milestone Gap-Closure Reports
|
|
2
|
+
|
|
3
|
+
<!-- Guidance: Use these reports to complete milestone governance and quality review. -->
|
|
4
|
+
|
|
5
|
+
## When To Use
|
|
6
|
+
|
|
7
|
+
Create/update a closure report when a milestone reaches completion readiness.
|
|
8
|
+
|
|
9
|
+
## Workflow
|
|
10
|
+
|
|
11
|
+
1. Copy `GAP_CLOSURE_TEMPLATE.md` into the milestone or reference location.
|
|
12
|
+
2. Fill each section with concrete findings and evidence.
|
|
13
|
+
3. Run validation commands (`pa check`, `pa report`) and record outcomes.
|
|
14
|
+
4. Track unresolved items as follow-on tasks/decisions.
|
|
15
|
+
|
|
16
|
+
## Suggested Locations
|
|
17
|
+
|
|
18
|
+
- `architecture/reference/` for reusable report artifacts and examples
|
|
19
|
+
- `roadmap/phases/<phase>/milestones/<milestone>/closure.md` for milestone-specific closure records
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Milestone Gap-Closure Report - Example
|
|
2
|
+
|
|
3
|
+
## Executive Summary
|
|
4
|
+
|
|
5
|
+
Milestone scope is complete, critical architecture artifacts are synchronized, and remaining low-risk gaps are tracked for the next milestone.
|
|
6
|
+
|
|
7
|
+
## Gap Categories And Resolutions
|
|
8
|
+
|
|
9
|
+
- Traceability drift
|
|
10
|
+
- Finding: concept-map dependencies were incomplete for one feature cluster.
|
|
11
|
+
- Resolution: updated `arch-model/concept-map.json` and linked missing surfaces.
|
|
12
|
+
- Status: closed
|
|
13
|
+
- Documentation clarity
|
|
14
|
+
- Finding: architecture scope language was ambiguous for one boundary.
|
|
15
|
+
- Resolution: clarified in architecture spec and referenced decision note.
|
|
16
|
+
- Status: closed
|
|
17
|
+
|
|
18
|
+
## Layer Synchronization Check
|
|
19
|
+
|
|
20
|
+
- [x] Architecture docs updated
|
|
21
|
+
- [x] Roadmap tasks/decisions synchronized
|
|
22
|
+
- [x] Graph/parity checks pass (`pa check`)
|
|
23
|
+
- [x] Report diagnostics reviewed (`pa report`)
|
|
24
|
+
|
|
25
|
+
## Coverage Audit
|
|
26
|
+
|
|
27
|
+
- Spec section: service boundary constraints
|
|
28
|
+
- Coverage status: covered
|
|
29
|
+
- Notes: validated against acceptance checks and policy explain output.
|
|
30
|
+
- Spec section: advanced optimization strategy
|
|
31
|
+
- Coverage status: deferred
|
|
32
|
+
- Notes: deferred to next milestone to protect launch scope.
|
|
33
|
+
|
|
34
|
+
## Remaining Gaps And Follow-On Items
|
|
35
|
+
|
|
36
|
+
- Remaining gap: deferred optimization strategy details
|
|
37
|
+
- Follow-on task/decision: roadmap task `phase-2/milestone-2-performance/003`
|
|
38
|
+
|
|
39
|
+
## Template Improvement Feedback
|
|
40
|
+
|
|
41
|
+
- Improvement idea: add explicit section for policy conflict outcomes
|
|
42
|
+
- Rationale: closure reviews repeatedly reference policy findings
|
|
43
|
+
- Proposed change: add "Policy Findings" subsection to template
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Validation Hook Scaffold
|
|
2
|
+
|
|
3
|
+
This scaffold adds baseline architecture validation automation.
|
|
4
|
+
|
|
5
|
+
## Included Files
|
|
6
|
+
|
|
7
|
+
- `scripts/validate.sh` - local validation entrypoint
|
|
8
|
+
- `.githooks/pre-commit` - optional local pre-commit hook example
|
|
9
|
+
|
|
10
|
+
## Default Workflow
|
|
11
|
+
|
|
12
|
+
1. Run `sh scripts/validate.sh` locally.
|
|
13
|
+
2. The script executes:
|
|
14
|
+
- `pnpm arch:check`
|
|
15
|
+
- `pnpm arch:report`
|
|
16
|
+
3. Optionally run the same script from `.githooks/pre-commit` for local enforcement.
|
|
17
|
+
|
|
18
|
+
## Task Verification Guidance
|
|
19
|
+
|
|
20
|
+
When writing or reviewing roadmap tasks, include architecture validation in acceptance checks and verification steps.
|