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
|
@@ -14,22 +14,16 @@ specdojo:
|
|
|
14
14
|
|
|
15
15
|
Success Criteria and Acceptance Criteria Documentation Rulebook
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
判定基準、責任者、証跡を揃え、完了判断のぶれを防ぎます。
|
|
17
|
+
プロジェクトの業務価値に対する成功と、成果物・リリースの受入可否を、判定基準・責任者・証跡で判断するためのルールです。
|
|
19
18
|
|
|
20
19
|
## 1. 全体方針
|
|
21
20
|
|
|
22
|
-
-
|
|
23
|
-
-
|
|
24
|
-
-
|
|
25
|
-
-
|
|
26
|
-
- 成功基準は、初期公開・初期リリース、公開・運用開始後の短期、中長期の事業・社会的成果に分けます。後続時期の基準は初期受入の合否から分離します。
|
|
27
|
-
- 受入条件は、対象成果物やリリースが利用者価値の提供を開始できるかを判定する条件であり、中長期の成功そのものとは区別します。
|
|
28
|
-
- 実装詳細、個別テスト手順、設計判断は扱わず、判定に必要な要求レベルの条件のみを扱います。
|
|
21
|
+
- **対象と目的**: プロジェクトの成功基準と受入条件を対象とし、業務価値に対して誰が、いつ、どの証跡で合否を判断するかを定めます。
|
|
22
|
+
- **判定の区分**: 成功基準は初期公開・初期リリース、運用開始後の短期、中長期の事業・社会的成果に分けます。受入条件は価値提供を開始できる状態を判定し、公開後の利用件数や中長期成果を初期受入の必須条件にしません。
|
|
23
|
+
- **記載レベル**: 要求レベルの判定条件を扱い、実装詳細、個別テスト手順、設計判断は後続成果物へ委ねます。
|
|
24
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。文書の整形・lint・見出し・wikilink の検査はリポジトリの検証で扱い、業務の検証や受入条件に含めません。
|
|
29
25
|
|
|
30
|
-
## 2.
|
|
31
|
-
|
|
32
|
-
### 2.1. 位置づけ(他ドキュメントとの関係)
|
|
26
|
+
## 2. 位置づけ
|
|
33
27
|
|
|
34
28
|
```mermaid
|
|
35
29
|
flowchart LR
|
|
@@ -46,88 +40,40 @@ flowchart LR
|
|
|
46
40
|
class SAC target
|
|
47
41
|
```
|
|
48
42
|
|
|
49
|
-
### 2.2. 用語定義(本ルール内)
|
|
50
|
-
|
|
51
|
-
| 用語 | 定義 |
|
|
52
|
-
| -------- | ------------------------------------------------------------------ |
|
|
53
|
-
| 成功基準 | 利用者、業務、事業または社会に期待する成果が達成されたかを示す条件 |
|
|
54
|
-
| 受入条件 | 成果物やリリースを利用側が受け入れ可能と判断する条件 |
|
|
55
|
-
| 業務価値 | 利用者・業務にとって実現したい効果または状態 |
|
|
56
|
-
| 判定段階 | 初期公開・初期リリース、短期、中長期など、条件を評価する時間区分 |
|
|
57
|
-
| 完了定義 | 完了とみなすために満たすべき必須条件 |
|
|
58
|
-
| 証跡 | 判定結果を確認できる記録(報告書、ログ、議事録等) |
|
|
59
|
-
| 確認者 | 条件の充足と証跡を確認する役割 |
|
|
60
|
-
| 承認者 | 判定結果に対して最終責任を持つ役割 |
|
|
61
|
-
|
|
62
43
|
## 3. ファイル命名・ID規則
|
|
63
44
|
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
- `
|
|
67
|
-
- 判定結果の証跡(評価表、受入記録)は参照可能な場所に配置します。
|
|
68
|
-
|
|
69
|
-
### 3.2. ドキュメントID(推奨)
|
|
70
|
-
|
|
71
|
-
- 推奨: `<project-id>:prj-success-criteria-and-acceptance-criteria`
|
|
72
|
-
- 例: `prj-0001:prj-success-criteria-and-acceptance-criteria`
|
|
73
|
-
|
|
74
|
-
### 3.3. ファイル名(推奨)
|
|
75
|
-
|
|
76
|
-
- 推奨: `prj-success-criteria-and-acceptance-criteria.md`
|
|
77
|
-
- 日本語ファイル名の場合: `成功基準と受入条件.md`
|
|
45
|
+
- **推奨配置**: `docs/ja/projects/<project-id>/020-project-definition/prj-success-criteria-and-acceptance-criteria.md`。
|
|
46
|
+
- **推奨 ID**: `<project-id>:prj-success-criteria-and-acceptance-criteria`(例: `prj-0001:prj-success-criteria-and-acceptance-criteria`)。
|
|
47
|
+
- **ファイル名**: `prj-success-criteria-and-acceptance-criteria.md`。日本語名なら `成功基準と受入条件.md`。
|
|
78
48
|
|
|
79
49
|
## 4. 推奨 Frontmatter 項目
|
|
80
50
|
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
-
|
|
84
|
-
- メタ情報標準: [document-metadata-standard.md](../standards/document-metadata-standard.md)
|
|
85
|
-
|
|
86
|
-
| 項目 | 説明 | 必須 |
|
|
87
|
-
| ---------- | ---------------------------------------------------------------- | ---- |
|
|
88
|
-
| id | `<project-id>:prj-success-criteria-and-acceptance-criteria` | ○ |
|
|
89
|
-
| type | `project` 固定 | ○ |
|
|
90
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
91
|
-
| rulebook | `specdojo:prj-success-criteria-and-acceptance-criteria-rulebook` | ○ |
|
|
92
|
-
| based_on | `prj-scope` など、直接の根拠となる文書を含む配列 | 任意 |
|
|
93
|
-
| supersedes | 置き換え対象の旧文書 ID | 任意 |
|
|
94
|
-
|
|
95
|
-
### 4.2. 推奨ルール
|
|
96
|
-
|
|
97
|
-
- 成功基準と受入条件は混在させず、別表で管理します。
|
|
98
|
-
- 各成功基準・受入条件には、少なくとも一つの業務価値を対応付けます。技術的受入条件は、支援する業務価値と技術条件を区別します。
|
|
99
|
-
- `based_on` には、根拠となる `prj-scope` に加え、期待効果を定義した `prj-overview` がある場合は含めます。
|
|
100
|
-
- 閾値が未確定の場合は _UNDECIDED_: を使い、確定期限と担当を記載します。
|
|
51
|
+
- 許可キー・必須項目・型は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
|
|
52
|
+
- `type` は `project`、`rulebook` は `specdojo:prj-success-criteria-and-acceptance-criteria-rulebook` とします。
|
|
53
|
+
- `based_on` には根拠とした `prj-scope` と、期待効果の根拠にした `prj-overview` を記載します。成果物カタログに `depends_on` がある場合はその推移閉包内に限定します。
|
|
101
54
|
|
|
102
|
-
## 5.
|
|
55
|
+
## 5. 本文要件
|
|
103
56
|
|
|
104
|
-
|
|
57
|
+
見出し順・表・記入欄の骨組みは Frontmatter で宣言した template を正本とし、ここでは各章の内容要件を定めます。
|
|
105
58
|
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
| 3 | 受入条件 | ○ | 業務価値、受入項目、合否基準、証跡、承認者 |
|
|
111
|
-
| 4 | 判定手順と証跡 | ○ | 判定タイミング、証跡、承認経路 |
|
|
112
|
-
| 5 | 例外条件と未解決事項 | 任意 | 保留条件、暫定対応、解決期限 |
|
|
59
|
+
- **判定対象と適用範囲(必須)**: 対象、対象外、判定段階、初期受入に必須とする条件が判別できること。
|
|
60
|
+
- **成功基準・受入条件(各必須)**: 業務価値から条件・判定・測定または証跡・責任者を追跡できること。具体的な記載項目は「記述ガイド」に従います。
|
|
61
|
+
- **判定手順と証跡(必須)**: 条件ごとの確認順・判定時期・証跡の保存先・確認者・承認者を示し、合格基準との照合から受入可否の判断まで辿れること。否決時は是正内容、再確認する条件 ID、再判定時期を定めます。
|
|
62
|
+
- **例外条件と未解決事項(任意)**: 論点、判定への影響、保留条件、当面の扱いを示します。未確定の閾値は _UNDECIDED_: で示し、初期受入を進められるかを明記します。
|
|
113
63
|
|
|
114
64
|
## 6. 記述ガイド
|
|
115
65
|
|
|
116
66
|
### 6.1. 共通
|
|
117
67
|
|
|
68
|
+
- 成功基準と受入条件は別表にし、各条件に少なくとも一つの業務価値を対応付けます。
|
|
69
|
+
- 業務価値は利用者・業務に期待する効果や状態とし、対象利用者、利用場面、期待効果のいずれかが読み取れる表現にします。
|
|
118
70
|
- 各条件は測定可能で再現可能な表現にします。
|
|
119
|
-
- 業務価値は、対象利用者、利用場面、期待効果のいずれかを読み取れる表現にします。
|
|
120
|
-
- 成果物の存在、機能数、文書数、lint 合格などは業務価値ではなく、必要に応じて受入条件へ置きます。
|
|
121
|
-
- 章参照は章番号ではなく章タイトルで記述します。
|
|
122
|
-
- 条件追加/変更時は、変更理由と影響範囲を追記します。
|
|
123
71
|
|
|
124
72
|
### 6.2. 成功基準
|
|
125
73
|
|
|
126
74
|
- 初期公開・初期リリースでは代表利用者による作業完遂、短期では利用・定着・直接的改善、中長期では事業・社会的成果への寄与を扱います。
|
|
127
|
-
-
|
|
128
|
-
-
|
|
129
|
-
- 各条件に対応する業務価値、判定タイミング、確認ロールを必ず設定する。
|
|
130
|
-
- 閾値を置く場合は、測定対象、単位、母数または比較対象を明記する。
|
|
75
|
+
- 公開後にしか測定できない成功基準も、判定時期と確認者を定めて成功基準の表に残します。
|
|
76
|
+
- 定量指標だけでなく、運用定着や利用者受容などの定性条件も確認方法を明示します。閾値には測定対象、単位、母数または比較対象を記載します。
|
|
131
77
|
- 外部要因を受ける成果は、当該プロジェクトだけの因果と断定せず、利用前後の変化と寄与を確認します。
|
|
132
78
|
- 低コスト、費用負担の軽減、無償提供などを業務価値に置く場合は、少なくとも追加の現金支出、人の作業時間、継続的な運用負荷を分けて測定します。既存資産、寄付、無償枠を使う場合は評価上の扱いを定め、人の無償労働への負荷転嫁を成功とみなしません。
|
|
133
79
|
|
|
@@ -138,11 +84,9 @@ flowchart LR
|
|
|
138
84
|
|
|
139
85
|
### 6.3. 受入条件
|
|
140
86
|
|
|
141
|
-
- `種別`
|
|
142
|
-
-
|
|
143
|
-
-
|
|
144
|
-
- 否決時の是正内容、再確認する受入条件、再判定時期を例外条件または是正プロセスで定義する。
|
|
145
|
-
- 技術的な確認条件は、業務価値の受入条件と混在させず、種別と確認者を明示する。
|
|
87
|
+
- `種別` 列で受入観点(利用者視点、文書体系、実践の型、技術的受入、品質、公開適性など)を分類します。技術的条件は、支援する業務価値と区別し、確認者を明示します。
|
|
88
|
+
- 条件は「対象・操作または確認・期待結果」で書き、合格基準と証跡(参照先ファイル、ログ、記録等)を対応付けます。
|
|
89
|
+
- 確認者は条件の充足と証跡を確認し、承認者はその結果から受入可否を判断します。
|
|
146
90
|
|
|
147
91
|
推奨表(受入条件):
|
|
148
92
|
|
|
@@ -153,7 +97,6 @@ flowchart LR
|
|
|
153
97
|
|
|
154
98
|
| 項目 | 理由 |
|
|
155
99
|
| -------------------------------------------------------------- | ------------------------------------------ |
|
|
156
|
-
| 「十分に」「問題ない」等のみで基準記載 | 合否判定ができないため |
|
|
157
100
|
| 業務価値と対応しない成功基準または受入条件 | 何のための判定か追跡できないため |
|
|
158
101
|
| 成果物数、機能数、作業完了率だけを業務価値として扱う | 利用者や事業に生じる変化を判定できないため |
|
|
159
102
|
| 公開後の成功基準を未解決事項へ移し、測定責任を定めない | 成功の判定が初期受入だけで終わるため |
|
|
@@ -162,5 +105,3 @@ flowchart LR
|
|
|
162
105
|
| 現金支出の削減だけで低コストと判定し、作業・運用負荷を除外する | 人への負荷転嫁を成功と誤認するため |
|
|
163
106
|
| 確認者または承認者不在の受入判定 | 確認責任または最終責任が不明確になるため |
|
|
164
107
|
| 証跡なしの合格宣言 | 監査と追跡ができないため |
|
|
165
|
-
| Agent に最終判断・GO 判定を委ねる | 人間の判断責任を代替してしまうため |
|
|
166
|
-
| 公開リポジトリに個人名・個人連絡先・非公開の組織情報を記載する | 公開範囲とプライバシーに反するため |
|
|
@@ -11,64 +11,36 @@ specdojo:
|
|
|
11
11
|
|
|
12
12
|
# システム受入条件仕様(SAC)作成ルール
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
|
|
14
|
+
System Acceptance Criteria (SAC) Documentation Rules
|
|
15
|
+
|
|
16
|
+
システム全体としての合格基準(機能・非機能・障害・移行など)を、検証可能な Markdown 形式で記述し、受入判断の根拠を明確にするための基準を定めます。
|
|
16
17
|
|
|
17
18
|
## 1. 全体方針
|
|
18
19
|
|
|
19
20
|
- SAC は **システム全体としての出口条件(合格基準)** です。
|
|
20
21
|
- 例: 「性能試験で全ての NFR を満たし、重大障害 0 件であること」
|
|
21
|
-
- 受入条件は
|
|
22
|
-
- 「正しく動作する」「問題ない」などの曖昧表現は禁止。
|
|
23
|
-
- 手順書を作るのが目的ではありません。
|
|
24
|
-
- クリック手順や画面遷移の逐語列挙は避け、**システムに与える入力/操作**と**期待結果**を要約します。
|
|
25
|
-
- 実装詳細(例: 物理テーブル名、SQL全文、実装クラス/関数名、特定ライブラリの設定値)は記載しません。
|
|
22
|
+
- 受入条件は **観測・計測できる事実**として書き、手順書にはせず入力/操作と期待結果を要約します。
|
|
26
23
|
- 1ファイル = 1 受入対象(合格基準のまとまり)を基本とします。
|
|
24
|
+
- 例: `性能`, `障害復旧`, `セキュリティ(権限/監査)`, `移行(初期データ)`
|
|
25
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、本書と成果物で言い直しません。文書の整形・lint はリポジトリの検証で扱い、受入条件に含めません。
|
|
27
26
|
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
## 2. 用語定義
|
|
27
|
+
## 2. 位置づけ
|
|
31
28
|
|
|
32
|
-
|
|
33
|
-
| -------- | ---------------------------------------------------------- |
|
|
34
|
-
| SAC | システム受入条件。システム全体としての合格基準(出口条件) |
|
|
35
|
-
| 受入対象 | 受入として保証したい範囲や品質(例: 性能、障害復旧、移行) |
|
|
36
|
-
| シナリオ | 受入条件の具体ケース |
|
|
37
|
-
| 前提 | シナリオ開始前の条件(前提状態、試験環境、負荷条件など) |
|
|
38
|
-
| 操作 | システムに与える入力/操作/イベントの要約 |
|
|
39
|
-
| 期待結果 | 観測可能な事実(状態変化、記録、通知、計測値など) |
|
|
29
|
+
SAC は非機能要件(NFR)や業務受入条件(BAC)を根拠に、システム全体の合格基準を定めます。下位のテスト設計(テスト条件一覧、システムテスト仕様など)は SAC の受入条件を分解して参照するため、ID は安定させます。
|
|
40
30
|
|
|
41
31
|
## 3. ファイル命名・ID規則
|
|
42
32
|
|
|
43
|
-
- ファイル名: `sac
|
|
44
|
-
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
推奨:
|
|
49
|
-
|
|
50
|
-
- 受入対象が肥大化する場合は、カテゴリやサブシステム単位で分割し、下位文書側で `part_of` に上位SACを指定します。
|
|
51
|
-
|
|
52
|
-
- `based_on` には、根拠となる仕様 ID(例: `nfr-...`, `bac-...`, `br-...`, `bps-...`)を列挙します。
|
|
33
|
+
- ファイル名: `sac-<term>.md` とし、`<term>` は受入対象を表す英小文字の kebab-case とします(例: `sac-performance.md`、`sac-reliability.md`)。
|
|
34
|
+
- 文書 ID: ファイル名と同じ `sac-<term>` とし、成果物カタログの宣言と一致させます。
|
|
35
|
+
- 文書タイトル(H1): `# システム受入条件: <受入対象>` とします(例: `# システム受入条件: 性能`)。
|
|
36
|
+
- 受入対象が肥大化する場合は、カテゴリやサブシステム単位で分割し、下位文書側で `part_of` に上位 SAC を指定します。
|
|
53
37
|
|
|
54
38
|
## 4. 推奨 Frontmatter 項目
|
|
55
39
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
| 項目 | 説明 | 必須 |
|
|
59
|
-
| ---------- | --------------------------------------------- | ---- |
|
|
60
|
-
| id | 受入条件ID(`sac-...`) | ○ |
|
|
61
|
-
| type | `requirement` 固定 | ○ |
|
|
62
|
-
| title | 受入条件名(例: システム受入条件: 性能) | ○ |
|
|
63
|
-
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
64
|
-
| part_of | 上位SAC ID(分割している場合) | 任意 |
|
|
65
|
-
| based_on | 根拠となる仕様ID(NFR/BAC/BR/BPS/DEC/TSL 等) | 任意 |
|
|
66
|
-
| supersedes | 置き換え関係(古仕様→新仕様) | 任意 |
|
|
67
|
-
|
|
68
|
-
推奨:
|
|
40
|
+
許可キー・必須項目・型制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
|
|
69
41
|
|
|
70
|
-
- `
|
|
71
|
-
-
|
|
42
|
+
- `specdojo.type` は `requirement`、`specdojo.rulebook` は `specdojo:sac-rulebook` とします。
|
|
43
|
+
- `specdojo.based_on` に、受入条件の根拠となる NFR・BAC 等の ID を必ず紐づけます。
|
|
72
44
|
|
|
73
45
|
## 5. 本文構成(標準テンプレ)
|
|
74
46
|
|
|
@@ -80,55 +52,35 @@ Frontmatter は `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml`
|
|
|
80
52
|
|
|
81
53
|
## 6. 記述ガイド詳細
|
|
82
54
|
|
|
83
|
-
### 6.1 概要
|
|
55
|
+
### 6.1. 概要
|
|
84
56
|
|
|
85
57
|
- 1〜3文で「何を合格とするか(出口条件)」を書きます。
|
|
86
|
-
-
|
|
58
|
+
- 対象仕様(NFR/BAC/主要機能)に言及し、`based_on` と整合させます。
|
|
87
59
|
|
|
88
|
-
### 6.2 受入条件
|
|
60
|
+
### 6.2. 受入条件
|
|
89
61
|
|
|
90
|
-
SAC は **Markdown** で「受入対象」と「シナリオ」を記述します。
|
|
91
|
-
|
|
92
|
-
基本:
|
|
93
|
-
|
|
94
|
-
- 1ファイル = 1 受入対象(大きい場合はファイル分割)。
|
|
95
62
|
- シナリオは 2〜8 個程度を目安に、合否判定が必要な代表パターンを押さえます。
|
|
96
|
-
-
|
|
63
|
+
- 非機能は「指標+基準(閾値)」まで書きます(例: 応答時間(P95)/ 稼働率 / エラー率 / RTO / RPO / 監査ログの保持期間)。
|
|
97
64
|
|
|
98
65
|
シナリオの標準テンプレ(推奨):
|
|
99
66
|
|
|
100
67
|
- `### シナリオ: <短い条件名>`
|
|
101
|
-
- `####
|
|
102
|
-
- `####
|
|
68
|
+
- `#### 前提`(箇条書き。前提状態、試験環境、負荷条件など)
|
|
69
|
+
- `#### 操作`(箇条書き。入力/操作/イベントの要約)
|
|
103
70
|
- `#### 期待結果`(箇条書き。観測点/計測値/閾値を含める)
|
|
104
71
|
- `#### 判定方法`(任意。どこを見て合否判定するか)
|
|
105
72
|
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
- 非機能は「指標+基準(閾値)」まで書きます。
|
|
109
|
-
- 例: 応答時間(P95)/ 稼働率 / エラー率 / RTO / RPO / 監査ログの保持期間 など
|
|
110
|
-
- “環境や負荷条件”が重要な場合は、「前提」に条件を明記します。
|
|
111
|
-
- 例: 「ピーク時相当の負荷(100 RPS)を与えている」
|
|
112
|
-
- 1つのシナリオに要求を詰め込みすぎない(レビュー・切り分けが難しくなる)。
|
|
113
|
-
|
|
114
|
-
#### 6.2.1 ケース表
|
|
115
|
-
|
|
116
|
-
同じ操作を **条件/入力だけ変えて反復**する場合は、シナリオを増やす代わりに **ケース表**で差分をまとめてよいです。
|
|
117
|
-
|
|
118
|
-
書き方(最小):
|
|
73
|
+
#### 6.2.1. ケース表
|
|
119
74
|
|
|
120
|
-
|
|
121
|
-
- その下に `#### ケース一覧`(表)を置き、ケースごとの違いを表にまとめる
|
|
122
|
-
|
|
123
|
-
ケース表の例(列は必要に応じて調整):
|
|
75
|
+
条件/入力だけ変えて同じ操作を反復する場合は、`### シナリオ: <共通の操作/イベント>` の下の `#### ケース一覧` の表へ差分をまとめてよいです。
|
|
124
76
|
|
|
125
77
|
| ケース | 前提(条件/負荷/データ量) | 操作 | 期待結果(観測点/基準) |
|
|
126
78
|
| ------ | -------------------------- | ---- | ----------------------- |
|
|
127
79
|
| C1 | … | … | … |
|
|
128
80
|
|
|
129
|
-
### 6.3 メモ / 将来課題
|
|
81
|
+
### 6.3. メモ / 将来課題
|
|
130
82
|
|
|
131
|
-
- 未確定の前提(例: ピーク時の定義、想定データ量、外部依存のSLA
|
|
83
|
+
- 未確定の前提(例: ピーク時の定義、想定データ量、外部依存のSLA)の論点と影響
|
|
132
84
|
- 将来追加したい SAC(例: DR訓練頻度、監査ログの検索性)
|
|
133
85
|
|
|
134
86
|
## 7. 禁止事項
|
|
@@ -143,61 +95,46 @@ SAC は **Markdown** で「受入対象」と「シナリオ」を記述しま
|
|
|
143
95
|
## 8. よくある誤りと対策
|
|
144
96
|
|
|
145
97
|
- 期待結果が曖昧(「性能が良い」) → 指標と基準(数値/単位)に分解する
|
|
146
|
-
- 前提がない(平常/ピークが不明) →
|
|
98
|
+
- 前提がない(平常/ピークが不明) → 前提に条件(例: ピーク時相当の負荷 100 RPS、データ量、時間帯)を書く
|
|
147
99
|
- 期待結果が測れない → 観測点(ログ/監視/試験レポート等)を期待結果や判定方法に含める
|
|
148
100
|
- 1つのシナリオに要件を詰め込みすぎ → シナリオを分割する
|
|
149
101
|
|
|
150
102
|
## 9. サンプル(簡易)
|
|
151
103
|
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
```yaml
|
|
104
|
+
```markdown
|
|
155
105
|
---
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
status: draft
|
|
160
|
-
|
|
161
|
-
based_on:
|
|
162
|
-
|
|
163
|
-
supersedes: []
|
|
106
|
+
specdojo:
|
|
107
|
+
id: sac-performance
|
|
108
|
+
type: requirement
|
|
109
|
+
status: draft
|
|
110
|
+
rulebook: specdojo:sac-rulebook
|
|
111
|
+
based_on:
|
|
112
|
+
- nfr-performance
|
|
164
113
|
---
|
|
165
|
-
```
|
|
166
|
-
|
|
167
|
-
### 概要
|
|
168
114
|
|
|
169
|
-
|
|
115
|
+
# システム受入条件: 性能
|
|
170
116
|
|
|
171
|
-
|
|
117
|
+
## 1. 概要
|
|
172
118
|
|
|
173
|
-
|
|
119
|
+
主要 API が平常時に業務上許容できる時間内で応答することを合格基準とする。
|
|
174
120
|
|
|
175
|
-
|
|
121
|
+
## 2. 受入条件
|
|
176
122
|
|
|
177
|
-
|
|
123
|
+
### シナリオ: 在庫照会APIの応答時間(平常時)
|
|
178
124
|
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
- おばあちゃんが販売登録画面で一般的な会計を行う
|
|
182
|
-
|
|
183
|
-
##### 期待結果
|
|
184
|
-
|
|
185
|
-
- 会計確定から結果表示までが 3 秒以内であること
|
|
186
|
-
|
|
187
|
-
#### シナリオ: 在庫照会APIの応答時間(平常時)
|
|
188
|
-
|
|
189
|
-
##### 前提
|
|
125
|
+
#### 前提
|
|
190
126
|
|
|
191
127
|
- 平常時相当の負荷(20 RPS)を与えている
|
|
192
128
|
|
|
193
|
-
|
|
129
|
+
#### 操作
|
|
194
130
|
|
|
195
131
|
- 在庫照会APIを呼び出す
|
|
196
132
|
|
|
197
|
-
|
|
133
|
+
#### 期待結果
|
|
198
134
|
|
|
199
135
|
- 応答時間(P95)が 500ms 以内であること
|
|
200
136
|
|
|
201
|
-
|
|
137
|
+
## 3. メモ / 将来課題
|
|
202
138
|
|
|
203
139
|
- ピーク時の同時接続数・データ量の確定
|
|
140
|
+
```
|
|
@@ -14,28 +14,28 @@ specdojo:
|
|
|
14
14
|
|
|
15
15
|
System Functions Index Documentation Rules
|
|
16
16
|
|
|
17
|
-
`sf-index.md`
|
|
17
|
+
`sf-index.md` は、機能の全体構成と業務プロセス仕様(BPS)・利用接点・個別機能仕様の対応を示す入口文書である。スコープの判断、機能分割、テスト対象の網羅確認に使う。
|
|
18
18
|
|
|
19
19
|
## 1. 全体方針
|
|
20
20
|
|
|
21
|
-
-
|
|
22
|
-
-
|
|
23
|
-
-
|
|
21
|
+
- システムまたは合意した範囲ごとに正本を一つにし、複数システムを扱う場合は対象範囲を冒頭で明示する。
|
|
22
|
+
- 業務プロセス領域を起点に機能を洗い出し、全領域を機能またはシステム化しない理由に対応させる。
|
|
23
|
+
- 一覧行は「システム化機能一覧」の標準6列で要約参照にとどめ、入出力・振る舞い・受入条件は個別機能仕様へ委ねる。
|
|
24
24
|
- システムが担う処理(記録・検証・生成・起動)と、人間に残す判断を区別する。承認や確定の判断をシステム化機能として数えない。
|
|
25
25
|
- 上流の BPS・利用接点の仕様が未作成でも、成果物カタログなど確認できた根拠から一覧を作ってよい。未照合の対応は確定扱いにせず、未決事項で追跡する。
|
|
26
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status`・承認、改訂と廃止、未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めない。
|
|
26
27
|
|
|
27
28
|
## 2. 位置づけ
|
|
28
29
|
|
|
29
|
-
| 文書・情報 |
|
|
30
|
-
| -------------------------------- |
|
|
31
|
-
| `sf-index` |
|
|
32
|
-
| `sf-<term>` |
|
|
33
|
-
| 業務プロセス仕様(BPS) |
|
|
34
|
-
| 利用接点の仕様(CLIS・UIS・IFX) | コマンド群・画面・外部 I/F
|
|
35
|
-
| 成果物カタログ |
|
|
30
|
+
| 文書・情報 | 一覧との関係・分担 |
|
|
31
|
+
| -------------------------------- | ------------------------------------------------------------------------------------------------ |
|
|
32
|
+
| `sf-index` | 機能の全体構成と網羅性、機能 ID の採番元。本書の対象 |
|
|
33
|
+
| `sf-<term>` | 一覧行から参照する個別機能の入出力・処理要件・制約・受入観点。全体の網羅性は扱わない |
|
|
34
|
+
| 業務プロセス仕様(BPS) | 業務のトリガー・処理ステップ・判断の正本。機能の網羅と割当ての起点 |
|
|
35
|
+
| 利用接点の仕様(CLIS・UIS・IFX) | コマンド群・画面・外部 I/F の利用方法と入出力、構文・画面配置の正本 |
|
|
36
|
+
| 成果物カタログ | 個別仕様の要否・依存・完了条件の正本。追加前に登録し、個別仕様がない機能は一覧行の要約を正とする |
|
|
36
37
|
|
|
37
38
|
- 個別機能仕様の作成ルールは [[specdojo:sf-rulebook|システム化機能仕様 作成ルール]] とし、本書は一覧ハブだけを扱う。
|
|
38
|
-
- 一覧に載せた機能のうち、どれを個別仕様へ詳細化するかは成果物カタログで管理する。個別仕様がない機能は、一覧行の要約を正とする。
|
|
39
39
|
- 作成の入力は、上位の目的・スコープ、業務プロセス領域と BPS、利用接点の仕様、成果物カタログとする。業務から機能への割当てを先に決め、実装・schema・リファレンスは参照先や現行制約の照合に使う。
|
|
40
40
|
|
|
41
41
|
## 3. ファイル命名・ID規則
|
|
@@ -47,36 +47,34 @@ System Functions Index Documentation Rules
|
|
|
47
47
|
|
|
48
48
|
## 4. 推奨 Frontmatter 項目
|
|
49
49
|
|
|
50
|
-
-
|
|
50
|
+
- 共通項目・制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` に従う。
|
|
51
51
|
- `type` は `requirement`、`rulebook` は `specdojo:sf-index-rulebook` とする。文書名は H1 に置く。
|
|
52
|
-
- 作成・改訂中は `status: draft` とする。静的検査の成功や作業タスクの完了だけで `ready` へ昇格せず、人間の PO がスコープを承認して判断する。
|
|
53
52
|
|
|
54
53
|
## 5. 本文要件
|
|
55
54
|
|
|
56
|
-
|
|
55
|
+
次の章を開始時の構成とする。
|
|
57
56
|
|
|
58
|
-
| 章 | 章タイトル | 必須 | 目的と記載要件
|
|
59
|
-
| --- | ------------------ | -------- |
|
|
60
|
-
| - | 冒頭の概要 | ○ | 対象システム、一覧の利用目的と対象範囲を 1〜3 文で示す
|
|
61
|
-
| 1 | 目的と対象範囲 | ○ |
|
|
62
|
-
| 2 | 機能構成 | ○ |
|
|
63
|
-
| 3 | システム化機能一覧 | ○ |
|
|
64
|
-
| 4 | 未決事項 | 条件付き |
|
|
57
|
+
| 章 | 章タイトル | 必須 | 目的と記載要件 |
|
|
58
|
+
| --- | ------------------ | -------- | ------------------------------------------------------------------------------------------------ |
|
|
59
|
+
| - | 冒頭の概要 | ○ | 対象システム、一覧の利用目的と対象範囲を 1〜3 文で示す |
|
|
60
|
+
| 1 | 目的と対象範囲 | ○ | 一覧で判断できることと上位目的の関係、対象者の業務課題、対象・対象外、誰がどの判断に使うかを示す |
|
|
61
|
+
| 2 | 機能構成 | ○ | 「機能構成」の推奨5列で責務を示し、システム化しない業務プロセス領域と理由を示す |
|
|
62
|
+
| 3 | システム化機能一覧 | ○ | 「システム化機能一覧」の標準6列を一つの主一覧表で対応させる |
|
|
63
|
+
| 4 | 未決事項 | 条件付き | 未照合の対応や未作成の参照先がある場合に、論点、影響する機能 ID・参照先、当面の扱いを示す |
|
|
65
64
|
|
|
66
65
|
- 機能構成と一覧の両方で、すべての業務プロセス領域を確認できるようにする。一覧から機能構成へ、機能構成から業務プロセス領域へ辿れれば、網羅の確認表を別に設けない。
|
|
67
66
|
- 行が多く一つの表で領域を見分けにくい場合は、機能領域ごとに小節を分けてよい。列は全小節でそろえる。
|
|
68
67
|
|
|
69
68
|
## 6. 記述ガイド
|
|
70
69
|
|
|
71
|
-
共通事項は上位の目的・スコープ、BPS
|
|
70
|
+
共通事項は上位の目的・スコープ、BPS、利用接点の仕様を正本として参照し、一覧には割当てと責務境界を残す。
|
|
72
71
|
|
|
73
72
|
### 6.1. 目的と対象範囲
|
|
74
73
|
|
|
75
|
-
-
|
|
74
|
+
- 解消する業務課題と一覧で判断できることを書き、上位目的を参照する。システムの紹介や機能の列挙で終えない。
|
|
76
75
|
- 対象と対象外を対にして示す。対象外には、人間が行う判断、外部製品の内部処理、個別機能の詳細を必要に応じて含める。
|
|
77
|
-
-
|
|
78
|
-
-
|
|
79
|
-
- 良い例: 「店番交代時の記録漏れを減らすため、販売・在庫の責務分担を確定する。BA が一覧を保守し、店主代表(PO)が対象範囲と外部公開用の匿名化を確認する」。
|
|
76
|
+
- 誰が機能分割、実装範囲、テスト対象の洗い出し、業務対応の確認に使うかを示す。
|
|
77
|
+
- 良い例: 「店番交代時の記録漏れを減らすため、店主代表と開発担当が販売・在庫の責務分担を確認する。対象は店頭での記録と照合、発注の最終判断は対象外とする」。
|
|
80
78
|
- 悪い例: 「本システムの機能を一覧にする」。一覧で判断することと対象範囲が分からない。
|
|
81
79
|
|
|
82
80
|
### 6.2. 機能構成
|
|
@@ -107,32 +105,25 @@ System Functions Index Documentation Rules
|
|
|
107
105
|
|
|
108
106
|
### 6.4. 未決事項
|
|
109
107
|
|
|
110
|
-
-
|
|
111
|
-
- 上流の BPS
|
|
112
|
-
-
|
|
113
|
-
-
|
|
114
|
-
-
|
|
115
|
-
- 良い例: 「BA が BPS 作成時に `SF-INV-01` の在庫反映の責務を照合する。未合意の間は当該境界の承認を保留し、PM が PJR で追跡して在庫設計の着手時期を見直す」。
|
|
116
|
-
- 悪い例: 「対応は後で確認する」。担当と確認の時点がない。
|
|
108
|
+
- 論点ごとに影響する機能 ID・参照先、後続設計・実装・検証への影響、当面の扱いを示す。
|
|
109
|
+
- 上流の BPS や利用接点の仕様が未作成で暫定の対応を置いた場合は、その対応と根拠を示す。網羅の根拠(成果物カタログの依存など)と一覧の範囲が一致しない場合も論点にする。
|
|
110
|
+
- 上流仕様の作成・改訂、機能の追加・廃止・統合、接点や個別仕様の変更を再照合の契機とする。機能 ID から BPS・一覧、機能分割・コンポーネント設計、接点・実装・schema・生成処理・運用手順、テスト対象への影響先を特定し、該当しないものには理由を残す。
|
|
111
|
+
- 良い例: 「`SF-INV-01` の在庫反映の責務は BPS 未作成のため暫定である。在庫の更新主体が未合意で、当該境界に依存する設計は確定できない」。
|
|
112
|
+
- 悪い例: 「対応は後で確認する」。論点と影響する機能・設計が分からない。
|
|
117
113
|
|
|
118
114
|
### 6.5. 完成判定と継続保守
|
|
119
115
|
|
|
120
|
-
|
|
116
|
+
一覧の受入確認は次の手順と合格条件で行う。確認結果と未充足条件をレビュー記録へ残し、変更後は影響する一覧行と参照先を再確認する。
|
|
121
117
|
|
|
122
|
-
|
|
|
123
|
-
|
|
|
124
|
-
|
|
|
125
|
-
|
|
|
126
|
-
|
|
|
127
|
-
|
|
|
128
|
-
| PM | 機能領域ごとの照合と影響先の追従を作業単位に分け、完了条件・担当・判断時点をカタログ・Schedule・PJR で追跡できる |
|
|
129
|
-
| PO | 上位目的に沿う対象範囲、人間に残す判断、公開範囲と非公開情報の除外を確認し、未決事項を含めて承認可否を判断できる |
|
|
118
|
+
| 観点 | 確認手順 | 合格条件 |
|
|
119
|
+
| ---------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
|
120
|
+
| 業務の網羅と目的 | 上位目的・業務領域を機能構成・各行の BPS と照合する | 対象範囲が目的に沿い、全領域に機能または対象外の理由があり、概要と BPS の責務が矛盾しない |
|
|
121
|
+
| 機能境界 | 全機能 ID・領域略号・表後の責務の注記を照合する | ID が一意で領域に対応し、責務の重なりと外部・人間との分担を設計入力にできる |
|
|
122
|
+
| 接点と詳細化 | 利用接点・個別仕様を根拠仕様・カタログと照合する | 起動接点と仕様の正本を辿れ、詳細化する機能と一覧で要約する機能を区別できる |
|
|
123
|
+
| テスト対象 | 全機能 ID をテスト対象に対応付け、必須6列と暫定対応を確認する | 機能の漏れがなく、必須列の内容と未照合箇所の論点・影響が特定できる |
|
|
130
124
|
|
|
131
|
-
-
|
|
132
|
-
-
|
|
133
|
-
- 公開後の対応漏れや参照切れは保守担当へ渡し、スコープ変更は PO、技術境界の矛盾は ARC、計画への影響は PM へ接続する。変更後は影響する一覧行と参照先を再確認する。
|
|
134
|
-
- 良い例: 「lint は成功したが、在庫反映の責務が未照合のため `draft` を維持する。BA・ARC の確認後に PO が対象範囲を承認する」。
|
|
135
|
-
- 悪い例: 「一覧が埋まり lint が通ったので `ready` として公開する」。網羅性・責務の合意と人間の最終判断を省いている。
|
|
125
|
+
- 良い例: 「販売・入荷の両機能から在庫確認への受け渡しを BPS と照合し、在庫更新の重複がなく、3 機能をテスト対象に対応付けられる」。
|
|
126
|
+
- 悪い例: 「表の全セルが埋まったので完成とする」。業務の網羅性と責務境界を確かめていない。
|
|
136
127
|
|
|
137
128
|
## 7. 禁止事項
|
|
138
129
|
|
|
@@ -145,4 +136,3 @@ System Functions Index Documentation Rules
|
|
|
145
136
|
| 成果物カタログに登録していない個別仕様を、存在するようにリンクする | デッドリンクと、作成判断の不在を招くため |
|
|
146
137
|
| 未照合の対応や未作成の参照先を、未決事項に残さず確定事項として扱う | 上流仕様の作成時に照合されず、誤りが残るため |
|
|
147
138
|
| 機能 ID を再利用する、または意味を変える | 個別仕様・テスト・変更記録からの参照が壊れるため |
|
|
148
|
-
| 文書検査の成功だけで agent が `ready` 昇格や公開の承認を行う | スコープと公開可否の最終判断は人間の PO が担うため |
|