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
|
@@ -7,7 +7,7 @@ specdojo:
|
|
|
7
7
|
target_format: markdown
|
|
8
8
|
recipe: undecided
|
|
9
9
|
sample:
|
|
10
|
-
- specdojo:opd-sample
|
|
10
|
+
- specdojo:opd-index-sample
|
|
11
11
|
- specdojo:opd-access-control-sample
|
|
12
12
|
- specdojo:opd-incident-management-sample
|
|
13
13
|
- specdojo:opd-monitoring-sample
|
|
@@ -18,193 +18,125 @@ specdojo:
|
|
|
18
18
|
|
|
19
19
|
Operations Policy and Design (OPD) Documentation Rules
|
|
20
20
|
|
|
21
|
-
|
|
22
|
-
切替後の恒常運用を「あるべき姿」として定義し、運用品質(SLO/SLA・責任分界・統制)を SSOT 化するための内容を定義します。
|
|
21
|
+
切替後の恒常運用の「あるべき姿」(SLO/SLA・責任分界・統制)を、運用方針・設計(`opd-index` / `opd-<term>`)に定義する基準を定めます。
|
|
23
22
|
|
|
24
23
|
## 1. 全体方針
|
|
25
24
|
|
|
26
25
|
`opd-index`(必要に応じて `opd-<term>`)は、恒常運用の方針と統制基準を一元化する SSOT とする。
|
|
27
26
|
|
|
28
27
|
- 運用の範囲・前提を明示し、責務境界を曖昧にしない
|
|
29
|
-
-
|
|
30
|
-
- 体制・責任分界(RACI/当番/エスカレーション)を明確化する
|
|
31
|
-
- 監視・障害対応・変更管理・バックアップ方針を統一する
|
|
32
|
-
- 問い合わせ運用と関連ドキュメント導線を維持する
|
|
28
|
+
- **共通の運用**: 役割は適用先のメンバー定義、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。文書の整形・lint はリポジトリの検証で扱い、運用方針の受入条件に含めない。
|
|
33
29
|
|
|
34
30
|
### 1.1. index / term 分割方針
|
|
35
31
|
|
|
36
|
-
- 原則 `opd-index`
|
|
37
|
-
- `opd-<term>`
|
|
38
|
-
- `opd-<term>` を追加する場合でも、共通の統制(SLO/SLA/KPI、責任分界、変更管理レベル、バックアップ原則など)は `opd-index` を正とする
|
|
39
|
-
- `opd-<term>` では、原則として **`opd-index` との差分(補足・具体化・例外)** を記述し、全体方針の重複記載を避ける
|
|
32
|
+
- 原則 `opd-index` を作成して入口とし、`opd-<term>` は運用ドメイン(監視/障害対応/権限等)を分冊した方が維持しやすい場合に追加する
|
|
33
|
+
- 共通の統制(SLO/SLA/KPI、責任分界、変更管理レベル、バックアップ原則など)は `opd-index` を正とし、`opd-<term>` には **`opd-index` との差分(補足・具体化・例外)** だけを書く
|
|
40
34
|
|
|
41
35
|
## 2. 位置づけ
|
|
42
36
|
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
- **`opd-index` / `opd-<term>`:恒常運用の方針・統制の SSOT(SLO/SLA・責任分界・統制基準を含む)**
|
|
46
|
-
- `opr-index` / `opr-<term>`:運用手順・Runbook(実行手順の詳細)
|
|
47
|
-
- OPD は「方針と統制(あるべき姿・判断基準)」、OPR は「手順と証跡(再現可能な作業)」を責務とする
|
|
37
|
+
- **`opd-index` / `opd-<term>`**: 恒常運用の方針と統制(あるべき姿・判断基準)の SSOT
|
|
38
|
+
- `opr-index` / `opr-<term>`: 運用手順・Runbook。手順と証跡(再現可能な作業)を責務とする
|
|
48
39
|
|
|
49
40
|
## 3. ファイル命名・ID規則
|
|
50
41
|
|
|
51
42
|
- `id` は `opd-index` または `opd-<term>`(kebab-case。例: `opd-monitoring`)。
|
|
52
|
-
-
|
|
53
|
-
|
|
54
|
-
- 並び順が必要な場合は接頭辞の番号付与(例: `opd-010-...`)を **任意** で用いてよい
|
|
55
|
-
- `<term>` は用語集(GL)の論理名キー(英小文字kebab-case)を用いる(表示名は title / ファイル名で日本語を使用してよい)。
|
|
43
|
+
- `<term>` は用語集(GL)の論理名キー(英小文字kebab-case)を用いる。
|
|
44
|
+
- ファイル名はプロジェクト内で一意にする(日本語可。例: `運用方針・設計-監視.md`)。
|
|
56
45
|
|
|
57
46
|
## 4. 推奨 Frontmatter 項目
|
|
58
47
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
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))。
|
|
62
|
-
|
|
63
|
-
| 項目 | 説明 | 必須 |
|
|
64
|
-
| ---------- | -------------------------------------------- | ---- |
|
|
65
|
-
| id | OPD ID(`opd-index` または `opd-<term>`) | ○ |
|
|
66
|
-
| type | `operations` 固定 | ○ |
|
|
67
|
-
| title | 運用方針・設計: <対象名> | ○ |
|
|
68
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
69
|
-
| based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
|
|
70
|
-
| supersedes | 置き換え関係(ID配列。未指定は `[]` 可) | 任意 |
|
|
48
|
+
許可キー・必須項目・型は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
|
|
71
49
|
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
- `based_on` には恒常運用設計判断に直接利用した成果物(例: `nfr-*` / `sac-*` / `br-*` / `issue-*`)のみ列挙する
|
|
75
|
-
- OPD は OPR を参照してよいが、`based_on` には **運用判断の根拠** のみを載せる(手順書は導線で扱う)
|
|
76
|
-
- `based_on` / `supersedes` は ID 配列(未指定は `[]` 可)
|
|
50
|
+
- `specdojo.type` は `operations`、`specdojo.rulebook` は `specdojo:opd-rulebook` とする
|
|
51
|
+
- `based_on` には恒常運用の設計判断に直接利用した成果物(例: `nfr-*` / `sac-*` / `br-*` / `issue-*`)のみ列挙する。OPR は本文の導線で扱い、`based_on` に載せない
|
|
77
52
|
|
|
78
53
|
## 5. 本文構成(標準テンプレ)
|
|
79
54
|
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
| 番号 | 見出し |
|
|
83
|
-
| ---- | -------------------------------------------------- |
|
|
84
|
-
| 1 | 概要(`index` / `<term>`) |
|
|
85
|
-
| 2 | 運用の範囲・前提 |
|
|
86
|
-
| 3 | SLO・SLA・KPI |
|
|
87
|
-
| 4 | 体制・責任分界(RACI・当番・エスカレーション) |
|
|
88
|
-
| 5 | 監視・アラート方針(指標・閾値・通知先・初動) |
|
|
89
|
-
| 6 | 障害対応方針(優先度・停止判断・周知) |
|
|
90
|
-
| 7 | 変更管理(リリース・設定変更・承認・ロールバック) |
|
|
91
|
-
| 8 | バックアップ・リストア方針(RTO/RPO) |
|
|
92
|
-
| 9 | 権限・アカウント運用(棚卸し・監査ログ) |
|
|
93
|
-
| 10 | 定期運用方針(バッチ・点検) |
|
|
94
|
-
| 11 | 問い合わせ運用方針(窓口・分類・SLA) |
|
|
95
|
-
| 12 | 関連ドキュメント導線(`opr` 等) |
|
|
55
|
+
見出しは次の順序で配置します。`opd-<term>` の条件付きの章は、`opd-index` との差分がある章だけを置き、章番号は詰めます。
|
|
56
|
+
|
|
57
|
+
| 番号 | 見出し | `opd-index` | `opd-<term>` |
|
|
58
|
+
| ---- | -------------------------------------------------- | ----------- | ------------ |
|
|
59
|
+
| 1 | 概要(`index` / `<term>`) | 必須 | 必須 |
|
|
60
|
+
| 2 | 運用の範囲・前提 | 必須 | 条件付き |
|
|
61
|
+
| 3 | SLO・SLA・KPI | 必須 | 条件付き |
|
|
62
|
+
| 4 | 体制・責任分界(RACI・当番・エスカレーション) | 必須 | 条件付き |
|
|
63
|
+
| 5 | 監視・アラート方針(指標・閾値・通知先・初動) | 必須 | 条件付き |
|
|
64
|
+
| 6 | 障害対応方針(優先度・停止判断・周知) | 必須 | 条件付き |
|
|
65
|
+
| 7 | 変更管理(リリース・設定変更・承認・ロールバック) | 必須 | 条件付き |
|
|
66
|
+
| 8 | バックアップ・リストア方針(RTO/RPO) | 必須 | 条件付き |
|
|
67
|
+
| 9 | 権限・アカウント運用(棚卸し・監査ログ) | 必須 | 条件付き |
|
|
68
|
+
| 10 | 定期運用方針(バッチ・点検) | 必須 | 条件付き |
|
|
69
|
+
| 11 | 問い合わせ運用方針(窓口・分類・SLA) | 必須 | 条件付き |
|
|
70
|
+
| 12 | 関連ドキュメント導線(`opr` 等) | 必須 | 必須 |
|
|
71
|
+
|
|
72
|
+
`opd-<term>` の 2〜11 を条件付きとするのは、`opd-index` と同じ内容を分冊へ重複記載させないためです。`opd-<term>` は 2〜11 のうち少なくとも 1 章を置きます。
|
|
96
73
|
|
|
97
74
|
## 6. 記述ガイド
|
|
98
75
|
|
|
99
76
|
### 6.1. 概要(`index` / `<term>`)
|
|
100
77
|
|
|
101
|
-
生成する本文の見出しは **## 1. 概要(`index` / `<term>`)**
|
|
102
|
-
|
|
103
78
|
- 何を運用方針として定義するかを 1〜3 行で示す
|
|
104
|
-
- `opd-index`
|
|
105
|
-
- `opd-<term>` の場合は「`opd-index` の差分・補足である」ことを 1 行で明示する
|
|
79
|
+
- `opd-index` は恒常運用の SSOT であること、`opd-<term>` は `opd-index` の差分・補足であることを 1 行で明示する
|
|
106
80
|
|
|
107
81
|
### 6.2. 運用の範囲・前提
|
|
108
82
|
|
|
109
|
-
生成する本文の見出しは **## 2. 運用の範囲・前提**
|
|
110
|
-
|
|
111
83
|
- 対象システム、対象業務、対象時間帯、非対象範囲を明記する
|
|
112
84
|
- 前提制約(法令/契約/セキュリティ/組織体制)を明記する
|
|
113
85
|
|
|
114
86
|
### 6.3. SLO・SLA・KPI
|
|
115
87
|
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
- 可用性/応答時間/一次応答などの目標を定量で定義する
|
|
119
|
-
- 判定期間・測定方法・証跡・判定者を明記する
|
|
120
|
-
|
|
121
|
-
推奨フォーマット(表):
|
|
88
|
+
- 可用性/応答時間/一次応答などの目標を定量で定義し、判定期間・測定方法・証跡・判定者を明記する
|
|
122
89
|
|
|
123
90
|
| 指標 | 目標値 | 測定期間 | 測定方法 | 証跡 | 判定者 |
|
|
124
91
|
| ---- | ------ | -------- | -------- | ---- | ------ |
|
|
125
92
|
|
|
126
93
|
### 6.4. 体制・責任分界(RACI・当番・エスカレーション)
|
|
127
94
|
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
- RACI、当番体制、連絡系統を明記する
|
|
131
|
-
- 優先度別のエスカレーション条件(いつ・誰が・どこへ)を明記する
|
|
132
|
-
|
|
133
|
-
推奨フォーマット(表):
|
|
95
|
+
- RACI、当番体制、連絡系統と、優先度別のエスカレーション条件(いつ・誰が・どこへ)を明記する
|
|
134
96
|
|
|
135
97
|
| 対象 | R | A | C | I | 備考 |
|
|
136
98
|
| ---- | --- | --- | --- | --- | ---- |
|
|
137
99
|
|
|
138
100
|
### 6.5. 監視・アラート方針(指標・閾値・通知先・初動)
|
|
139
101
|
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
- 監視対象、閾値、通知先、初動ルールを明記する
|
|
143
|
-
- 誤検知/検知漏れ対策の運用方針を必要に応じて記載する
|
|
144
|
-
|
|
145
|
-
推奨フォーマット(表):
|
|
102
|
+
- 監視対象、閾値、通知先、初動ルールを明記する。誤検知/検知漏れ対策は必要に応じて書く
|
|
146
103
|
|
|
147
104
|
| 監視対象 | 指標/閾値 | 通知先 | 初動(誰が何をするか) | 備考 |
|
|
148
105
|
| -------- | --------- | ------ | ---------------------- | ---- |
|
|
149
106
|
|
|
150
107
|
### 6.6. 障害対応方針(優先度・停止判断・周知)
|
|
151
108
|
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
- 優先度分類(P1/P2/P3 等)と停止判断条件を明記する
|
|
155
|
-
- 周知対象・手段・タイミングを明記する
|
|
156
|
-
|
|
157
|
-
推奨フォーマット(表):
|
|
109
|
+
- 優先度分類(P1/P2/P3 等)と停止判断条件、周知対象・手段・タイミングを明記する
|
|
158
110
|
|
|
159
111
|
| 優先度 | 例 | 目標(一次応答/復旧) | 停止判断 | 周知 |
|
|
160
112
|
| ------ | --- | --------------------- | -------- | ---- |
|
|
161
113
|
|
|
162
114
|
### 6.7. 変更管理(リリース・設定変更・承認・ロールバック)
|
|
163
115
|
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
- 変更種別、承認フロー、実施条件(時間帯/凍結期間等)を明記する
|
|
167
|
-
- ロールバック条件と承認者を明記する
|
|
116
|
+
- 変更種別、承認フロー、実施条件(時間帯/凍結期間等)、ロールバック条件と承認者を明記する
|
|
168
117
|
|
|
169
118
|
### 6.8. バックアップ・リストア方針(RTO/RPO)
|
|
170
119
|
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
- バックアップ方式、保管先、保持期間を明記する
|
|
174
|
-
- RTO/RPO と復旧手順参照先を明記する(詳細手順は OPR に寄せる)
|
|
120
|
+
- バックアップ方式、保管先、保持期間、RTO/RPO と復旧手順の参照先を明記する(詳細手順は OPR に寄せる)
|
|
175
121
|
|
|
176
122
|
### 6.9. 権限・アカウント運用(棚卸し・監査ログ)
|
|
177
123
|
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
- 権限付与/剥奪ルール、棚卸し周期、監査ログ方針を明記する
|
|
181
|
-
- 緊急権限(ブレークグラス)の管理条件を明記する
|
|
124
|
+
- 権限付与/剥奪ルール、棚卸し周期、監査ログ方針、緊急権限(ブレークグラス)の管理条件を明記する
|
|
182
125
|
|
|
183
126
|
### 6.10. 定期運用方針(バッチ・点検)
|
|
184
127
|
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
- 定期バッチ、定期点検、実施責任者、証跡を明記する
|
|
188
|
-
- 未実施時のエスカレーション方針を明記する
|
|
128
|
+
- 定期バッチ、定期点検、実施責任者、証跡と、未実施時のエスカレーション方針を明記する
|
|
189
129
|
|
|
190
130
|
### 6.11. 問い合わせ運用方針(窓口・分類・SLA)
|
|
191
131
|
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
- 受付窓口、分類ルール、一次対応 SLA を明記する
|
|
195
|
-
- 連携先(開発/業務/運用)への引き継ぎ条件を明記する
|
|
132
|
+
- 受付窓口、分類ルール、一次対応 SLA と、連携先(開発/業務/運用)への引き継ぎ条件を明記する
|
|
196
133
|
|
|
197
134
|
### 6.12. 関連ドキュメント導線(`opr` 等)
|
|
198
135
|
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
- `opr-index` への導線を **必ず** 記載する
|
|
202
|
-
- `opr-<term>` がある場合は、該当する手順への導線を併記する
|
|
136
|
+
- `opr-index` への導線を **必ず** 記載し、`opr-<term>` がある場合は該当する手順への導線を併記する
|
|
203
137
|
- 分冊がない場合でも `(本書のみ)` または `(なし)` を明記する
|
|
204
138
|
- 移行ドキュメント(`mip-*` / `mtp-*` / `cop-*` / `otp-*`)は必要時のみ参考情報として記載する
|
|
205
139
|
|
|
206
|
-
推奨フォーマット(表):
|
|
207
|
-
|
|
208
140
|
| 種別 | ドキュメントID | 目的 | 備考 |
|
|
209
141
|
| ---- | -------------- | ---- | ---- |
|
|
210
142
|
|
|
@@ -218,4 +150,5 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
218
150
|
| 変更管理の承認/ロールバック条件を未定義にする | 変更統制が崩壊するため |
|
|
219
151
|
| バックアップ/リストア方針に RTO/RPO 観点を含めない | 復旧計画の実効性が担保できないため |
|
|
220
152
|
| 関連ドキュメント導線(`opr` 等)を省略する | 参照先が分散し、運用時に判断を誤るため |
|
|
153
|
+
| `opd-<term>` に `opd-index` と同じ統制を再掲する | 正本が二重になり、改訂時に食い違うため |
|
|
221
154
|
| 手順(コマンド/チェックリスト)を OPD に大量記載する | OPR と二重管理になり、更新不整合を起こすため |
|
|
@@ -5,77 +5,64 @@ specdojo:
|
|
|
5
5
|
deliverable_type: operations
|
|
6
6
|
status: draft
|
|
7
7
|
target_format: markdown
|
|
8
|
-
recipe:
|
|
8
|
+
recipe: not-needed
|
|
9
9
|
sample: specdojo:opr-index-sample
|
|
10
|
-
template:
|
|
10
|
+
template: not-needed
|
|
11
11
|
---
|
|
12
12
|
|
|
13
13
|
# 運用手順 全体構成 作成ルール
|
|
14
14
|
|
|
15
15
|
Operations Procedure Runbook Index Documentation Rules
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
運用者が作業と証跡を再現できる `opr-index` の記述基準を定める。
|
|
18
18
|
|
|
19
19
|
## 1. 全体方針
|
|
20
20
|
|
|
21
|
-
- `
|
|
22
|
-
-
|
|
23
|
-
-
|
|
21
|
+
- 実行手順と証跡の正本とし、方針・統制は `opd-*` に従う。
|
|
22
|
+
- 本文構成と記述ガイドで骨組み・記入基準が定まるため、別の recipe・template は不要とする。
|
|
23
|
+
- **共通の運用**: 役割は適用先のメンバー定義、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。整形・lint はリポジトリの検証で扱う。
|
|
24
24
|
|
|
25
25
|
## 2. 位置づけと用語定義
|
|
26
26
|
|
|
27
|
-
-
|
|
28
|
-
- `opr-<term>` は `opr-index` の差分(具体手順・個別判断)を記述する。
|
|
29
|
-
- `opd-index` は運用方針の参照元であり、手順は `opd` と整合させる。
|
|
27
|
+
`opr-index` は手順群の入口・共通規約、`opr-<term>` は差分(具体手順・個別判断)、`opd-index` は方針を担う。
|
|
30
28
|
|
|
31
29
|
## 3. ファイル命名・ID規則
|
|
32
30
|
|
|
33
|
-
-
|
|
31
|
+
- ID は `opr-index` とする。
|
|
34
32
|
- ファイル名は `opr-index.md` を推奨する。
|
|
35
|
-
-
|
|
33
|
+
- 分冊は `opr-<term>.md`(kebab-case)とする。
|
|
36
34
|
|
|
37
35
|
## 4. 推奨 Frontmatter 項目
|
|
38
36
|
|
|
39
|
-
|
|
40
|
-
| ------------ | -------------------------------- | ---- |
|
|
41
|
-
| `id` | `opr-index` | ○ |
|
|
42
|
-
| `type` | `operations` | ○ |
|
|
43
|
-
| `status` | `draft` / `ready` / `deprecated` | ○ |
|
|
44
|
-
| `rulebook` | `specdojo:opr-index-rulebook` | 任意 |
|
|
45
|
-
| `based_on` | 根拠仕様 ID 配列 | 任意 |
|
|
46
|
-
| `supersedes` | 置換関係 ID 配列 | 任意 |
|
|
37
|
+
共通項目・必須性・型はドキュメントメタ情報標準に従う。`specdojo.type` は `operations`、必須の `specdojo.rulebook` は `specdojo:opr-index-rulebook` とする。
|
|
47
38
|
|
|
48
39
|
## 5. 本文構成(標準テンプレ)
|
|
49
40
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
|
53
|
-
|
|
|
54
|
-
|
|
|
55
|
-
|
|
|
56
|
-
|
|
|
57
|
-
|
|
|
58
|
-
|
|
|
59
|
-
|
|
|
60
|
-
|
|
|
61
|
-
|
|
62
|
-
|
|
|
63
|
-
|
|
|
64
|
-
|
|
65
|
-
| 12
|
|
41
|
+
全章必須。該当作業がなければ「対象外」と理由を示し、分冊した手順は参照で満たす。
|
|
42
|
+
|
|
43
|
+
| 章 | 内容 | 必須 | 受入条件 |
|
|
44
|
+
| --- | ------------------------------------------------ | ---- | ------------------------------------------------------------- |
|
|
45
|
+
| 1 | 概要(index) | ○ | 対象運用・目的・利用者 |
|
|
46
|
+
| 2 | 手順適用範囲・前提 | ○ | 対象内外・時間帯・権限・環境 |
|
|
47
|
+
| 3 | 日次/週次/月次点検手順 | ○ | 頻度別の点検対象・操作・判定 |
|
|
48
|
+
| 4 | 障害対応手順(P1/P2…、切り分け、一次対応、復旧) | ○ | 優先度別の初動 SLA・段階別操作・連絡条件と先 |
|
|
49
|
+
| 5 | アラート対応手順(確認→暫定対応→恒久対応) | ○ | 各段階の操作・誤検知の終了条件 |
|
|
50
|
+
| 6 | バックアップ確認・リストア手順(演習含む) | ○ | 確認・復元操作・演習頻度・復旧目標の達成判定 |
|
|
51
|
+
| 7 | バッチ再実行・失敗時対応 | ○ | 再実行条件・上限回数・冪等性・上限到達時の対応 |
|
|
52
|
+
| 8 | 運用変更作業(設定変更・デプロイ・ロールバック) | ○ | 承認者・実施条件・切戻し条件と操作 |
|
|
53
|
+
| 9 | アカウント付与/剥奪手順 | ○ | 申請・承認・実施・権限検証・記録 |
|
|
54
|
+
| 10 | 問い合わせ一次対応手順(テンプレ・ナレッジ) | ○ | 分類・回答例・参照知識・引継ぎ条件と先 |
|
|
55
|
+
| 11 | 証跡(ログ、チケット、チェックリスト、実施記録) | ○ | 保存先・保管期間・参照権限・`ticket_id` / `run_id` 等の識別子 |
|
|
56
|
+
| 12 | 関連ドキュメント導線(`opd-index` 参照) | ○ | 方針と分冊への導線(分冊なしも明示) |
|
|
66
57
|
|
|
67
58
|
## 6. 記述ガイド
|
|
68
59
|
|
|
69
|
-
-
|
|
70
|
-
-
|
|
71
|
-
-
|
|
72
|
-
- 変更作業は承認者とロールバック条件を必ず記述する。
|
|
73
|
-
- 証跡章では保存先、保管期間、識別子(ticket_id/run_id 等)を明記する。
|
|
60
|
+
- 方針と適用範囲を確認し、手順、証跡、関連導線の順に具体化する。未決の条件は該当章に論点と運用への影響を残す。
|
|
61
|
+
- 手順表の標準列は「実施者・入力条件・操作・完了条件・証跡」とする。良い例:「当番・再実行済み・実行 ID で結果照合・成功かつ重複なし・実行ログ」。悪い例:「適宜再実行」。
|
|
62
|
+
- 受入確認は各手順を検証環境で実行または模擬し、完了条件と証跡を照合する。異常時の分岐を含め、操作・判断・記録を再現でき、方針と一致すれば合格とする。
|
|
74
63
|
|
|
75
64
|
## 7. 禁止事項
|
|
76
65
|
|
|
77
|
-
- 「適宜」「必要に応じて」など判定不能な手順記述をしない。
|
|
78
|
-
|
|
79
66
|
- 優先度別障害対応を未定義のまま確定しない。
|
|
80
67
|
- 証跡要件(保存先・識別子)を省略しない。
|
|
81
68
|
- `opd` と矛盾する手順を独自に定義しない。
|
|
@@ -21,8 +21,7 @@ specdojo:
|
|
|
21
21
|
|
|
22
22
|
Operations Procedure Runbook (OPR) Documentation Rules
|
|
23
23
|
|
|
24
|
-
|
|
25
|
-
運用作業を再現可能な手順として定義し、誰が実施しても同じ結果になる状態(属人化防止)を実現するための内容を定義します。
|
|
24
|
+
運用手順(`opr-index` / `opr-<term>`)に、第三者が再現できる操作・判断・証跡を記述する基準を定めます。
|
|
26
25
|
|
|
27
26
|
## 1. 全体方針
|
|
28
27
|
|
|
@@ -33,31 +32,24 @@ Operations Procedure Runbook (OPR) Documentation Rules
|
|
|
33
32
|
- 変更作業(設定変更/デプロイ/ロールバック)の統制を明確化する
|
|
34
33
|
- バックアップ確認・リストア演習・バッチ再実行を手順化する
|
|
35
34
|
- 証跡(ログ/チケット/チェックリスト/実施記録)を必須化する
|
|
35
|
+
- **共通の運用**: 役割は適用先のメンバー定義、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。文書の整形・lint はリポジトリの検証で扱い、運用作業の受入確認に含めない。
|
|
36
36
|
|
|
37
37
|
### 1.1. index / term 分割方針
|
|
38
38
|
|
|
39
|
-
-
|
|
40
|
-
- `opr-<term>`
|
|
41
|
-
-
|
|
42
|
-
- `opr-<term>` では、原則として **`opr-index` の差分(具体手順・個別判断)** を記述し、共通規約の重複記載を避ける
|
|
39
|
+
- `opr-index` を入口とし、証跡・作業承認・優先度・エスカレーション・手順テンプレの共通規約を置く
|
|
40
|
+
- `opr-<term>` は障害・監視・バッチ・権限・問い合わせ・変更等のドメインが独立する場合に追加する
|
|
41
|
+
- 分冊は共通規約を参照し、差分となる具体手順と個別判断を記述する
|
|
43
42
|
|
|
44
43
|
## 2. 位置づけと用語定義
|
|
45
44
|
|
|
46
45
|
### 2.1. 位置づけ(他ドキュメントとの関係)
|
|
47
46
|
|
|
48
|
-
`opr-index` / `opr-<term>` と他ドキュメントの関係を示します。必要に応じて Mermaid を用いた図を使用してよい。
|
|
49
|
-
|
|
50
47
|
- `opd-index` / `opd-<term>`:運用方針・統制(あるべき姿・判断基準)
|
|
51
|
-
-
|
|
52
|
-
- OPD は「方針と統制(あるべき姿・判断基準)」、OPR は「手順と証跡(再現可能な作業)」を責務とする
|
|
48
|
+
- `opr-index` / `opr-<term>`:その方針に基づく実行手順と証跡
|
|
53
49
|
|
|
54
50
|
### 2.2. 用語定義
|
|
55
51
|
|
|
56
|
-
|
|
57
|
-
| -------- | ------------------------------------------------------------------------------ |
|
|
58
|
-
| 証跡 | 実施結果を第三者が追跡可能にする記録(ログURL/チケットID/チェックリスト/添付) |
|
|
59
|
-
| 一次対応 | 影響拡大防止の暫定措置と状況確定(切り分け・通知・暫定復旧) |
|
|
60
|
-
| 恒久対応 | 根本原因の除去(修正・設定変更・再発防止) |
|
|
52
|
+
一次対応は影響拡大防止の暫定措置と状況確定(切り分け・通知・暫定復旧)、恒久対応は根本原因の除去(修正・設定変更・再発防止)を指す。
|
|
61
53
|
|
|
62
54
|
## 3. ファイル命名・ID規則
|
|
63
55
|
|
|
@@ -71,21 +63,17 @@ Operations Procedure Runbook (OPR) Documentation Rules
|
|
|
71
63
|
|
|
72
64
|
### 4.1. 設定内容
|
|
73
65
|
|
|
74
|
-
|
|
66
|
+
共通項目の必須性・型は「共通の運用」の参照先と [成果物スキーマ](../../../specdojo/schemas/v1/deliverable-frontmatter.schema.yaml) に従う。OPR 固有の値は次のとおり。
|
|
75
67
|
|
|
76
|
-
| 項目
|
|
77
|
-
|
|
|
78
|
-
| id
|
|
79
|
-
| type
|
|
80
|
-
|
|
|
81
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
82
|
-
| based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
|
|
83
|
-
| supersedes | 置き換え関係(ID配列。未指定は `[]` 可) | 任意 |
|
|
68
|
+
| 項目 | 値 | 必須 |
|
|
69
|
+
| -------- | ------------------------------- | ---- |
|
|
70
|
+
| id | `opr-index` または `opr-<term>` | ○ |
|
|
71
|
+
| type | `operations` | ○ |
|
|
72
|
+
| rulebook | `specdojo:opr-rulebook` | ○ |
|
|
84
73
|
|
|
85
74
|
### 4.2. 推奨ルール
|
|
86
75
|
|
|
87
76
|
- `based_on` には手順判断に直接利用した成果物(例: `opd-*` / `nfr-*` / `issue-*`)のみ列挙する
|
|
88
|
-
- `based_on` / `supersedes` は ID 配列(未指定は `[]` 可)
|
|
89
77
|
|
|
90
78
|
## 5. 本文要件
|
|
91
79
|
|
|
@@ -94,13 +82,13 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
94
82
|
- 概要、適用範囲・前提、定期点検、障害対応、アラート対応、バックアップ・リストア、バッチ再実行、運用変更、アカウント付与・剥奪、問い合わせ一次対応、証跡、関連文書導線を必須とします。
|
|
95
83
|
- 各章は、実施条件、実施者、判断条件、完了条件、証跡のうち該当する要素を第三者が再現できる粒度で定義します。
|
|
96
84
|
- `opr-<term>` で該当する作業がない章も省略せず、`なし`、`opr-index 参照`、`本書の範囲外` のいずれかと理由を記載します。
|
|
97
|
-
-
|
|
85
|
+
- 未決の条件は該当章に論点と運用への影響を記載します。
|
|
98
86
|
|
|
99
87
|
## 6. 記述ガイド
|
|
100
88
|
|
|
101
|
-
|
|
89
|
+
以下の節名は扱う内容を示すもので、成果物に生成する見出し・表の列名は template に従う。
|
|
102
90
|
|
|
103
|
-
|
|
91
|
+
### 6.1. 概要(`index` / `<term>`)
|
|
104
92
|
|
|
105
93
|
- 手順の対象と目的を 1〜3 行で示す
|
|
106
94
|
- `opr-index` が実行手順の SSOT であることを明示する
|
|
@@ -108,128 +96,82 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
108
96
|
|
|
109
97
|
### 6.2. 手順適用範囲・前提
|
|
110
98
|
|
|
111
|
-
生成する本文の見出しは **## 2. 手順適用範囲・前提**
|
|
112
|
-
|
|
113
99
|
- 適用対象、適用外、実施可能時間帯、必要権限を明記する
|
|
114
100
|
- 前提(環境、ツール、連絡経路、参照先)を明記する
|
|
115
101
|
|
|
116
|
-
推奨フォーマット(表):
|
|
117
|
-
|
|
118
|
-
| 項目 | 内容 |
|
|
119
|
-
| ---------- | -------------------------------- |
|
|
120
|
-
| 対象 | (例:本番環境、staging) |
|
|
121
|
-
| 時間帯 | (例:平日9-18、夜間可否) |
|
|
122
|
-
| 必要権限 | (例:SRE権限、DB read-only 等) |
|
|
123
|
-
| 使用ツール | (例:監視SaaS、チケット、CLI) |
|
|
124
|
-
| 連絡先 | (例:#ops、#dev、電話) |
|
|
125
|
-
|
|
126
102
|
### 6.3. 日次/週次/月次点検手順
|
|
127
103
|
|
|
128
|
-
生成する本文の見出しは **## 3. 日次/週次/月次点検手順**
|
|
129
|
-
|
|
130
104
|
- 頻度別に手順、実施者、完了条件、証跡を定義する
|
|
131
105
|
- 実施漏れの検知方法とエスカレーションを明記してよい
|
|
132
106
|
|
|
133
|
-
推奨フォーマット(表):
|
|
134
|
-
|
|
135
|
-
| 頻度 | 手順 | 実施者 | 完了条件 | 証跡 |
|
|
136
|
-
| ---- | ---- | ------ | -------- | ---- |
|
|
137
|
-
|
|
138
107
|
### 6.4. 障害対応手順(P1/P2…、切り分け、一次対応、復旧)
|
|
139
108
|
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
- 優先度別に切り分け手順、一次対応、復旧手順を明記する
|
|
109
|
+
- 優先度別に初動目標、切り分け手順、一次対応、復旧手順を明記する
|
|
143
110
|
- エスカレーション条件と判断者を明記する
|
|
144
111
|
- 停止判断・ロールバックが関わる場合は、判断条件と承認者を必ず書く
|
|
145
112
|
|
|
146
|
-
推奨フォーマット(表):
|
|
147
|
-
|
|
148
|
-
| 優先度 | 初動SLA | 切り分け | 一次対応 | 復旧 | エスカレーション |
|
|
149
|
-
| ------ | ------- | -------- | -------- | ---- | ---------------- |
|
|
150
|
-
|
|
151
113
|
### 6.5. アラート対応手順(確認→暫定対応→恒久対応)
|
|
152
114
|
|
|
153
|
-
生成する本文の見出しは **## 5. アラート対応手順(確認→暫定対応→恒久対応)**
|
|
154
|
-
|
|
155
115
|
- 検知後の確認、暫定対応、恒久対応の流れを明記する
|
|
156
116
|
- 誤検知時の扱い(クローズ条件、閾値調整、抑止)を明記する
|
|
157
117
|
|
|
158
|
-
推奨フォーマット(表):
|
|
159
|
-
|
|
160
|
-
| 段階 | 手順 | 完了条件 | 証跡 |
|
|
161
|
-
| ---- | ---- | -------- | ---- |
|
|
162
|
-
|
|
163
118
|
### 6.6. バックアップ確認・リストア手順(演習含む)
|
|
164
119
|
|
|
165
|
-
生成する本文の見出しは **## 6. バックアップ確認・リストア手順(演習含む)**
|
|
166
|
-
|
|
167
120
|
- バックアップ確認項目、リストア手順、演習頻度を明記する
|
|
168
121
|
- 演習結果の証跡(ログ/レポート/所要時間)を必須化する
|
|
169
122
|
- RTO/RPO がある場合は、達成可否の判定方法を明記する(方針は OPD、実施は OPR)
|
|
170
123
|
|
|
171
124
|
### 6.7. バッチ再実行・失敗時対応
|
|
172
125
|
|
|
173
|
-
生成する本文の見出しは **## 7. バッチ再実行・失敗時対応**
|
|
174
|
-
|
|
175
126
|
- 失敗検知、再実行条件、再実行上限、エスカレーションを明記する
|
|
176
|
-
-
|
|
127
|
+
- 再実行でデータ重複が起きうる場合は、冪等性/防止策(`run_id` 等)を明記する
|
|
177
128
|
|
|
178
129
|
### 6.8. 運用変更作業(設定変更・デプロイ・ロールバック)
|
|
179
130
|
|
|
180
|
-
生成する本文の見出しは **## 8. 運用変更作業(設定変更・デプロイ・ロールバック)**
|
|
181
|
-
|
|
182
131
|
- 変更種別、承認者、実施条件(時間帯/凍結)、ロールバック条件を明記する
|
|
183
132
|
- 変更の証跡(チケット、差分、承認ログ、実施ログ)を必須化する
|
|
184
133
|
- 重大変更は事前周知の要否と手段を明記する
|
|
185
134
|
|
|
186
135
|
### 6.9. アカウント付与/剥奪手順
|
|
187
136
|
|
|
188
|
-
生成する本文の見出しは **## 9. アカウント付与/剥奪手順**
|
|
189
|
-
|
|
190
137
|
- 申請→承認→実施→検証→記録の流れを明記する
|
|
191
138
|
- 棚卸し(定期)と緊急権限(ブレークグラス)がある場合は、その実施手順と証跡を明記する
|
|
192
139
|
|
|
193
140
|
### 6.10. 問い合わせ一次対応手順(テンプレ・ナレッジ)
|
|
194
141
|
|
|
195
|
-
生成する本文の見出しは **## 10. 問い合わせ一次対応手順(テンプレ・ナレッジ)**
|
|
196
|
-
|
|
197
142
|
- 問い合わせ分類、一次対応テンプレ、ナレッジ参照先を明記する
|
|
198
143
|
- 引き継ぎ条件(開発/業務/運用)を明記する
|
|
199
144
|
|
|
200
145
|
### 6.11. 証跡(ログ、チケット、チェックリスト、実施記録)
|
|
201
146
|
|
|
202
|
-
生成する本文の見出しは **## 11. 証跡(ログ、チケット、チェックリスト、実施記録)**
|
|
203
|
-
|
|
204
147
|
- 必須証跡、保存先、保管期間、参照権限を明記する
|
|
205
|
-
-
|
|
148
|
+
- 証跡は URL や `ticket_id`、`run_id` 等で実施結果を第三者が追跡できる粒度で残す
|
|
206
149
|
|
|
207
150
|
推奨フォーマット(表):
|
|
208
151
|
|
|
209
|
-
| 証跡種別 | 保存先 | 保管期間 | 参照権限 | 最低限残す識別子
|
|
210
|
-
| -------------- | ---------------- | ------------ | --------------- |
|
|
211
|
-
| チケット | (例:Jira) | (例:2年) | (例:Ops/Dev) | ticket_id |
|
|
212
|
-
| 実施ログ | (例:ログ基盤) | (例:90日) | (例:Ops) | run_id
|
|
213
|
-
| チェックリスト | (例:Docs) | (例:1年) | (例:Ops) | 実施日, 実施者
|
|
152
|
+
| 証跡種別 | 保存先 | 保管期間 | 参照権限 | 最低限残す識別子 |
|
|
153
|
+
| -------------- | ---------------- | ------------ | --------------- | ------------------ |
|
|
154
|
+
| チケット | (例:Jira) | (例:2年) | (例:Ops/Dev) | `ticket_id` |
|
|
155
|
+
| 実施ログ | (例:ログ基盤) | (例:90日) | (例:Ops) | `run_id`, `job_id` |
|
|
156
|
+
| チェックリスト | (例:Docs) | (例:1年) | (例:Ops) | 実施日, 実施者 |
|
|
214
157
|
|
|
215
158
|
### 6.12. 関連ドキュメント導線(`opd` 参照、`mip` / `otp` / `cop` 連携)
|
|
216
159
|
|
|
217
|
-
生成する本文の見出しは **## 12. 関連ドキュメント導線(`opd` 参照、`mip` / `otp` / `cop` 連携)**
|
|
218
|
-
|
|
219
160
|
- `opd-index` への導線を必ず記載する
|
|
220
161
|
- `mip-*` / `otp-*` / `cop-*` は必要時のみ連携情報として記載する
|
|
221
162
|
- 分冊がない場合でも `(本書のみ)` または `(なし)` を明記する
|
|
163
|
+
- 「手順適用範囲・前提」等に記載済みの参照先は、その章タイトルへの参照で満たし、同じリンク・目的を表に再掲しない
|
|
222
164
|
|
|
223
|
-
|
|
165
|
+
### 6.13. 運用作業の受入確認
|
|
224
166
|
|
|
225
|
-
|
|
226
|
-
|
|
167
|
+
- 手順を検証環境で実行または模擬し、実施条件・判断分岐・完了条件と証跡を照合する
|
|
168
|
+
- 障害時の停止・復旧、再実行時の重複防止、変更時のロールバックを該当する手順で確認する
|
|
169
|
+
- 第三者が同じ操作・判断・記録を再現でき、完了条件と OPD の基準を満たせば合格とする
|
|
227
170
|
|
|
228
171
|
## 7. 禁止事項
|
|
229
172
|
|
|
230
173
|
| 禁止事項 | 理由 |
|
|
231
174
|
| ------------------------------------------------------ | --------------------------------------------- |
|
|
232
|
-
| 手順を曖昧語(適宜/必要に応じて等)で記載する | 再現性が担保できないため |
|
|
233
175
|
| 優先度別手順(P1/P2等)を省略する | 障害時初動が標準化できないため |
|
|
234
176
|
| 証跡要件(ログ/チケット/チェックリスト)を未定義にする | 監査性・追跡性が欠落するため |
|
|
235
177
|
| 変更作業の承認・ロールバック条件を未記載にする | 変更統制が崩壊するため |
|