specdojo 0.8.0 → 0.9.0
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/.github/agents/specdojo-orchestrator.md +4 -1
- package/CHANGELOG.md +64 -0
- package/dist/catalog/catalog.js +16 -14
- package/dist/commands/agent.js +5 -3
- package/dist/commands/build.js +69 -10
- package/dist/commands/git.js +206 -0
- package/dist/commands/init.js +4 -2
- package/dist/commands/where.js +25 -0
- package/dist/dashboard/dashboard.js +5 -3
- package/dist/dashboard/routines.js +4 -7
- package/dist/dashboard/timeline.js +14 -14
- package/dist/docs/index-command.js +2 -2
- package/dist/docs/yaml-business-tables.js +243 -0
- package/dist/docs/yaml-interface-tables.js +106 -0
- package/dist/docs/yaml-pages-command.js +5 -3
- package/dist/docs/yaml-pages.js +146 -3
- package/dist/docs/yaml-table-shared.js +70 -0
- package/dist/docs/yaml-tables.js +39 -0
- package/dist/exec/agent-config.js +9 -0
- package/dist/exec/agent-protected-config.js +2 -0
- package/dist/exec/commands.js +31 -18
- package/dist/exec/events.js +34 -14
- package/dist/exec/evidence.js +13 -3
- package/dist/exec/parent-validation.js +56 -3
- package/dist/exec/plans-core.js +21 -2
- package/dist/exec/plans-generation.js +6 -7
- package/dist/exec/post-integration.js +162 -0
- package/dist/exec/queue-command.js +166 -0
- package/dist/exec/queue.js +285 -0
- package/dist/exec/register-foreign-wait.js +84 -0
- package/dist/exec/repo-integration-sync.js +17 -5
- package/dist/exec/reporter.js +2 -2
- package/dist/exec/results.js +24 -4
- package/dist/exec/review-kata.js +4 -1
- package/dist/exec/run/agent-pipeline.js +3 -2
- package/dist/exec/run/agent.js +12 -6
- package/dist/exec/run/change-scope.js +365 -0
- package/dist/exec/run/deferred-cleanup.js +31 -0
- package/dist/exec/run/in-place.js +4 -1
- package/dist/exec/run/job-lock.js +66 -0
- package/dist/exec/run/job-sequence.js +137 -0
- package/dist/exec/run/job.js +56 -19
- package/dist/exec/run/lifecycle-commands.js +1 -1
- package/dist/exec/run/lock.js +22 -1
- package/dist/exec/run/register-command.js +8 -5
- package/dist/exec/run/register-mode.js +68 -8
- package/dist/exec/run/register-resume.js +68 -14
- package/dist/exec/run/register-state.js +13 -8
- package/dist/exec/run/register-worktree.js +140 -125
- package/dist/exec/run/schedule-mode.js +75 -14
- package/dist/exec/run/schedule-prepare.js +3 -0
- package/dist/exec/run/schedule-task.js +88 -38
- package/dist/exec/run/shared.js +5 -0
- package/dist/exec/schedule/schedule.js +116 -4
- package/dist/exec/shared.js +1 -1
- package/dist/exec/smoke.js +190 -0
- package/dist/exec/strategy.js +13 -3
- package/dist/exec/task-view.js +6 -4
- package/dist/exec/trial-commands.js +5 -2
- package/dist/exec/trial-core.js +6 -1
- package/dist/exec/validation-metrics.js +181 -0
- package/dist/exec/worktree-cleanup-lock.js +26 -0
- package/dist/exec/worktree-command.js +9 -1
- package/dist/exec/worktree-ops-commit.js +2 -2
- package/dist/exec/worktree.js +13 -2
- package/dist/grade/command-apply.js +3 -3
- package/dist/grade/command-inspect.js +5 -3
- package/dist/grade/command-plan.js +1 -1
- package/dist/grade/command-run.js +5 -1
- package/dist/grade/run.js +64 -8
- package/dist/job/definition.js +84 -8
- package/dist/job/job.js +79 -23
- package/dist/register/authoring-sources.js +22 -16
- package/dist/register/maintenance-commands.js +2 -2
- package/dist/register/register.js +31 -7
- package/dist/routine/definition.js +9 -0
- package/dist/routine/routine.js +137 -43
- package/dist/routine/status.js +62 -0
- package/dist/schedule/schedule.js +38 -39
- package/dist/shared/agent-types.js +5 -0
- package/dist/shared/cross-process-lock.js +9 -1
- package/dist/shared/dist-freshness.js +8 -2
- package/dist/shared/git-environment.js +2 -1
- package/dist/shared/git.js +44 -1
- package/dist/shared/lefthook-scaffold.js +3 -0
- package/dist/shared/local-config.js +244 -0
- package/dist/shared/specdojo-config.js +34 -20
- package/dist/shared/specdojo-gitignore.js +1 -0
- package/dist/shared/text.js +9 -1
- package/dist/shared/where-alias.js +13 -0
- package/dist/specdojo.js +4 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +2 -0
- package/docs/ja/specdojo/guides/exec-config-guide.md +23 -4
- package/docs/ja/specdojo/guides/exec-operation-guide.md +44 -1
- package/docs/ja/specdojo/guides/job-sequence-guide.md +77 -0
- package/docs/ja/specdojo/guides/quick-start-guide.md +3 -3
- package/docs/ja/specdojo/guides/register-operation-guide.md +1 -1
- package/docs/ja/specdojo/guides/routine-operation-guide.md +11 -6
- package/docs/ja/specdojo/guides/schedule-design-guide.md +20 -17
- package/docs/ja/specdojo/guides/waza-guide.md +12 -8
- package/docs/ja/specdojo/recipes/bac-recipe.md +66 -49
- package/docs/ja/specdojo/recipes/bes-recipe.md +90 -54
- package/docs/ja/specdojo/recipes/bps-recipe.md +88 -139
- package/docs/ja/specdojo/recipes/br-recipe.md +40 -47
- package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +97 -109
- package/docs/ja/specdojo/recipes/cdfd-recipe.md +85 -146
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +91 -110
- package/docs/ja/specdojo/recipes/cnd-recipe.md +79 -69
- package/docs/ja/specdojo/recipes/cpd-recipe.md +78 -64
- package/docs/ja/specdojo/recipes/cxd-recipe.md +92 -75
- package/docs/ja/specdojo/recipes/ifd-recipe.md +79 -68
- package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +78 -105
- package/docs/ja/specdojo/recipes/ifx-index-recipe.md +105 -71
- package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +60 -49
- package/docs/ja/specdojo/recipes/pm-members-recipe.md +50 -51
- package/docs/ja/specdojo/recipes/pm-organization-recipe.md +59 -51
- package/docs/ja/specdojo/recipes/pm-plan-recipe.md +69 -56
- package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +37 -56
- package/docs/ja/specdojo/recipes/pm-raci-recipe.md +39 -53
- package/docs/ja/specdojo/recipes/pm-roles-recipe.md +52 -79
- package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +64 -93
- package/docs/ja/specdojo/recipes/prj-charter-recipe.md +71 -106
- package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +78 -157
- package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +62 -111
- package/docs/ja/specdojo/recipes/prj-scope-recipe.md +67 -123
- package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +60 -96
- package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +61 -105
- package/docs/ja/specdojo/recipes/stsd-recipe.md +79 -109
- package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +78 -55
- package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +82 -73
- package/docs/ja/specdojo/recipes/sysd-index-recipe.md +78 -59
- package/docs/ja/specdojo/recipes/tsd-recipe.md +149 -129
- package/docs/ja/specdojo/references/command-reference.md +257 -117
- package/docs/ja/specdojo/references/deliverables-reference.md +21 -12
- package/docs/ja/specdojo/references/specdojo-config-reference.md +37 -2
- package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +101 -257
- package/docs/ja/specdojo/rulebooks/atc-rulebook.md +102 -228
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +19 -28
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +16 -67
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +30 -51
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +41 -61
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +22 -50
- package/docs/ja/specdojo/rulebooks/bps-rulebook.md +24 -56
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +13 -38
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +41 -76
- package/docs/ja/specdojo/rulebooks/cdfd-d2-rulebook.md +18 -93
- package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +18 -52
- package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +109 -147
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +80 -108
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +21 -46
- package/docs/ja/specdojo/rulebooks/cdr-rulebook.md +144 -0
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +27 -48
- package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +37 -50
- package/docs/ja/specdojo/rulebooks/clis-rulebook.md +52 -69
- package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +33 -86
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +16 -32
- package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +45 -131
- package/docs/ja/specdojo/rulebooks/cop-rulebook.md +69 -275
- package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +20 -112
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +23 -56
- package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +12 -145
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +39 -47
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +37 -56
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +118 -175
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +5 -14
- package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +22 -66
- package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +36 -94
- package/docs/ja/specdojo/rulebooks/dss-rulebook.md +59 -81
- package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +31 -131
- package/docs/ja/specdojo/rulebooks/etc-rulebook.md +50 -104
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +51 -61
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +38 -45
- package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +14 -20
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +26 -38
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +26 -107
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +42 -49
- package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +14 -22
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +21 -44
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +41 -64
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +14 -38
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +34 -61
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +27 -50
- package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +70 -199
- package/docs/ja/specdojo/rulebooks/itc-rulebook.md +65 -153
- package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +74 -150
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +11 -23
- package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +99 -176
- package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +35 -61
- package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +75 -117
- package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +31 -60
- package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +26 -81
- package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +32 -70
- package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +45 -87
- package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +48 -101
- package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +44 -80
- package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +59 -127
- package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +31 -50
- package/docs/ja/specdojo/rulebooks/opd-rulebook.md +42 -109
- package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +29 -42
- package/docs/ja/specdojo/rulebooks/opr-rulebook.md +29 -87
- package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +62 -84
- package/docs/ja/specdojo/rulebooks/otp-rulebook.md +11 -61
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +91 -106
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +25 -34
- package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +30 -53
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +23 -35
- package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +27 -45
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +37 -45
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +45 -46
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +37 -48
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +25 -29
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +28 -35
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +36 -41
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +5 -18
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +16 -37
- package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +23 -97
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +39 -57
- package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +43 -116
- package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +16 -51
- package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +47 -92
- package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +25 -84
- package/docs/ja/specdojo/rulebooks/sac-rulebook.md +44 -107
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +39 -49
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +42 -49
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +64 -89
- package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +90 -189
- package/docs/ja/specdojo/rulebooks/stc-rulebook.md +45 -105
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +6 -12
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +49 -68
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +51 -60
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +46 -50
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +39 -64
- package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +47 -60
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +69 -70
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +65 -72
- package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +35 -46
- package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +49 -66
- package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +64 -139
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +41 -108
- package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +49 -144
- package/docs/ja/specdojo/rulebooks/utc-rulebook.md +67 -155
- package/docs/ja/specdojo/samples/bds-sample.md +58 -71
- package/docs/ja/specdojo/samples/bes-index-sample.md +20 -37
- package/docs/ja/specdojo/samples/bes-sample.md +43 -53
- package/docs/ja/specdojo/samples/bps-sample.md +42 -54
- package/docs/ja/specdojo/samples/br-sample.md +40 -52
- package/docs/ja/specdojo/samples/ccd-sample.md +0 -1
- package/docs/ja/specdojo/samples/cdr-sample.md +78 -0
- package/docs/ja/specdojo/samples/cdsd-sample.md +47 -63
- package/docs/ja/specdojo/samples/clis-sample.md +70 -77
- package/docs/ja/specdojo/samples/dec-sample.md +2 -3
- package/docs/ja/specdojo/samples/ifx-api-sample.yaml +0 -2
- package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +0 -2
- package/docs/ja/specdojo/samples/job-sequence.yaml +67 -0
- package/docs/ja/specdojo/samples/mip-index-sample.md +98 -20
- package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +26 -19
- package/docs/ja/specdojo/samples/pm-organization-sample.md +39 -50
- package/docs/ja/specdojo/samples/pm-plan-sample.md +61 -67
- package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +31 -45
- package/docs/ja/specdojo/samples/pm-raci-sample.md +31 -37
- package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +32 -48
- package/docs/ja/specdojo/samples/prj-charter-sample.md +42 -59
- package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +55 -61
- package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +30 -33
- package/docs/ja/specdojo/samples/sf-index-sample.md +13 -55
- package/docs/ja/specdojo/samples/sf-sample.md +73 -85
- package/docs/ja/specdojo/samples/sld-sample.md +60 -79
- package/docs/ja/specdojo/samples/uis-sample.md +98 -121
- package/docs/ja/specdojo/standards/job-definition-standard.md +24 -9
- package/docs/ja/specdojo/templates/cdr-template.md +58 -0
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +2 -1
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +42 -5
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +35 -0
- package/docs/specdojo/schemas/v1/job-run.schema.yaml +23 -0
- package/docs/specdojo/schemas/v1/job.schema.yaml +63 -2
- package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +2 -2
- package/package.json +9 -6
- package/templates/antigravity/orchestrator.md +4 -1
- package/templates/claude/agents/specdojo-orchestrator.md +4 -1
- package/templates/codex/agents/specdojo-orchestrator.toml +4 -1
- package/templates/codex/orchestrator.md +4 -1
- package/templates/init-exec-defaults.yaml +13 -0
- package/templates/lefthook/tools/specdojo-pre-commit.mjs +8 -0
- package/templates/opencode/agents/specdojo-orchestrator.md +5 -2
|
@@ -12,22 +12,17 @@ specdojo:
|
|
|
12
12
|
|
|
13
13
|
Deliverables Catalog (Domain) Documentation Rulebook
|
|
14
14
|
|
|
15
|
-
|
|
16
|
-
各ドメインが管理する成果物の `local_id`・`kind`・`depends_on`・配置先・`done_criteria` を machine-readable な YAML として一覧化し、スケジュール展開・レビュー計画生成・トレーサビリティの基礎とする。
|
|
17
|
-
構造の詳細仕様は `docs/specdojo/schemas/v1/dct.schema.yaml` を SSOT とし、本ルールはその運用方針を補う。
|
|
15
|
+
ドメイン別成果物カタログ(`dct-<domain>.yaml`)に、成果物の `local_id`・`kind`・`depends_on`・配置先・`done_criteria` を machine-readable に一覧化し、スケジュール展開・レビュー計画生成・トレーサビリティの基礎とするためのルールを定める。構造の詳細は `docs/specdojo/schemas/v1/dct.schema.yaml` を SSOT とし、本ルールは schema で表せない運用方針を補う。
|
|
18
16
|
|
|
19
17
|
## 1. 全体方針
|
|
20
18
|
|
|
21
|
-
-
|
|
22
|
-
-
|
|
23
|
-
-
|
|
24
|
-
- `
|
|
25
|
-
-
|
|
26
|
-
- `dct-index` の「共通ルール」を SSOT として参照し、重複定義を避ける。
|
|
19
|
+
- カタログはメタ情報(ID・種別・依存・配置先・概要・完了条件)の管理に専念し、個別成果物の本文は各成果物ファイルを正とする。
|
|
20
|
+
- 漏れ・重複・所在不明を防ぐため、プロジェクトで発生するすべての成果物をいずれかのドメインカタログに記載する。
|
|
21
|
+
- 共通事項は `dct-index` の「共通ルール」を SSOT とし、本ルールと成果物で再定義しない。
|
|
22
|
+
- 実践の型の構成: template はドメインごとの `dct-<domain>-template.yaml`(物理分割時は `dct-<domain>-<part>-template.yaml`)で、`catalog scaffold` が `domain` から選ぶ。1 つの ID しか持てない frontmatter の `template` では表せないため宣言しない。
|
|
23
|
+
- 共通の運用: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、本書と成果物で言い直さない。文書の整形・lint はリポジトリの検証で扱う。
|
|
27
24
|
|
|
28
|
-
## 2.
|
|
29
|
-
|
|
30
|
-
`dct-<domain>.yaml` と関連ドキュメントの関係を示す。
|
|
25
|
+
## 2. 位置づけ
|
|
31
26
|
|
|
32
27
|
```mermaid
|
|
33
28
|
flowchart LR
|
|
@@ -41,100 +36,74 @@ flowchart LR
|
|
|
41
36
|
class DCT_DOM target
|
|
42
37
|
```
|
|
43
38
|
|
|
44
|
-
|
|
45
|
-
| ----------- | --------------------------------------------------------------------------------------------------- |
|
|
46
|
-
| `group` | カタログ内の章に対応する区分。`deliverables` を持つ葉グループと、子 `groups` を持つ親グループがある |
|
|
47
|
-
| `local_id` | 成果物の論理名。プロジェクト内で一意とし、`depends_on` の参照キーとして使う |
|
|
48
|
-
| `kind` | 成果物の種別。`work` / `control` / `generated` の3値 |
|
|
49
|
-
| `base_path` | グループまたはドメインの配置先ディレクトリ。先頭スラッシュの有無で解決方法が変わる |
|
|
50
|
-
|
|
51
|
-
- `dct-index` の索引エントリから各 `dct-<domain>.yaml` へ参照される。
|
|
52
|
-
- 成果物本体(`<local_id>.md` 等)への参照は、`base_path` と各成果物の `path` から解決する。
|
|
39
|
+
`dct-index` の索引から各カタログを参照し、成果物本体は `base_path` と各成果物の `path` から解決する。
|
|
53
40
|
|
|
54
41
|
## 3. ファイル命名・ID規則
|
|
55
42
|
|
|
56
43
|
### 3.1. ファイル命名規約
|
|
57
44
|
|
|
58
|
-
- ファイル名は `dct-<domain>.yaml`
|
|
59
|
-
- `<domain>`
|
|
60
|
-
-
|
|
61
|
-
- テンプレートは `dct-<domain>-template.yaml` とし、`type: template` で記述する。
|
|
62
|
-
- テンプレートを物理分割する場合は `dct-<domain>-<part>-template.yaml` とし、各ファイルの `domain` キーは分割前と同じ `<domain>` を保つ(例: `dct-data-model-bdd-template.yaml`・`dct-data-model-cdsd-template.yaml` はいずれも `domain: data-model`)。scaffold で `dct-<domain>-<part>.yaml` に展開され、`catalog build` で同一 `domain` としてマージされる。
|
|
45
|
+
- ファイル名は `dct-<domain>.yaml` とし、`<domain>` は `domain` キーの値と一致させる(例: `dct-project-management.yaml`)。
|
|
46
|
+
- 1 ドメインを物理分割する場合は `dct-<domain>-<part>.yaml` とし、各ファイルの `domain` は分割前の `<domain>` を保つ。`<part>` は分割軸を表す kebab-case とし、成果物種別で分割する場合は成果物 ID の接頭辞を用いる(例: `dct-data-model-bdd.yaml`・`dct-data-model-cdsd.yaml` はいずれも `domain: data-model`)。判断基準は `物理分割(1 ドメイン複数ファイル)` を参照する。
|
|
47
|
+
- テンプレートは `dct-<domain>-template.yaml`(物理分割時は `dct-<domain>-<part>-template.yaml`)とし、`type: template` で記述する。scaffold で `dct-<domain>-<part>.yaml` に展開され、`catalog build` で同一 `domain` としてマージされる。
|
|
63
48
|
|
|
64
49
|
### 3.2. ID・識別子規約
|
|
65
50
|
|
|
66
|
-
-
|
|
67
|
-
- `domain`
|
|
68
|
-
- `project_id` は `
|
|
69
|
-
-
|
|
70
|
-
-
|
|
51
|
+
- `id` は `type: project` では `<project-id>:dct-<domain>`、テンプレートでは `dct-<domain>-template` とする。物理分割時は末尾に `-<part>` を付ける(例: `prj-0001:dct-data-model-bdd`、`specdojo:dct-data-model-bdd-template`)。
|
|
52
|
+
- `domain` は kebab-case で、先頭は英小文字または数字、最大 63 文字とする。
|
|
53
|
+
- `project_id` は `type: project` で必須とし、配置先プロジェクト ID と一致させる。
|
|
54
|
+
- `local_id` は `type: project` では英小文字・数字・ハイフンのみとし、プロジェクト内で一意にする。
|
|
55
|
+
- 反復作成する成果物は、ファミリーを表す固定の `local_id` と実体 ID の規則を表す `instance_id_pattern` を分ける(`反復成果物` を参照)。
|
|
71
56
|
|
|
72
57
|
## 4. 推奨メタ項目
|
|
73
58
|
|
|
74
|
-
YAML
|
|
59
|
+
YAML 成果物のため、ファイル先頭のトップレベルキーとして記載する。
|
|
75
60
|
|
|
76
|
-
| キー | 説明
|
|
77
|
-
| ------------ |
|
|
78
|
-
| `id` | 成果物 ID(例: `prj-0001:dct-project-definition`)
|
|
79
|
-
| `type` | `project` / `template`
|
|
80
|
-
| `status` | `draft` / `ready` / `deprecated`
|
|
81
|
-
| `title` | ドキュメント名。表示ページの見出しになる
|
|
82
|
-
| `rulebook` |
|
|
83
|
-
| `part_of` | 親となる `dct-index` の `id
|
|
84
|
-
| `project_id` | プロジェクト ID(例: `prj-0001`)
|
|
85
|
-
| `domain` | ドメイン識別子。ファイル名 `dct-<domain>.yaml` と一致させる
|
|
86
|
-
| `base_path` |
|
|
61
|
+
| キー | 説明 | 必須 |
|
|
62
|
+
| ------------ | ----------------------------------------------------------- | -------------- |
|
|
63
|
+
| `id` | 成果物 ID(例: `prj-0001:dct-project-definition`) | ○ |
|
|
64
|
+
| `type` | `project` / `template` | ○ |
|
|
65
|
+
| `status` | `draft` / `ready` / `deprecated` | ○ |
|
|
66
|
+
| `title` | ドキュメント名。表示ページの見出しになる | ○ |
|
|
67
|
+
| `rulebook` | `specdojo:dct-rulebook` | ○ |
|
|
68
|
+
| `part_of` | 親となる `dct-index` の `id`(配列) | 任意 |
|
|
69
|
+
| `project_id` | プロジェクト ID(例: `prj-0001`) | ○(`project`) |
|
|
70
|
+
| `domain` | ドメイン識別子。ファイル名 `dct-<domain>.yaml` と一致させる | ○ |
|
|
71
|
+
| `base_path` | ドメインの既定ディレクトリ。先頭 `/` の絶対パスで記載する | 任意 |
|
|
87
72
|
|
|
88
73
|
## 5. 本文構成(標準テンプレ)
|
|
89
74
|
|
|
90
75
|
### 5.1. ルート構造
|
|
91
76
|
|
|
92
|
-
`
|
|
93
|
-
|
|
94
|
-
| キー | 必須 | 内容 |
|
|
95
|
-
| ---------- | ---- | --------------------------- |
|
|
96
|
-
| `id` | ○ | 成果物 ID |
|
|
97
|
-
| `type` | ○ | `project` / `template` |
|
|
98
|
-
| `status` | ○ | 状態 |
|
|
99
|
-
| `title` | ○ | ドキュメント名 |
|
|
100
|
-
| `rulebook` | ○ | 参照する rulebook ID |
|
|
101
|
-
| `part_of` | 任意 | 親 `dct-index` の `id` 配列 |
|
|
102
|
-
|
|
103
|
-
| `project_id` | ○(`project`) | プロジェクト ID |
|
|
104
|
-
|
|
105
|
-
| `domain` | ○ | ドメイン識別子 |
|
|
106
|
-
| `base_path` | 任意 | ドメインの既定ディレクトリ |
|
|
107
|
-
| `groups` | ○ | グループ(章)の配列。`project` では成果物がまだない領域を空配列 `[]` で表せる |
|
|
77
|
+
ルートは「推奨メタ項目」のキーと、グループ(章)の配列 `groups`(必須)で構成する。`type: project` では、成果物がまだない領域を空配列 `[]` で表せる。
|
|
108
78
|
|
|
109
79
|
### 5.2. `groups[]`(グループ)
|
|
110
80
|
|
|
111
|
-
各グループは Markdown カタログの章に対応する。葉グループは `deliverables` を、親グループは子 `groups`
|
|
81
|
+
各グループは Markdown カタログの章に対応する。葉グループは `deliverables` を、親グループは子 `groups` を持ち、両方を同時に持たない。schema(`anyOf`)は両方を持つ構造も受理するため、この境界はレビューで確認する。
|
|
112
82
|
|
|
113
83
|
| フィールド | 必須 | 内容 |
|
|
114
84
|
| -------------- | ---- | ------------------------------------------------- |
|
|
115
|
-
| `name` | 任意 | 章タイトル(例:
|
|
85
|
+
| `name` | 任意 | 章タイトル(例: `管理計画`) |
|
|
116
86
|
| `base_path` | 任意 | グループの配置先ディレクトリ |
|
|
117
87
|
| `note` | 任意 | グループへの補足(例: `WBSへの落とし込み対象外`) |
|
|
118
|
-
| `groups` |
|
|
119
|
-
| `deliverables` |
|
|
88
|
+
| `groups` | 条件 | 子グループの配列(親グループ) |
|
|
89
|
+
| `deliverables` | 条件 | 成果物エントリの配列(葉グループ) |
|
|
120
90
|
|
|
121
91
|
### 5.3. `deliverables[]`(成果物エントリ)
|
|
122
92
|
|
|
123
|
-
| フィールド | 必須
|
|
124
|
-
| --------------------- |
|
|
125
|
-
| `local_id` | ○
|
|
126
|
-
| `instance_id_pattern` | 任意
|
|
127
|
-
| `name` | ○
|
|
128
|
-
| `kind` | ○
|
|
129
|
-
|
|
130
|
-
| `
|
|
131
|
-
| `
|
|
132
|
-
| `
|
|
133
|
-
| `
|
|
134
|
-
| `
|
|
135
|
-
| `
|
|
136
|
-
| `
|
|
137
|
-
| `note` | 任意 | 構造化フィールドで表せない補足 |
|
|
93
|
+
| フィールド | 必須 | 内容 |
|
|
94
|
+
| --------------------- | ----------- | ------------------------------------------------------------- |
|
|
95
|
+
| `local_id` | ○ | 成果物の論理名(例: `prj-overview`) |
|
|
96
|
+
| `instance_id_pattern` | 任意 | 反復成果物の実体 ID 規則(例: `pjr-{sequence}-{term}`) |
|
|
97
|
+
| `name` | ○ | 業務ユーザーが理解できる日本語名 |
|
|
98
|
+
| `kind` | ○ | `work` / `control` / `generated` |
|
|
99
|
+
| `depends_on` | 任意 | 直接依存する成果物の `local_id` 配列。なければ `[]` |
|
|
100
|
+
| `overview` | ○ | 成果物の目的を 1 文で記述 |
|
|
101
|
+
| `brief` | 任意 | 成果物の外から継続して渡す前提(技術スタックや制約など) |
|
|
102
|
+
| `path` | ○(`work`) | 成果物のファイルパス |
|
|
103
|
+
| `rulebook` | 任意 | rulebook の完全 ID、未判断は `undecided`、不要は `not-needed` |
|
|
104
|
+
| `evidence_refs` | 任意 | `retrofit` で読む非成果物エビデンス |
|
|
105
|
+
| `done_criteria` | ○(`work`) | 完了条件の配列 |
|
|
106
|
+
| `note` | 任意 | 構造化フィールドで表せない補足 |
|
|
138
107
|
|
|
139
108
|
### 5.4. `evidence_refs[]`(非成果物エビデンス)
|
|
140
109
|
|
|
@@ -146,154 +115,128 @@ YAML 成果物のため、Markdown Frontmatter ではなくファイル先頭の
|
|
|
146
115
|
|
|
147
116
|
### 5.5. `done_criteria[]`(完了条件)
|
|
148
117
|
|
|
149
|
-
| フィールド | 必須 | 内容
|
|
150
|
-
| ----------- | ---- |
|
|
151
|
-
| `text` | ○ | 成果物が満たすべき検証可能な条件
|
|
152
|
-
| `roles` | ○ | 条件を確認するロールコード配列(`PO
|
|
153
|
-
| `viewpoint` | ○ | 主たるレビュー観点 ID(`
|
|
118
|
+
| フィールド | 必須 | 内容 |
|
|
119
|
+
| ----------- | ---- | ----------------------------------------------------------------------------------- |
|
|
120
|
+
| `text` | ○ | 成果物が満たすべき検証可能な条件 |
|
|
121
|
+
| `roles` | ○ | 条件を確認するロールコード配列(`PO`・`PM`・`BA`・`ARC`・`DEV`・`QE`・`UX`・`OPS`) |
|
|
122
|
+
| `viewpoint` | ○ | 主たるレビュー観点 ID(`pm-review-viewpoints.yaml` の `vp-*`) |
|
|
154
123
|
|
|
155
124
|
## 6. 記述ガイド
|
|
156
125
|
|
|
157
126
|
### 6.1. グループ構成
|
|
158
127
|
|
|
159
|
-
- `type: project`
|
|
128
|
+
- `type: project` で `groups` を `[]` にするのは、対象領域に成果物がまだない場合に限る。`groups` の省略や配列以外の値は認めない。テンプレートには 1 つ以上のグループを定義する。
|
|
160
129
|
- サブドメインに分かれない場合は、単一の葉グループに `deliverables` を並べる(平坦型)。
|
|
161
|
-
- サブドメインが2
|
|
162
|
-
- 親グループは `deliverables` を直接持たず、子 `groups` で表現する。
|
|
130
|
+
- サブドメインが 2 つ以上ある場合は、親グループの `groups` 配下に `name`・`base_path`・`deliverables` を持つ子グループを並べる(章分割型)。
|
|
163
131
|
|
|
164
132
|
### 6.2. `kind`(種別)
|
|
165
133
|
|
|
166
|
-
- `work`:
|
|
134
|
+
- `work`: スケジュール展開対象。成果物を実際に作成する作業に対応し、`path` と `done_criteria` が必須。
|
|
167
135
|
- `control`: プロジェクト管理・統制文書。スケジュール展開対象外。
|
|
168
|
-
- `generated`:
|
|
169
|
-
- 3値以外に拡張しない。
|
|
170
|
-
- `generated` には実践の型を適用しない。`rulebook` が記載されていても、実行時は `kind` から非適用を導出する。
|
|
136
|
+
- `generated`: 自動生成・派生成果物。スケジュール展開対象外で、`rulebook` が記載されていても実践の型を適用しない(`kind` から導出する)。
|
|
171
137
|
|
|
172
|
-
|
|
138
|
+
計画成果物は生成方法ではなくライフサイクルで区別する。
|
|
173
139
|
|
|
174
140
|
- 人または agent が判断して更新する `dct-index`、`dct-plan-<domain>`、`sch-strategy-<track>`、`sch-defaults` は `work` とする。
|
|
175
|
-
-
|
|
176
|
-
- `sch-track-<track>` と `sch-milestones` は strategy から再生成できるため `generated` とし、対応する `sch-strategy-<track>` を `depends_on` に宣言する。
|
|
177
|
-
|
|
141
|
+
- `sch-track-<track>` と `sch-milestones` は strategy から再生成できるため `generated` とし、生成元の `sch-strategy-<track>` を `depends_on` に宣言する。テンプレートでも同じとする。
|
|
178
142
|
- 計画成果物を所有するトラック自身の `sch-strategy` は、自己生成の循環を避けるため `control` とするか、そのトラックの scope 外へ置く。
|
|
179
|
-
-
|
|
180
|
-
-
|
|
143
|
+
- 全体計画は登録簿の epic を正本とする([[specdojo:register-operation-guide|登録簿運用ガイド]])。非推奨の `tml-index` は新しく登録せず、移行時に旧エントリと不要な依存を外す。
|
|
144
|
+
- `dct-<domain>.yaml` 自身と `generated/` 配下の表示用生成物は、二重管理を避けるため登録しない。
|
|
145
|
+
- トラック別の strategy・track の `local_id` は、対象 epic の範囲のカタログを人間が確認し、`catalog-planning` の子 todo を完了させてから追加する。未着手トラックの分を先行登録しない。
|
|
181
146
|
|
|
182
147
|
### 6.3. `depends_on`
|
|
183
148
|
|
|
184
|
-
-
|
|
185
|
-
-
|
|
186
|
-
-
|
|
149
|
+
- 依存がない場合は空配列 `[]` とする。
|
|
150
|
+
- 参照先は同一カタログまたは他ドメインカタログの `local_id` とし、ファイルパスや URL を混在させない。
|
|
151
|
+
- 反復成果物は、`instance_id_pattern` ではなく固定の `local_id` を参照する。
|
|
187
152
|
|
|
188
153
|
### 6.4. 実践の型の要否宣言
|
|
189
154
|
|
|
190
|
-
-
|
|
191
|
-
|
|
192
|
-
- `rulebook`
|
|
193
|
-
-
|
|
194
|
-
- `kind: generated` では `rulebook` 宣言の有無にかかわらず4種すべてを適用しない。成果物ごとの型宣言を追加せず、`kind` から導出する。
|
|
195
|
-
- recipe / sample / template の `undecided` は利用可能性判定で未整備として扱い、`not-needed` は欠落とみなさず対応する `*-maintenance` の対象にも含めない。要否を再検討する場合は、先に rulebook frontmatter の宣言を更新する。
|
|
155
|
+
- カタログは成果物と rulebook の対応だけを `rulebook` に宣言し、recipe / sample / template の要否と所在は参照先 rulebook の frontmatter を正本とする。
|
|
156
|
+
- `rulebook` には実在する rulebook の完全 ID を記載する。要否未判断は `undecided`、不要は `not-needed`、省略は必要だが未整備を表す。`catalog validate` は完全 ID の実在を検証する。
|
|
157
|
+
- `rulebook: none` は成果物本体のメタ情報で「準拠 rulebook なし」を表す値であり、カタログでは使わない。
|
|
158
|
+
- recipe / sample / template の `undecided` は未整備として扱い、`not-needed` は欠落とみなさず `*-maintenance` の対象にも含めない。要否を再検討する場合は、先に rulebook frontmatter を更新する。
|
|
196
159
|
|
|
197
160
|
### 6.5. `evidence_refs`
|
|
198
161
|
|
|
199
|
-
- `
|
|
200
|
-
- `
|
|
201
|
-
- `path`
|
|
202
|
-
- `
|
|
203
|
-
-
|
|
204
|
-
- ディレクトリを指定する場合は責務単位に限定し、`src`、`tools`、`docs`、リポジトリルートのような過度に広い範囲を指定しない。
|
|
205
|
-
- `purpose` はファイル名の言い換えではなく、入出力、状態遷移、例外など、その参照から何を確認するかを記載する。
|
|
206
|
-
- 実装エビデンスは読み取り専用であり、plan frontmatter の `targets`、worktree の変更許可範囲、commit 許可リストへ追加しない。
|
|
162
|
+
- `approach: retrofit` の edit / review plan に「実装エビデンス」として展開される調査入力である。`depends_on` のような成果物間の根拠・実行順序や、`based_on` のような文書 ID 参照には使わない。
|
|
163
|
+
- `path` は先頭スラッシュなしのリポジトリルート相対パスとする。`catalog validate` が存在と同一成果物内の重複を検証する。
|
|
164
|
+
- `path` は責務単位に限定し、`src`・`tools`・`docs`・リポジトリルートのような広い範囲を指定しない。状態遷移・判定・検証の本体を含むファイルを参照し、入口が re-export だけなら転送先をたどる(`catalog validate` は re-export だけのファイルを警告する)。
|
|
165
|
+
- `purpose` はファイル名の言い換えではなく、入出力・状態遷移・例外など、その参照から何を確認するかを記載する。
|
|
166
|
+
- 実装エビデンスは読み取り専用であり、plan の `targets`、worktree の変更許可範囲、commit 許可リストへ追加しない。
|
|
207
167
|
|
|
208
168
|
### 6.6. `base_path` と `path` の解決
|
|
209
169
|
|
|
210
|
-
- 先頭が `/`
|
|
211
|
-
-
|
|
212
|
-
-
|
|
213
|
-
- 解決結果はリポジトリルートからの相対パスを正準形とし、先頭スラッシュなし・POSIX 区切り(`/`)で正規化する。`base_path` 先頭の `/` はルートを起点とする記法上の目印であり、生成される dct ビュー・exec plan・doc-index など下流の参照表記には残さない。
|
|
170
|
+
- 先頭が `/` のパスはリポジトリルートからの絶対パス、先頭が `/` でないパスは最も近い祖先(グループまたはドメイン)の解決済み `base_path` に連結する相対パスとして解決する。
|
|
171
|
+
- ドメインの `base_path` は絶対パス(先頭 `/`)で記載する。schema が先頭 `/` を必須とする。
|
|
172
|
+
- 解決結果は先頭スラッシュなし・POSIX 区切りのリポジトリルート相対パスを正準形とし、dct ビュー・exec plan・doc-index など下流の表記に先頭 `/` を残さない。
|
|
214
173
|
|
|
215
174
|
### 6.7. `done_criteria`
|
|
216
175
|
|
|
217
|
-
- `work`
|
|
218
|
-
- `text`
|
|
219
|
-
- `roles`
|
|
220
|
-
- `viewpoint` には `pm-review-viewpoints.yaml` で定義された `vp-*` の ID を 1 つ記載する。
|
|
176
|
+
- `work` 成果物には 1 件以上の完了条件を記載する。
|
|
177
|
+
- `text` は「確認できること」「識別できること」など検証可能な形で書き、前提や指示ではなく成果物が達成した振る舞い・状態を記載する。
|
|
178
|
+
- `roles` には条件を確認する責務を持つロールコードだけを記載し、`viewpoint` には `vp-*` の ID を 1 つ記載する。
|
|
221
179
|
|
|
222
180
|
### 6.8. 反復成果物
|
|
223
181
|
|
|
224
|
-
-
|
|
225
|
-
-
|
|
226
|
-
- プレースホルダは小文字を波括弧で囲んで記述し、固定語はハイフンで連結する。
|
|
182
|
+
- `local_id` にはファミリーを表す固定の kebab-case を使い、実体 ID の規則は `instance_id_pattern` に分ける(例: `pjr-{sequence}-{term}`、`pr-{yyyy}-{mm}-{dd}`)。
|
|
183
|
+
- プレースホルダは小文字を波括弧で囲み、固定語はハイフンで連結する。
|
|
227
184
|
|
|
228
185
|
### 6.9. テンプレート固有項目
|
|
229
186
|
|
|
230
|
-
- `
|
|
231
|
-
|
|
232
|
-
- `min_size` は規模に応じた取捨選択のための項目であり、scaffold 時に除去される。
|
|
187
|
+
- `min_size`(`small` / `medium` / `large`)は規模に応じた取捨選択のための項目で、`type: template` だけに書く。scaffold 時に除去される。schema は `type: project` でも受理するため、レビューで確認する。
|
|
233
188
|
- テンプレートでは `local_id` や `part_of` にアンダースコアで囲んだプレースホルダ(例: `_PROJECT_ID_:dct-index`)を使用できる。
|
|
234
189
|
|
|
235
190
|
### 6.10. 業務領域テンプレートの反復方針(`_TERM_` の使い分け)
|
|
236
191
|
|
|
237
|
-
- `local_id` に `_TERM_`
|
|
238
|
-
-
|
|
239
|
-
-
|
|
240
|
-
- パターンBの実例は `prj-0001:dct-data-flow`(`domain: data-flow`。単一業務(SpecDojo運用)を、初期化・課題整理・タスク実行・例外対応・定期実行など複数のデータフロー(`cdfd`)に分割している)を参照する。
|
|
192
|
+
- `local_id` に `_TERM_` を含む項目(例: `cdfd-_TERM_`)は、パターンA(複数業務領域)を既定とする。業務領域ごと(例: 販売/調達/会計)に項目を複製し、`_TERM_` を各領域の略称へ置き換える。
|
|
193
|
+
- 対象業務が単一で、局面・処理内容ごとに複数項目へ分割する場合はパターンB(単一領域・複数項目)とし、`_TERM_` を使わず項目ごとに固定の `local_id` と `done_criteria` を記載する。実例は `prj-0001:dct-data-flow` である。
|
|
194
|
+
- どちらのパターンでも項目数に上限はない。テンプレートの 1 件は書式サンプルであり、必要な数だけ記載する。
|
|
241
195
|
|
|
242
196
|
### 6.11. 物理分割(1 ドメイン複数ファイル)
|
|
243
197
|
|
|
244
|
-
-
|
|
245
|
-
-
|
|
246
|
-
-
|
|
247
|
-
-
|
|
248
|
-
- 名前が異なる group は別章として保持する。無名 group は結合キーを持たないため、従来どおりファイル名昇順で見出しなしの内容として連結する。単一ファイル内の group 構造は変更しない。
|
|
249
|
-
- マージ順序はファイル名の昇順で決定的に定まる。最初に現れる章の並びを制御したい場合は `<part>` の命名で順序を表現する。
|
|
250
|
-
- 同一 `domain` の各ファイルは `project_id` と `base_path` を一致させる。`base_path` はマージ後の配置先解決の起点となるため、部分ファイルごとに変えない。
|
|
251
|
-
- `local_id` はプロジェクト内で一意という制約を維持する。同一ドメインの分割ファイル間で `local_id` が重複するとマージがエラーになる。
|
|
252
|
-
- ドキュメントの `id`・`title` 等のメタ情報は、マージ後カタログではファイル名昇順で先頭となるファイルの値を採用する。分割してもメタ情報が一貫するよう記載する。
|
|
198
|
+
- 反復要素が多く単一ファイルが肥大化するドメインは、論理ドメインを保ったまま `dct-<domain>-<part>.yaml` へ物理分割してよい。`catalog build` は同一 `domain` のファイルをファイル名の昇順でマージし、`dct-<domain>.md` を 1 つ生成する。
|
|
199
|
+
- 同一階層の名前付き group は `name` の完全一致で 1 章へ結合する。章の位置と `base_path`・`note`・`min_size` は最初に現れた group の値を採用し、`deliverables` はファイル名昇順・定義順で追記する。同名の子 `groups` にも再帰的に適用する。名前が異なる group は別章とし、無名 group はファイル名昇順で見出しなしで連結する。
|
|
200
|
+
- 同名 group の `base_path` と、同一 `domain` の各ファイルの `project_id`・`base_path` は一致させる。章の並びを制御したい場合は `<part>` の命名で順序を表す。
|
|
201
|
+
- 分割ファイル間で `local_id` が重複するとマージがエラーになる。`id`・`title` 等のメタ情報はファイル名昇順で先頭のファイルの値を採用するため、分割しても一貫させる。
|
|
253
202
|
|
|
254
203
|
### 6.12. 成果物カタログ判定計画(`dct-plan-<domain>.yaml`)
|
|
255
204
|
|
|
256
|
-
-
|
|
257
|
-
- 配置先は成果物カタログディレクトリ配下の `plans/`
|
|
258
|
-
-
|
|
259
|
-
-
|
|
260
|
-
-
|
|
261
|
-
-
|
|
262
|
-
-
|
|
263
|
-
- 既に `dct-<domain>.yaml` があるドメインでは、既存カタログを基準線として入力に含め、既存 `local_id` を落とす場合は `exclusions` に理由を残す。
|
|
264
|
-
- 既存の判定計画は無条件に上書きしない。再判定時は差分をレビューし、上書きは明示的な `--force` 操作で行う。
|
|
265
|
-
- 判定計画は draft 作成支援であり、その存在だけでカタログの内容確認や `catalog-planning` の完了を代替しない。
|
|
205
|
+
- 上流成果物からどの成果物インスタンスが必要かを agent が判定した結果は、`dct-plan-<domain>.yaml` に保存する。構造の SSOT は `docs/specdojo/schemas/v1/dct-plan.schema.yaml` とする。
|
|
206
|
+
- 配置先は成果物カタログディレクトリ配下の `plans/` とし、`catalog validate` / `catalog build` の対象と混同しないよう `dct-*.yaml` と同じ階層に置かない。`generated/` の派生ビューとは異なり、バージョン管理対象の正本である。
|
|
207
|
+
- 書くのは、必要な成果物インスタンス・placeholder 値・採用しない候補・未確定事項・判定根拠・確度に限る。`groups`・`base_path`・`done_criteria` などのカタログ構造はテンプレートとジェネレーターの責務であり、複製しない。
|
|
208
|
+
- `iteration_pattern` はパターンAを `pattern-a`、パターンBを `pattern-b` とする。`pattern-a` では placeholder ごとに値と根拠を `variables` へ書き、`local_id` を展開結果と一致させる。`pattern-b` では `variables` を使わず固定の `local_id` を記載する。
|
|
209
|
+
- 上流成果物から根拠を得られない placeholder・要否・名称・依存関係は確定させず、`open_questions` に理由と次のアクションを残す。
|
|
210
|
+
- 入力は epic の `domains` が示す対象ドメインの上流成果物とし、関係する data-flow 成果物をすべて含める。data-flow がないドメインでは入力文書を明示する。既存カタログがあれば基準線として含め、既存 `local_id` を落とす場合は `exclusions` に理由を残す。
|
|
211
|
+
- 既存の判定計画は再判定時に差分をレビューし、上書きは `--force` で明示する。判定計画の存在だけで、カタログの内容確認や `catalog-planning` の完了を代替しない。
|
|
266
212
|
|
|
267
213
|
### 6.13. 判定計画からの決定論的生成
|
|
268
214
|
|
|
269
|
-
-
|
|
270
|
-
-
|
|
271
|
-
- blocking な `open_questions`、未解決 placeholder、重複 `local_id`、存在しない `depends_on`、schema
|
|
272
|
-
-
|
|
273
|
-
- 生成されたカタログの `status` は template に従い `draft`
|
|
215
|
+
- 判定計画からの生成は `catalog scaffold --plan --domain <domain>` を使い、`--var` は併用しない。placeholder 値は根拠付きの `variables` を正本とする。
|
|
216
|
+
- `min_size`・placeholder 展開・`part_of`・`domain`・`base_path`・group 構造・物理分割は scaffold と共通の処理で適用する。
|
|
217
|
+
- blocking な `open_questions`、未解決 placeholder、重複 `local_id`、存在しない `depends_on`、schema 違反が 1 件でもあれば、その domain のファイルを書き込まない。
|
|
218
|
+
- 差分は `--dry-run` で確認し、内容の異なる既存ファイルの上書きには `--force` を要する。
|
|
219
|
+
- 生成されたカタログの `status` は template に従い `draft` のままとし、人間の内容確認を経て `catalog-planning` の完了を記録する。
|
|
274
220
|
|
|
275
221
|
### 6.14. `brief`・`overview`・`done_criteria` の使い分けと YAML アンカー
|
|
276
222
|
|
|
277
|
-
- `overview`: 成果物の目的・責務を 1
|
|
278
|
-
- `brief`:
|
|
279
|
-
- `done_criteria`:
|
|
280
|
-
-
|
|
223
|
+
- `overview`: 成果物の目的・責務を 1 文で書く。カタログの表示ページの一覧に載り、ドメインの俯瞰に用いる。
|
|
224
|
+
- `brief`: 採用する技術スタック、アーキテクチャ上の制約、設計・選定方針など、成果物の外から継続して渡す前提を書く。schedule・register の plan に「前提」として展開され、未指定なら載らない。
|
|
225
|
+
- `done_criteria`: 「`done_criteria`」の記述ガイドに従う。
|
|
226
|
+
- 複数の成果物で前提を共有する場合は、同一ファイル内で YAML のアンカー(`&anchor`)を定義し、各 `brief` からエイリアス(`*anchor`)で参照する。
|
|
281
227
|
|
|
282
228
|
## 7. 禁止事項
|
|
283
229
|
|
|
284
|
-
| 禁止事項
|
|
285
|
-
|
|
|
286
|
-
|
|
|
287
|
-
|
|
|
288
|
-
|
|
|
289
|
-
|
|
|
290
|
-
| `
|
|
291
|
-
| `evidence_refs.path`
|
|
292
|
-
| `
|
|
293
|
-
| `
|
|
294
|
-
|
|
|
295
|
-
|
|
|
296
|
-
| `dct
|
|
297
|
-
| 根拠のない placeholder 値や成果物を判定計画で確定させる | 推測がそのままカタログへ流れ込むため |
|
|
298
|
-
| 判定計画がある domain を `--var` 付きの通常 scaffold で再生成する | 根拠付きの判定結果と生成入力が分岐するため |
|
|
299
|
-
| 本ルールや成果物ファイルでスキーマ定義を再掲・上書きする | `dct.schema.yaml` を SSOT とするため |
|
|
230
|
+
| 禁止事項 | 理由 |
|
|
231
|
+
| ------------------------------------------------------------------------ | --------------------------------------------------------------- |
|
|
232
|
+
| 成果物の詳細本文(仕様・手順・構成図など)をカタログに記載する | 詳細は成果物本体に集約するため |
|
|
233
|
+
| `kind` を `work` / `control` / `generated` 以外に拡張する | スケジュール展開・レビュー生成の前提が崩れるため |
|
|
234
|
+
| 同一 `local_id` を複数ドメインのカタログに重複して記載する | トレーサビリティとスケジュール展開が破綻するため |
|
|
235
|
+
| 1 つのグループに `groups` と `deliverables` を両方持たせる | 親グループと葉グループの境界が曖昧になるため |
|
|
236
|
+
| `type: project` に `min_size` を書く | scaffold 後の項目であり、規模による取捨選択の結果と食い違うため |
|
|
237
|
+
| `evidence_refs.path` に広すぎる範囲や re-export だけのファイルを指定する | 調査範囲を限定できず、判定・検証の本体が漏れるため |
|
|
238
|
+
| 実在しない実践の型 ID、またはカタログで `rulebook: none` を使う | 未判断・未整備・不要・参照切れを機械的に区別できないため |
|
|
239
|
+
| `dct-plan-<domain>.yaml` にカタログ構造や自由文の判断メモを書く | ジェネレーターが機械的に扱えず責務境界が崩れるため |
|
|
240
|
+
| 根拠のない placeholder 値や成果物を判定計画で確定させる | 推測がそのままカタログへ流れ込むため |
|
|
241
|
+
| 判定計画がある domain を `--var` 付きの通常 scaffold で再生成する | 根拠付きの判定結果と生成入力が分岐するため |
|
|
242
|
+
| 本ルールや成果物ファイルでスキーマ定義を再掲・上書きする | `dct.schema.yaml` を SSOT とするため |
|
|
@@ -18,27 +18,20 @@ Decision Log Documentation Rulebook
|
|
|
18
18
|
|
|
19
19
|
- 重要な判断の背景、選択肢、採択理由を追跡可能に残す。
|
|
20
20
|
- 決定後の影響範囲とフォローアップを明示する。
|
|
21
|
-
-
|
|
21
|
+
- **共通の運用**: 役割はメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。
|
|
22
22
|
|
|
23
|
-
## 2.
|
|
23
|
+
## 2. 位置づけ
|
|
24
24
|
|
|
25
|
-
-
|
|
26
|
-
- 課題ログ、変更要求ログと相互参照する。
|
|
25
|
+
- 決定記録はプロジェクト運営・設計判断の証跡であり、課題ログ、変更要求ログと相互参照する。
|
|
27
26
|
|
|
28
27
|
## 3. ファイル命名・ID規則
|
|
29
28
|
|
|
30
|
-
-
|
|
31
|
-
- 連番は4桁ゼロ埋めとする(例: `dec-0001-auth`)。
|
|
29
|
+
- ファイル名は `dec-<NNNN>-<topic>.md` とし、連番は4桁ゼロ埋めとする(例: `dec-0001-auth`)。
|
|
32
30
|
- 文書 ID は `<project-id>:dec-<NNNN>-<topic>` 形式とする(例: `prj-0001:dec-0001-auth`)。
|
|
33
31
|
|
|
34
32
|
## 4. 推奨 Frontmatter 項目
|
|
35
33
|
|
|
36
|
-
|
|
37
|
-
| ---- | ---- | ---- |
|
|
38
|
-
|
|
39
|
-
| id | `<project-id>:dec-<NNNN>-<topic>` | ○ |
|
|
40
|
-
| type | `project` | ○ |
|
|
41
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
34
|
+
`specdojo.id` は `<project-id>:dec-<NNNN>-<topic>`、`specdojo.type` は `project` とし、その他の項目は共通の運用に従う。
|
|
42
35
|
|
|
43
36
|
## 5. 本文構成(標準テンプレ)
|
|
44
37
|
|
|
@@ -53,7 +46,6 @@ Decision Log Documentation Rulebook
|
|
|
53
46
|
## 6. 記述ガイド
|
|
54
47
|
|
|
55
48
|
- 選択肢は少なくとも2案以上を記載する。
|
|
56
|
-
|
|
57
49
|
- 採択理由は判断軸とともに記載する。
|
|
58
50
|
- 影響範囲は仕様・実装・運用の観点で示す。
|
|
59
51
|
|
|
@@ -61,4 +53,3 @@ Decision Log Documentation Rulebook
|
|
|
61
53
|
|
|
62
54
|
- 根拠なしで結論のみを記載しない。
|
|
63
55
|
- 実装断片の貼り付けで説明を代替しない。
|
|
64
|
-
- 影響範囲未記載のまま確定しない。
|
|
@@ -13,89 +13,45 @@ specdojo:
|
|
|
13
13
|
|
|
14
14
|
Data Migration Design Documentation Rules
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
移行の共通設計と対象別DMDへの導線を定める。
|
|
17
17
|
|
|
18
18
|
## 1. 全体方針
|
|
19
19
|
|
|
20
|
-
- `dmd
|
|
21
|
-
-
|
|
22
|
-
-
|
|
20
|
+
- 共通方針を正本とし、対象別の詳細は `dmd-<term>` に委譲する。
|
|
21
|
+
- 再実行で同一結果となる条件と検証の合否を定義する。
|
|
22
|
+
- **共通の運用**: 役割は適用先のメンバー定義、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。整形・lint はリポジトリの検証で扱う。
|
|
23
23
|
|
|
24
|
-
## 2.
|
|
24
|
+
## 2. 位置づけ
|
|
25
25
|
|
|
26
|
-
|
|
27
|
-
- `dmd-index`: データ移行の共通設計(本書)
|
|
28
|
-
- `dmd-<term>`: 対象別の詳細設計(抽出条件/マッピング/手順/検証)
|
|
29
|
-
- `mtp-index` / `mtp-<term>`: リハーサル計画と証跡設計
|
|
30
|
-
- `cop-index` / `cop-<term>`: 当日実行の詳細手順(Runbook)
|
|
26
|
+
`mip-index` の対象・成功条件・停止許容時間を受ける。個別設計は `dmd-<term>`、リハーサル・証跡設計は `mtp-*`、当日手順は `cop-*` が担う。
|
|
31
27
|
|
|
32
28
|
## 3. ファイル命名・ID規則
|
|
33
29
|
|
|
34
|
-
-
|
|
35
|
-
-
|
|
30
|
+
- ファイル名の例: `dmd-index.md`。
|
|
31
|
+
- ID はプロダクト仕様では `dmd-index`、プロジェクトでは `<project-id>:dmd-index`(例: `prj-0001:dmd-index`)。sample の ID は共通標準に従う。
|
|
36
32
|
|
|
37
33
|
## 4. 推奨 Frontmatter 項目
|
|
38
34
|
|
|
39
|
-
|
|
40
|
-
| ----- | ---------------------- | ---- |
|
|
41
|
-
| id | `dmd-index` | ○ |
|
|
42
|
-
| type | `data` 固定 | ○ |
|
|
43
|
-
| title | `データ移行設計: 全体` | ○ |
|
|
44
|
-
|
|
45
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
46
|
-
| based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
|
|
47
|
-
| supersedes | 置き換え関係(ID配列。未指定は `[]` 可) | 任意 |
|
|
35
|
+
共通項目は「共通の運用」の標準に従う。`specdojo.type: data`、`specdojo.rulebook: specdojo:dmd-index-rulebook` とし、文書名は H1 に置く。
|
|
48
36
|
|
|
49
37
|
## 5. 本文構成(標準テンプレ)
|
|
50
38
|
|
|
51
|
-
|
|
|
52
|
-
|
|
53
|
-
|
|
|
54
|
-
|
|
|
55
|
-
|
|
|
56
|
-
|
|
|
57
|
-
|
|
|
58
|
-
|
|
|
59
|
-
| 6 | 関連ドキュメント(必須) | ○ |
|
|
39
|
+
| 見出し | 必須 | 受入条件 |
|
|
40
|
+
| ------------------------------------------------- | ---- | -------------------------------------------------------------------------- |
|
|
41
|
+
| 概要(index) | ○ | 目的(再現性・品質担保)と範囲を1〜3行で示す |
|
|
42
|
+
| 共通方針(抽出/変換/除外/冪等性/ログ) | ○ | フル/増分の選択と増分基準、変換/除外の原則と根拠、冪等性、ログ必須項目 |
|
|
43
|
+
| `run_id` 規約(命名/採番/記録/参照方法) | ○ | 命名・採番方法、ログ/投入データ/照合レポートの関連付け |
|
|
44
|
+
| 検証の共通方針(種別/基準/証跡/保管) | ○ | 件数/サンプル/重要値の照合手順、差分0または許容差εと理由、証跡保管先・命名 |
|
|
45
|
+
| 対象一覧(スコープ/非対象/担当/対応ドキュメント) | ○ | 対象/非対象/担当/対応DMDの一覧と `mip-index` との整合 |
|
|
46
|
+
| 関連ドキュメント(必須) | ○ | 各 `dmd-<term>` への導線。分冊がなければ「(本書のみ)」と明記 |
|
|
60
47
|
|
|
61
48
|
## 6. 記述ガイド
|
|
62
49
|
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
-
|
|
66
|
-
- 本書が入口(SSOT)であり、詳細は `dmd-<term>` にあることを明記する。
|
|
67
|
-
|
|
68
|
-
### 6.2. 共通方針(抽出/変換/除外/冪等性/ログ)
|
|
69
|
-
|
|
70
|
-
- 抽出(フル/増分)の採用方針と増分基準を定義する。
|
|
71
|
-
- 変換/除外の原則(再実行で同一結果)と根拠リンクの方針を定義する。
|
|
72
|
-
- 冪等性とログ要件(最低限残す項目)を定義する。
|
|
73
|
-
|
|
74
|
-
### 6.3. run_id 規約(命名/採番/記録/参照方法)
|
|
75
|
-
|
|
76
|
-
- 命名規則(例: `DMD-YYYYMMDD-<term>-NN`)と採番方法を定義する。
|
|
77
|
-
|
|
78
|
-
- run_id をログ/投入データ/照合レポートに紐づける。
|
|
79
|
-
|
|
80
|
-
### 6.4. 検証の共通方針(種別/基準/証跡/保管)
|
|
81
|
-
|
|
82
|
-
- 最低限の検証種別(件数/サンプル/重要値)を定義する。
|
|
83
|
-
- 合格基準(差分0 / 許容差ε)の記述方法を定義する。
|
|
84
|
-
- 証跡の保管場所と命名規約を定義する。
|
|
85
|
-
|
|
86
|
-
### 6.5. 対象一覧(スコープ/非対象/担当/対応ドキュメント)
|
|
87
|
-
|
|
88
|
-
- 対象/非対象/担当/対応 `dmd-<term>` を一覧化する。
|
|
89
|
-
- `mip-index` の移行対象と整合し、導線を明記する。
|
|
90
|
-
|
|
91
|
-
### 6.6. 関連ドキュメント(必須)
|
|
92
|
-
|
|
93
|
-
- 各 `dmd-<term>` への導線を必ず記載する。
|
|
94
|
-
- 分冊が無い場合でも `(本書のみ)` を明記する。
|
|
50
|
+
- 対象一覧の推奨列: 区分、対象(論理名)、旧→新、方針(フル/増分)、担当、対応DMD。
|
|
51
|
+
- `run_id` の例: `DMD-YYYYMMDD-<term>-NN`(当日内連番)。
|
|
52
|
+
- 検証の良い例: 「旧/新の期間別売上を照合し差分0。レポートを `run_id` 単位で保管」。悪い例: 「移行後に問題がないことを確認」。
|
|
95
53
|
|
|
96
54
|
## 7. 禁止事項
|
|
97
55
|
|
|
98
|
-
- `dmd-<term>`
|
|
99
|
-
-
|
|
100
|
-
- run_id 規約や検証共通方針を未定義のままにしない。
|
|
101
|
-
- 実装依存の長大なSQLやコードを本文に記載しない。
|
|
56
|
+
- 個別の変換仕様・実行手順を `dmd-<term>` と重複記載しない。
|
|
57
|
+
- 対象/非対象・対応DMDの導線、`run_id` 規約、検証共通方針を欠落させない。
|