@educa-corp/sdd-framework 0.3.0 → 0.4.2

package/templates/project-context.yaml

@@ -25,28 +25,41 @@ project:
 # All paths are relative to workspace root.
 paths:
   # Feature-Package Layout:
-  #   specs/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md  — PRD document
-  #   specs/{domain}/{prd-slug}/bdd/             — BDD .feature files
-  #   specs/{domain}/{prd-slug}/tech-docs/       — Technical design docs
-  #   specs/{domain}/{prd-slug}/design-spec/     — Design specs (FE/App only)
-  #   .trace/{domain}/{prd-slug}/{UC-ID}.tsv     — Trace state
+  #   specs/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md      — PRD document
+  #   specs/{domain}/{prd-slug}/bdd/{platform}/                — BDD .feature  ({platform} = web | app | system)
+  #   specs/{domain}/{prd-slug}/tech-docs/                     — Technical design (ONE merged doc per PRD: {TICKET-ID}-tech-design.md)
+  #   specs/{domain}/{prd-slug}/design-spec/                   — Design specs (FE/App only)
+  #   specs/{domain}/{prd-slug}/changelog/                     — PRD changelog overflow (created once history exceeds 5 versions)
+  #   .trace/{domain}/{prd-slug}/{UC-ID}-{platform}.tsv        — Trace state (ONE book per UC × platform)
+  #
+  # The {platform} segment is NOT optional — in any mode, including umbrella.
+  # A UC's `web` and `system` features are two different files; without the segment they
+  # collide on one filename and overwrite each other. Trace is split the same way, so the
+  # spec layout has to match it. Every .feature also carries `@trace.platform` matching
+  # its own {platform} segment. (Projects still on the old flat bdd/ layout:
+  # run `npx @educa-corp/sdd-framework --migrate-bdd-platform` — dry-run by default.)
   #
   # specs_dir is the unified root for all spec artifact types (PRD, BDD, tech-docs, design-spec).
   # prd-slug is derived from the PRD folder path — not a separate config variable.
   specs_dir: "specs"
-  templates_dir: "specs/templates"
 
   # Source code root — gốc mã nguồn của service/app này (nơi generate-code đặt & quét code).
   # BE thường suy vị trí từ CLAUDE.md §2 (code_base_package + layer); src_dir là gốc chung,
   # và là NGUỒN CHÍNH cho FE (component/hook/service/adapter) + phạm vi quét reuse (DS5).
   # Ví dụ: "src" (mono FE), "app/src", "src/main/java" (BE). Chỉnh theo layout thật của repo.
   src_dir: "src"
-  feature_template: ".agent/templates/feature.template"   # SoT skeleton .feature (dùng bởi /generate-bdd qua {{include}})
-  bdd_writing_guide: "specs/templates/bdd-writing-guide.md"
-  trace_report: "specs/.trace/trace-report.md"
 
-  # PRD template (PRDs are at specs/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md)
-  prd_template: "specs/templates/prd.template.md"
+  # ── Template artifact — KHÔNG cấu hình được ──
+  # Đã bỏ 6 key chết (không lệnh nào đọc): feature_template · prd_template ·
+  # templates_dir · bdd_writing_guide · product_definition_template · trace_report.
+  # Các skeleton được {{include}} NƯỚNG CỨNG vào file lệnh lúc `npm run build`,
+  # nên lệnh không bao giờ đọc một path template lúc chạy.
+  # (trace_report còn trỏ sai hẳn: report thật là {trace_dir}/trace-report.json.)
+  #
+  # Đổi cấu trúc .feature / PRD sinh ra = sửa templates/*.template* TRONG REPO
+  # FRAMEWORK rồi build lại. Sửa .agent/templates/* trong project KHÔNG có tác
+  # dụng, và sẽ bị GHI ĐÈ IM LẶNG ở lần /update-framework kế tiếp (--init copy
+  # core/ → .agent/ vô điều kiện; file duy nhất được giữ là .agent/project-context.yaml).
   refinement_dir: ".agent/review"
 
   # QC's OWN analysis/design working docs (qc-analyze/plan/design-test outputs:
@@ -66,7 +79,6 @@ paths:
 
   # Product Definitions
   product_definitions_dir: "specs/product-definition"
-  product_definition_template: "specs/templates/product-definition.template.md"
 
   # Domain Knowledge
   domain_knowledge_dir: "specs/domain-knowledge"
@@ -90,7 +102,7 @@ paths:
   # This variable is no longer needed as a separate path — derived from specs_dir.
   # design_spec_dir: "specs/design-spec"   ← removed; use specs_dir instead
 
-  # Trace (internal structure: .trace/{domain}/{prd-slug}/{UC-ID}.tsv)
+  # Trace (internal structure: .trace/{domain}/{prd-slug}/{UC-ID}-{platform}.tsv — one book per UC × platform)
   trace_dir: ".trace"
 
   # Tester / QC feedback (written by /report-bug and /propose-scenario).
@@ -133,14 +145,16 @@ domains:
 #   specs_dir            → {spec_source}/specs                # unified root — PRD/BDD/tech-docs/design-spec
 #   tech_docs_dir        → {spec_source}/specs                # merged into specs_dir
 #   domain_knowledge_dir → {spec_source}/specs/domain-knowledge
-#   trace_dir            → {spec_source}/.trace               # structure: .trace/{domain}/{prd-slug}/{UC-ID}.tsv
+#   trace_dir            → {spec_source}/.trace               # structure: .trace/{domain}/{prd-slug}/{UC-ID}-{platform}.tsv
 # (You can still override these manually in paths: section below.)
 # With spec_source set, only ONE override is needed instead of four separate dir vars.
 #
 # services:                                   # domain → service submodule routing
 #   # Each domain key MUST match the PRD's `Domain` (Metadata row) / folder path segment.
-#   # A domain value has TWO forms — context-loader (Step 1.5) auto-detects by whether
-#   # `path` is present directly:
+#   # A domain value has THREE forms — context-loader (Step 1.5) auto-detects in this order:
+#   #   has `path`          → FORM A (resolved)
+#   #   has `by_prd_slug`   → FORM C (look up one more level)
+#   #   otherwise           → FORM B (per-platform map)
 #   #
 #   # FORM A — FLAT (one domain ↔ one submodule, all platforms):
 #   {{DOMAIN_1}}:
@@ -157,6 +171,22 @@ domains:
 #     web:    { path: "{{WEB_SUBMODULE_DIR}}", module: "nextjs" }
 #     app:    { path: "{{APP_SUBMODULE_DIR}}", module: "flutter" }
 #   #
+#   # FORM C — PER-PRD_SLUG MAP (one routing cell ↔ MANY submodules, one per feature-package).
+#   #          Use when a platform — or a whole domain — is split into one repo per feature,
+#   #          e.g. each webview mini-game lives in its own repo. No `path`; instead a
+#   #          `by_prd_slug` table keyed by the feature-package folder name. context-loader
+#   #          already extracted prd_slug in Step 1, so no extra detection is needed.
+#   #          Valid at BOTH levels: directly under the domain, or nested under a platform.
+#   {{DOMAIN_3}}:
+#     system: { path: "{{BE_SUBMODULE_DIR}}", module: "java-spring" }   # normal entry
+#     webview:                                                          # this cell → many repos
+#       by_prd_slug:
+#         {{PRD_SLUG_1}}: { path: "games/{{GAME_1}}", module: "phaser-game" }
+#         {{PRD_SLUG_2}}: { path: "games/{{GAME_2}}", module: "phaser-game" }
+#   #  A prd_slug with no entry → active_service = unresolved (the command STOPS rather than
+#   #  guessing a lookalike repo). An entry with BOTH `path` and `by_prd_slug` is a config
+#   #  error, as is nesting `by_prd_slug` inside `by_prd_slug`.
+#   #
 #   # NOTE: with spec_source set, BDD + tech-docs are cross-team and live in the spec repo —
 #   # do NOT pin per-service specs_dir / tech_docs_dir here (they would be ignored).
 #   # Per-service specs_dir / tech_docs_dir apply ONLY when there is no spec_source.
@@ -169,7 +199,9 @@ domains:
 #   root, so without a service CLAUDE.md, code generation falls back to umbrella defaults
 #   + the module stack-profile (a ⚠️ is flagged in the context recap). Generate one per
 #   service via /setup-ai-first inside each. For FORM B, add one CLAUDE.md per platform
-#   submodule ({system|web|app}.path/CLAUDE.md).
+#   submodule ({system|web|app}.path/CLAUDE.md). For FORM C, one per feature repo
+#   (by_prd_slug.{slug}.path/CLAUDE.md) — these repos usually share a stack, so the fastest
+#   route is to write one and copy it, adjusting the parts that actually differ.
 
 # ----- Architecture -----
 architecture:

package/templates/tech-design.template.md

@@ -40,7 +40,7 @@
 @trace.service: {service — từ header BDD @trace.service}
 @trace.module: {module liên quan — vd dotnet, angular}
 @trace.platforms: {system | web | app — tuỳ thư mục BDD nào tồn tại}
-@trace.bdd_version: {map theo từng platform — vd system=1.5, web=1.9, app=1.7; chỉ platform có mặt. Mỗi feature mang bdd_version riêng; đừng gộp về một số.}
+@trace.bdd_versions: {MAP theo từng platform — số nhiều, KHÁC @trace.bdd_version (scalar) của .feature — vd system=1.5, web=1.9, app=1.7; chỉ platform có mặt. Mỗi feature mang bdd_version riêng; đừng gộp về một số.}
 @trace.api_source: {existing | —}
 @trace.revision: 1
 @trace.status: draft