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
|
@@ -25,28 +25,12 @@ C4 Component Diagram (CPD) Authoring Rule
|
|
|
25
25
|
- 上位 C4 コンテナ図から対象コンテナを一つ選び、利用者、外部依存、ストアの境界を引き継ぎます。別コンテナを内部コンポーネントへ取り込みません。
|
|
26
26
|
- 分割単位は固有の責務と入出力を持つまとまりです。主要コンポーネントは 5〜15 個程度を目安とし、数合わせやコマンド・ファイル単位の機械的な分割はしません。
|
|
27
27
|
- 図は主要依存、定義表は責務・情報の受け渡し・制約を担います。主要経路を選んだ理由と省略範囲を示し、全関数・全呼び出しの一覧にしません。
|
|
28
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めません。
|
|
28
29
|
- 記法は `includes` で適用する [[specdojo:cpd-mermaid-rulebook|CPD Mermaid 記法ルール]] を正本とし、形状・色・構文は本書で再定義しません。
|
|
29
30
|
|
|
30
|
-
### 1.1. 作成・確認・合意の分担
|
|
31
|
-
|
|
32
|
-
以下を作業単位とし、PM が対象コンテナ数、関係数、未確認の依存を基に担当と見積もりを Schedule に割り当てます。Role code と実行主体の対応・兼務はプロジェクトの組織定義に従い、CPD に別の名簿を作りません。
|
|
33
|
-
|
|
34
|
-
| 作業・確認対象 | 担当 Role code | 判断タイミング・完了条件 |
|
|
35
|
-
| ---------------------------------------------- | ------------------------------ | --------------------------------------------------------------------------------------- |
|
|
36
|
-
| 対象者の課題・期待価値と分割の目的 | BA、業務確認者となる利用者代表 | 分割案の作成前。上位の目的と成功基準に対応すること |
|
|
37
|
-
| 境界・責務・依存方向の作成とアーキテクチャ確認 | ARC | 詳細設計への引き渡し前。上位図との対応と採用理由を説明できること |
|
|
38
|
-
| 実装配置・詳細契約への対応確認 | DEV | 実装着手前。確認済みの対応と未確認の論点を分離できること |
|
|
39
|
-
| 図・定義表の照合と結合観測点の確認 | QE | 合意依頼前。「検証と合意の判定」の条件を満たすこと |
|
|
40
|
-
| 未決事項・後続作業・期限の調整 | PM | 依存変更時と合意依頼前。PJR と Schedule への反映先が定まること |
|
|
41
|
-
| 公開前確認と最終合意 | OPS、人間の PO | 公開・確定前。OPS が確認結果を提示し、PO が承認・保留・差し戻しと公開可否を判断すること |
|
|
42
|
-
|
|
43
31
|
## 2. 位置づけと用語定義
|
|
44
32
|
|
|
45
|
-
|
|
46
|
-
| -------------- | ---------------------------------------------------------------------------- |
|
|
47
|
-
| コンテナ | 上位図が定める実行・配備単位。コンポーネントごとの別プロセス化を意味しない |
|
|
48
|
-
| コンポーネント | 対象コンテナ内で、まとまった責務と他要素との接点を持つ論理単位 |
|
|
49
|
-
| 依存方向 | 主たる利用・依頼の起点から終点への向き。時系列や応答データの向きとは区別する |
|
|
33
|
+
コンテナは上位図が定める実行・配備単位、コンポーネントはその内部の論理的な責務のまとまりです。依存方向は主たる利用・依頼の起点から終点への向きであり、時系列や応答データの向きとは区別します。
|
|
50
34
|
|
|
51
35
|
上位図は実行単位間の境界、本図は一単位の内部責務を扱います。物理配置、内部クラス、値・構文・データ構造はインフラ設計、実装、リファレンス、schema、外部 IF 仕様を正本とします。
|
|
52
36
|
|
|
@@ -62,26 +46,23 @@ C4 Component Diagram (CPD) Authoring Rule
|
|
|
62
46
|
共通項目の型・値・必須条件は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
|
|
63
47
|
|
|
64
48
|
- メタ情報は `specdojo:` 配下に置き、`type` は `architecture`、主 `rulebook` は `specdojo:cpd-rulebook` とします。記法部品を主 rulebook にしません。
|
|
65
|
-
- `based_on` には対象コンテナの根拠となる上位 CND を接続します。適用する外部 IF
|
|
66
|
-
- 作成・編集時の `status` は `draft` とします。`owner`、`part_of`、`supersedes` は共通規約に従い、本文の設計前提を独自メタ項目で代用しません。
|
|
49
|
+
- `based_on` には対象コンテナの根拠となる上位 CND を接続します。適用する外部 IF・用語定義は本文の該当箇所から参照します。
|
|
67
50
|
- 未同梱の上位図を使う学習用例は、架空参照と `based_on` 未接続の理由を概要へ明記します。実案件の依存未接続を、この例外で解決済みにはできません。
|
|
68
51
|
|
|
69
52
|
## 5. 本文要件
|
|
70
53
|
|
|
71
54
|
見出し順・表の列・記入欄の骨組みは template を正本とし、ここでは意味要件を定めます。
|
|
72
55
|
|
|
73
|
-
| 章の役割 | 必須 | 満たす内容
|
|
74
|
-
| -------------------- | -------- |
|
|
75
|
-
| 概要 | 必須 |
|
|
76
|
-
| 構成図 | 必須 | 一つのコンテナ境界、主要コンポーネント、接点となる利用者・ストア・外部依存、ラベル付きの関係
|
|
77
|
-
| 要素・境界の定義 | 必須 | 内外の分界、コンポーネントの責務・入出力・論理配置と採用理由、外部依存の利用条件、関係の授受情報と詳細の正本
|
|
78
|
-
| 技術前提・検証対象 | 必須 | 依存の制約、失敗時に区別する結果、関係 ID に結び付く結合検証の観測点
|
|
79
|
-
| 未確定事項の引き継ぎ | 条件付き |
|
|
56
|
+
| 章の役割 | 必須 | 満たす内容 |
|
|
57
|
+
| -------------------- | -------- | ------------------------------------------------------------------------------------------------------------ |
|
|
58
|
+
| 概要 | 必須 | 上位図の対象コンテナ、業務目的との対応、分割の目的、利用する設計判断、対象外、確定度 |
|
|
59
|
+
| 構成図 | 必須 | 一つのコンテナ境界、主要コンポーネント、接点となる利用者・ストア・外部依存、ラベル付きの関係 |
|
|
60
|
+
| 要素・境界の定義 | 必須 | 内外の分界、コンポーネントの責務・入出力・論理配置と採用理由、外部依存の利用条件、関係の授受情報と詳細の正本 |
|
|
61
|
+
| 技術前提・検証対象 | 必須 | 依存の制約、失敗時に区別する結果、関係 ID に結び付く結合検証の観測点 |
|
|
62
|
+
| 未確定事項の引き継ぎ | 条件付き | 仮定・未確認箇所がある場合の対象・論点、影響する要素・関係と後続設計、当面の扱い・解消条件 |
|
|
80
63
|
|
|
81
64
|
Person・ストア・外部システムが該当しない場合は、定義欄へ非該当の理由を書きます。論理配置はコンテナ内部の責務の配置までとし、確認できていないソースパスを断定しません。
|
|
82
65
|
|
|
83
|
-
確認者・公開範囲・変更時の影響は概要、技術前提またはメモの該当箇所に記録し、独立した章を増やすことは必須にしません。作業・検証・承認の証跡は実行記録や決定記録を正本とし、CPD から参照します。
|
|
84
|
-
|
|
85
66
|
## 6. 記述ガイド
|
|
86
67
|
|
|
87
68
|
共通のメタ情報・命名は上位標準を参照し、以下ではコンポーネント分割に固有の判断を扱います。
|
|
@@ -89,8 +70,7 @@ Person・ストア・外部システムが該当しない場合は、定義欄
|
|
|
89
70
|
### 6.1. 概要
|
|
90
71
|
|
|
91
72
|
- 上位図のどのコンテナを展開するか、何の設計入力に使うか、何を扱わないかを書きます。
|
|
92
|
-
-
|
|
93
|
-
- 作成者、アーキテクチャ確認者、業務確認者、最終合意者を「作成・確認・合意の分担」に対応付け、プロジェクトの役割割当てまたは合意記録を参照します。公開する相手・媒体・範囲も示します。
|
|
73
|
+
- 対象者の業務課題、放置時の影響、期待価値・成功基準は、上位の要求・目的の該当箇所へ必ず参照を置きます。上位に定義がなければ論点として残し、CPD だけで業務上の成功を確定しません。
|
|
94
74
|
- 設計案と実装の確認済み構成を区別し、未確認の分割は _ASSUMPTION_: として影響と確認先を残します。
|
|
95
75
|
- 良い例: 「販売処理サービス内部を分け、保存と印字の責任境界を結合設計へ渡す。再送の詳細は連携仕様へ委ねる」。悪い例: 「システム全体の詳細を示す」。対象と用途を限定できるかが基準です。
|
|
96
76
|
|
|
@@ -115,39 +95,27 @@ Person・ストア・外部システムが該当しない場合は、定義欄
|
|
|
115
95
|
|
|
116
96
|
### 6.5. メモ / 将来課題
|
|
117
97
|
|
|
118
|
-
- 仮定・未確認事項は共通ラベルで確定事項と区別し、対象要素・関係 ID
|
|
119
|
-
-
|
|
120
|
-
-
|
|
121
|
-
- 良い例: 「印字応答欠落は結果不明を生むリスク。ARC が外部 IF の回復条件を整理し QE が観測点を確認する。人間の PO が実装着手前に採否を判断し、未解消なら当該経路を保留する。PM が PJR 登録候補として結合設計の開始条件へ反映する」。悪い例: 「将来検討する」。判断する人と時点、判断後の作業が特定できるかが基準です。
|
|
98
|
+
- 仮定・未確認事項は共通ラベルで確定事項と区別し、対象要素・関係 ID と対応付けます。
|
|
99
|
+
- 記録項目は「対象・論点 / 影響と後続成果物 / 当面の扱い・解消条件」とし、境界・契約・結合設計・作業順への影響を示します。
|
|
100
|
+
- 良い例: 「`REL-08` の印字応答欠落では結果不明が生じる。外部 IF の回復条件と結合観測点が定まるまで自動再送を認めず、当該経路の受入を保留する」。悪い例: 「将来検討する」。未確認の条件と、後続設計で決めるべき内容を特定できるかが基準です。
|
|
122
101
|
|
|
123
102
|
### 6.6. 検証と合意の判定
|
|
124
103
|
|
|
125
|
-
|
|
104
|
+
受入確認では次の順に照合します。
|
|
126
105
|
|
|
127
|
-
|
|
106
|
+
1. 図の全要素を定義表または境界の説明へ、全関係を一意な関係 ID へ対応付けます。定義表だけにある要素・関係には省略理由が必要です。
|
|
107
|
+
2. 上位図と内外配置・依存方向を比較し、説明のない差異が残らないことを確認します。描画した図で要素名・関係ラベルが欠けず、境界内外と矢印の端点を判読できることも確かめます。
|
|
108
|
+
3. 主要経路の通常時と失敗・応答欠落時について、入力条件・観測結果・詳細契約を関係 ID から辿ります。すべて対応し、結果を区別できれば合格、矛盾や欠落は不合格、契約や観測方法が未整備なら未判定として当該経路の受入を保留します。
|
|
128
109
|
|
|
129
|
-
|
|
130
|
-
| ------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
|
131
|
-
| メタ情報・主 rulebook の型宣言 | `npm run lint:fm`(対象は `docs/` の Markdown) | CPD の schema・型宣言エラーがない。指摘された項目を正本と照合して直す |
|
|
132
|
-
| 参照先 | `node --import tsx src/specdojo.ts index lookup <id>` と参照先の該当箇所の閲読 | 既存 ID が意図した文書へ解決する。索引不整合は管理側に再生成を依頼し、未作成参照は仮参照と引き継ぎ事項へ直す |
|
|
133
|
-
| Mermaid 構文 | `node tools/lint-mermaid.mjs <対象.md>` | 全図が passed、構文エラー・未検査がない。指摘された fence を修正し、未検査なら依存環境を整える |
|
|
134
|
-
| 描画・可読性 | `npm run docs:build:mermaid` 後に対象図の SVG を閲覧 | 要素名・関係ラベルが欠けず、境界内外・矢印の端点を判読できる。重なりや切れを修正して再描画する |
|
|
135
|
-
|
|
136
|
-
OPS は公開前に対象の本文・図・ラベル・参照先について、個人情報、認証情報、内部ホスト名や非公開の構成情報が含まれないか、プロジェクトの公開方針と照合します。確認範囲・除外または匿名化した情報・残る懸念を合意記録へ残し、人間の PO が公開先と最終可否を判断します。技術検証の成功や `status` だけでは公開許可を表しません。
|
|
137
|
-
|
|
138
|
-
人間の PO が `ready` へ昇格できる条件は、必須内容と検証の充足、技術・業務確認の完了、依存と詳細化先の接続、公開前確認の完了、および判断記録の存在です。未解決事項を残せるのは、承認対象の境界・責務・受け渡し・成功基準・公開可否を変えず、担当・解消時点と影響を限定できる場合に限ります。判断材料不足は保留、上位境界との矛盾や検証失敗は差し戻しとし、対象範囲と次アクションを記録します。
|
|
139
|
-
|
|
140
|
-
良い例: 「全関係の照合と描画確認を終え、公開用の接続先表記を PO が承認した。対象外の将来拡張だけを担当・期限付きで残す」。悪い例: 「lint が通ったので公開・確定する」。技術検証と人間の合意の両方を証跡から確認できるかが基準です。
|
|
110
|
+
良い例: 「保存後の印字応答欠落をたどり、保存済み販売と印字の結果不明を別々に確認できる」。悪い例: 「矢印がつながっているので受入可能」。境界ごとの結果と未確認の範囲を説明できるかが基準です。
|
|
141
111
|
|
|
142
112
|
### 6.7. 変更・保守時の影響確認
|
|
143
113
|
|
|
144
|
-
更新契機は上位 CND の境界変更、責務の追加・統合・廃止、外部 IF・ストアの契約変更、実装との不一致、結合検証での前提否定です。
|
|
145
|
-
|
|
146
|
-
- ARC は上位 CND、用語定義、外部 IF、下位のデータ・詳細設計を照合し、影響する要素・関係 ID、変更理由、変更前後、更新要否と理由を変更記録へ残します。図と定義表は同じ改訂で同期します。
|
|
147
|
-
- DEV は実装、schema、参照元、生成物・運用手順への追従を確認し、QE は結合観測点とテスト仕様の更新・再検証を確認します。実践の型へ一般化した規定を変える場合は ARC が sample・recipe・template の追従要否も判断します。値・構文・構造は各正本を更新し、CPD には複製しません。
|
|
148
|
-
- PM は後続成果物と Schedule への波及を整理して PJR の更新作業へ割り当てます。OPS は変更図を再描画し、QE が「検証と合意の判定」の該当検査を再実施した証跡を確認して、人間の PO に再合意・公開判断を依頼します。改訂・廃止・置き換えと履歴は共通のライフサイクル規約に従います。
|
|
114
|
+
更新契機は上位 CND の境界変更、責務の追加・統合・廃止、外部 IF・ストアの契約変更、実装との不一致、結合検証での前提否定です。
|
|
149
115
|
|
|
150
|
-
|
|
116
|
+
- 変更する要素・関係 ID から、上位 CND、用語定義、外部 IF、下位のデータ・詳細設計への影響をたどります。図と定義表の対応を保ちます。
|
|
117
|
+
- 実装・schema・参照元・生成物・運用手順、結合観測点・テスト仕様の追従要否を確認します。値・構文・構造は各正本を更新し、CPD に複製しません。
|
|
118
|
+
- 良い例: 「保存責務の統合で `REL-05` の終点が変わり、図・関係表とデータ設計、実装対応、保存失敗の観測点、結合作業の開始条件に影響する」。悪い例: 「図だけ差し替える」。影響先ごとに更新要否と根拠を説明できるかが基準です。
|
|
151
119
|
|
|
152
120
|
## 7. 禁止事項
|
|
153
121
|
|
|
@@ -155,4 +123,3 @@ OPS は公開前に対象の本文・図・ラベル・参照先について、
|
|
|
155
123
|
- クラス・関数・ファイル一覧、コマンドオプション、API 構文、データ項目・値制約を詳細仕様と重複して管理すること。
|
|
156
124
|
- ラベルのない関係、方向の意味が混在する矢印、図と表で対応しない名称・接続。
|
|
157
125
|
- 未確認の依存・物理配置・障害回復保証を確定事項として記載すること。
|
|
158
|
-
- 自動検査や AI 作業の成功を、業務判断・承認・公開許可と同一視すること。
|
|
@@ -16,11 +16,7 @@ specdojo:
|
|
|
16
16
|
|
|
17
17
|
C4 Context Diagram (CXD) Documentation Rules using Mermaid
|
|
18
18
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
C4 コンテキスト図は「対象システム」と、その周辺の **利用者(人)**・**外部システム**・**関係(やり取り)** を、概念レベルで合意するために用います。
|
|
22
|
-
|
|
23
|
-
---
|
|
19
|
+
Mermaid の `flowchart` 構文で C4 コンテキスト図を描くための記法を定めます。要素の選定と責任分界は [[specdojo:cxd-rulebook|C4コンテキスト図(CXD)作成ルール]] に従います。
|
|
24
20
|
|
|
25
21
|
## 1. 全体方針
|
|
26
22
|
|
|
@@ -29,6 +25,7 @@ C4 コンテキスト図は「対象システム」と、その周辺の **利
|
|
|
29
25
|
- 対象は「システム境界の外側との関係」であり、内部構造(コンテナ/コンポーネント)や実装詳細は含めない。
|
|
30
26
|
- 図は「正確さ(過剰な詳細)」よりも「解釈が割れないこと(合意)」を優先する。
|
|
31
27
|
- 1つの図には **対象システムを1つ**だけ置く(複数対象は図を分ける)。
|
|
28
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認には含めません。
|
|
32
29
|
|
|
33
30
|
## 2. C4要素と Mermaid 記号の対応
|
|
34
31
|
|
|
@@ -42,7 +39,7 @@ C4 の要素を、以下のように Mermaid の記号にマッピングする
|
|
|
42
39
|
| System Boundary(境界) | 対象システムの範囲 | `subgraph 境界["対象システム"] ... end` |
|
|
43
40
|
| Relationship(関係) | 依存・利用・連携(概念) | `店員 -->\| "売上登録" \| 販売管理システム` |
|
|
44
41
|
|
|
45
|
-
|
|
42
|
+
### 2.1. 標準の色分け(推奨)
|
|
46
43
|
|
|
47
44
|
C4コンテキスト図は色が必須ではありませんが、読み手が「人 / 対象システム / 外部システム」を一目で区別できるよう、以下の色分けを推奨します。
|
|
48
45
|
|
|
@@ -53,7 +50,7 @@ C4コンテキスト図は色が必須ではありませんが、読み手が「
|
|
|
53
50
|
|
|
54
51
|
Mermaid `flowchart` では `classDef` + `class`、境界は `style` を使用します。
|
|
55
52
|
|
|
56
|
-
|
|
53
|
+
#### 2.1.1. 標準スタイル定義(コピーして利用)
|
|
57
54
|
|
|
58
55
|
```mermaid
|
|
59
56
|
flowchart LR
|
|
@@ -69,15 +66,7 @@ flowchart LR
|
|
|
69
66
|
|
|
70
67
|
```
|
|
71
68
|
|
|
72
|
-
|
|
73
|
-
flowchart LR
|
|
74
|
-
classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
|
|
75
|
-
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
76
|
-
classDef external fill:#e9ecef,stroke:#495057,color:#000;
|
|
77
|
-
style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
### 2.1.2 適用ルール
|
|
69
|
+
#### 2.1.2. 適用ルール
|
|
81
70
|
|
|
82
71
|
- Personノードには `person` クラスを付ける
|
|
83
72
|
- 対象システムノードには `system` クラスを付ける
|
|
@@ -100,23 +89,9 @@ flowchart LR
|
|
|
100
89
|
style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
101
90
|
```
|
|
102
91
|
|
|
103
|
-
```plainText
|
|
104
|
-
flowchart LR
|
|
105
|
-
店員["店員"]
|
|
106
|
-
会計システム["会計システム"]
|
|
107
|
-
subgraph 境界["対象システム"]
|
|
108
|
-
販売管理システム("販売管理システム")
|
|
109
|
-
end
|
|
110
|
-
|
|
111
|
-
class 店員 person;
|
|
112
|
-
class 販売管理システム system;
|
|
113
|
-
class 会計システム external;
|
|
114
|
-
style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
115
|
-
```
|
|
116
|
-
|
|
117
92
|
## 3. ノードのルール
|
|
118
93
|
|
|
119
|
-
### 3.1 Person(人/ロール)
|
|
94
|
+
### 3.1. Person(人/ロール)
|
|
120
95
|
|
|
121
96
|
- **四角 `[]`** を使用する。
|
|
122
97
|
- 表示ラベルは業務ロール/主体を短い日本語で表す。
|
|
@@ -132,16 +107,7 @@ flowchart LR
|
|
|
132
107
|
class 店員,店主 person;
|
|
133
108
|
```
|
|
134
109
|
|
|
135
|
-
|
|
136
|
-
flowchart LR
|
|
137
|
-
店員["👤店員"]
|
|
138
|
-
店主["👤店主"]
|
|
139
|
-
|
|
140
|
-
classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
|
|
141
|
-
class 店員,店主 person;
|
|
142
|
-
```
|
|
143
|
-
|
|
144
|
-
### 3.2 Software System(対象システム)
|
|
110
|
+
### 3.2. Software System(対象システム)
|
|
145
111
|
|
|
146
112
|
- **角丸長方形 `()`** を使用する。
|
|
147
113
|
- 図の中心として扱い、表示ラベルは「システム名(+必要なら短い補足)」とする。
|
|
@@ -157,15 +123,7 @@ flowchart LR
|
|
|
157
123
|
class 販売管理システム system;
|
|
158
124
|
```
|
|
159
125
|
|
|
160
|
-
|
|
161
|
-
flowchart LR
|
|
162
|
-
販売管理システム("駄菓子屋きぬや<br>販売管理システム")
|
|
163
|
-
|
|
164
|
-
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
165
|
-
class 販売管理システム system;
|
|
166
|
-
```
|
|
167
|
-
|
|
168
|
-
### 3.3 External Software System(外部システム)
|
|
126
|
+
### 3.3. External Software System(外部システム)
|
|
169
127
|
|
|
170
128
|
- **四角 `[]`** を使用する。
|
|
171
129
|
- 表示ラベルは外部システムの一般名(例: 決済、会計、EC、配送など)。
|
|
@@ -181,16 +139,7 @@ flowchart LR
|
|
|
181
139
|
class 会計システム,決済サービス external;
|
|
182
140
|
```
|
|
183
141
|
|
|
184
|
-
|
|
185
|
-
flowchart LR
|
|
186
|
-
会計システム["会計システム"]
|
|
187
|
-
決済サービス["決済サービス"]
|
|
188
|
-
|
|
189
|
-
classDef external fill:#e9ecef,stroke:#495057,color:#000;
|
|
190
|
-
class 会計システム,決済サービス external;
|
|
191
|
-
```
|
|
192
|
-
|
|
193
|
-
### 3.4 System Boundary(境界)
|
|
142
|
+
### 3.4. System Boundary(境界)
|
|
194
143
|
|
|
195
144
|
- 対象システムは **サブグラフ `subgraph ... end`** で囲う。
|
|
196
145
|
- 境界内には、原則として **対象システムのノード1つ**だけを置く(コンテキスト図の過密化防止)。
|
|
@@ -208,27 +157,16 @@ flowchart LR
|
|
|
208
157
|
style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
209
158
|
```
|
|
210
159
|
|
|
211
|
-
```plainText
|
|
212
|
-
flowchart LR
|
|
213
|
-
subgraph 境界["対象システム"]
|
|
214
|
-
販売管理システム("駄菓子屋きぬや<br>販売管理システム")
|
|
215
|
-
end
|
|
216
|
-
|
|
217
|
-
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
218
|
-
class 販売管理システム system;
|
|
219
|
-
style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
220
|
-
```
|
|
221
|
-
|
|
222
160
|
## 4. エッジ(関係)のルール
|
|
223
161
|
|
|
224
|
-
### 4.1 方向
|
|
162
|
+
### 4.1. 方向
|
|
225
163
|
|
|
226
164
|
- `A --> B` を基本とする。
|
|
227
165
|
- 方向は「主たる依存/利用/送信の向き」が分かるように統一する。
|
|
228
166
|
- 例: 人がシステムを利用する: `人 -->|"利用"| 対象システム`
|
|
229
167
|
- 例: 対象システムが外部システムに連携する: `対象システム -->|"連携"| 外部システム`
|
|
230
168
|
|
|
231
|
-
### 4.2 ラベル
|
|
169
|
+
### 4.2. ラベル
|
|
232
170
|
|
|
233
171
|
- すべてのエッジにラベルを付ける(「何の関係か」を合意するため)。
|
|
234
172
|
- ラベルは **短い名詞句**または **短い動詞句**で書く。
|
|
@@ -239,7 +177,7 @@ flowchart LR
|
|
|
239
177
|
|
|
240
178
|
```mermaid
|
|
241
179
|
flowchart LR
|
|
242
|
-
店員["
|
|
180
|
+
店員["店員"] -->|"売上登録"| 販売管理システム("販売管理システム")
|
|
243
181
|
販売管理システム -->|"会計仕訳<br>連携"| 会計システム["会計システム"]
|
|
244
182
|
|
|
245
183
|
classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
|
|
@@ -250,29 +188,12 @@ flowchart LR
|
|
|
250
188
|
class 会計システム external;
|
|
251
189
|
```
|
|
252
190
|
|
|
253
|
-
```plainText
|
|
254
|
-
flowchart LR
|
|
255
|
-
店員["一店員"] -->|"売上登録"| 販売管理システム("販売管理システム")
|
|
256
|
-
販売管理システム -->|"会計仕訳<br>連携"| 会計システム["会計システム"]
|
|
257
|
-
|
|
258
|
-
classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
|
|
259
|
-
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
260
|
-
classDef external fill:#e9ecef,stroke:#495057,color:#000;
|
|
261
|
-
class 店員 person;
|
|
262
|
-
class 販売管理システム system;
|
|
263
|
-
class 会計システム external;
|
|
264
|
-
```
|
|
265
|
-
|
|
266
|
-
---
|
|
267
|
-
|
|
268
191
|
## 5. 命名・表記ルール
|
|
269
192
|
|
|
270
193
|
- ノードIDは日本語でもよいが、記号や空白は避け、短い識別子にする(例: `販売管理システム`, `会計システム`, `店員`)。
|
|
271
194
|
- 表示ラベルは `"..."` で囲ってよい(混乱を避けるため、必要に応じて統一)。
|
|
272
195
|
- 同じ主体/システムは、図の中で名称を揺らさない。
|
|
273
196
|
|
|
274
|
-
---
|
|
275
|
-
|
|
276
197
|
## 6. 禁止事項
|
|
277
198
|
|
|
278
199
|
| 項目 | 理由 |
|
|
@@ -283,8 +204,6 @@ flowchart LR
|
|
|
283
204
|
| 対象システムの内部プロセス/内部データストアの詳細 | コンテナ図/コンポーネント図で表す |
|
|
284
205
|
| 矢印ラベルなしの関係 | 合意が取れない |
|
|
285
206
|
|
|
286
|
-
---
|
|
287
|
-
|
|
288
207
|
## 7. サンプル(最小)
|
|
289
208
|
|
|
290
209
|
```mermaid
|
|
@@ -320,34 +239,6 @@ flowchart LR
|
|
|
320
239
|
style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
321
240
|
```
|
|
322
241
|
|
|
323
|
-
```plainText
|
|
324
|
-
flowchart LR
|
|
325
|
-
店員["👤店員"]
|
|
326
|
-
店主["👤店主"]
|
|
327
|
-
|
|
328
|
-
会計システム["会計システム"]
|
|
329
|
-
決済サービス["決済サービス"]
|
|
330
|
-
|
|
331
|
-
subgraph 境界["対象システム"]
|
|
332
|
-
販売管理システム("駄菓子屋きぬや<br>販売管理システム")
|
|
333
|
-
end
|
|
334
|
-
|
|
335
|
-
店員 -->|"売上登録"| 販売管理システム
|
|
336
|
-
店主 -->|"商品・在庫管理"| 販売管理システム
|
|
337
|
-
|
|
338
|
-
販売管理システム -->|"会計仕訳連携"| 会計システム
|
|
339
|
-
販売管理システム -->|"決済依頼"| 決済サービス
|
|
340
|
-
決済サービス -->|"決済結果"| 販売管理システム
|
|
341
|
-
|
|
342
|
-
classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
|
|
343
|
-
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
344
|
-
classDef external fill:#e9ecef,stroke:#495057,color:#000;
|
|
345
|
-
class 店員,店主 person;
|
|
346
|
-
class 販売管理システム system;
|
|
347
|
-
class 会計システム,決済サービス external;
|
|
348
|
-
style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
349
|
-
```
|
|
350
|
-
|
|
351
242
|
## 8. 凡例(推奨)
|
|
352
243
|
|
|
353
244
|
凡例は下記のように表現する(必要な場合のみ)。
|
|
@@ -376,27 +267,3 @@ flowchart LR
|
|
|
376
267
|
class 外部 external;
|
|
377
268
|
style 境界例 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
378
269
|
```
|
|
379
|
-
|
|
380
|
-
```plainText
|
|
381
|
-
flowchart LR
|
|
382
|
-
subgraph 凡例["凡例"]
|
|
383
|
-
direction LR
|
|
384
|
-
人["👤Person<br>(人/ロール)"]
|
|
385
|
-
|
|
386
|
-
subgraph 境界例["システム境界"]
|
|
387
|
-
対象("Software System<br>(対象システム)")
|
|
388
|
-
end
|
|
389
|
-
外部["External System<br>(外部システム)"]
|
|
390
|
-
|
|
391
|
-
人 -->|"Relationship(関係)"| 対象
|
|
392
|
-
対象 -->|"Relationship(関係)"| 外部
|
|
393
|
-
end
|
|
394
|
-
|
|
395
|
-
classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
|
|
396
|
-
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
397
|
-
classDef external fill:#e9ecef,stroke:#495057,color:#000;
|
|
398
|
-
class 人 person;
|
|
399
|
-
class 対象 system;
|
|
400
|
-
class 外部 external;
|
|
401
|
-
style 境界例 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
402
|
-
```
|
|
@@ -18,23 +18,26 @@ specdojo:
|
|
|
18
18
|
|
|
19
19
|
C4 Context Diagram (CXD) Authoring Rule
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
対象システムを単一のブラックボックスとして捉え、境界外の利用者・外部システムとの関係と責任分界を定義します。境界の合意、外部依存の識別、境界上の技術制約と検証観点を扱います。
|
|
22
22
|
|
|
23
23
|
## 1. 全体方針
|
|
24
24
|
|
|
25
|
-
- 1
|
|
26
|
-
-
|
|
25
|
+
- 1 ファイルにつき対象システム(または合意したシステム境界)を 1 つ扱い、内部構造は展開しません。
|
|
26
|
+
- 利用者と外部システム、主たる利用・連携の関係を、図と対応表で解釈が割れない粒度で記述します。
|
|
27
27
|
- 図の描画記法は `includes` で宣言した [[specdojo:cxd-mermaid-rulebook|Mermaid を用いたC4コンテキスト図 作成ルール]] に従います。図と本文の表で要素名・関係ラベルを一致させ、図の矢印を文章でそのままなぞる重複説明は行いません。
|
|
28
|
-
-
|
|
29
|
-
-
|
|
28
|
+
- 詳細の委譲先は「正本の選び方と参照の境界」に従い、CXD には境界判断に必要な要点と参照先だけを残します。
|
|
29
|
+
- 未作成の参照先や未確定の境界論点は、確定仕様と分けて「メモ / 将来課題」に記録します。
|
|
30
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認には含めません。
|
|
30
31
|
|
|
31
32
|
### 1.1. 対象者と確認する内容
|
|
32
33
|
|
|
33
|
-
| 対象者
|
|
34
|
-
|
|
|
35
|
-
|
|
|
36
|
-
|
|
|
37
|
-
|
|
|
34
|
+
| 対象者 | 解決する課題 | 確認する内容 |
|
|
35
|
+
| ---------------------------- | -------------------------------------- | ---------------------------------------------- |
|
|
36
|
+
| 価値・対象範囲を確認する読者 | 業務とシステムの責務がずれる | 境界の内外、委譲先、利用者・外部連携の妥当性 |
|
|
37
|
+
| 設計・開発に用いる読者 | 下位設計の前提が曖昧になる | 依存方向、信頼・実行境界、詳細の正本 |
|
|
38
|
+
| 品質・運用を確認する読者 | 外部依存の障害時に確認対象が分からない | 境界上の入出力、異常時の扱い、テスト・監視対象 |
|
|
39
|
+
|
|
40
|
+
この表は文書の読者の確認観点を示します。直接のシステム利用者は「Person(人・ロール)」で定義します。
|
|
38
41
|
|
|
39
42
|
## 2. 位置づけと用語定義
|
|
40
43
|
|
|
@@ -48,13 +51,7 @@ graph TD
|
|
|
48
51
|
CXD -.->|"採用技術の正本参照"| TSD["技術スタック一覧<br/>(tsd-index / tsd-*)"]
|
|
49
52
|
```
|
|
50
53
|
|
|
51
|
-
|
|
52
|
-
| ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
|
53
|
-
| Person(人・ロール) | システム境界の外側から対象システムを直接利用・運用・管理する業務ロールまたは利用者区分。個人名ではなく役割で定義する |
|
|
54
|
-
| Software System(対象システム) | 本コンテキスト図の中心となるシステム。内部のコンテナやモジュール構造を展開せず、単一の責務単位として扱う |
|
|
55
|
-
| System Boundary(システム境界) | 対象システムが直接責務を持つ範囲と、外部の運用・外部システムへ委ねる範囲の分界線 |
|
|
56
|
-
| External Software System(外部システム) | 対象システムの境界外にあり、対象システムとデータや制御をやり取りする外部ソフトウェア・外部サービス・外部ツールチェーン |
|
|
57
|
-
| Relationship(関係) | Person または External Software System と対象システムの間の主たる利用・呼び出し・データ連携の関係 |
|
|
54
|
+
要素の意味と選定基準は「要素と境界の定義」に集約します。
|
|
58
55
|
|
|
59
56
|
## 3. ファイル命名・ID規則
|
|
60
57
|
|
|
@@ -72,29 +69,28 @@ graph TD
|
|
|
72
69
|
- `type` は本 rulebook の `deliverable_type` に対応する `architecture`、`rulebook` は `specdojo:cxd-rulebook` とします。
|
|
73
70
|
- `part_of` は所属する上位アーキテクチャ文書や索引がある場合に記載し、`based_on` は成果物カタログの `depends_on` の推移閉包に含まれる直接の内容根拠だけを示します。プロジェクト共通文脈(`prj-overview` 等)が `depends_on` にない場合は `based_on` に含めず、本文中で参照します。
|
|
74
71
|
- 未作成の依存先や未確定の契約は「メモ / 将来課題」へ記録し、空の `based_on` を埋めるために無関係な ID を追加しません。
|
|
75
|
-
- 作成・編集時の `status` は `draft` とし、完了条件をすべて満たして承認者が合意した時点で `ready` へ昇格します。
|
|
76
72
|
|
|
77
73
|
## 5. 本文要件
|
|
78
74
|
|
|
79
|
-
見出し順・表・記入欄の骨組みは frontmatter で宣言した template を正本とし、本章は各内容の目的と必須性を定義します。
|
|
75
|
+
見出し順・表・記入欄の骨組みは frontmatter で宣言した template を正本とし、本章は各内容の目的と必須性を定義します。
|
|
80
76
|
|
|
81
|
-
| 章 | 必須・任意 | 目的と内容要件
|
|
82
|
-
| --------------------------- | ---------- |
|
|
83
|
-
| 概要 | 必須 | 対象システムの目的・提供価値、コンテキスト図の対象範囲と対象外、主要ステークホルダーと確認内容を 1〜3 文と表で示す
|
|
84
|
-
| C4コンテキスト図(Mermaid) | 必須 | `specdojo:cxd-mermaid-rulebook` に準拠したコンテキスト図と、図の読み取りに必要な補足注記(1〜3 文)を示す
|
|
85
|
-
| 要素と境界の定義 | 必須 | 対象システムとシステム境界、Person、External Software System、Relationship を表で定義し、詳細仕様の正本へ案内する
|
|
86
|
-
| 技術前提・制約と検証観点 | 必須 | システム境界における技術前提・制約(実行形態、信頼境界、外部依存の前提)と、境界・外部依存のテスト・検証観点を示す
|
|
87
|
-
| メモ / 将来課題 | 任意 |
|
|
77
|
+
| 章 | 必須・任意 | 目的と内容要件 |
|
|
78
|
+
| --------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------ |
|
|
79
|
+
| 概要 | 必須 | 対象システムの目的・提供価値、コンテキスト図の対象範囲と対象外、主要ステークホルダーと確認内容を 1〜3 文と表で示す |
|
|
80
|
+
| C4コンテキスト図(Mermaid) | 必須 | `specdojo:cxd-mermaid-rulebook` に準拠したコンテキスト図と、図の読み取りに必要な補足注記(1〜3 文)を示す |
|
|
81
|
+
| 要素と境界の定義 | 必須 | 対象システムとシステム境界、Person、External Software System、Relationship を表で定義し、詳細仕様の正本へ案内する |
|
|
82
|
+
| 技術前提・制約と検証観点 | 必須 | システム境界における技術前提・制約(実行形態、信頼境界、外部依存の前提)と、境界・外部依存のテスト・検証観点を示す |
|
|
83
|
+
| メモ / 将来課題 | 任意 | 未作成の参照先、未確定の境界論点、段階的拡張予定について、論点・影響・解消条件を示す。該当事項があれば必須 |
|
|
88
84
|
|
|
89
85
|
## 6. 記述ガイド
|
|
90
86
|
|
|
91
|
-
|
|
87
|
+
各章の判断基準と対比例を示します。
|
|
92
88
|
|
|
93
89
|
### 6.1. 概要
|
|
94
90
|
|
|
95
|
-
- 判断基準:
|
|
91
|
+
- 判断基準: 対象システムが誰の何の課題を解決し、どこまでを本図の対象範囲とし、何を下位図や別仕様へ委ねるかを読み取れること。また、主要ステークホルダーが本図で確認・合意する観点が対応付けられていること。
|
|
96
92
|
- 良い例: 「本図は販売管理 CLI を単一のシステム境界として捉え、店舗スタッフ・管理者および外部の印刷・会計基盤との関係を定義する。コンテナ内部のモジュール構成は `cnd`、コマンド構文は `clis` を参照する。」
|
|
97
|
-
- 悪い例:
|
|
93
|
+
- 悪い例: 「本図はシステムの全体像を示すコンテキスト図である。」対象範囲と委譲先が分かりません。
|
|
98
94
|
|
|
99
95
|
### 6.2. C4コンテキスト図(Mermaid)
|
|
100
96
|
|
|
@@ -111,11 +107,11 @@ graph TD
|
|
|
111
107
|
|
|
112
108
|
- 対象システムの「システム名」「提供する中核責務」「境界内に含める範囲」「境界外へ委ねる範囲(対象外と委譲先)」を表または項目で明記します。
|
|
113
109
|
- 良い例: 「境界内: 取引記録とレシート控えの保持。境界外: プリンタの物理制御(印刷基盤へ委譲)、現金授受(店番担当が実施)。」
|
|
114
|
-
- 悪い例:
|
|
110
|
+
- 悪い例: 「販売管理に関する機能一式を提供する。」自システムと委譲先の責務が分かりません。
|
|
115
111
|
|
|
116
112
|
#### 6.3.2. Person(人・ロール)
|
|
117
113
|
|
|
118
|
-
- 推奨列は「Person
|
|
114
|
+
- 推奨列は「Person(図中ラベル)」「対応ロール」「利用目的・主な関わり」「境界上の接点・確認責務」です。直接の利用・運用・管理の接点を持つ業務上の利用者区分と対応させます。
|
|
119
115
|
- 良い例: 「店番担当: 現金販売を記録する。会計・印字の状態を確認し、保留取引を店舗責任者へ渡す。」業務上の利用者区分を用い、プロジェクトの役職を直接利用者として機械的に列挙しません。
|
|
120
116
|
- 悪い例: 「ユーザー: システムを使う人。」ロールごとの利用目的や境界上の確認責務が分かりません。
|
|
121
117
|
|
|
@@ -124,15 +120,15 @@ graph TD
|
|
|
124
120
|
- 推奨列は「外部システム(図中ラベル)」「区分・位置づけ」「対象システムとの責任分界」「不在・障害時の影響と扱い」です。
|
|
125
121
|
- 確認できた連携相手を列挙し、必須の依存と機能を選んだ場合だけ使う依存を区別します。同じ端末で動く外部 CLI も責務が別なら境界外とし、未確認の接続経路や障害時の保証は仮定または論点として示します。
|
|
126
122
|
- 複数の外部システムを一つのノードにまとめる場合も、利用条件・責務・障害の影響は区別します。例えばローカル履歴管理とリモート共有をまとめても、通信失敗がローカル操作をすべて停止させるとは扱いません。注記と表で違いを説明できない場合はノードを分けます。
|
|
127
|
-
- 良い例: 「印刷基盤:
|
|
128
|
-
- 悪い例: 「外部サービス:
|
|
123
|
+
- 良い例: 「印刷基盤: 対象システムから控えを受け取って物理印字を担う。会計記録の管理は対象システムに残す。」復旧保証は確認済みの連携契約に限ります。
|
|
124
|
+
- 悪い例: 「外部サービス: データを連携する。」委譲範囲と障害の影響が分かりません。
|
|
129
125
|
|
|
130
126
|
#### 6.3.4. Relationship(関係・連携契約)
|
|
131
127
|
|
|
132
128
|
- 推奨列は「関係ID」「起点 → 終点」「図中ラベル」「やり取りする情報・制御の要点」「連携方式・境界」「正本・関連仕様」です。
|
|
133
|
-
-
|
|
129
|
+
- 図の全矢印と対応付け、起動・参照する主体と方向、詳細仕様の正本(`clis`、`ifx-cmd`、`ifx-api`、`ifx-file` 等)を示します。
|
|
134
130
|
- 良い例: 「`REL-03`: 対象システム → 印刷基盤。印字依頼と結果をやり取りし、詳細は外部コマンド連携仕様を参照する。」目的・方向・詳細の更新先が分かります。
|
|
135
|
-
- 悪い例: 引数フラグの全一覧や JSON
|
|
131
|
+
- 悪い例: 引数フラグの全一覧や JSON ペイロードの全フィールドを表に転載する。詳細の正本との二重管理になります。
|
|
136
132
|
|
|
137
133
|
#### 6.3.5. 正本の選び方と参照の境界
|
|
138
134
|
|
|
@@ -144,21 +140,21 @@ graph TD
|
|
|
144
140
|
| 利用者の画面操作・CLI 操作 | 画面仕様(`uis`)・CLI 仕様(`clis`) | 誰がどの目的で対象システムを操作するか |
|
|
145
141
|
| 外部システムとの連携契約 | 外部インターフェース仕様(`ifx-index` / `ifx-*`) | 連携の目的、方向、渡す情報の概要、不在・失敗時の境界上の扱い |
|
|
146
142
|
|
|
147
|
-
-
|
|
143
|
+
- 未作成の正本については、必要な境界・契約と影響を「メモ / 将来課題」に記録します。
|
|
148
144
|
- 判断基準: CXD だけで境界を説明でき、値・構文・構造の詳細には固有の更新先があること。良い例は「連携目的を残して電文は IF 仕様へ委ねる」、悪い例は「正本へのリンクだけを置き、責任分界を省く」です。
|
|
149
145
|
|
|
150
146
|
### 6.4. 技術前提・制約と検証観点
|
|
151
147
|
|
|
152
|
-
- 判断基準:
|
|
148
|
+
- 判断基準: システム境界の成立に必要な技術的前提・制約(実行環境、ネットワーク到達性、認証・秘密情報の管理境界、人間による承認ゲート等)が明示され、かつ境界・外部依存に対するテスト・受入観点が識別できること。
|
|
153
149
|
- 「技術前提・制約」と「システム境界・外部依存の検証観点」の 2 つの小節(または表)に分け、検証観点を関係 ID または対象境界に対応付けます。検証設計へ渡す確認事項と、契約・実装で確認済みの保証を区別します。
|
|
154
150
|
- 良い例: 「外部コマンドの時間切れ時に、会計結果と印字結果を区別できるか確認する。認証管理者と外部へ渡す情報は連携契約で確認する。」検証対象と確認済みの保証を区別します。
|
|
155
|
-
- 悪い例:
|
|
151
|
+
- 悪い例: 「セキュリティに配慮し、十分にテストを行う。」具体的な制約と検証対象が分かりません。
|
|
156
152
|
|
|
157
153
|
### 6.5. メモ / 将来課題
|
|
158
154
|
|
|
159
|
-
- 判断基準:
|
|
160
|
-
- 良い例:
|
|
161
|
-
- 悪い例:
|
|
155
|
+
- 判断基準: 確定仕様と未作成の下位文書・未確定の外部連携を区別し、論点・影響範囲・解消条件を示すこと。仮定の宣言は該当する境界定義に置き、ここでは見直す条件と影響する境界・関係を示します。
|
|
156
|
+
- 良い例: 「印字結果不明時の再印刷条件は未確定で、二重印字の恐れがある。照合・再印刷の条件を定め、会計を再実行せず紙面を照合できることを確認して解消する。」
|
|
157
|
+
- 悪い例: 「詳細は別途検討する。」どの境界に影響し、何を確認すれば解消するか判断できません。
|
|
162
158
|
|
|
163
159
|
## 7. 禁止事項
|
|
164
160
|
|
|
@@ -167,13 +163,9 @@ graph TD
|
|
|
167
163
|
| 内部コンテナ・内部モジュール・物理 DB テーブルの図中への混入 | C4 コンテキスト図の粒度を超え、`cnd`・`cpd`・`dts` の責務と重なる |
|
|
168
164
|
| コマンド引数・API エンドポイント・JSON ペイロード詳細の本文転載 | `clis`・`ifx-*`・リファレンス等の正本との二重管理を防ぐ(PJR-2GD6) |
|
|
169
165
|
| ラベルのない関係矢印、または図と表の間の要素名・ラベルの不一致 | ステークホルダー間でシステム境界と連携内容の合意が取れなくなる |
|
|
170
|
-
| 個人名や認証情報・秘密鍵の具体値の記載 | ロール定義およびセキュリティ原則に反する |
|
|
171
|
-
| 図の矢印をそのまま文章で列挙するだけの重複説明 | 判断情報を増やさず文書の保守コストだけを増やす |
|
|
172
|
-
| 未作成の関連文書をあたかも存在するかのようにリンクする記述 | 仕様の確定範囲と参照整合性を損なう |
|
|
173
|
-
| 本文への sample・recipe・template のリンク章や wikilink の設置 | 実践の型との対応関係は frontmatter で宣言する |
|
|
174
166
|
|
|
175
167
|
## 8. 運用ルール
|
|
176
168
|
|
|
177
169
|
- システム境界、対象ロール、外部システムの種類・連携方向、境界上の制約や検証観点が変わる場合は CXD を改訂します。外部コマンドのオプション追加や内部モジュール分割のみの変更は各正本(`clis`・`ifx-*`・`cnd` 等)へ反映し、CXD の境界定義に影響がないことを確認します。
|
|
178
|
-
-
|
|
179
|
-
-
|
|
170
|
+
- 境界を展開する `cnd`・`cpd`・`ifd`、利用者の接点を定義する `uis`・`clis`、外部連携の `ifx-*`、境界テスト・受入条件を CXD 固有の整合確認先とします。
|
|
171
|
+
- 受入確認では、利用目的から Person・関係・委譲先をたどり、外部依存の不在・失敗・結果不明の場合を照合します。図と表が対応し、責任分界、詳細の更新先、確認対象と期待結果を特定でき、未確認の保証を断定していなければ合格とします。
|