specdojo 0.1.0 → 0.2.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/LICENSE +22 -0
- package/README.md +82 -38
- package/dist/agent-response.js +27 -0
- package/dist/agent.js +124 -0
- package/dist/build-command.js +149 -0
- package/dist/build-if-stale.js +35 -0
- package/dist/catalog-build.js +1079 -0
- package/dist/catalog-generate.js +226 -0
- package/dist/catalog-paths.js +31 -0
- package/dist/catalog-plan-generate.js +301 -0
- package/dist/catalog-plan-prompt.js +73 -0
- package/dist/catalog-plan.js +471 -0
- package/dist/catalog-scaffold.js +255 -0
- package/dist/catalog-types.js +4 -0
- package/dist/catalog.js +606 -0
- package/dist/dashboard.js +980 -0
- package/dist/deliverable-trash.js +148 -0
- package/dist/deliverable.js +97 -0
- package/dist/dist-freshness.js +150 -0
- package/dist/doc-index.js +424 -0
- package/dist/exec-agent-config.js +172 -0
- package/dist/exec-agent-git-state.js +136 -0
- package/dist/exec-agent-protected-config.js +276 -0
- package/dist/exec-events.js +250 -112
- package/dist/exec-evidence.js +317 -0
- package/dist/exec-format.js +45 -0
- package/dist/exec-limit.js +202 -0
- package/dist/exec-parent-validation.js +169 -0
- package/dist/exec-pipeline-state.js +160 -0
- package/dist/exec-plans.js +1016 -0
- package/dist/exec-project.js +25 -11
- package/dist/exec-protection-handoff.js +169 -0
- package/dist/exec-provider-scaffold.js +99 -0
- package/dist/exec-register-resume.js +196 -0
- package/dist/exec-register.js +281 -0
- package/dist/exec-reporter.js +329 -0
- package/dist/exec-results.js +510 -0
- package/dist/exec-run-lock.js +149 -0
- package/dist/exec-run.js +4953 -0
- package/dist/exec-schedule-calendar.js +86 -9
- package/dist/exec-schedule-cpm.js +30 -12
- package/dist/exec-schedule-gantt-chart-render.js +428 -0
- package/dist/exec-schedule-gantt-chart-scope.js +111 -0
- package/dist/exec-schedule-gantt-chart.js +2 -0
- package/dist/exec-schedule-hash.js +34 -25
- package/dist/exec-schedule-index.js +200 -67
- package/dist/exec-schedule-initial.js +100 -0
- package/dist/exec-schedule-progress.js +51 -26
- package/dist/exec-schedule-ready.js +71 -27
- package/dist/exec-schedule.js +171 -93
- package/dist/exec-shared.js +146 -25
- package/dist/exec-strategy.js +547 -0
- package/dist/exec-task-view.js +64 -0
- package/dist/exec-trial.js +895 -0
- package/dist/exec-worktree-command.js +426 -0
- package/dist/exec-worktree-ops.js +847 -0
- package/dist/exec-worktree.js +359 -0
- package/dist/exec.js +744 -192
- package/dist/frontmatter-namespace.js +48 -0
- package/dist/git-environment.js +23 -0
- package/dist/grade-result.js +137 -0
- package/dist/grade.js +2456 -0
- package/dist/index-command.js +103 -0
- package/dist/job.js +1081 -0
- package/dist/kata-command.js +303 -0
- package/dist/kata.js +187 -0
- package/dist/package-paths.js +15 -0
- package/dist/practice-id.js +24 -0
- package/dist/register-date.js +122 -0
- package/dist/register-events.js +363 -0
- package/dist/register-history.js +323 -0
- package/dist/register-item.js +455 -0
- package/dist/register-migrate-timestamps.js +176 -0
- package/dist/register.js +2199 -0
- package/dist/review-plan.js +199 -0
- package/dist/review-types.js +1 -0
- package/dist/role-types.js +1 -0
- package/dist/routine.js +814 -0
- package/dist/schedule-approach.js +252 -0
- package/dist/schedule-build.js +552 -0
- package/dist/schedule-phase-sets.js +73 -0
- package/dist/schedule-strategy-generate.js +812 -0
- package/dist/schedule-strategy-profiles.js +276 -0
- package/dist/schedule.js +420 -0
- package/dist/spawn-self.js +28 -0
- package/dist/specdojo-config.js +133 -39
- package/dist/specdojo.js +55 -7
- package/dist/template-frontmatter.js +89 -0
- package/dist/template-resolution.js +92 -0
- package/dist/timeline-build.js +334 -0
- package/dist/timeline.js +107 -0
- package/dist/watch.js +313 -0
- package/dist/yaml-pages-command.js +28 -0
- package/dist/yaml-pages.js +180 -0
- package/dist/yaml-schema-modeline.js +49 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +600 -0
- package/docs/ja/specdojo/exec-templates/xep-bootstrap-template.md +120 -0
- package/docs/ja/specdojo/exec-templates/xep-common-conventions-template.md +37 -0
- package/docs/ja/specdojo/exec-templates/xep-cross-deliverable-dedup-template.md +51 -0
- package/docs/ja/specdojo/exec-templates/xep-freeform-template.md +74 -0
- package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +109 -0
- package/docs/ja/specdojo/exec-templates/xep-job-template.md +43 -0
- package/docs/ja/specdojo/exec-templates/xep-recipe-guided-template.md +82 -0
- package/docs/ja/specdojo/exec-templates/xep-recipe-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-register-investigate-template.md +42 -0
- package/docs/ja/specdojo/exec-templates/xep-register-template.md +49 -0
- package/docs/ja/specdojo/exec-templates/xep-retrofit-template.md +98 -0
- package/docs/ja/specdojo/exec-templates/xep-rulebook-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-sample-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-template-maintenance-template.md +86 -0
- package/docs/ja/specdojo/exec-templates/xep-template.md +66 -0
- package/docs/ja/specdojo/exec-templates/xer-cross-deliverable-dedup-template.md +31 -0
- package/docs/ja/specdojo/exec-templates/xer-human-bootstrap-finalize-template.md +40 -0
- package/docs/ja/specdojo/exec-templates/xer-human-finalize-template.md +30 -0
- package/docs/ja/specdojo/exec-templates/xer-template.md +19 -0
- package/docs/ja/specdojo/exec-templates/xrp-freeform-template.md +70 -0
- package/docs/ja/specdojo/exec-templates/xrp-fully-guided-template.md +97 -0
- package/docs/ja/specdojo/exec-templates/xrp-recipe-guided-template.md +76 -0
- package/docs/ja/specdojo/exec-templates/xrp-recipe-maintenance-template.md +73 -0
- package/docs/ja/specdojo/exec-templates/xrp-retrofit-template.md +74 -0
- package/docs/ja/specdojo/exec-templates/xrp-rulebook-maintenance-template.md +74 -0
- package/docs/ja/specdojo/exec-templates/xrp-sample-maintenance-template.md +73 -0
- package/docs/ja/specdojo/exec-templates/xrp-template-maintenance-template.md +73 -0
- package/docs/ja/specdojo/exec-templates/xrp-template.md +67 -0
- package/docs/ja/specdojo/exec-templates/xrp-viewpoint-detail-template.md +7 -0
- package/docs/ja/specdojo/exec-templates/xrr-template.md +21 -0
- package/docs/ja/specdojo/exec-templates/xrr-viewpoint-detail-template.md +7 -0
- package/docs/ja/specdojo/guides/branch-workflow-guide.md +354 -0
- package/docs/ja/specdojo/guides/docs-editing-guide.md +327 -0
- package/docs/ja/specdojo/guides/docs-structure-guide.md +519 -0
- package/docs/ja/specdojo/guides/exec-config-guide.md +589 -0
- package/docs/ja/specdojo/guides/exec-operation-guide.md +440 -0
- package/docs/ja/specdojo/guides/exec-worktree-guide.md +318 -0
- package/docs/ja/specdojo/guides/kata-guide.md +89 -0
- package/docs/ja/specdojo/guides/orchestrator-operation-guide.md +127 -0
- package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +228 -0
- package/docs/ja/specdojo/guides/practice-system-composition-guide.md +111 -0
- package/docs/ja/specdojo/guides/quick-start-guide.md +473 -0
- package/docs/ja/specdojo/guides/register-operation-guide.md +418 -0
- package/docs/ja/specdojo/guides/review-guide.md +428 -0
- package/docs/ja/specdojo/guides/routine-operation-guide.md +282 -0
- package/docs/ja/specdojo/guides/ryu-guide.md +230 -0
- package/docs/ja/specdojo/guides/schedule-design-guide.md +429 -0
- package/docs/ja/specdojo/guides/schedule-operation-guide.md +151 -0
- package/docs/ja/specdojo/guides/specdojo-overview-guide.md +257 -0
- package/docs/ja/specdojo/guides/timeline-design-guide.md +160 -0
- package/docs/ja/specdojo/guides/track-design-guide.md +215 -0
- package/docs/ja/specdojo/guides/use-case-guide.md +133 -0
- package/docs/ja/specdojo/guides/waza-guide.md +224 -0
- package/docs/ja/specdojo/index.md +33 -0
- package/docs/ja/specdojo/philosophy/needs-to-implementation-philosophy.md +212 -0
- package/docs/ja/specdojo/philosophy/specdojo-philosophy.md +242 -0
- package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +198 -0
- package/docs/ja/specdojo/recipes/cdfd-recipe.md +218 -0
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +198 -0
- package/docs/ja/specdojo/recipes/exec-human-finalize-recipe.md +100 -0
- package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +148 -0
- package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +97 -0
- package/docs/ja/specdojo/recipes/pm-members-recipe.md +149 -0
- package/docs/ja/specdojo/recipes/pm-organization-recipe.md +96 -0
- package/docs/ja/specdojo/recipes/pm-plan-recipe.md +98 -0
- package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +97 -0
- package/docs/ja/specdojo/recipes/pm-raci-recipe.md +96 -0
- package/docs/ja/specdojo/recipes/pm-roles-recipe.md +136 -0
- package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +162 -0
- package/docs/ja/specdojo/recipes/prj-charter-recipe.md +187 -0
- package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +235 -0
- package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +205 -0
- package/docs/ja/specdojo/recipes/prj-overview-recipe.md +289 -0
- package/docs/ja/specdojo/recipes/prj-scope-recipe.md +201 -0
- package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +168 -0
- package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +179 -0
- package/docs/ja/specdojo/recipes/stsd-recipe.md +138 -0
- package/docs/ja/specdojo/references/command-reference.md +718 -0
- package/docs/ja/specdojo/references/deliverables-reference.md +407 -0
- package/docs/ja/specdojo/references/directory-layout-reference.md +280 -0
- package/docs/ja/specdojo/references/specdojo-config-reference.md +133 -0
- package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +372 -0
- package/docs/ja/specdojo/rulebooks/atc-rulebook.md +302 -0
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +331 -0
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +134 -0
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +207 -0
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +102 -0
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +131 -0
- package/docs/ja/specdojo/rulebooks/bps-rulebook.md +269 -0
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +187 -0
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +279 -0
- package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +219 -0
- package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +233 -0
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +182 -0
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +171 -0
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +105 -0
- package/docs/ja/specdojo/rulebooks/cld-rulebook.md +195 -0
- package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +285 -0
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +292 -0
- package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +171 -0
- package/docs/ja/specdojo/rulebooks/cop-rulebook.md +325 -0
- package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +266 -0
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +294 -0
- package/docs/ja/specdojo/rulebooks/cstd-rulebook.md +21 -0
- package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +401 -0
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +311 -0
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +158 -0
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +287 -0
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +62 -0
- package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +100 -0
- package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +298 -0
- package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +379 -0
- package/docs/ja/specdojo/rulebooks/etc-rulebook.md +310 -0
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +86 -0
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +297 -0
- package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +79 -0
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +213 -0
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +311 -0
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +94 -0
- package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +81 -0
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +117 -0
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +118 -0
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +421 -0
- package/docs/ja/specdojo/rulebooks/itc-rulebook.md +307 -0
- package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +312 -0
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +63 -0
- package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +353 -0
- package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +184 -0
- package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +179 -0
- package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +184 -0
- package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +183 -0
- package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +185 -0
- package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +185 -0
- package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +186 -0
- package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +186 -0
- package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +184 -0
- package/docs/ja/specdojo/rulebooks/ntp-rulebook.md +61 -0
- package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +84 -0
- package/docs/ja/specdojo/rulebooks/opd-rulebook.md +357 -0
- package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +80 -0
- package/docs/ja/specdojo/rulebooks/opr-rulebook.md +484 -0
- package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +120 -0
- package/docs/ja/specdojo/rulebooks/otp-rulebook.md +293 -0
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +211 -0
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +94 -0
- package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +190 -0
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +108 -0
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +122 -0
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +117 -0
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +116 -0
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +146 -0
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +65 -0
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +178 -0
- package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +232 -0
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +235 -0
- package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +242 -0
- package/docs/ja/specdojo/rulebooks/prj-overview-rulebook.md +187 -0
- package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +201 -0
- package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +165 -0
- package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +165 -0
- package/docs/ja/specdojo/rulebooks/sac-rulebook.md +202 -0
- package/docs/ja/specdojo/rulebooks/sch-rulebook.md +139 -0
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +63 -0
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +93 -0
- package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +329 -0
- package/docs/ja/specdojo/rulebooks/stc-rulebook.md +297 -0
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +132 -0
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +215 -0
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +376 -0
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +313 -0
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +246 -0
- package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +119 -0
- package/docs/ja/specdojo/rulebooks/tml-rulebook.md +188 -0
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +114 -0
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +117 -0
- package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +101 -0
- package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +103 -0
- package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +396 -0
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +207 -0
- package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +387 -0
- package/docs/ja/specdojo/rulebooks/utc-rulebook.md +303 -0
- package/docs/ja/specdojo/samples/atc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/atc-sample.md +41 -0
- package/docs/ja/specdojo/samples/bac-sample.md +38 -0
- package/docs/ja/specdojo/samples/bdd-sample.yaml +71 -0
- package/docs/ja/specdojo/samples/bds-sample.md +38 -0
- package/docs/ja/specdojo/samples/bes-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/bes-sample.md +38 -0
- package/docs/ja/specdojo/samples/bps-sample.md +38 -0
- package/docs/ja/specdojo/samples/br-sample.md +40 -0
- package/docs/ja/specdojo/samples/ccd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cdfd-overview-sample.md +284 -0
- package/docs/ja/specdojo/samples/cdfd-sample.md +229 -0
- package/docs/ja/specdojo/samples/cdfd-uc-sample.md +146 -0
- package/docs/ja/specdojo/samples/cdsd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cld-sample.md +38 -0
- package/docs/ja/specdojo/samples/cnd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cop-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/cop-sample.md +38 -0
- package/docs/ja/specdojo/samples/cpd-sample.md +38 -0
- package/docs/ja/specdojo/samples/cstd-sample.md +11 -0
- package/docs/ja/specdojo/samples/cxd-sample.md +38 -0
- package/docs/ja/specdojo/samples/dct-index-sample.yaml +39 -0
- package/docs/ja/specdojo/samples/dct-sample.yaml +91 -0
- package/docs/ja/specdojo/samples/dec-sample.md +39 -0
- package/docs/ja/specdojo/samples/dmd-index-sample.md +50 -0
- package/docs/ja/specdojo/samples/dmd-sample.md +74 -0
- package/docs/ja/specdojo/samples/etc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/etc-sample.md +38 -0
- package/docs/ja/specdojo/samples/gl-sample.yaml +37 -0
- package/docs/ja/specdojo/samples/ifd-sample.md +38 -0
- package/docs/ja/specdojo/samples/ifx-api-sample.yaml +102 -0
- package/docs/ja/specdojo/samples/ifx-cmd-sample.yaml +107 -0
- package/docs/ja/specdojo/samples/ifx-file-sample.md +38 -0
- package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +89 -0
- package/docs/ja/specdojo/samples/imp-business-sample.md +66 -0
- package/docs/ja/specdojo/samples/imp-data-sample.md +60 -0
- package/docs/ja/specdojo/samples/imp-interface-sample.md +60 -0
- package/docs/ja/specdojo/samples/imp-operations-sample.md +60 -0
- package/docs/ja/specdojo/samples/imp-test-sample.md +60 -0
- package/docs/ja/specdojo/samples/itc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/itc-sample.md +38 -0
- package/docs/ja/specdojo/samples/mip-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/mm-sample.md +35 -0
- package/docs/ja/specdojo/samples/mtp-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-availability-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-integrity-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-maintainability-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-operations-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-performance-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-reliability-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-security-safety-sample.md +38 -0
- package/docs/ja/specdojo/samples/nfr-usability-sample.md +38 -0
- package/docs/ja/specdojo/samples/ntp-sample.md +38 -0
- package/docs/ja/specdojo/samples/opd-access-control-sample.md +29 -0
- package/docs/ja/specdojo/samples/opd-incident-management-sample.md +31 -0
- package/docs/ja/specdojo/samples/opd-index-sample.md +41 -0
- package/docs/ja/specdojo/samples/opd-monitoring-sample.md +32 -0
- package/docs/ja/specdojo/samples/opd-sample.md +38 -0
- package/docs/ja/specdojo/samples/opr-access-control-sample.md +24 -0
- package/docs/ja/specdojo/samples/opr-backup-restore-sample.md +27 -0
- package/docs/ja/specdojo/samples/opr-batch-sample.md +23 -0
- package/docs/ja/specdojo/samples/opr-change-sample.md +24 -0
- package/docs/ja/specdojo/samples/opr-incident-sample.md +38 -0
- package/docs/ja/specdojo/samples/opr-index-sample.md +43 -0
- package/docs/ja/specdojo/samples/opr-monitoring-sample.md +27 -0
- package/docs/ja/specdojo/samples/opr-sample.md +38 -0
- package/docs/ja/specdojo/samples/opr-support-sample.md +23 -0
- package/docs/ja/specdojo/samples/otp-index-sample.md +66 -0
- package/docs/ja/specdojo/samples/otp-sample.md +68 -0
- package/docs/ja/specdojo/samples/pm-change-request-log-sample.md +47 -0
- package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +46 -0
- package/docs/ja/specdojo/samples/pm-issue-log-sample.md +45 -0
- package/docs/ja/specdojo/samples/pm-members-sample.yaml +103 -0
- package/docs/ja/specdojo/samples/pm-organization-sample.md +46 -0
- package/docs/ja/specdojo/samples/pm-plan-sample.md +57 -0
- package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +52 -0
- package/docs/ja/specdojo/samples/pm-raci-sample.md +57 -0
- package/docs/ja/specdojo/samples/pm-risk-register-sample.md +43 -0
- package/docs/ja/specdojo/samples/pm-roles-sample.yaml +41 -0
- package/docs/ja/specdojo/samples/pr-sample.md +39 -0
- package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +57 -0
- package/docs/ja/specdojo/samples/prj-charter-sample.md +121 -0
- package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +105 -0
- package/docs/ja/specdojo/samples/prj-issues-and-approach-sample.md +78 -0
- package/docs/ja/specdojo/samples/prj-overview-sample.md +95 -0
- package/docs/ja/specdojo/samples/prj-scope-sample.md +71 -0
- package/docs/ja/specdojo/samples/prj-stakeholder-register-sample.md +60 -0
- package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +62 -0
- package/docs/ja/specdojo/samples/sac-sample.md +38 -0
- package/docs/ja/specdojo/samples/sf-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/sf-sample.md +38 -0
- package/docs/ja/specdojo/samples/sld-sample.md +38 -0
- package/docs/ja/specdojo/samples/stc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/stc-sample.md +38 -0
- package/docs/ja/specdojo/samples/stsd-sample.md +58 -0
- package/docs/ja/specdojo/samples/sysd-critical-flows-sample.md +38 -0
- package/docs/ja/specdojo/samples/sysd-cross-cutting-policy-sample.md +38 -0
- package/docs/ja/specdojo/samples/sysd-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/trc-requirements-to-specs-sample.md +56 -0
- package/docs/ja/specdojo/samples/trc-requirements-to-tests-sample.md +56 -0
- package/docs/ja/specdojo/samples/tsd-index-sample.md +29 -0
- package/docs/ja/specdojo/samples/tsd-sample.md +38 -0
- package/docs/ja/specdojo/samples/tsp-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/uis-sample.md +38 -0
- package/docs/ja/specdojo/samples/utc-index-sample.md +38 -0
- package/docs/ja/specdojo/samples/utc-sample.md +38 -0
- package/docs/ja/specdojo/schemas/v1/guide-content.schema.yaml +20 -0
- package/docs/ja/specdojo/schemas/v1/philosophy-content.schema.yaml +21 -0
- package/docs/ja/specdojo/schemas/v1/reference-content.schema.yaml +21 -0
- package/docs/ja/specdojo/standards/document-metadata-standard.md +323 -0
- package/docs/ja/specdojo/standards/exec-human-finalize-standard.md +75 -0
- package/docs/ja/specdojo/standards/git-branching-standard.md +227 -0
- package/docs/ja/specdojo/standards/guide-authoring-standard.md +124 -0
- package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +929 -0
- package/docs/ja/specdojo/standards/job-definition-standard.md +148 -0
- package/docs/ja/specdojo/standards/people-and-organization-definition-standard.md +431 -0
- package/docs/ja/specdojo/standards/philosophy-authoring-standard.md +113 -0
- package/docs/ja/specdojo/standards/recipe-authoring-standard.md +143 -0
- package/docs/ja/specdojo/standards/reference-authoring-standard.md +99 -0
- package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +140 -0
- package/docs/ja/specdojo/standards/sample-authoring-standard.md +151 -0
- package/docs/ja/specdojo/standards/standard-authoring-standard.md +108 -0
- package/docs/ja/specdojo/standards/template-authoring-standard.md +101 -0
- package/docs/ja/specdojo/standards/test-document-scope-standard.md +176 -0
- package/docs/ja/specdojo/templates/cdfd-overview-template.md +199 -0
- package/docs/ja/specdojo/templates/cdfd-template.md +173 -0
- package/docs/ja/specdojo/templates/cdfd-uc-template.md +148 -0
- package/docs/ja/specdojo/templates/dct-architecture-template.yaml +136 -0
- package/docs/ja/specdojo/templates/dct-business-acceptance-criteria-template.yaml +34 -0
- package/docs/ja/specdojo/templates/dct-business-model-bes-template.yaml +75 -0
- package/docs/ja/specdojo/templates/dct-business-model-bps-template.yaml +49 -0
- package/docs/ja/specdojo/templates/dct-business-model-br-template.yaml +50 -0
- package/docs/ja/specdojo/templates/dct-data-flow-template.yaml +40 -0
- package/docs/ja/specdojo/templates/dct-data-model-bdd-template.yaml +46 -0
- package/docs/ja/specdojo/templates/dct-data-model-ccd-template.yaml +46 -0
- package/docs/ja/specdojo/templates/dct-data-model-cdsd-template.yaml +41 -0
- package/docs/ja/specdojo/templates/dct-data-model-cld-template.yaml +38 -0
- package/docs/ja/specdojo/templates/dct-data-model-sld-template.yaml +38 -0
- package/docs/ja/specdojo/templates/dct-data-model-stsd-template.yaml +46 -0
- package/docs/ja/specdojo/templates/dct-external-interface-specs-template.yaml +114 -0
- package/docs/ja/specdojo/templates/dct-glossary-template.yaml +35 -0
- package/docs/ja/specdojo/templates/dct-impact-analysis-template.yaml +138 -0
- package/docs/ja/specdojo/templates/dct-index-template.md +40 -0
- package/docs/ja/specdojo/templates/dct-migration-planning-template.yaml +148 -0
- package/docs/ja/specdojo/templates/dct-non-functional-requirements-template.yaml +222 -0
- package/docs/ja/specdojo/templates/dct-operations-template.yaml +108 -0
- package/docs/ja/specdojo/templates/dct-project-definition-template.yaml +210 -0
- package/docs/ja/specdojo/templates/dct-project-management-template.yaml +423 -0
- package/docs/ja/specdojo/templates/dct-system-acceptance-criteria-template.yaml +37 -0
- package/docs/ja/specdojo/templates/dct-system-design-template.yaml +82 -0
- package/docs/ja/specdojo/templates/dct-system-functions-template.yaml +58 -0
- package/docs/ja/specdojo/templates/dct-test-specs-template.yaml +261 -0
- package/docs/ja/specdojo/templates/dct-user-interface-model-template.yaml +60 -0
- package/docs/ja/specdojo/templates/ifx-cmd-template.yaml +88 -0
- package/docs/ja/specdojo/templates/opr-template.md +85 -0
- package/docs/ja/specdojo/templates/pjr-change-request-template.md +60 -0
- package/docs/ja/specdojo/templates/pjr-decision-template.md +61 -0
- package/docs/ja/specdojo/templates/pjr-index-template.md +49 -0
- package/docs/ja/specdojo/templates/pjr-issue-template.md +50 -0
- package/docs/ja/specdojo/templates/pjr-note-template.md +35 -0
- package/docs/ja/specdojo/templates/pjr-question-template.md +53 -0
- package/docs/ja/specdojo/templates/pjr-risk-template.md +49 -0
- package/docs/ja/specdojo/templates/pjr-todo-template.md +41 -0
- package/docs/ja/specdojo/templates/pjr-views-by-owner-template.md +22 -0
- package/docs/ja/specdojo/templates/pjr-views-by-priority-template.md +22 -0
- package/docs/ja/specdojo/templates/pjr-views-by-status-template.md +22 -0
- package/docs/ja/specdojo/templates/pm-change-request-log-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-communication-plan-template.md +46 -0
- package/docs/ja/specdojo/templates/pm-decision-log-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-issue-log-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-members-template.yaml +105 -0
- package/docs/ja/specdojo/templates/pm-organization-template.md +44 -0
- package/docs/ja/specdojo/templates/pm-plan-template.md +52 -0
- package/docs/ja/specdojo/templates/pm-quality-management-plan-template.md +46 -0
- package/docs/ja/specdojo/templates/pm-raci-template.md +51 -0
- package/docs/ja/specdojo/templates/pm-risk-register-template.md +20 -0
- package/docs/ja/specdojo/templates/pm-roles-template.yaml +53 -0
- package/docs/ja/specdojo/templates/prj-assumptions-constraints-dependencies-template.md +59 -0
- package/docs/ja/specdojo/templates/prj-charter-template.md +116 -0
- package/docs/ja/specdojo/templates/prj-comparison-of-alternatives-template.md +116 -0
- package/docs/ja/specdojo/templates/prj-issues-and-approach-template.md +89 -0
- package/docs/ja/specdojo/templates/prj-overview-template.md +85 -0
- package/docs/ja/specdojo/templates/prj-scope-template.md +75 -0
- package/docs/ja/specdojo/templates/prj-stakeholder-register-template.md +64 -0
- package/docs/ja/specdojo/templates/prj-success-criteria-and-acceptance-criteria-template.md +60 -0
- package/docs/ja/specdojo/templates/stsd-template.md +57 -0
- package/docs/specdojo/schemas/v1/bdd.schema.yaml +230 -0
- package/docs/specdojo/schemas/v1/common-frontmatter.schema.yaml +77 -0
- package/docs/specdojo/schemas/v1/dct-index.schema.yaml +85 -0
- package/docs/specdojo/schemas/v1/dct-plan.schema.yaml +324 -0
- package/docs/specdojo/schemas/v1/dct.schema.yaml +368 -0
- package/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml +91 -0
- package/docs/specdojo/schemas/v1/esil.schema.yaml +142 -0
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +101 -0
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +272 -0
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +162 -0
- package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +126 -0
- package/docs/specdojo/schemas/v1/exec-reporter-output.schema.yaml +151 -0
- package/docs/specdojo/schemas/v1/exec-result-frontmatter.schema.yaml +144 -0
- package/docs/specdojo/schemas/v1/grade-done-criteria.schema.yaml +79 -0
- package/docs/specdojo/schemas/v1/grade-pipeline-state.schema.yaml +60 -0
- package/docs/specdojo/schemas/v1/grade-result.schema.yaml +118 -0
- package/docs/specdojo/schemas/v1/guide-frontmatter.schema.yaml +19 -0
- package/docs/specdojo/schemas/v1/ifx-cmd.schema.yaml +293 -0
- package/docs/specdojo/schemas/v1/job-run.schema.yaml +90 -0
- package/docs/specdojo/schemas/v1/job.schema.yaml +198 -0
- package/docs/specdojo/schemas/v1/philosophy-frontmatter.schema.yaml +19 -0
- package/docs/specdojo/schemas/v1/pipeline-state.schema.yaml +56 -0
- package/docs/specdojo/schemas/v1/pm-members.schema.yaml +252 -0
- package/docs/specdojo/schemas/v1/pm-review-viewpoints.schema.yaml +387 -0
- package/docs/specdojo/schemas/v1/pm-roles.schema.yaml +106 -0
- package/docs/specdojo/schemas/v1/recipe-frontmatter.schema.yaml +27 -0
- package/docs/specdojo/schemas/v1/reference-frontmatter.schema.yaml +18 -0
- package/docs/specdojo/schemas/v1/register-events.schema.yaml +106 -0
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +204 -0
- package/docs/specdojo/schemas/v1/routine-run.schema.yaml +36 -0
- package/docs/specdojo/schemas/v1/routine.schema.yaml +87 -0
- package/docs/specdojo/schemas/v1/rulebook-frontmatter.schema.yaml +61 -0
- package/docs/specdojo/schemas/v1/sch-common.schema.yaml +258 -0
- package/docs/specdojo/schemas/v1/sch-defaults.schema.yaml +48 -0
- package/docs/specdojo/schemas/v1/sch-milestones.schema.yaml +64 -0
- package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +772 -0
- package/docs/specdojo/schemas/v1/sch-track.schema.yaml +66 -0
- package/docs/specdojo/schemas/v1/standard-frontmatter.schema.yaml +18 -0
- package/docs/specdojo/schemas/v1/tml-index.schema.yaml +103 -0
- package/package.json +120 -24
- package/templates/claude/README.md +46 -0
- package/templates/claude/agents/claude-expert-review-executor.md +14 -0
- package/templates/claude/agents/claude-review-executor.md +14 -0
- package/templates/claude/settings.edit.json +6 -0
- package/templates/claude/settings.report.json +6 -0
- package/templates/claude/settings.review.json +7 -0
- package/templates/codex/README.md +61 -0
- package/templates/codex/agents/codex-executor.toml +12 -0
- package/templates/codex/agents/codex-expert-executor.toml +12 -0
- package/templates/codex/agents/codex-expert-review-executor.toml +10 -0
- package/templates/codex/agents/codex-review-executor.toml +10 -0
- package/templates/copilot/README.md +41 -0
- package/templates/copilot/exec-defaults-snippet.yaml +28 -0
- package/templates/copilot/pm-members-snippet.yaml +44 -0
- package/templates/opencode/README.md +41 -0
- package/templates/opencode/agents/opencode-executor.md +59 -0
- package/templates/opencode/agents/opencode-reporter.md +26 -0
- package/templates/opencode/agents/opencode-review-executor.md +48 -0
- package/dist/exec-schedule-timeline-render.js +0 -201
- package/dist/exec-schedule-timeline.js +0 -2
|
@@ -0,0 +1,484 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:opr-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
target_format: markdown
|
|
7
|
+
sample:
|
|
8
|
+
- specdojo:opr-sample
|
|
9
|
+
- specdojo:opr-access-control-sample
|
|
10
|
+
- specdojo:opr-backup-restore-sample
|
|
11
|
+
- specdojo:opr-batch-sample
|
|
12
|
+
- specdojo:opr-change-sample
|
|
13
|
+
- specdojo:opr-incident-sample
|
|
14
|
+
- specdojo:opr-monitoring-sample
|
|
15
|
+
- specdojo:opr-support-sample
|
|
16
|
+
template: specdojo:opr-template
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
# 運用手順 作成ルール
|
|
20
|
+
|
|
21
|
+
Operations Procedure Runbook (OPR) Documentation Rules
|
|
22
|
+
|
|
23
|
+
本ドキュメントは、運用手順ドキュメント(`opr-index` / `opr-<term>`)を統一形式で記述するためのルールです。
|
|
24
|
+
運用作業を再現可能な手順として定義し、誰が実施しても同じ結果になる状態(属人化防止)を実現するための内容を定義します。
|
|
25
|
+
|
|
26
|
+
## 1. 全体方針
|
|
27
|
+
|
|
28
|
+
`opr-index`(必要に応じて `opr-<term>`)は、恒常運用の実行手順と証跡ルールを一元化する SSOT とする。
|
|
29
|
+
|
|
30
|
+
- 日次/週次/月次運用を再現可能な手順として定義する
|
|
31
|
+
- 障害/アラート対応を優先度別に明文化し、初動を標準化する
|
|
32
|
+
- 変更作業(設定変更/デプロイ/ロールバック)の統制を明確化する
|
|
33
|
+
- バックアップ確認・リストア演習・バッチ再実行を手順化する
|
|
34
|
+
- 証跡(ログ/チケット/チェックリスト/実施記録)を必須化する
|
|
35
|
+
|
|
36
|
+
### 1.1. index / term 分割方針
|
|
37
|
+
|
|
38
|
+
- 原則 `opr-index` を作成し、運用手順の入口(SSOT)とする
|
|
39
|
+
- `opr-<term>` は運用ドメイン(障害対応/監視/バッチ/権限/問い合わせ/変更等)が独立している場合に追加する
|
|
40
|
+
- `opr-<term>` を追加する場合でも、共通手順規約(証跡、承認、優先度定義、エスカレーション基準、テンプレ)は `opr-index` を正とする
|
|
41
|
+
- `opr-<term>` では、原則として **`opr-index` の差分(具体手順・個別判断)** を記述し、共通規約の重複記載を避ける
|
|
42
|
+
|
|
43
|
+
## 2. 位置づけと用語定義
|
|
44
|
+
|
|
45
|
+
### 2.1. 位置づけ(他ドキュメントとの関係)
|
|
46
|
+
|
|
47
|
+
`opr-index` / `opr-<term>` と他ドキュメントの関係を示します。必要に応じて Mermaid を用いた図を使用してよい。
|
|
48
|
+
|
|
49
|
+
- `opd-index` / `opd-<term>`:運用方針・統制(あるべき姿・判断基準)
|
|
50
|
+
- **`opr-index` / `opr-<term>`:運用手順・Runbook(再現可能な実行手順と証跡)**
|
|
51
|
+
- OPD は「方針と統制(あるべき姿・判断基準)」、OPR は「手順と証跡(再現可能な作業)」を責務とする
|
|
52
|
+
|
|
53
|
+
### 2.2. 用語定義
|
|
54
|
+
|
|
55
|
+
| 用語 | 定義 |
|
|
56
|
+
| -------- | ------------------------------------------------------------------------------ |
|
|
57
|
+
| 証跡 | 実施結果を第三者が追跡可能にする記録(ログURL/チケットID/チェックリスト/添付) |
|
|
58
|
+
| 一次対応 | 影響拡大防止の暫定措置と状況確定(切り分け・通知・暫定復旧) |
|
|
59
|
+
| 恒久対応 | 根本原因の除去(修正・設定変更・再発防止) |
|
|
60
|
+
|
|
61
|
+
## 3. ファイル命名・ID規則
|
|
62
|
+
|
|
63
|
+
- `id` は `opr-index` または `opr-<term>`(kebab-case。例: `opr-incident`)。
|
|
64
|
+
- ファイル名はプロジェクト内で一意になるように命名する(日本語可)。
|
|
65
|
+
- 例: `運用手順.md` / `運用手順-障害対応.md`
|
|
66
|
+
- 並び順が必要な場合は接頭辞の番号付与(例: `opr-010-...`)を **任意** で用いてよい
|
|
67
|
+
- `<term>` は用語集(GL)の論理名キー(英小文字kebab-case)を用いる(表示名は title / ファイル名で日本語を使用してよい)。
|
|
68
|
+
|
|
69
|
+
## 4. 推奨 Frontmatter 項目
|
|
70
|
+
|
|
71
|
+
### 4.1. 設定内容
|
|
72
|
+
|
|
73
|
+
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))。
|
|
74
|
+
|
|
75
|
+
| 項目 | 説明 | 必須 |
|
|
76
|
+
| ---------- | -------------------------------------------- | ---- |
|
|
77
|
+
| id | OPR ID(`opr-index` または `opr-<term>`) | ○ |
|
|
78
|
+
| type | `operations` 固定 | ○ |
|
|
79
|
+
| title | 運用手順: <対象名> | ○ |
|
|
80
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
81
|
+
| based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
|
|
82
|
+
| supersedes | 置き換え関係(ID配列。未指定は `[]` 可) | 任意 |
|
|
83
|
+
|
|
84
|
+
### 4.2. 推奨ルール
|
|
85
|
+
|
|
86
|
+
- `based_on` には手順判断に直接利用した成果物(例: `opd-*` / `nfr-*` / `issue-*`)のみ列挙する
|
|
87
|
+
- `based_on` / `supersedes` は ID 配列(未指定は `[]` 可)
|
|
88
|
+
|
|
89
|
+
## 5. 本文要件
|
|
90
|
+
|
|
91
|
+
本文の見出し順と記入欄の骨組みは Frontmatter で宣言した template を正本とし、本章では各章の目的と必須性だけを定めます。
|
|
92
|
+
|
|
93
|
+
- 概要、適用範囲・前提、定期点検、障害対応、アラート対応、バックアップ・リストア、バッチ再実行、運用変更、アカウント付与・剥奪、問い合わせ一次対応、証跡、関連文書導線を必須とします。
|
|
94
|
+
- 各章は、実施条件、実施者、判断条件、完了条件、証跡のうち該当する要素を第三者が再現できる粒度で定義します。
|
|
95
|
+
- `opr-<term>` で該当する作業がない章も省略せず、`なし`、`opr-index 参照`、`本書の範囲外` のいずれかと理由を記載します。
|
|
96
|
+
- `opr-index` は共通規約と全体の導線、`opr-<term>` は対象作業の具体手順と個別判断を正本とし、同じ規約を重複させません。
|
|
97
|
+
|
|
98
|
+
## 6. 記述ガイド
|
|
99
|
+
|
|
100
|
+
### 6.1. 概要(`index` / `<term>`)
|
|
101
|
+
|
|
102
|
+
生成する本文の見出しは **## 1. 概要(`index` / `<term>`)**
|
|
103
|
+
|
|
104
|
+
- 手順の対象と目的を 1〜3 行で示す
|
|
105
|
+
- `opr-index` が実行手順の SSOT であることを明示する
|
|
106
|
+
- `opr-<term>` の場合は「`opr-index` の差分・具体化である」ことを 1 行で明示する
|
|
107
|
+
|
|
108
|
+
### 6.2. 手順適用範囲・前提
|
|
109
|
+
|
|
110
|
+
生成する本文の見出しは **## 2. 手順適用範囲・前提**
|
|
111
|
+
|
|
112
|
+
- 適用対象、適用外、実施可能時間帯、必要権限を明記する
|
|
113
|
+
- 前提(環境、ツール、連絡経路、参照先)を明記する
|
|
114
|
+
|
|
115
|
+
推奨フォーマット(表):
|
|
116
|
+
|
|
117
|
+
| 項目 | 内容 |
|
|
118
|
+
| ---------- | -------------------------------- |
|
|
119
|
+
| 対象 | (例:本番環境、staging) |
|
|
120
|
+
| 時間帯 | (例:平日9-18、夜間可否) |
|
|
121
|
+
| 必要権限 | (例:SRE権限、DB read-only 等) |
|
|
122
|
+
| 使用ツール | (例:監視SaaS、チケット、CLI) |
|
|
123
|
+
| 連絡先 | (例:#ops、#dev、電話) |
|
|
124
|
+
|
|
125
|
+
### 6.3. 日次/週次/月次点検手順
|
|
126
|
+
|
|
127
|
+
生成する本文の見出しは **## 3. 日次/週次/月次点検手順**
|
|
128
|
+
|
|
129
|
+
- 頻度別に手順、実施者、完了条件、証跡を定義する
|
|
130
|
+
- 実施漏れの検知方法とエスカレーションを明記してよい
|
|
131
|
+
|
|
132
|
+
推奨フォーマット(表):
|
|
133
|
+
|
|
134
|
+
| 頻度 | 手順 | 実施者 | 完了条件 | 証跡 |
|
|
135
|
+
| ---- | ---- | ------ | -------- | ---- |
|
|
136
|
+
|
|
137
|
+
### 6.4. 障害対応手順(P1/P2…、切り分け、一次対応、復旧)
|
|
138
|
+
|
|
139
|
+
生成する本文の見出しは **## 4. 障害対応手順(P1/P2…、切り分け、一次対応、復旧)**
|
|
140
|
+
|
|
141
|
+
- 優先度別に切り分け手順、一次対応、復旧手順を明記する
|
|
142
|
+
- エスカレーション条件と判断者を明記する
|
|
143
|
+
- 停止判断・ロールバックが関わる場合は、判断条件と承認者を必ず書く
|
|
144
|
+
|
|
145
|
+
推奨フォーマット(表):
|
|
146
|
+
|
|
147
|
+
| 優先度 | 初動SLA | 切り分け | 一次対応 | 復旧 | エスカレーション |
|
|
148
|
+
| ------ | ------- | -------- | -------- | ---- | ---------------- |
|
|
149
|
+
|
|
150
|
+
### 6.5. アラート対応手順(確認→暫定対応→恒久対応)
|
|
151
|
+
|
|
152
|
+
生成する本文の見出しは **## 5. アラート対応手順(確認→暫定対応→恒久対応)**
|
|
153
|
+
|
|
154
|
+
- 検知後の確認、暫定対応、恒久対応の流れを明記する
|
|
155
|
+
- 誤検知時の扱い(クローズ条件、閾値調整、抑止)を明記する
|
|
156
|
+
|
|
157
|
+
推奨フォーマット(表):
|
|
158
|
+
|
|
159
|
+
| 段階 | 手順 | 完了条件 | 証跡 |
|
|
160
|
+
| ---- | ---- | -------- | ---- |
|
|
161
|
+
|
|
162
|
+
### 6.6. バックアップ確認・リストア手順(演習含む)
|
|
163
|
+
|
|
164
|
+
生成する本文の見出しは **## 6. バックアップ確認・リストア手順(演習含む)**
|
|
165
|
+
|
|
166
|
+
- バックアップ確認項目、リストア手順、演習頻度を明記する
|
|
167
|
+
- 演習結果の証跡(ログ/レポート/所要時間)を必須化する
|
|
168
|
+
- RTO/RPO がある場合は、達成可否の判定方法を明記する(方針は OPD、実施は OPR)
|
|
169
|
+
|
|
170
|
+
### 6.7. バッチ再実行・失敗時対応
|
|
171
|
+
|
|
172
|
+
生成する本文の見出しは **## 7. バッチ再実行・失敗時対応**
|
|
173
|
+
|
|
174
|
+
- 失敗検知、再実行条件、再実行上限、エスカレーションを明記する
|
|
175
|
+
- 再実行でデータ重複が起きうる場合は、冪等性/防止策(run_id 等)を明記する
|
|
176
|
+
|
|
177
|
+
### 6.8. 運用変更作業(設定変更・デプロイ・ロールバック)
|
|
178
|
+
|
|
179
|
+
生成する本文の見出しは **## 8. 運用変更作業(設定変更・デプロイ・ロールバック)**
|
|
180
|
+
|
|
181
|
+
- 変更種別、承認者、実施条件(時間帯/凍結)、ロールバック条件を明記する
|
|
182
|
+
- 変更の証跡(チケット、差分、承認ログ、実施ログ)を必須化する
|
|
183
|
+
- 重大変更は事前周知の要否と手段を明記する
|
|
184
|
+
|
|
185
|
+
### 6.9. アカウント付与/剥奪手順
|
|
186
|
+
|
|
187
|
+
生成する本文の見出しは **## 9. アカウント付与/剥奪手順**
|
|
188
|
+
|
|
189
|
+
- 申請→承認→実施→検証→記録の流れを明記する
|
|
190
|
+
- 棚卸し(定期)と緊急権限(ブレークグラス)がある場合は、その実施手順と証跡を明記する
|
|
191
|
+
|
|
192
|
+
### 6.10. 問い合わせ一次対応手順(テンプレ・ナレッジ)
|
|
193
|
+
|
|
194
|
+
生成する本文の見出しは **## 10. 問い合わせ一次対応手順(テンプレ・ナレッジ)**
|
|
195
|
+
|
|
196
|
+
- 問い合わせ分類、一次対応テンプレ、ナレッジ参照先を明記する
|
|
197
|
+
- 引き継ぎ条件(開発/業務/運用)を明記する
|
|
198
|
+
|
|
199
|
+
### 6.11. 証跡(ログ、チケット、チェックリスト、実施記録)
|
|
200
|
+
|
|
201
|
+
生成する本文の見出しは **## 11. 証跡(ログ、チケット、チェックリスト、実施記録)**
|
|
202
|
+
|
|
203
|
+
- 必須証跡、保存先、保管期間、参照権限を明記する
|
|
204
|
+
- 証跡は「どのURL/どのID/どのrun_id」が分かる粒度で残す
|
|
205
|
+
|
|
206
|
+
推奨フォーマット(表):
|
|
207
|
+
|
|
208
|
+
| 証跡種別 | 保存先 | 保管期間 | 参照権限 | 最低限残す識別子 |
|
|
209
|
+
| -------------- | ---------------- | ------------ | --------------- | ---------------- |
|
|
210
|
+
| チケット | (例:Jira) | (例:2年) | (例:Ops/Dev) | ticket_id |
|
|
211
|
+
| 実施ログ | (例:ログ基盤) | (例:90日) | (例:Ops) | run_id, job_id |
|
|
212
|
+
| チェックリスト | (例:Docs) | (例:1年) | (例:Ops) | 実施日, 実施者 |
|
|
213
|
+
|
|
214
|
+
### 6.12. 関連ドキュメント導線(`opd` 参照、`mip` / `otp` / `cop` 連携)
|
|
215
|
+
|
|
216
|
+
生成する本文の見出しは **## 12. 関連ドキュメント導線(`opd` 参照、`mip` / `otp` / `cop` 連携)**
|
|
217
|
+
|
|
218
|
+
- `opd-index` への導線を必ず記載する
|
|
219
|
+
- `mip-*` / `otp-*` / `cop-*` は必要時のみ連携情報として記載する
|
|
220
|
+
- 分冊がない場合でも `(本書のみ)` または `(なし)` を明記する
|
|
221
|
+
|
|
222
|
+
推奨フォーマット(表):
|
|
223
|
+
|
|
224
|
+
| 種別 | ドキュメントID | 目的 | 備考 |
|
|
225
|
+
| ---- | -------------- | ---- | ---- |
|
|
226
|
+
|
|
227
|
+
## 7. 禁止事項
|
|
228
|
+
|
|
229
|
+
| 禁止事項 | 理由 |
|
|
230
|
+
| ------------------------------------------------------ | --------------------------------------------- |
|
|
231
|
+
| 手順を曖昧語(適宜/必要に応じて等)で記載する | 再現性が担保できないため |
|
|
232
|
+
| 優先度別手順(P1/P2等)を省略する | 障害時初動が標準化できないため |
|
|
233
|
+
| 証跡要件(ログ/チケット/チェックリスト)を未定義にする | 監査性・追跡性が欠落するため |
|
|
234
|
+
| 変更作業の承認・ロールバック条件を未記載にする | 変更統制が崩壊するため |
|
|
235
|
+
| バックアップ確認・リストア演習を手順化しない | 復旧可能性が検証できないため |
|
|
236
|
+
| OPD と矛盾する運用手順を独自定義する | 方針と手順の整合が崩れ、運用品質を損なうため |
|
|
237
|
+
| 長大なコマンド列や設定全文を本文に貼り付ける | 差分管理が破綻するため(別紙/リンクに寄せる) |
|
|
238
|
+
|
|
239
|
+
## 8. サンプル(拡充)
|
|
240
|
+
|
|
241
|
+
注:以下はルール文書内の例示です。生成する `opr-index` / `opr-<term>` では `## 1...` から始まります。
|
|
242
|
+
|
|
243
|
+
### 8.1. サンプル: opr-index(全体)
|
|
244
|
+
|
|
245
|
+
```yaml
|
|
246
|
+
---
|
|
247
|
+
id: opr-index
|
|
248
|
+
type: operations
|
|
249
|
+
title: 運用手順: 全体
|
|
250
|
+
status: draft
|
|
251
|
+
based_on: []
|
|
252
|
+
supersedes: []
|
|
253
|
+
---
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
#### 8.1.1. ## 1. 概要(index)
|
|
257
|
+
|
|
258
|
+
恒常運用の実行手順を標準化し、担当者差によらず同一品質で運用できる状態を定義する(本書がSSOT)。
|
|
259
|
+
|
|
260
|
+
#### 8.1.2. ## 3. 日次/週次/月次点検手順
|
|
261
|
+
|
|
262
|
+
| 頻度 | 手順 | 実施者 | 完了条件 | 証跡 |
|
|
263
|
+
| ---- | ---- | ------ | -------- | ---- |
|
|
264
|
+
|
|
265
|
+
| 日次 | 監視ダッシュ確認 | Ops当番 | P1相当の異常がない、または起票済み | 日次チェックシート |
|
|
266
|
+
| 週次 | 主要アラートの誤検知レビュー | Ops Lead | 誤検知が棚卸し済み | 週次レビュー記録 |
|
|
267
|
+
| 月次 | 権限棚卸しの実施確認 | Sec/Ops | 棚卸し完了 | 棚卸しレポート |
|
|
268
|
+
|
|
269
|
+
#### 8.1.3. ## 11. 証跡(ログ、チケット、チェックリスト、実施記録)
|
|
270
|
+
|
|
271
|
+
| 証跡種別 | 保存先 | 保管期間 | 参照権限 | 最低限残す識別子 |
|
|
272
|
+
| -------------- | --------- | -------- | -------- | ---------------- |
|
|
273
|
+
| チケット | Issue管理 | 2年 | Ops/Dev | ticket_id |
|
|
274
|
+
| 実施ログ | ログ基盤 | 90日 | Ops | run_id, job_id |
|
|
275
|
+
| チェックリスト | Docs | 1年 | Ops | 実施日, 実施者 |
|
|
276
|
+
|
|
277
|
+
#### 8.1.4. ## 12. 関連ドキュメント導線(`opd` 参照、`mip` / `otp` / `cop` 連携)
|
|
278
|
+
|
|
279
|
+
| 種別 | ドキュメントID | 目的 | 備考 |
|
|
280
|
+
| ---- | ------------------ | ------------------------------------- | ---------- |
|
|
281
|
+
| 方針 | opd-index | 統制・判断基準(SLO/SLA、停止判断等) | 必須 |
|
|
282
|
+
| 手順 | opr-incident | 障害対応手順(優先度別) | 該当時 |
|
|
283
|
+
| 手順 | opr-monitoring | アラート対応手順 | 該当時 |
|
|
284
|
+
| 手順 | opr-backup-restore | バックアップ確認/復旧演習 | 該当時 |
|
|
285
|
+
| 移行 | otp-index | ハイパーケア連携(参考) | 必要時のみ |
|
|
286
|
+
|
|
287
|
+
---
|
|
288
|
+
|
|
289
|
+
### 8.2. サンプル: opr-incident(障害対応)
|
|
290
|
+
|
|
291
|
+
```yaml
|
|
292
|
+
---
|
|
293
|
+
id: opr-incident
|
|
294
|
+
type: operations
|
|
295
|
+
title: 運用手順: 障害対応
|
|
296
|
+
status: draft
|
|
297
|
+
based_on: [opd-incident-management]
|
|
298
|
+
supersedes: []
|
|
299
|
+
---
|
|
300
|
+
```
|
|
301
|
+
|
|
302
|
+
#### 8.2.1. 概要(incident)
|
|
303
|
+
|
|
304
|
+
障害対応の切り分け・一次対応・復旧・報告を `opr-index` の具体手順として定義する。
|
|
305
|
+
|
|
306
|
+
#### 8.2.2. 障害対応手順(P1/P2…、切り分け、一次対応、復旧)
|
|
307
|
+
|
|
308
|
+
| 優先度 | 初動SLA | 切り分け | 一次対応 | 復旧 | エスカレーション |
|
|
309
|
+
| ------ | ------- | -------------------------- | ------------------------- | -------------------- | ----------------------- |
|
|
310
|
+
| P1 | 30分 | 監視→直近変更→主要依存確認 | 影響遮断(機能停止/迂回) | 復旧作業→確認 | Ops Lead→PO(停止判断) |
|
|
311
|
+
| P2 | 2時間 | ログ/メトリクス確認 | 回避策提示 | 恒久対応チケット起票 | Ops Lead→Dev Lead |
|
|
312
|
+
| P3 | 1営業日 | 再現条件整理 | 影響が小さければ保留 | 次リリースで対応 | Ops Leadへ共有 |
|
|
313
|
+
|
|
314
|
+
#### 8.2.3. 証跡(ログ、チケット、チェックリスト、実施記録)
|
|
315
|
+
|
|
316
|
+
- 必須: ticket_id、影響範囲、発生/検知時刻、一次対応内容、復旧時刻、原因、再発防止
|
|
317
|
+
- 保存先: 障害チケット(template: INC-01)
|
|
318
|
+
|
|
319
|
+
#### 8.2.4. 関連ドキュメント導線
|
|
320
|
+
|
|
321
|
+
| 種別 | ドキュメントID | 目的 | 備考 |
|
|
322
|
+
| ---- | ----------------------- | ------------------------ | ------ |
|
|
323
|
+
| 方針 | opd-incident-management | 優先度/停止判断/周知基準 | 必須 |
|
|
324
|
+
| 手順 | opr-monitoring | アラート起点の切り分け | 該当時 |
|
|
325
|
+
|
|
326
|
+
---
|
|
327
|
+
|
|
328
|
+
### 8.3. サンプル: opr-monitoring(アラート対応)
|
|
329
|
+
|
|
330
|
+
```yaml
|
|
331
|
+
---
|
|
332
|
+
id: opr-monitoring
|
|
333
|
+
type: operations
|
|
334
|
+
title: 運用手順: 監視・アラート対応
|
|
335
|
+
status: draft
|
|
336
|
+
based_on: [opd-monitoring]
|
|
337
|
+
supersedes: []
|
|
338
|
+
---
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
#### 8.3.1. 概要(monitoring)
|
|
342
|
+
|
|
343
|
+
監視アラートの確認→暫定対応→恒久対応を `opr-index` の具体手順として定義する。
|
|
344
|
+
|
|
345
|
+
#### 8.3.2. アラート対応手順(確認→暫定対応→恒久対応)
|
|
346
|
+
|
|
347
|
+
| 段階 | 手順 | 完了条件 | 証跡 |
|
|
348
|
+
| -------- | -------------------------------- | ---------------------- | ------------ |
|
|
349
|
+
| 確認 | アラート種別/影響/発生範囲を確認 | 優先度(P1/P2/P3)確定 | チケット起票 |
|
|
350
|
+
| 暫定対応 | 影響遮断(機能停止/スロットル) | 影響拡大が止まる | 実施ログ |
|
|
351
|
+
| 恒久対応 | 原因特定→修正計画→反映 | 再発防止策が合意 | 修正チケット |
|
|
352
|
+
| 誤検知 | 根拠を記録し閾値/抑止を提案 | 再発防止(閾値調整) | 設定変更記録 |
|
|
353
|
+
|
|
354
|
+
---
|
|
355
|
+
|
|
356
|
+
### 8.4. サンプル: opr-backup-restore(バックアップ/復旧演習)
|
|
357
|
+
|
|
358
|
+
```yaml
|
|
359
|
+
---
|
|
360
|
+
id: opr-backup-restore
|
|
361
|
+
type: operations
|
|
362
|
+
title: 運用手順: バックアップ確認・リストア
|
|
363
|
+
status: draft
|
|
364
|
+
based_on: [opd-index]
|
|
365
|
+
supersedes: []
|
|
366
|
+
---
|
|
367
|
+
```
|
|
368
|
+
|
|
369
|
+
#### 8.4.1. バックアップ確認・リストア手順(演習含む)
|
|
370
|
+
|
|
371
|
+
- 確認(毎日):
|
|
372
|
+
- 最新バックアップの生成時刻とサイズを確認
|
|
373
|
+
- 失敗があればチケット起票(P2)
|
|
374
|
+
|
|
375
|
+
- 演習(四半期):
|
|
376
|
+
- staging にリストア → 主要テーブルの件数/参照整合を確認
|
|
377
|
+
- 所要時間を記録し、RTO/RPO達成可否を判定する
|
|
378
|
+
|
|
379
|
+
証跡:
|
|
380
|
+
|
|
381
|
+
- 演習レポート(日時/所要時間/成功可否/ログURL)
|
|
382
|
+
|
|
383
|
+
---
|
|
384
|
+
|
|
385
|
+
### 8.5. サンプル: opr-batch(バッチ再実行)
|
|
386
|
+
|
|
387
|
+
```yaml
|
|
388
|
+
---
|
|
389
|
+
id: opr-batch
|
|
390
|
+
type: operations
|
|
391
|
+
title: 運用手順: バッチ再実行・失敗対応
|
|
392
|
+
status: draft
|
|
393
|
+
based_on: [opd-index]
|
|
394
|
+
supersedes: []
|
|
395
|
+
---
|
|
396
|
+
```
|
|
397
|
+
|
|
398
|
+
#### 8.5.1. バッチ再実行・失敗時対応
|
|
399
|
+
|
|
400
|
+
- 失敗検知: 監視アラート or ジョブ管理の失敗通知
|
|
401
|
+
- 再実行条件:
|
|
402
|
+
- 同一run_idで再実行可否を確認(冪等性方式に従う)
|
|
403
|
+
- 再実行上限: 1回(2回目はOps Lead判断)
|
|
404
|
+
|
|
405
|
+
- エスカレーション:
|
|
406
|
+
- データ不整合の可能性がある場合は P1 として `opr-incident` に切替
|
|
407
|
+
|
|
408
|
+
---
|
|
409
|
+
|
|
410
|
+
### 8.6. サンプル: opr-change(運用変更)
|
|
411
|
+
|
|
412
|
+
```yaml
|
|
413
|
+
---
|
|
414
|
+
id: opr-change
|
|
415
|
+
type: operations
|
|
416
|
+
title: 運用手順: 運用変更(設定変更・デプロイ)
|
|
417
|
+
status: draft
|
|
418
|
+
based_on: [opd-index]
|
|
419
|
+
supersedes: []
|
|
420
|
+
---
|
|
421
|
+
```
|
|
422
|
+
|
|
423
|
+
#### 8.6.1. 運用変更作業(設定変更・デプロイ・ロールバック)
|
|
424
|
+
|
|
425
|
+
- 事前:
|
|
426
|
+
- 変更チケット起票(承認者: Ops Lead)
|
|
427
|
+
- 影響評価とロールバック方針を記載
|
|
428
|
+
|
|
429
|
+
- 実施:
|
|
430
|
+
- 実施ログ(誰が/いつ/何を)を残す
|
|
431
|
+
|
|
432
|
+
- ロールバック:
|
|
433
|
+
- 異常(P1/P2)発生時は即時戻し、報告
|
|
434
|
+
|
|
435
|
+
---
|
|
436
|
+
|
|
437
|
+
### 8.7. サンプル: opr-access-control(アカウント付与/剥奪)
|
|
438
|
+
|
|
439
|
+
```yaml
|
|
440
|
+
---
|
|
441
|
+
id: opr-access-control
|
|
442
|
+
type: operations
|
|
443
|
+
title: 運用手順: アカウント付与・剥奪
|
|
444
|
+
status: draft
|
|
445
|
+
based_on: [opd-access-control]
|
|
446
|
+
supersedes: []
|
|
447
|
+
---
|
|
448
|
+
```
|
|
449
|
+
|
|
450
|
+
#### 8.7.1. アカウント付与/剥奪手順
|
|
451
|
+
|
|
452
|
+
| 手順 | 内容 | 実施者 | 完了条件 | 証跡 |
|
|
453
|
+
| ---- | -------------------- | ----------- | ---------------- | ------------- |
|
|
454
|
+
| 1 | 申請受付(チケット) | Support/Ops | 必要情報が揃う | ticket_id |
|
|
455
|
+
| 2 | 承認 | Ops Lead | 承認コメントあり | 承認ログ |
|
|
456
|
+
| 3 | 付与/剥奪 | Ops | 権限反映確認 | 実施ログ |
|
|
457
|
+
| 4 | 検証 | 申請者 | ログイン確認 | スクショ/ログ |
|
|
458
|
+
| 5 | 記録 | Ops | 台帳更新 | 台帳 |
|
|
459
|
+
|
|
460
|
+
---
|
|
461
|
+
|
|
462
|
+
### 8.8. サンプル: opr-support(問い合わせ一次対応)
|
|
463
|
+
|
|
464
|
+
```yaml
|
|
465
|
+
---
|
|
466
|
+
id: opr-support
|
|
467
|
+
type: operations
|
|
468
|
+
title: 運用手順: 問い合わせ一次対応
|
|
469
|
+
status: draft
|
|
470
|
+
based_on: [opd-index]
|
|
471
|
+
supersedes: []
|
|
472
|
+
---
|
|
473
|
+
```
|
|
474
|
+
|
|
475
|
+
#### 8.8.1. 問い合わせ一次対応手順(テンプレ・ナレッジ)
|
|
476
|
+
|
|
477
|
+
- 分類:
|
|
478
|
+
- 仕様確認 / 障害疑い / 依頼(権限・設定) / データ修正要否
|
|
479
|
+
|
|
480
|
+
- 一次対応テンプレ(例):
|
|
481
|
+
- 受付→再現条件→影響→暫定回避→引継ぎ要否
|
|
482
|
+
|
|
483
|
+
- 引き継ぎ条件:
|
|
484
|
+
- 障害疑いは `opr-incident` へ(P判定を付与)
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:otp-index-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
recipe: undecided
|
|
7
|
+
sample: specdojo:otp-index-sample
|
|
8
|
+
template: undecided
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# 運用切替計画(ハイパーケア含む) 作成ルール
|
|
12
|
+
|
|
13
|
+
Operations Transition Plan Documentation Rules
|
|
14
|
+
|
|
15
|
+
本ドキュメントは、`otp-index`(運用切替計画の入口・共通SSOT)を一貫した粒度で作成するためのルールを定義する。
|
|
16
|
+
|
|
17
|
+
## 1. 全体方針
|
|
18
|
+
|
|
19
|
+
- `otp-index` は運用切替計画の入口(共通SSOT)として、運用安定化に必要な共通方針と判断軸を定義する。
|
|
20
|
+
- 個別領域の詳細は `otp-<term>` に委譲し、`otp-index` では共通運用と導線を定義する。
|
|
21
|
+
- 曖昧表現を避け、一次応答条件・SLA・クローズ条件が判定可能な記述にする。
|
|
22
|
+
|
|
23
|
+
## 2. 位置づけと用語定義(必要に応じて)
|
|
24
|
+
|
|
25
|
+
- `mip-index`: 移行計画・成功条件・ハイパーケア方針の合意
|
|
26
|
+
- `cop-index`: 当日切替の実行計画(Runbook)
|
|
27
|
+
- `otp-index`: 運用切替の共通設計(本書)
|
|
28
|
+
- `otp-<term>`: 対象別の運用詳細(監視、窓口、当番、手順差分)
|
|
29
|
+
- `mtp-index` / `mtp-<term>`: リハーサル計画と証跡
|
|
30
|
+
|
|
31
|
+
## 3. ファイル命名・ID規則
|
|
32
|
+
|
|
33
|
+
- `id` は `otp-index` を使用する。
|
|
34
|
+
- ファイル名は `otp-index-運用切替計画.md` など、プロジェクト内で一意になるように命名する。
|
|
35
|
+
|
|
36
|
+
## 4. 推奨 Frontmatter 項目
|
|
37
|
+
|
|
38
|
+
| 項目 | 説明 | 必須 |
|
|
39
|
+
| ---- | ---- | ---- |
|
|
40
|
+
|
|
41
|
+
| id | `otp-index` | ○ |
|
|
42
|
+
|
|
43
|
+
| type | `migration` 固定 | ○ |
|
|
44
|
+
| title | `運用切替計画: 全体` | ○ |
|
|
45
|
+
|
|
46
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
47
|
+
| based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
|
|
48
|
+
| supersedes | 置き換え関係(ID配列。未指定は `[]` 可) | 任意 |
|
|
49
|
+
|
|
50
|
+
## 5. 本文構成(標準テンプレ)
|
|
51
|
+
|
|
52
|
+
| 番号 | 見出し | 必須 |
|
|
53
|
+
| ---- | ------ | ---- |
|
|
54
|
+
|
|
55
|
+
| 1 | 概要(index) | ○ |
|
|
56
|
+
| 2 | 監視/アラート | ○ |
|
|
57
|
+
| 3 | バックアップ/リストア | ○ |
|
|
58
|
+
| 4 | 権限/アカウント移行 | ○ |
|
|
59
|
+
| 5 | 運用手順の変更点 | ○ |
|
|
60
|
+
| 6 | 問合せ窓口/一次対応 | ○ |
|
|
61
|
+
| 7 | 障害対応フロー | ○ |
|
|
62
|
+
| 8 | 初期増員体制(期間・当番・SLA) | ○ |
|
|
63
|
+
| 9 | 旧システムの停止/参照方針 | ○ |
|
|
64
|
+
| 10 | 移行完了後のクローズ条件 | ○ |
|
|
65
|
+
| 11 | 関連ドキュメント(必須) | ○ |
|
|
66
|
+
|
|
67
|
+
## 6. 記述ガイド
|
|
68
|
+
|
|
69
|
+
### 6.1. 概要(index)
|
|
70
|
+
|
|
71
|
+
- 運用安定化の目的と適用範囲を 1〜3 行で示す。
|
|
72
|
+
- 本書が入口(SSOT)であり、詳細は `otp-<term>` にあることを明記する。
|
|
73
|
+
|
|
74
|
+
### 6.2. 監視/アラート
|
|
75
|
+
|
|
76
|
+
- 監視対象、指標/閾値、通知先、初動ルールを明記する。
|
|
77
|
+
|
|
78
|
+
### 6.3. バックアップ/リストア
|
|
79
|
+
|
|
80
|
+
- バックアップ頻度、保管先、保持期間、リストア責任者を明記する。
|
|
81
|
+
|
|
82
|
+
### 6.4. 権限/アカウント移行
|
|
83
|
+
|
|
84
|
+
- 旧/新の権限差分、移行タイミング、検証方法を明記する。
|
|
85
|
+
|
|
86
|
+
### 6.5. 運用手順の変更点
|
|
87
|
+
|
|
88
|
+
- 旧手順との差分、理由、影響を明記し、詳細はリンク参照とする。
|
|
89
|
+
|
|
90
|
+
### 6.6. 問合せ窓口/一次対応
|
|
91
|
+
|
|
92
|
+
- 受付時間、チャネル、優先度分類、エスカレーション条件を明記する。
|
|
93
|
+
|
|
94
|
+
### 6.7. 障害対応フロー
|
|
95
|
+
|
|
96
|
+
- 判断/連絡/復旧/報告の流れと指揮系統を明記する。
|
|
97
|
+
|
|
98
|
+
### 6.8. 初期増員体制(期間・当番・SLA)
|
|
99
|
+
|
|
100
|
+
- ハイパーケア期間、当番体制、SLA、終了判断者を明記する。
|
|
101
|
+
|
|
102
|
+
### 6.9. 旧システムの停止/参照方針
|
|
103
|
+
|
|
104
|
+
- 停止時期、参照可否、アーカイブ方針を明記する。
|
|
105
|
+
|
|
106
|
+
### 6.10. 移行完了後のクローズ条件
|
|
107
|
+
|
|
108
|
+
- 完了条件、クローズ判断者、最終報告物を明記する。
|
|
109
|
+
|
|
110
|
+
### 6.11. 関連ドキュメント(必須)
|
|
111
|
+
|
|
112
|
+
- 各 `otp-<term>` への導線を必ず記載する。
|
|
113
|
+
- 分冊が無い場合でも `(本書のみ)` を明記する。
|
|
114
|
+
|
|
115
|
+
## 7. 禁止事項
|
|
116
|
+
|
|
117
|
+
- `otp-<term>` に委譲すべき個別運用詳細を `otp-index` に重複記載しない。
|
|
118
|
+
- 監視/窓口/SLA/クローズ条件を未定義にしない。
|
|
119
|
+
- `otp-<term>` への導線を欠落させない。
|
|
120
|
+
- 実装依存の長大な手順やコードを本文に記載しない。
|