specdojo 0.8.0 → 0.9.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/agents/specdojo-orchestrator.md +4 -1
- package/CHANGELOG.md +77 -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/orchestrator.js +5 -77
- package/dist/commands/where.js +25 -0
- package/dist/dashboard/dashboard.js +5 -3
- package/dist/dashboard/routines.js +4 -7
- package/dist/dashboard/shared.js +2 -2
- package/dist/dashboard/timeline.js +14 -14
- package/dist/deliverable/trash.js +2 -1
- 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/opencode-permissions.js +117 -0
- 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 +82 -0
- package/dist/exec/repo-integration-sync.js +17 -5
- package/dist/exec/repo-trace.js +2 -1
- 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 +5 -2
- 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 +2 -2
- package/dist/exec/smoke.js +190 -0
- package/dist/exec/strategy.js +13 -3
- package/dist/exec/task-repos.js +19 -4
- 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 +12 -2
- 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/register/renumber.js +1 -3
- 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 +17 -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/orchestrator-operation-guide.md +1 -1
- 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 +258 -118
- package/docs/ja/specdojo/references/deliverables-reference.md +21 -12
- package/docs/ja/specdojo/references/specdojo-config-reference.md +47 -10
- 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,187 +11,160 @@ specdojo:
|
|
|
11
11
|
|
|
12
12
|
External Command Interface Specification Writing Recipe
|
|
13
13
|
|
|
14
|
-
外部 CLI
|
|
14
|
+
外部 CLI とのプロセス境界を、呼び出し元が成功・失敗を判定し、次の動作を一つに決められる契約に仕上げるための作り方を示す。
|
|
15
15
|
|
|
16
16
|
## 1. このレシピの使い方
|
|
17
17
|
|
|
18
|
-
- ESIL(外部システム I/F
|
|
19
|
-
-
|
|
20
|
-
- 起動方法や設定値は設定・リファレンスへ、値・構文・構造の詳細は `docs/specdojo/schemas/v1/ifx-cmd.schema.yaml` へ委ねる。ここでは呼び出し元が判断するための意味と参照先の選び方を扱う。
|
|
21
|
-
- 最後に ESIL の `spec_ref`、成功後の状態、観測信号、次の動作をたどる。実装が識別できない失敗や保証できない回復は、できることとして書かず、制約と確認先を残す。
|
|
18
|
+
- この仕様は、ESIL(外部システム I/F 一覧)の連携目的を引き継ぎ(Why)、呼び出し元が成功後に得る状態と入出力・終了状態の約束を定め(What)、識別信号・再試行・認証の渡し方を決める(How)。起動方法は正本の文書・設定キーへの参照で、仕様自体は ESIL の `spec_ref` からたどれるようにする(Trace)。
|
|
19
|
+
- 「作成前に集める情報」をメモでそろえてから、「全体の作成手順」の順に書く。判断が止まった項目だけ「深掘り手順」で調べ直す。
|
|
22
20
|
|
|
23
21
|
## 2. 作成前に集める情報
|
|
24
22
|
|
|
25
|
-
| 項目 |
|
|
26
|
-
| -------------- |
|
|
27
|
-
|
|
|
28
|
-
|
|
|
29
|
-
|
|
|
30
|
-
|
|
|
31
|
-
|
|
|
32
|
-
|
|
|
33
|
-
|
|
|
34
|
-
| 認証と権限 | 認証方式、注入機構と参照名、必要権限、供給元、ログ保存境界 | 誰が認証状態を管理し、どの段階で何をマスクするか。秘密値自体は収集しない |
|
|
35
|
-
| 制約と回復 | 作業ディレクトリ、時間・並列数・ネットワークの制約、再試行方針 | 上限は固定か設定依存か未決定か。子プロセス・部分出力・既存変更をどう扱うか |
|
|
23
|
+
| 項目 | 集める情報 | 取り出し元 |
|
|
24
|
+
| -------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
|
25
|
+
| 連携目的 | 呼び出し元と連携先、成功後に残る状態、別の契約に分ける操作 | ESIL の対象行、呼び出し元の担当者への確認 |
|
|
26
|
+
| 起動方法の正本 | 起動方法を決める文書・設定キー、対応バージョン、シェルを使う理由 | AI provider CLI は起動設定と exec 設定ガイド、ほかはコマンドリファレンス・公式資料 |
|
|
27
|
+
| 入出力 | stdin の内容と終端、stdout の採用範囲、stderr の用途、ファイルのパスと作成者 | 正本、実際の出力 1 回分、呼び出し元の実装担当への確認 |
|
|
28
|
+
| 終了状態 | 公開された終了コード、同じコードの失敗を分ける追加信号とその定義元 | 正本、検出信号を定義する設定 |
|
|
29
|
+
| 副作用と再実行 | 残る変更、利用枠の消費、途中失敗後に残る状態、重複を防ぐ手段 | 正本、運用担当への確認 |
|
|
30
|
+
| 認証 | 認証方式、渡し方、参照名、供給元、ログの保存先 | 認証を管理する担当への確認(秘密値そのものは集めない) |
|
|
31
|
+
| 制約 | 作業ディレクトリ、時間・並列数・ネットワークの上限と、固定・設定依存・未決定 | 起動設定、呼び出し元の実装担当への確認 |
|
|
36
32
|
|
|
37
33
|
## 3. 全体の作成手順
|
|
38
34
|
|
|
39
|
-
1.
|
|
40
|
-
2.
|
|
41
|
-
3.
|
|
42
|
-
4.
|
|
43
|
-
5.
|
|
44
|
-
6.
|
|
45
|
-
7.
|
|
46
|
-
8. **分岐の照合**: 成功、同じコードの異なる失敗、出力欠落、途中失敗後の再実行を順に追う。各ケースの次の動作が一つに決まり、未確定項目の確認先を引き継げる状態で仕上げる。
|
|
35
|
+
1. 連携単位を最初に決め、ESIL の目的と成功後の状態を 1 文で対応させる。目的・権限・出力が違う操作を混ぜたままだと、終了状態と副作用が一つに決まらない。
|
|
36
|
+
2. `command` で起動方法の正本を決める。実行ファイル・引数・provider をどこまで書くかは、正本が何を持つかで決まる。
|
|
37
|
+
3. `streams` と `files` で、成功を観測する信号と、後続処理が採用する出力を分ける。
|
|
38
|
+
4. `exit_codes` を書く。前の手順で決めた観測信号が、同じコードの失敗を分ける材料になる。
|
|
39
|
+
5. `side_effects` と冪等性を書く。途中失敗後に残る状態が分からないと、再試行してよいかを決められない。
|
|
40
|
+
6. `authentication` を書く。
|
|
41
|
+
7. `execution` と `error_handling` を最後に書く。終了状態と副作用が決まってから再試行の対象を選ぶと、回復の条件がない再試行を避けられる。
|
|
47
42
|
|
|
48
43
|
## 4. 各章の書き方
|
|
49
44
|
|
|
50
|
-
YAML の各要素を、以下の判断単位として組み立てる。キーの必須性や型の一覧を作り直さず、呼び出し元が必要とする説明を該当要素へ置く。
|
|
51
|
-
|
|
52
45
|
### 4.1. 連携単位とメタ情報
|
|
53
46
|
|
|
54
47
|
問い:
|
|
55
48
|
|
|
56
|
-
-
|
|
57
|
-
- 複数の操作や provider
|
|
58
|
-
- 契約の改版と CLI の対応バージョンを混同していないか。
|
|
49
|
+
- 呼び出し元の何が終われば、この連携は成功か。
|
|
50
|
+
- 複数の操作や provider をまとめても、同じ成功条件で確かめられるか。
|
|
59
51
|
|
|
60
|
-
|
|
52
|
+
コツ:
|
|
61
53
|
|
|
62
|
-
-
|
|
63
|
-
-
|
|
54
|
+
- 「何が残れば成功か」を呼び出し元の担当者に聞くと、分けるべき操作が見つかる。
|
|
55
|
+
- 上位の背景説明を写したくなったら、ESIL の対象行への参照に置き換える。
|
|
64
56
|
|
|
65
57
|
### 4.2. コマンドと正本参照
|
|
66
58
|
|
|
67
59
|
問い:
|
|
68
60
|
|
|
69
|
-
-
|
|
70
|
-
- provider
|
|
71
|
-
- 実際にシェルを使うか。使う理由、設定の管理者、展開値の検証・制限をどこで確認できるか。
|
|
61
|
+
- 起動方法を、どの文書・設定キーから解決するか。
|
|
62
|
+
- provider が増えたとき、この仕様のどこを直す必要があるか。
|
|
72
63
|
|
|
73
|
-
|
|
64
|
+
コツ:
|
|
74
65
|
|
|
75
|
-
-
|
|
76
|
-
-
|
|
77
|
-
-
|
|
66
|
+
- `executable` の括弧やコメント、`purpose` の括弧に provider 名を並べたくなったら書かない。一覧は起動設定の鍵が持ち、`executable` には先頭要素から解決する旨だけを書く。provider を足すたびに複数箇所を直すなら、写しが残っている。
|
|
67
|
+
- 一覧を削るときに、認証の参照名まで消しやすい。参照名は認証の対象を識別するのに要るので残す。
|
|
68
|
+
- シェルを使うかは、宣言ではなく実際の起動設定を見て確かめる。
|
|
78
69
|
|
|
79
70
|
### 4.3. ストリーム
|
|
80
71
|
|
|
81
72
|
問い:
|
|
82
73
|
|
|
83
|
-
-
|
|
84
|
-
- stdout
|
|
85
|
-
- stderr は何に使い、完了判定に使う信号とはどう区別するか。
|
|
74
|
+
- プロセスの終了と業務の完了を、それぞれ何で判断するか。
|
|
75
|
+
- stdout のうち、後続処理が採用するのはどこか。
|
|
86
76
|
|
|
87
|
-
|
|
77
|
+
コツ:
|
|
88
78
|
|
|
89
|
-
-
|
|
90
|
-
-
|
|
79
|
+
- 構造化した報告が出るからといって、stdout 全体が構造化とは限らない。実際の出力を 1 回分見て、進捗が混ざるか確かめる。
|
|
80
|
+
- 報告の項目一覧は写さず、判断に使う意味だけを残す。
|
|
91
81
|
|
|
92
82
|
### 4.4. ファイル
|
|
93
83
|
|
|
94
84
|
問い:
|
|
95
85
|
|
|
96
|
-
-
|
|
97
|
-
-
|
|
98
|
-
- 内容の詳細構造を持つ schema・仕様はどこか。
|
|
86
|
+
- 各ファイルのパスは、何を基準に何から決まるか。
|
|
87
|
+
- 各ファイルを作るのは CLI か、呼び出し元か。
|
|
99
88
|
|
|
100
|
-
|
|
89
|
+
コツ:
|
|
101
90
|
|
|
102
|
-
-
|
|
103
|
-
- CLI が編集する成果物と、呼び出し元が保存するログ・報告を分けて説明する。後者を CLI 自身の生成物として数えず、内容のフィールド一覧は正本へ委ねる。
|
|
91
|
+
- 呼び出し元が保存するログや報告を、CLI の出力に数えやすい。作成者を実装担当に聞いて分ける。
|
|
104
92
|
|
|
105
93
|
### 4.5. 終了状態と識別条件
|
|
106
94
|
|
|
107
95
|
問い:
|
|
108
96
|
|
|
109
|
-
-
|
|
110
|
-
-
|
|
111
|
-
- 認証失敗などを個別検出できない場合、誰が何を確認するか。
|
|
97
|
+
- 同じ終了コードを返す失敗を、どの追加信号で分けるか。
|
|
98
|
+
- どの信号にも一致しないとき、呼び出し元はどう動くか。
|
|
112
99
|
|
|
113
|
-
|
|
100
|
+
コツ:
|
|
114
101
|
|
|
115
|
-
-
|
|
116
|
-
-
|
|
102
|
+
- 認証失敗などを個別に検出できない実装は多い。検出できない原因は断定せず、人が確かめる扱いにする。
|
|
103
|
+
- 検出パターンを写したくなったら、定義している設定への参照に置き換える。
|
|
117
104
|
|
|
118
105
|
### 4.6. 副作用と冪等性
|
|
119
106
|
|
|
120
107
|
問い:
|
|
121
108
|
|
|
122
|
-
-
|
|
123
|
-
-
|
|
124
|
-
- 保証できない処理を再開する前に、誰がどの状態を確認するか。
|
|
109
|
+
- 途中で失敗したとき、外部状態・ファイル・利用枠に何が残るか。
|
|
110
|
+
- 再実行の前に、誰が何を確かめるか。
|
|
125
111
|
|
|
126
|
-
|
|
112
|
+
コツ:
|
|
127
113
|
|
|
128
|
-
-
|
|
129
|
-
- `execution.idempotency` は保証の有無を先に判断し、保証するなら重複排除条件、しないなら理由と既存変更を引き継ぐ条件を書く。同名ファイルへの書き込みだけを保証の根拠にしない。
|
|
114
|
+
- 「同じファイルに書くから再実行しても安全」と考えやすい。利用枠の追加消費と、非決定的な編集の差分を聞いて確かめる。
|
|
130
115
|
|
|
131
116
|
### 4.7. 認証注入
|
|
132
117
|
|
|
133
118
|
問い:
|
|
134
119
|
|
|
135
|
-
-
|
|
136
|
-
-
|
|
137
|
-
- 認証値の供給元と、引数・環境変数・stdout・stderr・保存ログの秘匿処理を誰が管理するか。
|
|
120
|
+
- 認証値は誰が用意し、どの経路でプロセスに渡るか。
|
|
121
|
+
- 引数・stdout・stderr・保存ログのどこで、誰がマスクするか。
|
|
138
122
|
|
|
139
|
-
|
|
123
|
+
コツ:
|
|
140
124
|
|
|
141
|
-
-
|
|
142
|
-
- `secret_source` に管理境界、`log_policy` にマスク対象と実施時点を書く。機構の参照名だけで説明し、秘密値や個人環境の認証パスは例にも使わない。
|
|
125
|
+
- 担当者には秘密値ではなく、仕組みと参照名だけを聞く。例にも実値や個人環境のパスを使わない。
|
|
143
126
|
|
|
144
127
|
### 4.8. 実行制約と失敗処置
|
|
145
128
|
|
|
146
129
|
問い:
|
|
147
130
|
|
|
148
|
-
-
|
|
149
|
-
-
|
|
150
|
-
- タイムアウト、出力解析失敗、認証失敗の後に、子プロセス・部分出力・既存変更をどう扱うか。
|
|
131
|
+
- 時間・並列数の上限は固定か、設定依存か、未決定か。
|
|
132
|
+
- タイムアウトや出力の解析失敗の後、子プロセス・部分出力・既存の変更をどう扱うか。
|
|
151
133
|
|
|
152
|
-
|
|
134
|
+
コツ:
|
|
153
135
|
|
|
154
|
-
-
|
|
155
|
-
-
|
|
156
|
-
- 三つの失敗処置は、停止する対象、保持・破棄するもの、次の確認者または再開条件から書く。上限や処置が未決定なら、現在の待機動作と決めるべき方針を混同しない。
|
|
136
|
+
- 上限が決まっていないとき、検査を通すために値を作りやすい。現在の動作と決めるべき判断を分け、_UNDECIDED_ で残す。
|
|
137
|
+
- 利用制限は、短時間の制限か利用枠の枯渇かを聞き分ける。待ち方が変わる。
|
|
157
138
|
|
|
158
139
|
## 5. 深掘り手順
|
|
159
140
|
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
141
|
+
内容が浅いときは、次の順で対応のない主張を探す。
|
|
142
|
+
|
|
143
|
+
1. 各制約・処置が防ぐ失敗を挙げ、ESIL の目的に結び付かないものを外す。
|
|
144
|
+
2. 各終了コードについて、入力・追加信号・次の動作を並べ、同じ観測結果に複数の動作が残る箇所を探す。
|
|
145
|
+
3. 再試行の対象ごとに、副作用から回復する条件があるかを確かめる。
|
|
146
|
+
4. 正本と同じ一覧・テンプレート・検出パターンを書いた箇所を、参照に戻す。
|
|
165
147
|
|
|
166
148
|
## 6. 良い例 / 悪い例
|
|
167
149
|
|
|
168
|
-
|
|
|
169
|
-
|
|
|
170
|
-
|
|
|
171
|
-
|
|
|
172
|
-
|
|
|
173
|
-
|
|
|
174
|
-
|
|
|
175
|
-
| 終了状態 | 非ゼロ終了と設定済み検出信号が一致した場合だけ利用制限とし、未一致は汎用失敗として停止する | exit 1 をすべて `transient_failure` にし、識別できない認証失敗まで自動再試行する |
|
|
176
|
-
| 副作用と冪等性 | 非決定的な編集は冪等性を保証せず、差分を保持して確認後に再開する条件を書く | 同じファイルへ書くので再実行も安全だと判断し、利用枠の追加消費を無視する |
|
|
177
|
-
| 認証注入 | ログインプロファイルの参照名と管理境界を残し、保存前のマスク対象を示す | 一覧の重複を削る際に認証対象まで不明にする、または秘密値・個人パスを例示する |
|
|
178
|
-
| 実行制約と回復 | 時間上限が未決定なら現在は終了まで待つ事実と必要な判断を分け、出力異常後の変更保持と確認者を示す | 検査を通すためだけに固定上限を作り、失敗処置を「リトライする」で済ませる |
|
|
150
|
+
| 観点 | 良い例 | 悪い例 |
|
|
151
|
+
| ------------- | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
|
152
|
+
| 連携単位 | 発注登録の成功を受付番号の受領とし、在庫照会とは別の仕様 ID にする | 登録と照会をまとめ、何が終われば成功か分からない |
|
|
153
|
+
| provider 一覧 | `executable` は起動設定の先頭要素から解決すると書き、`purpose` は成功後の状態だけを書く | `executable` の括弧、`purpose` の括弧、コメントに同じ provider 名を並べる |
|
|
154
|
+
| ストリーム | stdout は進捗を含むテキストとし、末尾の報告を取り出して完了を確かめる | 報告があるだけで stdout 全体を JSON とし、exit 0 だけで完了とする |
|
|
155
|
+
| 終了状態 | 非ゼロ終了と設定済みの検出信号が一致したときだけ利用制限とし、ほかは汎用失敗で止める | exit 1 をすべて一時失敗にし、識別できない認証失敗まで自動で再試行する |
|
|
156
|
+
| 失敗処置 | 出力の解析に失敗したら再試行を止め、変更を保持し、確認する人を示す | 「失敗時はリトライする」とだけ書く |
|
|
179
157
|
|
|
180
158
|
## 7. レビュー観点
|
|
181
159
|
|
|
182
|
-
| 観点
|
|
183
|
-
|
|
|
184
|
-
|
|
|
185
|
-
|
|
|
186
|
-
|
|
|
187
|
-
| 分岐の実現性 | 同じコードの失敗を追加信号と判定順で追い、検出できない原因が手動確認へ進むか確かめる |
|
|
188
|
-
| 回復の成立条件 | 途中失敗後の状態から再実行を追い、重複処理と利用枠消費を考慮した条件が再試行方針に反映されているか確かめる |
|
|
189
|
-
| 認証の管理境界 | 参照名から供給元とマスク実施点を追い、秘密値を収集・転載せずに認証経路を説明できるか確認する |
|
|
190
|
-
| 未確定事項の引き継ぎ | 固定値・設定依存・未決定を区別し、未決定項目から現在動作と次の確認先をたどれるか確認する |
|
|
160
|
+
| 観点 | 確認内容 |
|
|
161
|
+
| ---------- | ----------------------------------------------------------------------------- |
|
|
162
|
+
| 目的整合 | 成功後の状態が ESIL の連携目的とつながっているか |
|
|
163
|
+
| 回復 | 途中失敗後の状態から再実行を追い、二重処理と利用枠の消費を避ける条件があるか |
|
|
164
|
+
| 委譲の境界 | API・ファイル・メッセージの詳細や起動テンプレートを、正本と別に書いていないか |
|
|
191
165
|
|
|
192
166
|
## 8. 仕上げチェック
|
|
193
167
|
|
|
194
|
-
-
|
|
195
|
-
-
|
|
196
|
-
-
|
|
197
|
-
- 公開する本文・例・実行記録に秘密値、秘密値入り URL、個人環境の認証パスがなく、内部実装の説明は契約の参照に置き換わっている。
|
|
168
|
+
- 根拠のない固定値や、実際の起動方式・作成者と違う宣言が残っていない。
|
|
169
|
+
- 本文・コメント・例に、秘密値、秘密値入り URL、個人環境の認証パスがない。
|
|
170
|
+
- 未決定の項目は、現在の動作と次の確認先をたどれる形で残っている。
|
|
@@ -11,120 +11,154 @@ specdojo:
|
|
|
11
11
|
|
|
12
12
|
External System Interface List Writing Recipe
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
外部連携の抜けと過剰な詳細化を避け、設計・実装・結合テストの担当が同じ連携対象を特定できる一覧へまとめるための作り方を示す。
|
|
15
15
|
|
|
16
16
|
## 1. このレシピの使い方
|
|
17
17
|
|
|
18
|
-
-
|
|
19
|
-
-
|
|
20
|
-
-
|
|
18
|
+
- 一覧は、上位の要求から連携が必要な理由(Why)を引き継ぎ、連携ごとの目的・両端・発生条件・異常時の判断(What)を定め、方向と方式(How)を境界の上で示す。連携名と `spec_ref` から詳細契約・結合テスト対象へたどれるようにする(Trace)。
|
|
19
|
+
- 「作成前に集める情報」をメモでそろえてから、「全体の作成手順」の順に書く。
|
|
20
|
+
- 書き終えたら「レビュー観点」で読み直し、「仕上げチェック」で確かめる。
|
|
21
21
|
|
|
22
22
|
## 2. 作成前に集める情報
|
|
23
23
|
|
|
24
|
-
|
|
|
25
|
-
|
|
|
26
|
-
| 目的と範囲
|
|
27
|
-
| 境界と両端
|
|
28
|
-
| 発生条件
|
|
29
|
-
|
|
|
30
|
-
| 失敗の影響
|
|
31
|
-
|
|
|
32
|
-
| 未完了作業 | 未決論点、担当 Role、判断時点、依存作業、Schedule・管理記録 | 何が決まらないとどの作業が進まず、誰へ報告するか |
|
|
24
|
+
| 項目 | 集める情報 | 取り出し元・聞く相手 |
|
|
25
|
+
| ------------ | -------------------------------------------------------- | ------------------------------ |
|
|
26
|
+
| 目的と範囲 | 対象の利用場面、連携しないと未完了になる結果、対象外 | 上位の要求・プロジェクトの範囲 |
|
|
27
|
+
| 境界と両端 | 自システム、外部サービス、起動する CLI、受け渡すファイル | 構成図、実装担当への確認 |
|
|
28
|
+
| 発生条件 | 人の操作、業務イベント、周期、起動の前提 | 業務の流れ、利用者への確認 |
|
|
29
|
+
| 詳細契約 | 対象操作に対応する詳細仕様の有無 | 外部 I/F 仕様の文書群 |
|
|
30
|
+
| 失敗の影響 | 未完了・結果不明になる結果、副作用を照合する担当 | 業務担当・運用担当への確認 |
|
|
31
|
+
| 確認者と論点 | 連携ごとの確認者と合意対象、外部側の窓口、未決の方式 | 確認の過程のメモ |
|
|
33
32
|
|
|
34
|
-
|
|
33
|
+
秘密値や個人環境の認証ファイルは集めない。認証は管理主体と方式の確認先だけを控える。
|
|
35
34
|
|
|
36
35
|
## 3. 全体の作成手順
|
|
37
36
|
|
|
38
|
-
1.
|
|
39
|
-
2.
|
|
40
|
-
3.
|
|
41
|
-
4.
|
|
42
|
-
5.
|
|
43
|
-
6.
|
|
44
|
-
7.
|
|
37
|
+
1. 冒頭コメントに対象範囲と対象外を書く。範囲が決まらないと、連携候補を入れるか外すか決められない。
|
|
38
|
+
2. 利用場面を一つ選び、境界を越える要求・データ・結果を追って連携単位を切り出す。サービス名や採用ツールの列挙から始めると、目的のない行が混ざる。
|
|
39
|
+
3. 連携ごとに `source` と `target` を先に決め、その後で `direction`・`kind`・`format` を選ぶ。両端が決まらないと方向が読めない。
|
|
40
|
+
4. `timing` に発生条件を書く。
|
|
41
|
+
5. `error_handling` に異常時の判断を書く。
|
|
42
|
+
6. 詳細契約を対象操作と照らして `spec_ref` を決め、未整備や未決の論点をコメントに残す。
|
|
43
|
+
7. 連携ごとの確認者と合意対象をコメントに書く。
|
|
44
|
+
8. 最後に `id`・`title` を決める。対象範囲と連携がそろってからのほうが、一覧を識別できる名前になる。
|
|
45
45
|
|
|
46
46
|
## 4. 各章の書き方
|
|
47
47
|
|
|
48
|
-
YAML の記入領域ごとに、次の問いを使う。
|
|
49
|
-
|
|
50
48
|
### 4.1. メタ情報と対象範囲
|
|
51
49
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
-
|
|
50
|
+
問い:
|
|
51
|
+
|
|
52
|
+
- 何のシステム・利用場面の一覧か。
|
|
53
|
+
- 将来案と今の対象をどう区別するか。
|
|
54
|
+
|
|
55
|
+
コツ:
|
|
56
|
+
|
|
57
|
+
- 「全外部システム」のような範囲は、利用場面の具体名に置き換える。
|
|
58
|
+
- 上位の背景や目的を写したくなったら、上位成果物への参照に置き換える。
|
|
55
59
|
|
|
56
60
|
### 4.2. 連携単位と両端
|
|
57
61
|
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
-
|
|
62
|
+
問い:
|
|
63
|
+
|
|
64
|
+
- 相手が同じでも、照会と更新で完了条件や失敗の影響は変わらないか。
|
|
65
|
+
- その連携で何を受け渡し、成功後にどんな結果を得るか。
|
|
66
|
+
|
|
67
|
+
コツ:
|
|
68
|
+
|
|
69
|
+
- 製品名ではなく、得る結果で分ける。名前も結果が伝わるものにする。
|
|
70
|
+
- 一つの行で回復の担当や完了条件が二つ出てきたら、分ける合図にする。
|
|
61
71
|
|
|
62
72
|
### 4.3. 方向・方式・形式
|
|
63
73
|
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
-
|
|
74
|
+
問い:
|
|
75
|
+
|
|
76
|
+
- 自システムは API を直接呼ぶか、CLI を起動するか、ファイルを置くか。
|
|
77
|
+
- 形式は受け渡すストリーム全体を表しているか。
|
|
78
|
+
|
|
79
|
+
コツ:
|
|
80
|
+
|
|
81
|
+
- 実装担当に「自分たちのコードが何を起動するか」を聞くと、背後のサービスの方式と呼び出し側の方式を取り違えない。
|
|
82
|
+
- 結果の一部が JSON だからといって全体を JSON にしない。入力と結果の形式が違えば内訳をコメントで分ける。
|
|
67
83
|
|
|
68
84
|
### 4.4. 発生条件
|
|
69
85
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
-
|
|
86
|
+
問い:
|
|
87
|
+
|
|
88
|
+
- 誰の操作、どの業務イベントの後に連携するか。
|
|
89
|
+
- 起動してはいけない前提不足は何か。
|
|
90
|
+
|
|
91
|
+
コツ:
|
|
92
|
+
|
|
93
|
+
- 「随時」「適宜」と書きそうになったら、直前に何が終わっているかを聞く。
|
|
94
|
+
- 周期が分からないときは、固定時刻を推測で埋めない。
|
|
73
95
|
|
|
74
96
|
### 4.5. 異常時の判断
|
|
75
97
|
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
-
|
|
98
|
+
問い:
|
|
99
|
+
|
|
100
|
+
- 応答がないとき、未処理なのか結果不明なのか。
|
|
101
|
+
- 副作用を誰が照合し、その間どの操作を止め、どの結果を保つか。
|
|
102
|
+
|
|
103
|
+
コツ:
|
|
104
|
+
|
|
105
|
+
- 業務担当に「二重に登録・印字されたら何が困るか」を聞くと、再送してよいかが分かる。
|
|
106
|
+
- 引数や再試行の数値を書きたくなったら、回復条件の正本への参照に置き換える。
|
|
79
107
|
|
|
80
108
|
### 4.6. 詳細参照と未決事項
|
|
81
109
|
|
|
82
|
-
|
|
83
|
-
- 未整備なら、誰が何を確認・決定すれば接続できるか。解消条件と期限または判断するマイルストーンは何か。決まるまでどの業務・後続作業・公開範囲を保留するか。
|
|
84
|
-
- コメントを書く際は、作成・確認待ちを `_TODO_:`、意思決定待ちを `_UNDECIDED_:`、仮定を `_ASSUMPTION_:` で整理する。良い例は「`spec_ref: TBD` とし、ARC が DEV と結果照合方式を決め、外部結合テスト着手前に QE が期待結果を確認するまで当該連携の受入を保留」。避けたい例は「契約は後で作る」。論点から解消後の次アクションまでをつなぐ。
|
|
110
|
+
問い:
|
|
85
111
|
|
|
86
|
-
|
|
112
|
+
- 詳細契約はこの操作の成功・結果不明の判断に対応しているか。
|
|
113
|
+
- 決まるまで、どの連携の受入や後続作業を保留するか。
|
|
87
114
|
|
|
88
|
-
|
|
89
|
-
- 詳細仕様の未着手・作成中・確認待ちのどこで止まっているか。担当 Role、完了条件、判断時点、依存作業は計画のどこから確認できるか。
|
|
90
|
-
- 未決論点や方式変更は、どの連携・後続仕様・Schedule に影響するか。PM へどの作業・課題の登録をいつ依頼し、PO へ何の判断と保留範囲を報告するか。
|
|
91
|
-
- 良い例は「売上登録の認証未合意を、PM が結合テスト計画確定前に PJR へ登録し、着手条件と PO の判断を追跡する」。避けたい例は「関係者確認済み」。合意対象と残作業をコメントから管理記録へ結び、登録後は実在する作業・レコードへの参照へ付け替える。
|
|
115
|
+
コツ:
|
|
92
116
|
|
|
93
|
-
|
|
117
|
+
- 文書 ID があるだけで対応を確かめずに `spec_ref` へ入れやすい。対象操作の記述まで開いて照らす。
|
|
118
|
+
- 詳細契約があっても残る論点は、`spec_ref` で解決済みにせずコメントに残す。
|
|
94
119
|
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
120
|
+
### 4.7. 合意と計画への引き継ぎ
|
|
121
|
+
|
|
122
|
+
問い:
|
|
123
|
+
|
|
124
|
+
- 利用場面・業務影響、契約、期待結果を、それぞれ誰に確かめてもらうか。
|
|
125
|
+
- 外部側の確認が要るなら、窓口は誰か。
|
|
126
|
+
|
|
127
|
+
コツ:
|
|
128
|
+
|
|
129
|
+
- 「関係者確認済み」で済ませず、何について合意したかを聞く。
|
|
130
|
+
- 計画の期日や進捗を写したくなったら、計画や管理記録への参照に置き換える。
|
|
98
131
|
|
|
99
132
|
## 5. 深掘り手順
|
|
100
133
|
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
134
|
+
内容が浅いときは、次の順で対応のない主張を探す。
|
|
135
|
+
|
|
136
|
+
1. 各連携について、連携がなくても同じ結果を得られるかを確かめ、目的に対応しない行を外すか範囲の判断へ戻す。
|
|
137
|
+
2. 各連携の方向と方式が、両端の間の同じ受け渡しを表しているかを確かめる。
|
|
138
|
+
3. 異常時の判断ごとに、照合の担当と止める操作が決まっているかを確かめる。
|
|
139
|
+
4. 未決事項ごとに、影響する連携と保留する後続作業を逆にたどる。たどれない論点は、どの連携の論点かを決め直す。
|
|
105
140
|
|
|
106
141
|
## 6. 良い例 / 悪い例
|
|
107
142
|
|
|
108
|
-
| 観点
|
|
109
|
-
|
|
|
110
|
-
|
|
|
111
|
-
|
|
|
112
|
-
|
|
|
113
|
-
|
|
|
143
|
+
| 観点 | 良い例 | 悪い例 |
|
|
144
|
+
| ---------- | ------------------------------------------------------------ | ---------------------------------------- |
|
|
145
|
+
| 連携単位 | 「商品照会」と「売上登録」を分ける | 「本部連携」一行に全操作を詰める |
|
|
146
|
+
| 発生条件 | 「会計確定と控え保存の後に印字」 | 「適宜印字」 |
|
|
147
|
+
| 異常時 | 「受付結果不明なら記録を保持し担当が照合」 | 「失敗なら即再送」 |
|
|
148
|
+
| 未決の出口 | 照合方式が決まるまで売上登録の受入を保留する、とコメントする | 「契約は後で作る」 |
|
|
149
|
+
| 変更の追跡 | 分割元の連携名と影響する契約・テスト対象を対応づける | 改称後の一覧だけを渡し、旧契約を放置する |
|
|
114
150
|
|
|
115
151
|
## 7. レビュー観点
|
|
116
152
|
|
|
117
|
-
| 観点
|
|
118
|
-
|
|
|
119
|
-
| 必要性と範囲
|
|
120
|
-
| 境界の一貫性
|
|
121
|
-
| 下流への接続
|
|
122
|
-
|
|
|
123
|
-
| 委譲と未決事項 | 詳細を重複管理せず、論点から担当・解消条件・判断時点・保留する作業へたどれるか |
|
|
124
|
-
| 計画と管理 | 残作業やリスクが Schedule・PJR・決定記録へつながり、未登録なら PM への依頼時点が分かるか |
|
|
153
|
+
| 観点 | 確認内容 |
|
|
154
|
+
| ------------ | ------------------------------------------------------------------ |
|
|
155
|
+
| 必要性と範囲 | 各連携が対象の目的に結び付き、将来案と対象外を区別できるか |
|
|
156
|
+
| 境界の一貫性 | 両端、方向、方式、形式が同じ受け渡しを表しているか |
|
|
157
|
+
| 下流への接続 | 連携名から詳細契約と失敗時の確認先へ着き、結合テスト対象を選べるか |
|
|
158
|
+
| 委譲の境界 | 引数・設定値・計画の期日を写さず、参照に置き換えているか |
|
|
125
159
|
|
|
126
160
|
## 8. 仕上げチェック
|
|
127
161
|
|
|
128
|
-
-
|
|
129
|
-
-
|
|
130
|
-
-
|
|
162
|
+
- 集めた利用場面と一覧を突き合わせ、載っていない連携候補を対象外または判断待ちとして説明できる。
|
|
163
|
+
- 各節の問いへの答えが同じ連携を指し、例の担当や条件を実案件の確認なしで転用していない。
|
|
164
|
+
- 確認待ちの連携を解消済みと扱っていない。
|