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
|
@@ -19,49 +19,34 @@ Non-Functional Requirements Operations Documentation Rules
|
|
|
19
19
|
## 1. 全体方針
|
|
20
20
|
|
|
21
21
|
- 運用は監視可能性、通知、手動介入条件、復旧性を要求として定義する。
|
|
22
|
-
-
|
|
22
|
+
- 運用手順そのものは OPR に置き、本書には満たすべき運用結果(達成基準)だけを記述する。
|
|
23
23
|
- OPR/OPD と接続して実行可能性を担保する。
|
|
24
|
+
- 共通の運用: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、本書と成果物で言い直さない。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めない。
|
|
24
25
|
|
|
25
|
-
## 2.
|
|
26
|
-
|
|
27
|
-
### 2.1. 位置づけ
|
|
26
|
+
## 2. 位置づけ
|
|
28
27
|
|
|
29
28
|
- `nfr-operations`:運用要求の正本
|
|
30
29
|
- `nfr-index`:NFR全体の入口
|
|
31
30
|
- `opd-*` / `opr-*`:運用方針・運用手順
|
|
32
31
|
- `sac-*`:運用要件の受入判定
|
|
33
32
|
|
|
34
|
-
### 2.2. 用語定義
|
|
35
|
-
|
|
36
|
-
| 用語 | 定義 |
|
|
37
|
-
| ------------ | -------------------------------------------- |
|
|
38
|
-
| 運用性 | 監視・保守・障害対応を継続的に実行できる性質 |
|
|
39
|
-
| MTTD | 平均検知時間 |
|
|
40
|
-
| 手動介入条件 | 自動処理から運用判断へ切り替える条件 |
|
|
41
|
-
|
|
42
33
|
## 3. ファイル命名・ID規則
|
|
43
34
|
|
|
44
35
|
- ルールドキュメントIDは `specdojo:nfr-operations-rulebook`。
|
|
45
36
|
- 生成対象ドキュメントIDは `nfr-operations` を推奨する。
|
|
37
|
+
- 配置先は `docs/ja/product/060-non-functional-requirements/nfr-operations.md` を推奨する。
|
|
46
38
|
- 要件IDは `nfr-ops-<連番>` を推奨する。
|
|
47
39
|
|
|
48
40
|
## 4. 推奨 Frontmatter 項目
|
|
49
41
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml](../../../specdojo/schemas/v1/deliverable-frontmatter.schema.yaml) / [document-metadata-standard.md](../standards/document-metadata-standard.md))。
|
|
42
|
+
許可キー・必須項目・型制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とする。
|
|
53
43
|
|
|
54
|
-
| 項目
|
|
55
|
-
|
|
|
56
|
-
| id
|
|
57
|
-
| type
|
|
58
|
-
|
|
|
59
|
-
|
|
|
60
|
-
| part_of | `nfr-index` | 任意 |
|
|
61
|
-
|
|
62
|
-
### 4.2. 推奨ルール
|
|
63
|
-
|
|
64
|
-
- OPRに手順がある要件は、NFRでは達成基準のみを書く。
|
|
44
|
+
| 項目 | 説明 | 必須 |
|
|
45
|
+
| ---------- | ---------------------------------- | ---- |
|
|
46
|
+
| `id` | `nfr-operations` | ○ |
|
|
47
|
+
| `type` | `requirement` 固定 | ○ |
|
|
48
|
+
| `rulebook` | `specdojo:nfr-operations-rulebook` | ○ |
|
|
49
|
+
| `part_of` | `nfr-index` | 任意 |
|
|
65
50
|
|
|
66
51
|
## 5. 本文構成(標準テンプレ)
|
|
67
52
|
|
|
@@ -77,35 +62,27 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
77
62
|
|
|
78
63
|
## 6. 記述ガイド
|
|
79
64
|
|
|
80
|
-
|
|
65
|
+
生成する本文の見出しは「本文構成(標準テンプレ)」の番号と見出しをそのまま使う。
|
|
81
66
|
|
|
82
|
-
|
|
67
|
+
### 6.1. 概要(対象・目的)
|
|
83
68
|
|
|
84
69
|
- 監視・運用の目的と対象を示す。
|
|
85
70
|
|
|
86
71
|
### 6.2. 適用範囲・体制前提
|
|
87
72
|
|
|
88
|
-
生成する本文の見出しは **## 2. 適用範囲・体制前提**
|
|
89
|
-
|
|
90
73
|
- 監視時間、オンコール体制、通知経路を明記する。
|
|
91
74
|
|
|
92
75
|
### 6.3. 運用要件一覧
|
|
93
76
|
|
|
94
|
-
生成する本文の見出しは **## 3. 運用要件一覧**
|
|
95
|
-
|
|
96
77
|
- 表形式(`id` / `内容` / `指標` / `基準` / `備考`)で記述する。
|
|
97
78
|
- 指標例:MTTD、アラート誤検知率、バックアップ成功率。
|
|
98
79
|
|
|
99
80
|
### 6.4. 測定・検証方法
|
|
100
81
|
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
- 監視ダッシュボード、運用レポート、訓練結果で判定する。
|
|
82
|
+
- 要件 ID ごとに測定方法・判定タイミング・判定者を示す(監視ダッシュボード、運用レポート、訓練結果)。
|
|
104
83
|
|
|
105
84
|
### 6.5. 関連ドキュメント導線
|
|
106
85
|
|
|
107
|
-
生成する本文の見出しは **## 5. 関連ドキュメント導線**
|
|
108
|
-
|
|
109
86
|
- `opd-*`、`opr-*`、`sac-*`、`dec-*` への導線を記載する。
|
|
110
87
|
|
|
111
88
|
## 7. 禁止事項
|
|
@@ -118,26 +95,22 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
118
95
|
|
|
119
96
|
## 8. サンプル
|
|
120
97
|
|
|
121
|
-
|
|
98
|
+
注:以下はルール文書内の最小例です。生成する `nfr-operations` では `## 1...` から始まります。
|
|
122
99
|
|
|
123
100
|
```yaml
|
|
124
101
|
---
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
status: draft
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
supersedes: []
|
|
102
|
+
specdojo:
|
|
103
|
+
id: nfr-operations
|
|
104
|
+
type: requirement
|
|
105
|
+
status: draft
|
|
106
|
+
rulebook: specdojo:nfr-operations-rulebook
|
|
107
|
+
part_of: [nfr-index]
|
|
132
108
|
---
|
|
133
109
|
```
|
|
134
110
|
|
|
135
111
|
### 8.1. 概要(対象・目的)(例)
|
|
136
112
|
|
|
137
|
-
本書は、GCS
|
|
138
|
-
非機能要件を定義する。
|
|
139
|
-
平常時の監視と異常時の対応が継続的に実行可能であることを基準化し、
|
|
140
|
-
運用品質の維持・改善を目的とする。
|
|
113
|
+
本書は、GCS 基幹システムの運用要件を定義する。
|
|
141
114
|
|
|
142
115
|
### 8.2. 適用範囲・体制前提(例)
|
|
143
116
|
|
|
@@ -147,33 +120,22 @@ supersedes: []
|
|
|
147
120
|
| 監視時間 | 24 時間 365 日 |
|
|
148
121
|
| オンコール体制 | SRE 2 名(交代)・営業時間外はアラート待機 |
|
|
149
122
|
| 通知経路 | PagerDuty → Slack → 電話エスカレーション |
|
|
150
|
-
| 監視基盤 | Datadog(APM / Logs / Metrics) |
|
|
151
123
|
|
|
152
124
|
### 8.3. 運用要件一覧(例)
|
|
153
125
|
|
|
154
|
-
| id | 内容 | 指標 | 基準
|
|
155
|
-
| ----------- | -------------------------------------------------- | -------------- |
|
|
156
|
-
| nfr-ops-001 | 重大障害は基準時間内に検知する | MTTD | 10 分以内
|
|
157
|
-
| nfr-ops-002 | 日次バックアップは成功を維持する | 成功率 | 99.5% 以上
|
|
158
|
-
| nfr-ops-
|
|
159
|
-
| nfr-ops-004 | P1 障害の通知が基準時間内に届くこと | 通知到達時間 | 5 分以内 | PagerDuty → Slack |
|
|
160
|
-
| nfr-ops-005 | Runbook は全重要サービスに対して整備されていること | Runbook 網羅率 | 100% | 重要サービス=受注・在庫・会計 |
|
|
161
|
-
| nfr-ops-006 | 障害訓練を定期的に実施すること | 訓練実施頻度 | 四半期 1 回以上 | GameDay 形式 |
|
|
162
|
-
| nfr-ops-007 | デプロイは自動化され、手動介入なく完了すること | 自動デプロイ率 | 100% | カナリア + 自動ロールバック |
|
|
163
|
-
| nfr-ops-008 | ログ保持期間は基準以上を維持すること | ログ保持期間 | 90 日以上 | アーカイブ: 1 年 |
|
|
126
|
+
| id | 内容 | 指標 | 基準 | 備考 |
|
|
127
|
+
| ----------- | -------------------------------------------------- | -------------- | ---------- | ------------------------------ |
|
|
128
|
+
| nfr-ops-001 | 重大障害は基準時間内に検知する | MTTD | 10 分以内 | 24/365 |
|
|
129
|
+
| nfr-ops-002 | 日次バックアップは成功を維持する | 成功率 | 99.5% 以上 | 失敗時は自動再試行 |
|
|
130
|
+
| nfr-ops-005 | Runbook は全重要サービスに対して整備されていること | Runbook 網羅率 | 100% | 重要サービス=受注・在庫・会計 |
|
|
164
131
|
|
|
165
132
|
### 8.4. 測定・検証方法(例)
|
|
166
133
|
|
|
167
|
-
| 要件ID | 測定方法 | 判定タイミング | 判定者
|
|
168
|
-
| ----------- | -------------------------------------------------- | ---------------- |
|
|
169
|
-
| nfr-ops-001 | 監視アラート発報から検知までの時間を計測 | 障害事後レビュー | SRE
|
|
170
|
-
| nfr-ops-002 | バックアップジョブ監視ダッシュボードで成功率を集計 | 日次確認 | Ops
|
|
171
|
-
| nfr-ops-
|
|
172
|
-
| nfr-ops-004 | PagerDuty の通知到達ログから確認 | 障害事後レビュー | SRE |
|
|
173
|
-
| nfr-ops-005 | Runbook 一覧とサービス一覧の突合 | 四半期レビュー | SRE / PM |
|
|
174
|
-
| nfr-ops-006 | 障害訓練実施記録と振り返りレポート | 四半期実施確認 | SRE / PM |
|
|
175
|
-
| nfr-ops-007 | CI/CD パイプラインの手動ステップ有無を確認 | 四半期レビュー | テックリード |
|
|
176
|
-
| nfr-ops-008 | ログ保持ポリシーと実際の保持日数を確認 | 四半期監査 | SRE / DBA |
|
|
134
|
+
| 要件ID | 測定方法 | 判定タイミング | 判定者 |
|
|
135
|
+
| ----------- | -------------------------------------------------- | ---------------- | -------- |
|
|
136
|
+
| nfr-ops-001 | 監視アラート発報から検知までの時間を計測 | 障害事後レビュー | SRE |
|
|
137
|
+
| nfr-ops-002 | バックアップジョブ監視ダッシュボードで成功率を集計 | 日次確認 | Ops |
|
|
138
|
+
| nfr-ops-005 | Runbook 一覧とサービス一覧の突合 | 四半期レビュー | SRE / PM |
|
|
177
139
|
|
|
178
140
|
### 8.5. 関連ドキュメント導線(例)
|
|
179
141
|
|
|
@@ -21,24 +21,15 @@ Non-Functional Requirements Performance Documentation Rules
|
|
|
21
21
|
- 性能は応答時間・スループット・同時実行数の観点で定義する。
|
|
22
22
|
- 条件(負荷・時間帯・データ量)を明示し、再現可能にする。
|
|
23
23
|
- 平均値より P95/P99 等の分位値を優先して評価する。
|
|
24
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。文書の整形・lint はリポジトリの検証で扱い、性能の測定・検証に含めない。
|
|
24
25
|
|
|
25
|
-
## 2.
|
|
26
|
-
|
|
27
|
-
### 2.1. 位置づけ
|
|
26
|
+
## 2. 位置づけ
|
|
28
27
|
|
|
29
28
|
- `nfr-performance`:性能要求の正本
|
|
30
29
|
- `nfr-index`:NFR全体の入口
|
|
31
30
|
- `sac-*` / `stc-*`:性能受入・試験仕様
|
|
32
31
|
- `opd-*`:運用時監視閾値
|
|
33
32
|
|
|
34
|
-
### 2.2. 用語定義
|
|
35
|
-
|
|
36
|
-
| 用語 | 定義 |
|
|
37
|
-
| -------- | --------------------------------- |
|
|
38
|
-
| P95/P99 | 応答時間分布の95/99パーセンタイル |
|
|
39
|
-
| RPS | 秒間処理件数 |
|
|
40
|
-
| ピーク時 | 事前合意した高負荷条件 |
|
|
41
|
-
|
|
42
33
|
## 3. ファイル命名・ID規則
|
|
43
34
|
|
|
44
35
|
- ルールドキュメントIDは `specdojo:nfr-performance-rulebook`。
|
|
@@ -49,15 +40,9 @@ Non-Functional Requirements Performance Documentation Rules
|
|
|
49
40
|
|
|
50
41
|
### 4.1. 設定内容
|
|
51
42
|
|
|
52
|
-
|
|
43
|
+
許可キー・必須項目・型制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とする。
|
|
53
44
|
|
|
54
|
-
|
|
55
|
-
| ------- | -------------------------------- | ---- |
|
|
56
|
-
| id | `nfr-performance` | ○ |
|
|
57
|
-
| type | `requirement` 固定 | ○ |
|
|
58
|
-
| title | 非機能要件: 性能 | ○ |
|
|
59
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
60
|
-
| part_of | `nfr-index` | 任意 |
|
|
45
|
+
- `specdojo.id` は `nfr-performance`、`specdojo.type` は `requirement`、`specdojo.rulebook` は `specdojo:nfr-performance-rulebook`、任意の `specdojo.part_of` は `nfr-index` とする。
|
|
61
46
|
|
|
62
47
|
### 4.2. 推奨ルール
|
|
63
48
|
|
|
@@ -68,13 +53,16 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
68
53
|
|
|
69
54
|
`nfr-performance` は以下の見出し構成を **順序固定** で配置する。
|
|
70
55
|
|
|
71
|
-
| 番号 | 見出し | 必須
|
|
72
|
-
| ---- | -------------------- |
|
|
73
|
-
| 1 | 概要(対象・目的) | ○
|
|
74
|
-
| 2 | 適用範囲・負荷条件 | ○
|
|
75
|
-
| 3 | 性能要件一覧 | ○
|
|
76
|
-
| 4 | 測定・検証方法 | ○
|
|
77
|
-
| 5 | 関連ドキュメント導線 | ○
|
|
56
|
+
| 番号 | 見出し | 必須 |
|
|
57
|
+
| ---- | -------------------- | -------- |
|
|
58
|
+
| 1 | 概要(対象・目的) | ○ |
|
|
59
|
+
| 2 | 適用範囲・負荷条件 | ○ |
|
|
60
|
+
| 3 | 性能要件一覧 | ○ |
|
|
61
|
+
| 4 | 測定・検証方法 | ○ |
|
|
62
|
+
| 5 | 関連ドキュメント導線 | ○ |
|
|
63
|
+
| 6 | 未決事項 | 条件付き |
|
|
64
|
+
|
|
65
|
+
「未決事項」は未確定の負荷条件・基準値・測定手段があるときだけ置く(空の章を作らせないため)。
|
|
78
66
|
|
|
79
67
|
## 6. 記述ガイド
|
|
80
68
|
|
|
@@ -88,7 +76,7 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
88
76
|
|
|
89
77
|
生成する本文の見出しは **## 2. 適用範囲・負荷条件**
|
|
90
78
|
|
|
91
|
-
- 同時接続数、RPS
|
|
79
|
+
- 同時接続数、RPS(秒間処理件数)、データ量、時間帯を明記する。ピーク時は事前に合意した高負荷条件とする。
|
|
92
80
|
|
|
93
81
|
### 6.3. 性能要件一覧
|
|
94
82
|
|
|
@@ -101,7 +89,8 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
101
89
|
|
|
102
90
|
生成する本文の見出しは **## 4. 測定・検証方法**
|
|
103
91
|
|
|
104
|
-
-
|
|
92
|
+
- 要件IDごとに測定方法・判定タイミング・合格条件を示し、負荷試験と運用監視の双方で判定できる形にする。
|
|
93
|
+
- 合格条件は「性能要件一覧」の基準を参照し、ここで基準値を言い直さない。
|
|
105
94
|
|
|
106
95
|
### 6.5. 関連ドキュメント導線
|
|
107
96
|
|
|
@@ -109,6 +98,14 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
109
98
|
|
|
110
99
|
- `sac-*`、`stc-*`、`opd-*`、`dec-*` への導線を記載する。
|
|
111
100
|
|
|
101
|
+
### 6.6. 未決事項
|
|
102
|
+
|
|
103
|
+
生成する本文の見出しは **## 6. 未決事項**
|
|
104
|
+
|
|
105
|
+
- 未確定の項目は推測で確定せず、`_UNDECIDED_` を付して論点と影響(当面の扱い、決まったときに直す要件ID)を書く。管理台帳の区分・担当・判断時期の列は設けない。
|
|
106
|
+
- 良い例:「`_UNDECIDED_`: ピーク時の同時接続数(販促の規模が未定)。当面は平常時の 5 倍で試験し、決まったら `nfr-perf-002` の基準を見直す。」
|
|
107
|
+
- 悪い例:未定のピーク条件を推測値のまま確定基準として書く。
|
|
108
|
+
|
|
112
109
|
## 7. 禁止事項
|
|
113
110
|
|
|
114
111
|
| 禁止事項 | 理由 |
|
|
@@ -119,68 +116,29 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
119
116
|
|
|
120
117
|
## 8. サンプル
|
|
121
118
|
|
|
122
|
-
|
|
119
|
+
注:以下は形式の輪郭を示す最小例である。生成する `nfr-performance` では `## 1...` から始まる。
|
|
123
120
|
|
|
124
121
|
```yaml
|
|
125
122
|
---
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
status: draft
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
supersedes: []
|
|
123
|
+
specdojo:
|
|
124
|
+
id: nfr-performance
|
|
125
|
+
type: requirement
|
|
126
|
+
status: draft
|
|
127
|
+
rulebook: specdojo:nfr-performance-rulebook
|
|
128
|
+
part_of: [nfr-index]
|
|
133
129
|
---
|
|
134
130
|
```
|
|
135
131
|
|
|
136
|
-
### 8.1.
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
### 8.2.
|
|
144
|
-
|
|
145
|
-
|
|
|
146
|
-
| ------------ |
|
|
147
|
-
|
|
|
148
|
-
|
|
|
149
|
-
| ピーク時負荷 | 100 RPS・同時接続 1,000(16–18 時台) |
|
|
150
|
-
| データ量前提 | 受注テーブル 500 万件・在庫テーブル 300 万件 |
|
|
151
|
-
| バッチ前提 | 日次売上集計対象約 10 万件 |
|
|
152
|
-
| 除外条件 | 外部 PSP / 物流 API の応答遅延は指標対象外 |
|
|
153
|
-
|
|
154
|
-
### 8.3. 性能要件一覧(例)
|
|
155
|
-
|
|
156
|
-
| id | 内容 | 指標 | 基準 | 備考 |
|
|
157
|
-
| ------------ | ----------------------------------------------- | -------------------- | ---------------- | -------------------- |
|
|
158
|
-
| nfr-perf-001 | 在庫照会 API は平常時に応答時間を満たす | 応答時間(P95) | 500 ms 以内 | 20 RPS |
|
|
159
|
-
| nfr-perf-002 | 会計確定 API はピーク時に基準を満たす | 応答時間(P95)/ RPS | 800 ms / 100 RPS | 16–18 時相当 |
|
|
160
|
-
| nfr-perf-003 | 受注一覧検索は P99 で基準内 | 応答時間(P99) | 2,000 ms 以内 | 複合検索条件 |
|
|
161
|
-
| nfr-perf-004 | 日次売上集計バッチは基準時間内に完了する | バッチ完了時間 | 60 分以内 | 対象 10 万件 |
|
|
162
|
-
| nfr-perf-005 | DB コネクションプール使用率はピーク時でも基準内 | プール使用率 | 80% 以下 | コネクション枯渇防止 |
|
|
163
|
-
| nfr-perf-006 | フロントエンドの初回表示は基準時間内 | LCP | 2.5 秒以内 | Core Web Vitals 準拠 |
|
|
164
|
-
| nfr-perf-007 | イベントバスのスループットは基準以上 | メッセージ処理速度 | 500 msg/s 以上 | 非同期メッセージ基盤 |
|
|
165
|
-
|
|
166
|
-
### 8.4. 測定・検証方法(例)
|
|
167
|
-
|
|
168
|
-
| 要件ID | 測定方法 | 判定タイミング | 判定者 |
|
|
169
|
-
| ------------ | ---------------------------------------------------- | ---------------- | --------- |
|
|
170
|
-
| nfr-perf-001 | 負荷試験(k6 / Gatling)で P95 を計測 | リリース前試験 | QA / SRE |
|
|
171
|
-
| nfr-perf-002 | ピーク負荷シナリオで P95 および RPS を計測 | リリース前試験 | QA / SRE |
|
|
172
|
-
| nfr-perf-003 | APM ダッシュボードで P99 を監視 | リアルタイム監視 | SRE |
|
|
173
|
-
| nfr-perf-004 | バッチジョブ監視ダッシュボードで完了時間を計測 | 日次確認 | Ops / SRE |
|
|
174
|
-
| nfr-perf-005 | DB 監視エージェントでプール使用率を取得 | リアルタイム監視 | SRE |
|
|
175
|
-
| nfr-perf-006 | Lighthouse CI で LCP を計測 | merge 毎 | フロント |
|
|
176
|
-
| nfr-perf-007 | メッセージブローカーモニタリングでスループットを確認 | リアルタイム監視 | SRE |
|
|
177
|
-
|
|
178
|
-
### 8.5. 関連ドキュメント導線(例)
|
|
179
|
-
|
|
180
|
-
| 種別 | ドキュメントID | 目的 | 備考 |
|
|
181
|
-
| ------------ | -------------- | -------------------------- | ---- |
|
|
182
|
-
| NFR 入口 | nfr-index | 非機能要件全体の俯瞰 | 必須 |
|
|
183
|
-
| 受入条件 | sac-\* | 性能要件の合否判定基準 | 必須 |
|
|
184
|
-
| システム試験 | stc-\* | 負荷試験・性能回帰試験 | 必須 |
|
|
185
|
-
| 運用設計 | opd-\* | 監視閾値・アラート設計 | 必須 |
|
|
186
|
-
| 判断記録 | dec-\* | 性能に関する設計判断の追跡 | 任意 |
|
|
132
|
+
### 8.1. 性能要件一覧(例)
|
|
133
|
+
|
|
134
|
+
| id | 内容 | 指標 | 基準 | 備考 |
|
|
135
|
+
| ------------ | --------------------------------------- | -------------------- | ---------------- | ------------ |
|
|
136
|
+
| nfr-perf-001 | 在庫照会 API は平常時に応答時間を満たす | 応答時間(P95) | 500 ms 以内 | 20 RPS |
|
|
137
|
+
| nfr-perf-002 | 会計確定 API はピーク時に基準を満たす | 応答時間(P95)/ RPS | 800 ms / 100 RPS | 16–18 時相当 |
|
|
138
|
+
|
|
139
|
+
### 8.2. 測定・検証方法(例)
|
|
140
|
+
|
|
141
|
+
| 要件ID | 測定方法 | 判定タイミング | 合格条件 |
|
|
142
|
+
| ------------ | -------------------------------------- | -------------- | -------------------------- |
|
|
143
|
+
| nfr-perf-001 | 負荷試験(k6)で P95 を計測 | リリース前試験 | 一覧の基準を満たす |
|
|
144
|
+
| nfr-perf-002 | ピーク負荷シナリオで P95 と RPS を計測 | リリース前試験 | ピーク時間帯に基準を満たす |
|
|
@@ -21,49 +21,27 @@ Non-Functional Requirements Reliability Documentation Rules
|
|
|
21
21
|
- 信頼性は「壊れにくさ」と「壊れた時の影響最小化」を要求として定義する。
|
|
22
22
|
- 要件は対象・条件・指標・基準を明示し、合否判定可能にする。
|
|
23
23
|
- 設計/実装手順ではなく、結果として満たす品質基準を書く。
|
|
24
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、本書と成果物で言い直さない。文書の整形・lint はリポジトリの検証で扱い、「測定・検証方法」に含めない。
|
|
24
25
|
|
|
25
|
-
## 2.
|
|
26
|
-
|
|
27
|
-
### 2.1. 位置づけ
|
|
26
|
+
## 2. 位置づけ
|
|
28
27
|
|
|
29
28
|
- `nfr-reliability`:信頼性要求の正本
|
|
30
29
|
- `nfr-index`:NFR全体の入口
|
|
31
30
|
- `sac-*` / `stc-*`:信頼性要件の検証先
|
|
32
31
|
- `opd-*` / `opr-*`:障害時運用方針・手順
|
|
33
32
|
|
|
34
|
-
### 2.2. 用語定義
|
|
35
|
-
|
|
36
|
-
| 用語 | 定義 |
|
|
37
|
-
| ------ | -------------------------------------------- |
|
|
38
|
-
| 信頼性 | 障害・誤動作を抑え、継続稼働を維持できる性質 |
|
|
39
|
-
| 障害率 | 処理失敗・異常終了の発生割合 |
|
|
40
|
-
| MTBF | 平均故障間隔 |
|
|
41
|
-
|
|
42
33
|
## 3. ファイル命名・ID規則
|
|
43
34
|
|
|
44
|
-
- ルールドキュメントIDは `specdojo:nfr-reliability-rulebook`。
|
|
45
35
|
- 生成対象ドキュメントIDは `nfr-reliability` を推奨する。
|
|
46
36
|
- 要件IDは `nfr-rel-<連番>`(例: `nfr-rel-001`)を推奨する。
|
|
47
37
|
|
|
48
38
|
## 4. 推奨 Frontmatter 項目
|
|
49
39
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml](../../../specdojo/schemas/v1/deliverable-frontmatter.schema.yaml) / [document-metadata-standard.md](../standards/document-metadata-standard.md))。
|
|
40
|
+
許可キー・必須項目・型制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とする。
|
|
53
41
|
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
| type | `requirement` 固定 | ○ |
|
|
58
|
-
| title | 非機能要件: 信頼性 | ○ |
|
|
59
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
60
|
-
| part_of | `nfr-index` | 任意 |
|
|
61
|
-
| based_on | 根拠仕様ID | 任意 |
|
|
62
|
-
|
|
63
|
-
### 4.2. 推奨ルール
|
|
64
|
-
|
|
65
|
-
- `part_of` は分冊運用時に `nfr-index` を設定する。
|
|
66
|
-
- `based_on` には障害履歴・業務重要度を示す仕様を列挙する。
|
|
42
|
+
- `specdojo.type` は `requirement`、`specdojo.rulebook` は `specdojo:nfr-reliability-rulebook` とする。
|
|
43
|
+
- `specdojo.part_of` は分冊運用時に `nfr-index` を設定する。
|
|
44
|
+
- `specdojo.based_on` には障害履歴・業務重要度を示す仕様を列挙する。
|
|
67
45
|
|
|
68
46
|
## 5. 本文構成(標準テンプレ)
|
|
69
47
|
|
|
@@ -81,33 +59,23 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
81
59
|
|
|
82
60
|
### 6.1. 概要(対象・目的)
|
|
83
61
|
|
|
84
|
-
生成する本文の見出しは **## 1. 概要(対象・目的)**
|
|
85
|
-
|
|
86
62
|
- 業務継続に対する信頼性要求の目的を 1〜3文で示す。
|
|
87
63
|
|
|
88
64
|
### 6.2. 適用範囲・前提条件
|
|
89
65
|
|
|
90
|
-
生成する本文の見出しは **## 2. 適用範囲・前提条件**
|
|
91
|
-
|
|
92
66
|
- 対象システム、対象時間帯、除外条件(計画停止など)を明記する。
|
|
93
67
|
|
|
94
68
|
### 6.3. 信頼性要件一覧
|
|
95
69
|
|
|
96
|
-
生成する本文の見出しは **## 3. 信頼性要件一覧**
|
|
97
|
-
|
|
98
70
|
- 要件は表形式(`id` / `内容` / `指標` / `基準` / `備考`)で記載する。
|
|
99
|
-
-
|
|
71
|
+
- 指標例:障害率(処理失敗・異常終了の発生割合)、MTBF(平均故障間隔)、再試行成功率。
|
|
100
72
|
|
|
101
73
|
### 6.4. 測定・検証方法
|
|
102
74
|
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
- 監視・テスト・レビューのどこで判定するかを明記する。
|
|
75
|
+
- 要件IDごとに、監視・テスト・レビューのどこで、いつ、誰が判定するかを明記する。
|
|
106
76
|
|
|
107
77
|
### 6.5. 関連ドキュメント導線
|
|
108
78
|
|
|
109
|
-
生成する本文の見出しは **## 5. 関連ドキュメント導線**
|
|
110
|
-
|
|
111
79
|
- `nfr-index`、`sac-*`、`opd-*`、`opr-*`、`dec-*` への導線を置く。
|
|
112
80
|
|
|
113
81
|
## 7. 禁止事項
|
|
@@ -120,68 +88,47 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
120
88
|
|
|
121
89
|
## 8. サンプル
|
|
122
90
|
|
|
123
|
-
|
|
91
|
+
形式の輪郭を示す最小例である。完成例は Frontmatter の `sample` で宣言された sample を正とする。
|
|
124
92
|
|
|
125
|
-
```
|
|
93
|
+
```markdown
|
|
126
94
|
---
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
status: draft
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
95
|
+
specdojo:
|
|
96
|
+
id: nfr-reliability
|
|
97
|
+
type: requirement
|
|
98
|
+
status: draft
|
|
99
|
+
rulebook: specdojo:nfr-reliability-rulebook
|
|
100
|
+
part_of:
|
|
101
|
+
- nfr-index
|
|
134
102
|
---
|
|
135
|
-
```
|
|
136
103
|
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
|
147
|
-
|
|
|
148
|
-
|
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
|
160
|
-
|
|
|
161
|
-
| nfr-rel-
|
|
162
|
-
| nfr-rel-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
| 要件ID | 測定方法 | 判定タイミング | 判定者 |
|
|
169
|
-
| ----------- | ---------------------------------------------- | ---------------- | -------- |
|
|
170
|
-
| nfr-rel-001 | APM ダッシュボードで月次障害率を集計 | 月次運用レビュー | SRE |
|
|
171
|
-
| nfr-rel-002 | 再試行ログから成功率を算出 | 月次運用レビュー | SRE |
|
|
172
|
-
| nfr-rel-003 | ITS 再実行テストケースで検証 | リリース前試験 | QA |
|
|
173
|
-
| nfr-rel-004 | 重複メッセージ検知アラートのカウント | リアルタイム監視 | SRE |
|
|
174
|
-
| nfr-rel-005 | インシデント記録から MTBF を計算 | 四半期レビュー | SRE / PM |
|
|
175
|
-
| nfr-rel-006 | DLQ モニタリングダッシュボード | リアルタイム監視 | Ops |
|
|
176
|
-
| nfr-rel-007 | ログ監査スクリプトで必須フィールドの欠落を検出 | CI / 月次監査 | QA / SRE |
|
|
177
|
-
|
|
178
|
-
### 8.5. 関連ドキュメント導線(例)
|
|
179
|
-
|
|
180
|
-
| 種別 | ドキュメントID | 目的 | 備考 |
|
|
181
|
-
| ------------ | -------------- | ---------------------------- | ---- |
|
|
182
|
-
| NFR 入口 | nfr-index | 非機能要件全体の俯瞰 | 必須 |
|
|
183
|
-
| 受入条件 | sac-\* | 信頼性要件の合否判定基準 | 必須 |
|
|
184
|
-
| システム試験 | stc-\* | 信頼性観点の E2E 試験 | 必須 |
|
|
185
|
-
| 運用設計 | opd-\* | 監視閾値・アラート設計 | 必須 |
|
|
186
|
-
| 運用手順 | opr-\* | DLQ 対応・再実行手順 | 必須 |
|
|
187
|
-
| 判断記録 | dec-\* | 信頼性に関する設計判断の追跡 | 任意 |
|
|
104
|
+
# 非機能要件: 信頼性
|
|
105
|
+
|
|
106
|
+
## 1. 概要(対象・目的)
|
|
107
|
+
|
|
108
|
+
販売管理システムの障害率と復旧性を測定可能な基準で管理し、営業時間中の販売を止めない。
|
|
109
|
+
|
|
110
|
+
## 2. 適用範囲・前提条件
|
|
111
|
+
|
|
112
|
+
| 項目 | 内容 |
|
|
113
|
+
| ------------ | ------------------------------ |
|
|
114
|
+
| 対象システム | 販売管理システム(レジ・在庫) |
|
|
115
|
+
| 対象時間帯 | 営業時間(計画停止を除く) |
|
|
116
|
+
|
|
117
|
+
## 3. 信頼性要件一覧
|
|
118
|
+
|
|
119
|
+
| id | 内容 | 指標 | 基準 | 備考 |
|
|
120
|
+
| ----------- | -------------------------------------- | ------------ | -------------- | ---------------- |
|
|
121
|
+
| nfr-rel-001 | 会計処理は障害率を基準内に保つ | 障害率 | 月次 0.1% 以下 | 対象外: 計画停止 |
|
|
122
|
+
| nfr-rel-002 | 障害発生時に自動再試行で復旧できること | 再試行成功率 | 95% 以上 | 3回まで再試行 |
|
|
123
|
+
|
|
124
|
+
## 4. 測定・検証方法
|
|
125
|
+
|
|
126
|
+
| 要件ID | 測定方法 | 判定タイミング | 判定者 |
|
|
127
|
+
| ----------- | ---------------------------- | -------------- | ------ |
|
|
128
|
+
| nfr-rel-001 | 障害ログから月次障害率を集計 | 月次レビュー | SRE |
|
|
129
|
+
| nfr-rel-002 | 再試行ログから成功率を算出 | 月次レビュー | SRE |
|
|
130
|
+
|
|
131
|
+
## 5. 関連ドキュメント導線
|
|
132
|
+
|
|
133
|
+
- `nfr-index`(必須)、`sac-*`(必須)、`opr-*`(必須)、`dec-*`(任意)
|
|
134
|
+
```
|