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
|
@@ -11,115 +11,125 @@ specdojo:
|
|
|
11
11
|
|
|
12
12
|
C4 Container Diagram Writing Recipe
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
利用者が必要とする結果から、実行単位・ストア・連携経路を選ぶ作り方を示す。
|
|
15
15
|
|
|
16
16
|
## 1. このレシピの使い方
|
|
17
17
|
|
|
18
|
-
-
|
|
19
|
-
- 実行単位ごとの入出力と記録先をつなぎ、配置上の前提までを扱います。内部のクラス、API 構文、ホスト構築手順は詳細設計へ渡します。
|
|
20
|
-
- 要素名と関係 ID を手掛かりに、図、定義、制約、未確定事項を対応させます。仮定は根拠のある仕様と分け、確認先を付けます。
|
|
18
|
+
- コンテナ図は、上位のコンテキスト図の利用目的と外部への委譲を引き継ぎ(Why)、それを担う実行単位・ストア・関係を定め(What)、配置の前提と結合で観測する結果までを扱う(How)。要素名と関係 ID で、図・定義・検証観点・仮定をたどれるようにする(Trace)。
|
|
21
19
|
|
|
22
20
|
## 2. 作成前に集める情報
|
|
23
21
|
|
|
24
|
-
|
|
|
25
|
-
| -------------- |
|
|
26
|
-
|
|
|
27
|
-
|
|
|
28
|
-
| 記録と生成物 |
|
|
29
|
-
| 外部依存 |
|
|
30
|
-
|
|
|
31
|
-
|
|
|
32
|
-
| 合意と判断時点 | どの利用場面を誰と確認するか。下流が着手する前に、誰の判断を得る必要があるか |
|
|
22
|
+
| 項目 | 集める情報 | 取り出し元 |
|
|
23
|
+
| -------------- | ------------------------------------------------------------ | ------------------------------------ |
|
|
24
|
+
| 利用目的と境界 | 誰が何を達成するか、対象に含める責務と外へ委ねる処理 | 上位のコンテキスト図 |
|
|
25
|
+
| 実行単位の候補 | 別に起動・配備するアプリと、別にする理由 | 開発者への確認、起動・配備の手順 |
|
|
26
|
+
| 記録と生成物 | 正本、更新する主体、読む主体と時点 | 開発者への確認、リポジトリの構成 |
|
|
27
|
+
| 外部依存 | 常時必要か特定の操作時だけか、同じ端末にある別ツール | 上位のコンテキスト図、開発者への確認 |
|
|
28
|
+
| 配置の前提 | ローカル・リモート、構築時・閲覧時の区別と、根拠のない配置案 | 運用担当への確認 |
|
|
29
|
+
| 詳細の正本 | 連携契約、データ構造、内部構成、インフラを扱う文書 | 文書の一覧 |
|
|
33
30
|
|
|
34
31
|
## 3. 全体の作成手順
|
|
35
32
|
|
|
36
|
-
1.
|
|
37
|
-
2.
|
|
38
|
-
3.
|
|
39
|
-
4.
|
|
40
|
-
5.
|
|
41
|
-
6.
|
|
42
|
-
7.
|
|
43
|
-
8. BA・DEV・QE・OPS へ担当する利用場面や技術前提の確認を依頼し、結果と残る論点を集めます。ARC が PO の判断に必要な材料をまとめ、公開する範囲と承認対象の対応を OPS と確認します。
|
|
33
|
+
1. 概要に、分解する対象と分割の目的を先に書く。目的がないと、分割を止める所が決まらない。
|
|
34
|
+
2. 要素と境界の定義で、実行単位の候補ごとに別に起動・配備する理由を付ける。理由が機能名だけなら元のアプリへ戻す。
|
|
35
|
+
3. ストアを正本と生成物に分け、更新する主体と読む主体を書く。
|
|
36
|
+
4. 利用者の操作から保存・外部への依頼・結果の確認までをたどって関係を書き、上位図の利用目的・外部依存ごとに担当するコンテナか描かない理由を決める。
|
|
37
|
+
5. 定義と関係が決まってから C4コンテナ図を描く。図から書くと、根拠のない線が残りやすい。
|
|
38
|
+
6. 技術前提・制約と検証観点では、経路ごとの正常な結果を先に決め、その後で読取不能・外部停止・応答欠落で区別する状態を書く。
|
|
39
|
+
7. 根拠の足りない配置・経路をメモ / 将来課題へ移す。
|
|
44
40
|
|
|
45
41
|
## 4. 各章の書き方
|
|
46
42
|
|
|
47
43
|
### 4.1. 概要
|
|
48
44
|
|
|
49
|
-
|
|
50
|
-
- 分割により、配置や接続について誰が何を判断できますか。
|
|
51
|
-
- サイトなどの派生した提供経路を含める場合、上位図との範囲の違いを説明できますか。
|
|
52
|
-
- 合意したい範囲と利用場面を、どの Role code の確認者へ渡しますか。図を使う Person と設計の確認者を取り違えていませんか。
|
|
45
|
+
問い:
|
|
53
46
|
|
|
54
|
-
|
|
47
|
+
- 上位図のどのシステムを分解し、分割によって誰が配置や接続の何を判断できるか。
|
|
48
|
+
- サイトなどの派生した提供経路を含める場合、上位図との範囲の違いは何か。
|
|
49
|
+
|
|
50
|
+
コツ:
|
|
51
|
+
|
|
52
|
+
- 上位図の目的や利用者の説明は写さず、上位図への参照に置き換える。
|
|
53
|
+
- 目的を判断したいことに絞ると、分割を止める基準になる。
|
|
55
54
|
|
|
56
55
|
### 4.2. C4コンテナ図(Mermaid)
|
|
57
56
|
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
-
|
|
61
|
-
-
|
|
57
|
+
問い:
|
|
58
|
+
|
|
59
|
+
- 読み手は線から、依頼・参照の向きと、その線が成立する時点を説明できるか。
|
|
60
|
+
- 上位図の各利用目的・外部依存から経路をたどれるか。
|
|
62
61
|
|
|
63
|
-
|
|
62
|
+
コツ:
|
|
63
|
+
|
|
64
|
+
- ラベルを縮めると「構築時」「印刷時だけ」などの条件が落ちやすい。
|
|
65
|
+
- 方式が分からない接続は線で補わず、メモ / 将来課題へ移す。
|
|
64
66
|
|
|
65
67
|
### 4.3. 要素と境界の定義
|
|
66
68
|
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
-
|
|
70
|
-
-
|
|
71
|
-
|
|
69
|
+
問い:
|
|
70
|
+
|
|
71
|
+
- 各コンテナの責務は、誰のどの結果につながるか。
|
|
72
|
+
- ストアは正本か生成物か。直接更新するのは誰か。
|
|
73
|
+
|
|
74
|
+
コツ:
|
|
72
75
|
|
|
73
|
-
|
|
76
|
+
- 同じ端末にある外部ツールは、同じアプリにまとめやすい。管理する主体と、止まったときの影響を聞いて分ける。
|
|
77
|
+
- ファイルの保存場所、版管理の仕組み、共有サービスを聞き分け、更新する主体が複数なら排他制御の有無を開発者に聞く。
|
|
74
78
|
|
|
75
79
|
### 4.4. 技術前提・制約と検証観点
|
|
76
80
|
|
|
77
|
-
|
|
78
|
-
- 経路が正常に成立したとき、入力に対してどの保存内容・生成物・返却結果を照合できますか。
|
|
79
|
-
- 接続を止めたとき、失われる結果と残る記録を何で観測しますか。
|
|
80
|
-
- 実行成功と人間の承認を混同する経路はありませんか。
|
|
81
|
+
問い:
|
|
81
82
|
|
|
82
|
-
|
|
83
|
+
- 経路が正常に成立したとき、入力に対してどの保存内容・生成物・返却結果を照合できるか。
|
|
84
|
+
- 接続を止めたとき、失われる結果と残る記録は何か。
|
|
85
|
+
|
|
86
|
+
コツ:
|
|
87
|
+
|
|
88
|
+
- 書込先・外部の実行環境・閲覧先は、配置を設計する人に「何が未定だと困るか」を聞いて集める。
|
|
89
|
+
- 実行の成功と人の承認を同じ結果として書きやすい。分けて観測する対象を決める。
|
|
83
90
|
|
|
84
91
|
### 4.5. メモ / 将来課題
|
|
85
92
|
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
-
|
|
89
|
-
-
|
|
90
|
-
- 境界を変更・廃止した場合、上位図・コンポーネント図・インフラ構成図と、DEV の連携実装・QE の結合対象のどこへ影響しますか。
|
|
93
|
+
問い:
|
|
94
|
+
|
|
95
|
+
- 未確認の技術名・接続方式・配備先はどれで、そのために配置や結合確認の何が決められないか。
|
|
96
|
+
- 誰が何を確認すれば、仮定を更新できるか。
|
|
91
97
|
|
|
92
|
-
|
|
98
|
+
コツ:
|
|
99
|
+
|
|
100
|
+
- 解消条件は「配信先が公開範囲を満たすかを運用担当が確かめる」のように、誰が何を確かめるかの形で聞く。
|
|
93
101
|
|
|
94
102
|
## 5. 深掘り手順
|
|
95
103
|
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
104
|
+
内容が浅いときは、次の順で対応のない主張を探す。
|
|
105
|
+
|
|
106
|
+
1. 一つの利用結果から逆にたどり、対応する結果のないコンテナ候補を外す。
|
|
107
|
+
2. 各関係を「いつ」「誰が起動し」「何を渡すか」で読み直し、上位図から取り残した経路を探す。
|
|
108
|
+
3. 正本の更新から閲覧・共有までをたどり、正常な結果を照合する記録と、障害の影響が止まる境界を確かめる。根拠へ戻れない期待結果はメモ / 将来課題へ移す。
|
|
99
109
|
|
|
100
110
|
## 6. 良い例 / 悪い例
|
|
101
111
|
|
|
102
|
-
| 観点
|
|
103
|
-
|
|
|
104
|
-
|
|
|
105
|
-
|
|
|
106
|
-
|
|
|
107
|
-
|
|
|
112
|
+
| 観点 | 良い例 | 悪い例 |
|
|
113
|
+
| ------------ | -------------------------------------------------------------- | ---------------------------------------------- |
|
|
114
|
+
| 分割の目的 | 「販売の入力、記録、印字の配備単位を示す」 | 「業務に必要なすべての構成」 |
|
|
115
|
+
| 分割の理由 | 画面はブラウザで動き、処理サービスはサーバーで動く | 登録・検索・削除をそれぞれコンテナにする |
|
|
116
|
+
| ストア | 文書の正本はファイル群、閲覧用 HTML は生成物とする | すべてを「DB」とし、更新元と派生物を区別しない |
|
|
117
|
+
| 関係のラベル | 「公開文書の参照(構築時)」 | 「データ連携」 |
|
|
118
|
+
| 外部依存 | 印刷時だけ印刷基盤へ依頼する | 印刷基盤の停止で全参照も止まると断定する |
|
|
119
|
+
| 検証観点 | 控えと紙面の一致と、印字失敗時に残る販売の記録を分けて確かめる | 「結合テストをする」 |
|
|
120
|
+
| 未確定の配置 | ローカル構築を仮定し、配信先の確認を運用担当へ渡す | 候補のホストを既存構成のように描く |
|
|
108
121
|
|
|
109
122
|
## 7. レビュー観点
|
|
110
123
|
|
|
111
|
-
| 観点 |
|
|
112
|
-
| ------------ |
|
|
113
|
-
|
|
|
114
|
-
|
|
|
115
|
-
|
|
|
116
|
-
| 詳細との分担 |
|
|
117
|
-
| 判断と公開 | 未決事項の影響・判断時点と、承認範囲・公開対象を照合できるか | PO / OPS |
|
|
124
|
+
| 観点 | 確認内容 |
|
|
125
|
+
| ------------ | -------------------------------------------------------- |
|
|
126
|
+
| 価値と範囲 | 利用者が得る結果が、分割後も上位図の境界からはみ出ないか |
|
|
127
|
+
| 配置への入力 | 実行単位、保持単位、必要な接続と仮定を分けて読み取れるか |
|
|
128
|
+
| 結合への入力 | 主要な経路と外部の失敗で観測する対象を関係 ID で追えるか |
|
|
129
|
+
| 詳細との分担 | 構文・データ構造・物理配置を書かず、更新先が分かるか |
|
|
118
130
|
|
|
119
131
|
## 8. 仕上げチェック
|
|
120
132
|
|
|
121
|
-
-
|
|
122
|
-
-
|
|
123
|
-
-
|
|
124
|
-
- 記法・メタ情報の検査結果と描画の確認結果を集め、内容のレビュー結果と併せて残る指摘を識別しましたか。
|
|
125
|
-
- 主要判断と公開可否を、人間が判断する境界として残し、承認・保留の記録と公開対象を照合できるようにしましたか。
|
|
133
|
+
- 各コンテナが一つ以上の利用結果につながっている。
|
|
134
|
+
- 正本、構築時の入力、閲覧用の生成物が区別され、関係が成立する時点が図と定義で食い違っていない。
|
|
135
|
+
- 仮定と確定事項が分かれ、各仮定に誰が何を確かめるかがある。
|
|
@@ -11,116 +11,130 @@ specdojo:
|
|
|
11
11
|
|
|
12
12
|
C4 Component Diagram Writing Recipe
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
上位コンテナの責務を内部のまとまりへ分け、機能名を並べただけの図から、実装と結合設計の判断に使える構成へ具体化する作り方を示す。
|
|
15
15
|
|
|
16
16
|
## 1. このレシピの使い方
|
|
17
17
|
|
|
18
|
-
-
|
|
19
|
-
- 内部の責務、利用者と外部依存への接点、保存する正本を整理し、責任が重なる箇所を分けます。別プロセス化やクラス設計はここで決めません。
|
|
20
|
-
- コンポーネント名と関係 ID を軸に、分割の理由、情報の受け渡し、失敗時の観測点をつなぎます。未確認の依存は確認先とともに引き継ぎます。
|
|
18
|
+
- CPD は、上位図と上位の要求から分割の理由(Why)を引き継ぎ、コンポーネントの責務と境界で受け渡す情報(What)を定め、依存方向と失敗時の観測点(How)を示す。これらをコンポーネント名と関係 ID でたどれるようにする(Trace)。
|
|
21
19
|
|
|
22
20
|
## 2. 作成前に集める情報
|
|
23
21
|
|
|
24
|
-
|
|
|
25
|
-
| ---------- |
|
|
26
|
-
| 上位の境界 |
|
|
27
|
-
| 必要な成果 |
|
|
28
|
-
|
|
|
29
|
-
|
|
|
30
|
-
|
|
|
31
|
-
|
|
|
32
|
-
| 確認と合意 | 構成・実装・結合・業務を誰にいつ確認してもらうか。最終合意と公開可否の判断者は誰か |
|
|
33
|
-
| 公開と保守 | 誰にどの媒体で見せるか。公開前に確認する情報と、境界・契約が変わったときの相談先はどこか |
|
|
22
|
+
| 項目 | 集める情報 | 取り出し元・聞く相手 |
|
|
23
|
+
| ---------- | ---------------------------------------------------------------------- | ----------------------- |
|
|
24
|
+
| 上位の境界 | 展開するコンテナ、外部のまま残す利用者・ストア・他システム | 上位のコンテナ図 |
|
|
25
|
+
| 必要な成果 | 利用者が確認して次へ進む結果、期待価値・成功基準の記述箇所 | 上位の要求・目的、BA |
|
|
26
|
+
| 代表の依頼 | 入力から結果の確認までの流れと、結果を作る側・記録する側 | 業務の流れ、BA・DEV |
|
|
27
|
+
| 責務の候補 | 入力の解釈・判断・記録・外部依頼のうち、別々に変更・確認したいもの | 実装担当(DEV)への確認 |
|
|
28
|
+
| 確定度 | 設計上の決定と実装で確かめた構成の区別、未確認の配置 | 実装担当(DEV)への確認 |
|
|
29
|
+
| 結合の論点 | 相手の不在・拒否・応答欠落で不明になる結果、依存する共通機構の保証範囲 | 外部 IF の仕様、ARC・QE |
|
|
34
30
|
|
|
35
31
|
## 3. 全体の作成手順
|
|
36
32
|
|
|
37
|
-
1.
|
|
38
|
-
2.
|
|
39
|
-
3.
|
|
40
|
-
4.
|
|
41
|
-
5.
|
|
42
|
-
6.
|
|
43
|
-
7. 図の要素・関係を定義表から逆引きし、差異と省略理由を確かめます。リポジトリの検査設定から対象と期待結果を整理し、構文・描画・参照の確認結果を実行記録へ残します。
|
|
44
|
-
8. 構成上の確認結果と業務・公開判断の材料を分けて合意者へ渡します。改訂なら、変更した関係から後続設計・実装・検証・作業順への影響をたどり、更新先を決めます。
|
|
33
|
+
1. 代表の依頼を一つ選び、入力から結果の確認までをたどってメモする。分割の候補は、この流れで結果を作る側と記録する側から見つける。
|
|
34
|
+
2. 「要素と境界の定義」を先に書く。責務と入出力が決まらないと、図の矢印の意味が決まらない。
|
|
35
|
+
3. 「C4コンポーネント図(Mermaid)」に、主要な依頼と依存を関係 ID 付きで描く。
|
|
36
|
+
4. 「技術前提・制約と検証観点」で、関係ごとの成功と失敗の観測点を書く。
|
|
37
|
+
5. 確かめられなかった配置や保証を「メモ / 将来課題」へ移す。
|
|
38
|
+
6. 最後に「概要」を書く。分割と未確認の範囲が決まってから書くと、対象外と確定度を言い切れる。
|
|
45
39
|
|
|
46
40
|
## 4. 各章の書き方
|
|
47
41
|
|
|
48
42
|
### 4.1. 概要
|
|
49
43
|
|
|
50
|
-
|
|
44
|
+
問い:
|
|
51
45
|
|
|
52
|
-
|
|
46
|
+
- この分割で、後続の設計・実装は何を判断できるようになるか。今回扱わない範囲は何か。
|
|
47
|
+
- 期待価値・成功基準は、どの上位記述から引き継ぐか。
|
|
53
48
|
|
|
54
|
-
|
|
49
|
+
コツ:
|
|
50
|
+
|
|
51
|
+
- 上位の目的や成功基準は写さず、参照に置き換える。上位に見つからなければ BA に聞き、答えが出るまで論点に残す。
|
|
52
|
+
- 構成案と確かめた構成を混ぜやすい。DEV に「どこまでコードで確かめたか」を聞き、残りは _ASSUMPTION_: にする。
|
|
55
53
|
|
|
56
54
|
### 4.2. C4コンポーネント図(Mermaid)
|
|
57
55
|
|
|
58
|
-
|
|
56
|
+
問い:
|
|
57
|
+
|
|
58
|
+
- 矢印は利用する側から利用される側へ向いているか。応答を逆向きの依存として足していないか。
|
|
59
|
+
- 主要経路を省くと、どの判断が変わるか。
|
|
59
60
|
|
|
60
|
-
|
|
61
|
+
コツ:
|
|
61
62
|
|
|
62
|
-
|
|
63
|
+
- 正常な依頼と外部応答が欠ける依頼の二本をたどると、描く経路と省く経路を選べる。
|
|
64
|
+
- 同じ端末で動くという理由で、上位図の外側の要素を内側へ移しやすい。
|
|
63
65
|
|
|
64
66
|
### 4.3. 要素と境界の定義
|
|
65
67
|
|
|
66
|
-
|
|
68
|
+
問い:
|
|
67
69
|
|
|
68
|
-
|
|
70
|
+
- その責務を削ると、誰が結果を作れなくなるか。
|
|
71
|
+
- 二つの要素が同じ記録の更新判断を持っていないか。
|
|
69
72
|
|
|
70
|
-
|
|
73
|
+
コツ:
|
|
71
74
|
|
|
72
|
-
|
|
75
|
+
- 入出力は「確認済み販売明細」「保存結果」のように意味で書くと、判断する側と記録する側の分界が見える。
|
|
76
|
+
- 共通化の候補には「分けたままだと、どの判断が重複するか」を聞く。同名の関数があるだけでは共通化の理由にならない。
|
|
77
|
+
- 値・構文・構造は写さず、管理する文書への参照に置き換える。未作成なら仮の参照と確認先を残す。
|
|
73
78
|
|
|
74
79
|
### 4.4. 技術前提・制約と検証観点
|
|
75
80
|
|
|
76
|
-
|
|
81
|
+
技術前提の問い:
|
|
82
|
+
|
|
83
|
+
- どの共通機構・外部依存に頼るか。排他・原子性・再試行の保証は確かめたか。
|
|
84
|
+
|
|
85
|
+
検証観点の問い:
|
|
77
86
|
|
|
78
|
-
|
|
87
|
+
- 各境界で、どの条件を与えると何を観測すれば成功・失敗を区別できるか。
|
|
79
88
|
|
|
80
|
-
|
|
89
|
+
コツ:
|
|
90
|
+
|
|
91
|
+
- 応答欠落を、成功・未実施のどちらかに即断しやすい。結果不明として別に観測する。
|
|
92
|
+
- 確かめられない期待値は、詳細の契約へ引き継ぐ。
|
|
81
93
|
|
|
82
94
|
### 4.5. メモ / 将来課題
|
|
83
95
|
|
|
84
|
-
|
|
96
|
+
問い:
|
|
97
|
+
|
|
98
|
+
- 未確認事項を確定するには、どの根拠が要るか。
|
|
99
|
+
- 確定しないまま進むと、どの要素・関係と後続の作業が止まるか。
|
|
85
100
|
|
|
86
|
-
|
|
101
|
+
コツ:
|
|
87
102
|
|
|
88
|
-
|
|
103
|
+
- 未確認の主張を仮定・判断待ち・確認作業に分けると、当面の扱いと解消条件を書ける。
|
|
104
|
+
- 対象の要素名・関係 ID を必ず添える。添えないと影響先をたどれない。
|
|
89
105
|
|
|
90
106
|
## 5. 深掘り手順
|
|
91
107
|
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
108
|
+
内容が浅いときは、次の順で対応のない主張を探す。
|
|
109
|
+
|
|
110
|
+
1. 各出力が、どの利用場面と上位の成功基準に応えるかを確かめ、使われない出力のためだけの分割を外す。
|
|
111
|
+
2. 外部依頼の直前と直後で止まった場合を比べ、残る記録と結果不明を区別できない関係を探す。
|
|
112
|
+
3. 共通機構を外したとき、複数の責務へ同じ判断が散らばるかを確かめる。散らばらない共通化は外す。
|
|
113
|
+
4. 一つの変更(境界・責務・外部契約)を仮定し、関係 ID から上位図・詳細契約・観測点・作業順への影響をたどる。たどれない関係は定義を補う。
|
|
97
114
|
|
|
98
115
|
## 6. 良い例 / 悪い例
|
|
99
116
|
|
|
100
|
-
| 観点 | 良い例
|
|
101
|
-
| ---------- |
|
|
102
|
-
|
|
|
103
|
-
|
|
|
104
|
-
|
|
|
105
|
-
|
|
|
106
|
-
|
|
|
107
|
-
|
|
|
117
|
+
| 観点 | 良い例 | 悪い例 |
|
|
118
|
+
| ---------- | ------------------------------------------------------------------------ | -------------------------------------- |
|
|
119
|
+
| 分割の用途 | 「交代時の未印字引き継ぎに応え、保存と印字の責任境界を結合設計へ渡す」 | 「販売を管理する」 |
|
|
120
|
+
| 分割の理由 | 印字失敗と販売確定を分けて確かめるため、印字連携を独立させる | コマンドの数だけ部品を作る |
|
|
121
|
+
| 依存の意味 | 会計処理が保存済み控えの印字を依頼し、発行結果を受ける | 会計と印字が相互に処理する |
|
|
122
|
+
| 共通化 | 商品参照と販売記録の保存接点を共通化し、販売可否の判断は会計側に残す | 共通処理がすべて判断する |
|
|
123
|
+
| 確定度 | 同一プロセス内の論理配置案とし、実装対応は DEV が確かめる | 未調査のソースパスを実装済みとして書く |
|
|
124
|
+
| 観測点 | `REL-08` の応答欠落で、保存済み販売と印字の結果不明を別々に観測する | 「異常系を確認する」 |
|
|
125
|
+
| 未確認事項 | 印字応答欠落の回復条件が定まるまで自動再送を認めず、印字経路の受入を保留 | 「保存を検討」 |
|
|
108
126
|
|
|
109
127
|
## 7. レビュー観点
|
|
110
128
|
|
|
111
|
-
| 観点
|
|
112
|
-
|
|
|
113
|
-
| 目的と分割
|
|
114
|
-
| 更新責任
|
|
115
|
-
| 境界の観測
|
|
116
|
-
|
|
|
117
|
-
| 合意の材料 | 技術・業務の確認結果と残る論点から、判断者が承認・保留・差し戻しを選べるか |
|
|
118
|
-
| 追従の範囲 | 上位境界・外部契約の変更から、図・定義表と後続設計の更新先を辿れるか |
|
|
129
|
+
| 観点 | 確認内容 |
|
|
130
|
+
| ---------- | ------------------------------------------------------------------ |
|
|
131
|
+
| 目的と分割 | 各責務の必要性を、上位コンテナが返す結果へ結び付けられるか |
|
|
132
|
+
| 更新責任 | 同じ結果を二つの要素が別々に確定していないか |
|
|
133
|
+
| 境界の観測 | 外部の不在・拒否・応答欠落で、起点が確かめる結果を区別できるか |
|
|
134
|
+
| 委譲の境界 | 値・構文・構造を写さず、変更が詳細の文書だけで済む形になっているか |
|
|
119
135
|
|
|
120
136
|
## 8. 仕上げチェック
|
|
121
137
|
|
|
122
|
-
-
|
|
123
|
-
-
|
|
124
|
-
-
|
|
125
|
-
- メタ情報・参照・構文と描画の確認記録を辿れ、ラベル欠け・重なり・境界の誤読を解消したか。
|
|
126
|
-
- 公開する本文・図・ラベル・参照先に残る非公開情報の懸念を OPS と確認し、人間の PO が公開先と可否を判断する材料を用意したか。
|
|
138
|
+
- 図で省いた経路ごとに、省いても判断が変わらない理由を書いている。
|
|
139
|
+
- 実装で確かめていない配置や外部の保証を、確定事項として書いていない。
|
|
140
|
+
- 未確認事項ごとに、影響する要素・関係 ID と当面の扱いが分かる。
|