specdojo 0.1.0 → 0.2.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/LICENSE +22 -0
- package/README.md +142 -35
- 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 +990 -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 +54 -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 +33 -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 +56 -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 +472 -0
- package/docs/ja/specdojo/guides/register-operation-guide.md +418 -0
- package/docs/ja/specdojo/guides/remote-host-development-guide.md +163 -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 +121 -24
- package/templates/antigravity/README.md +35 -0
- package/templates/antigravity/exec-defaults-snippet.yaml +38 -0
- package/templates/antigravity/orchestrator.md +146 -0
- package/templates/antigravity/pm-members-snippet.yaml +55 -0
- 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/agents/specdojo-orchestrator.md +153 -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/codex/agents/specdojo-orchestrator.toml +154 -0
- package/templates/codex/orchestrator.md +146 -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/templates/opencode/agents/specdojo-orchestrator.md +193 -0
- package/dist/exec-schedule-timeline-render.js +0 -201
- package/dist/exec-schedule-timeline.js +0 -2
|
@@ -0,0 +1,293 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:otp-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
sample: specdojo:otp-sample
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# 運用切替計画 作成ルール
|
|
10
|
+
|
|
11
|
+
Operations Transition Plan (OTP) Documentation Rules
|
|
12
|
+
|
|
13
|
+
本ドキュメントは、運用切替計画(ハイパーケア含む)ドキュメント(`otp-<term>`)を統一形式で記述するためのルールです。
|
|
14
|
+
切替後の運用を途切れさせず、初期不具合・問合せ増に耐える体制を作るための内容を定義します。
|
|
15
|
+
|
|
16
|
+
## 1. 全体方針
|
|
17
|
+
|
|
18
|
+
`otp-<term>` は、切替後の運用安定化と初期対応体制の対象別詳細を定義する個別SSOTとする。
|
|
19
|
+
|
|
20
|
+
- 共通方針(期間・SLA・優先度分類・クローズ基準)は `otp-index` を正とする
|
|
21
|
+
- 監視/アラート、バックアップ/リストアなどの運用基盤を明記する
|
|
22
|
+
- 権限/アカウント移行と運用手順の変更点を整理する
|
|
23
|
+
- 問合せ窓口と一次対応体制、障害対応フローを明確にする
|
|
24
|
+
- ハイパーケア期間の増員体制(期間/当番/SLA)を定義する
|
|
25
|
+
- 旧システムの停止/参照方針とクローズ条件を明記する
|
|
26
|
+
|
|
27
|
+
運用方針(term 運用):
|
|
28
|
+
|
|
29
|
+
- `otp-<term>` は、領域/拠点/システム群/運用ドメイン単位で作成する
|
|
30
|
+
- `otp-<term>` の判断体系は `otp-index` と矛盾させない
|
|
31
|
+
- **「関連ドキュメント」セクションは必須**(分冊が無い場合でも `(本書のみ)` を明記して空欄にしない)
|
|
32
|
+
|
|
33
|
+
## 2. 位置づけ
|
|
34
|
+
|
|
35
|
+
`otp-<term>` と他ドキュメントの関係を示します。必要に応じて Mermaid による図を使用してよい。
|
|
36
|
+
|
|
37
|
+
- `mip-index`:移行の合意・判断のSSOT(成功条件・カットオーバー骨格を含む)
|
|
38
|
+
- `dmd-index` / `dmd-<term>`:データ移行の詳細設計(マッピング/変換/検証)
|
|
39
|
+
- `mtp-index` / `mtp-<term>`:リハーサル計画・検証設計(観点/手順/証跡)
|
|
40
|
+
- `cop-index` / `cop-<term>`:当日実行の詳細手順(Runbook)
|
|
41
|
+
- `otp-index`:運用切替の入口(共通方針、期間/SLA、クローズ基準)
|
|
42
|
+
- **`otp-<term>`:運用切替の対象別詳細(監視設定/運用手順/窓口)**
|
|
43
|
+
|
|
44
|
+
## 3. ファイル命名・ID規則
|
|
45
|
+
|
|
46
|
+
- `id` は `otp-<term>`(kebab-case。例: `otp-hypercare` / `otp-support-desk`)。
|
|
47
|
+
- ファイル名は `otp-020-運用切替計画-<term>.md` 等、プロジェクト内で一意になるように命名する。
|
|
48
|
+
- `<term>` は用語集(GL)の論理名キー(英小文字kebab-case)を用いる(表示名は title / ファイル名で日本語を使用してよい)。
|
|
49
|
+
|
|
50
|
+
## 4. 推奨 Frontmatter 項目
|
|
51
|
+
|
|
52
|
+
### 4.1. 設定内容
|
|
53
|
+
|
|
54
|
+
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))。
|
|
55
|
+
|
|
56
|
+
| 項目 | 説明 | 必須 |
|
|
57
|
+
| ---------- | -------------------------------------------- | ---- |
|
|
58
|
+
| id | OTP ID(`otp-<term>`) | ○ |
|
|
59
|
+
| type | `migration` 固定 | ○ |
|
|
60
|
+
| title | 運用切替計画: <対象名> | ○ |
|
|
61
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
62
|
+
| based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
|
|
63
|
+
| supersedes | 置き換え関係(ID配列。未指定は `[]` 可) | 任意 |
|
|
64
|
+
|
|
65
|
+
### 4.2. 推奨ルール
|
|
66
|
+
|
|
67
|
+
- `based_on` には運用・移行判断に直接利用した成果物(例: `mip-index` / `cop-index` / `mtp-index` / `br-*` / `issue-*`)のみ列挙する
|
|
68
|
+
- `based_on` / `supersedes` は ID 配列(未指定は `[]` 可)
|
|
69
|
+
|
|
70
|
+
## 5. 本文構成(標準テンプレ)
|
|
71
|
+
|
|
72
|
+
`otp-<term>` は以下の見出し構成を **順序固定** で配置します。
|
|
73
|
+
|
|
74
|
+
| 番号 | 見出し | 必須 |
|
|
75
|
+
| ---- | ------------------------------- | ---- |
|
|
76
|
+
| 1 | 概要(`<term>`) | ○ |
|
|
77
|
+
| 2 | 監視/アラート | ○ |
|
|
78
|
+
| 3 | バックアップ/リストア | ○ |
|
|
79
|
+
| 4 | 権限/アカウント移行 | ○ |
|
|
80
|
+
| 5 | 運用手順の変更点 | ○ |
|
|
81
|
+
| 6 | 問合せ窓口/一次対応 | ○ |
|
|
82
|
+
| 7 | 障害対応フロー | ○ |
|
|
83
|
+
| 8 | 初期増員体制(期間・当番・SLA) | ○ |
|
|
84
|
+
| 9 | 旧システムの停止/参照方針 | ○ |
|
|
85
|
+
| 10 | 移行完了後のクローズ条件 | ○ |
|
|
86
|
+
| 11 | 関連ドキュメント | ○ |
|
|
87
|
+
|
|
88
|
+
補足:
|
|
89
|
+
|
|
90
|
+
- `otp-<term>` は term固有(監視対象、窓口、当番、手順差分)に寄せる
|
|
91
|
+
- 「関連ドキュメント」セクションは **必須**(分冊が無い場合も `(本書のみ)` と明記)
|
|
92
|
+
|
|
93
|
+
## 6. 記述ガイド
|
|
94
|
+
|
|
95
|
+
### 6.1. 概要(`<term>`)
|
|
96
|
+
|
|
97
|
+
生成する本文の見出しは **## 1. 概要(`<term>`)**
|
|
98
|
+
|
|
99
|
+
- 切替後の運用安定化の目的と適用範囲を 1〜3 行で示す
|
|
100
|
+
- `mip-index` のハイパーケア方針と整合させる
|
|
101
|
+
- 対象範囲(どの運用領域/チーム/サービスが対象か)を明記する
|
|
102
|
+
|
|
103
|
+
### 6.2. 監視/アラート
|
|
104
|
+
|
|
105
|
+
生成する本文の見出しは **## 2. 監視/アラート**
|
|
106
|
+
|
|
107
|
+
- 監視対象、指標/閾値、通知先を明記する
|
|
108
|
+
- 重大アラートの初動ルール(一次応答期限、エスカレーション条件)を明記する
|
|
109
|
+
|
|
110
|
+
推奨フォーマット(表):
|
|
111
|
+
|
|
112
|
+
| 監視対象 | 指標/閾値 | 通知先 | 初動ルール | 備考 |
|
|
113
|
+
| -------- | --------- | ------ | ---------- | ---- |
|
|
114
|
+
|
|
115
|
+
### 6.3. バックアップ/リストア
|
|
116
|
+
|
|
117
|
+
生成する本文の見出しは **## 3. バックアップ/リストア**
|
|
118
|
+
|
|
119
|
+
- バックアップ頻度、保管先、保持期間を明記する
|
|
120
|
+
- リストア時の責任者、実施手順(リンク可)、完了基準(整合性確認)を明記する
|
|
121
|
+
- 可能なら「復旧目標(RTO/RPO)」を方針として記載してよい
|
|
122
|
+
|
|
123
|
+
### 6.4. 権限/アカウント移行
|
|
124
|
+
|
|
125
|
+
生成する本文の見出しは **## 4. 権限/アカウント移行**
|
|
126
|
+
|
|
127
|
+
- 旧/新の権限差分、移行タイミング、切替当日の扱いを明記する
|
|
128
|
+
- 移行後のアクセス検証方法(主要ロールのログイン/操作)を明記する
|
|
129
|
+
- 緊急時の権限付与(ブレークグラス)方針がある場合は記載する
|
|
130
|
+
|
|
131
|
+
### 6.5. 運用手順の変更点
|
|
132
|
+
|
|
133
|
+
生成する本文の見出しは **## 5. 運用手順の変更点**
|
|
134
|
+
|
|
135
|
+
- 旧手順との差分を一覧で示す
|
|
136
|
+
- 変更理由と影響(誰の何が変わるか)を明記する
|
|
137
|
+
- 具体的手順書はリンクでよい(本文に詳細手順を長大に貼らない)
|
|
138
|
+
|
|
139
|
+
推奨フォーマット(表):
|
|
140
|
+
|
|
141
|
+
| 手順 | 旧 | 新 | 変更理由 | 影響 | 参照 |
|
|
142
|
+
| ---- | --- | --- | -------- | ---- | ---- |
|
|
143
|
+
|
|
144
|
+
### 6.6. 問合せ窓口/一次対応
|
|
145
|
+
|
|
146
|
+
生成する本文の見出しは **## 6. 問合せ窓口/一次対応**
|
|
147
|
+
|
|
148
|
+
- 問合せ窓口、受付時間、一次対応範囲を明記する
|
|
149
|
+
- 受付チャネル(メール/フォーム/チャット/電話)と優先度分類(P1〜等)を明記する
|
|
150
|
+
- エスカレーション条件(一次で止めない条件)を明記する
|
|
151
|
+
|
|
152
|
+
### 6.7. 障害対応フロー
|
|
153
|
+
|
|
154
|
+
生成する本文の見出しは **## 7. 障害対応フロー**
|
|
155
|
+
|
|
156
|
+
- 障害発生時の判断/連絡/復旧/報告の流れを明記する
|
|
157
|
+
- エスカレーション先と判断基準(重大度、影響範囲、復旧見込み)を明記する
|
|
158
|
+
- 重大障害時の指揮系統(インシデントコマンダー等)があれば明記する
|
|
159
|
+
|
|
160
|
+
### 6.8. 初期増員体制(期間・当番・SLA)
|
|
161
|
+
|
|
162
|
+
生成する本文の見出しは **## 8. 初期増員体制(期間・当番・SLA)**
|
|
163
|
+
|
|
164
|
+
- ハイパーケア期間、当番体制、SLA(一次応答/暫定復旧など)を明記する
|
|
165
|
+
- 期間終了の判断者と条件を明記する(クローズ条件と整合)
|
|
166
|
+
- 役割分担(運用/開発/業務)を最小限で示す
|
|
167
|
+
|
|
168
|
+
推奨フォーマット(表):
|
|
169
|
+
|
|
170
|
+
| 期間 | 体制(当番/時間帯) | SLA目安 | 判断者 | 備考 |
|
|
171
|
+
| ---- | ------------------- | ------- | ------ | ---- |
|
|
172
|
+
|
|
173
|
+
### 6.9. 旧システムの停止/参照方針
|
|
174
|
+
|
|
175
|
+
生成する本文の見出しは **## 9. 旧システムの停止/参照方針**
|
|
176
|
+
|
|
177
|
+
- 停止時期、参照可否、データ保持/アーカイブ方針を明記する
|
|
178
|
+
- 停止後の問い合わせ対応(どこで何を見られるか)を明記する
|
|
179
|
+
|
|
180
|
+
### 6.10. 移行完了後のクローズ条件
|
|
181
|
+
|
|
182
|
+
生成する本文の見出しは **## 10. 移行完了後のクローズ条件**
|
|
183
|
+
|
|
184
|
+
- 完了条件(重大障害未発生期間、問い合わせ収束、運用手順整備完了等)を列挙する
|
|
185
|
+
- クローズ判断者と最終報告物(振り返り/運用引継ぎ/残課題)を明記する
|
|
186
|
+
|
|
187
|
+
### 6.11. 関連ドキュメント(必須)
|
|
188
|
+
|
|
189
|
+
生成する本文の見出しは **## 11. 関連ドキュメント**
|
|
190
|
+
|
|
191
|
+
- `otp-index` への導線(本体SSOT)を必ず記載する
|
|
192
|
+
- 分冊が無い場合でも `(本書のみ)` を明記する
|
|
193
|
+
|
|
194
|
+
`otp-<term>` では、`otp-index` への導線を必ず記載する。
|
|
195
|
+
|
|
196
|
+
推奨フォーマット(箇条書き):
|
|
197
|
+
|
|
198
|
+
- `<doc-id>`:<説明>
|
|
199
|
+
- `<doc-id>`:<説明>
|
|
200
|
+
|
|
201
|
+
## 7. 禁止事項
|
|
202
|
+
|
|
203
|
+
| 禁止事項 | 理由 |
|
|
204
|
+
| ------------------------------------------------------------- | ---------------------------------- |
|
|
205
|
+
| 監視/アラートの通知先や閾値が未記載 | 初動が遅れ、障害影響が拡大するため |
|
|
206
|
+
| ハイパーケア体制(期間/当番/SLA)を省略する | 初期増加負荷に耐えられないため |
|
|
207
|
+
| 旧システム停止/参照方針が不明確 | 利用者・運用の混乱を招くため |
|
|
208
|
+
| クローズ条件を未記載にする | 収束判定ができないため |
|
|
209
|
+
| `otp-<term>` に共通方針を重複記載し、`otp-index` と矛盾させる | SSOTが崩れ、参照が割れるため |
|
|
210
|
+
| 「関連ドキュメント」セクションを省略する | 導線が失われ、参照先が分散するため |
|
|
211
|
+
|
|
212
|
+
## 8. サンプル(最小・整合版)
|
|
213
|
+
|
|
214
|
+
注:以下はルール文書内の例示です。生成する `otp-<term>` では `## 1...` から始まります。
|
|
215
|
+
|
|
216
|
+
### 8.1. `otp-<term>`(個別:例)
|
|
217
|
+
|
|
218
|
+
```yaml
|
|
219
|
+
---
|
|
220
|
+
id: otp-hypercare
|
|
221
|
+
type: project
|
|
222
|
+
title: 運用切替計画: ハイパーケア
|
|
223
|
+
status: draft
|
|
224
|
+
based_on:
|
|
225
|
+
- otp-index
|
|
226
|
+
- mip-index
|
|
227
|
+
supersedes: []
|
|
228
|
+
---
|
|
229
|
+
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
#### 8.1.1. 概要(hypercare)
|
|
233
|
+
|
|
234
|
+
切替後の初期不具合・問い合わせ増に対応するため、ハイパーケア体制(増員・SLA・運用手順)を具体化する。
|
|
235
|
+
共通方針は `otp-index` を正とし、本書はハイパーケアの運用詳細に限定する。
|
|
236
|
+
|
|
237
|
+
#### 8.1.2. 監視/アラート
|
|
238
|
+
|
|
239
|
+
| 監視対象 | 指標/閾値 | 通知先 | 初動ルール | 備考 |
|
|
240
|
+
| -------- | --------- | ------ | -------------------- | ------- |
|
|
241
|
+
| API | 5xx > 1% | #ops | P1は30分以内一次応答 | 5分平均 |
|
|
242
|
+
| バッチ | 失敗=1回 | #ops | 影響範囲を即共有 | 日次 |
|
|
243
|
+
|
|
244
|
+
#### 8.1.3. バックアップ/リストア
|
|
245
|
+
|
|
246
|
+
- 方式: 夜間フル + 日中差分(保持30日)
|
|
247
|
+
- リストア責任者: 運用責任者
|
|
248
|
+
- 完了基準: 主要業務のスモーク成功 + 整合性照合レポートOK
|
|
249
|
+
|
|
250
|
+
#### 8.1.4. 権限/アカウント移行
|
|
251
|
+
|
|
252
|
+
- 追加権限: ハイパーケア担当に限定付与(期間終了で剥奪)
|
|
253
|
+
- 検証: 当番ロールで監視/ログ参照/障害対応が可能であること
|
|
254
|
+
|
|
255
|
+
#### 8.1.5. 運用手順の変更点
|
|
256
|
+
|
|
257
|
+
| 手順 | 旧 | 新 | 変更理由 | 影響 | 参照 |
|
|
258
|
+
| ---------- | ------ | -------- | ----------- | ------------ | ------------------ |
|
|
259
|
+
| 問合せ受付 | メール | #support | 集約/可視化 | チャネル統一 | (運用手順リンク) |
|
|
260
|
+
|
|
261
|
+
#### 8.1.6. 問合せ窓口/一次対応
|
|
262
|
+
|
|
263
|
+
- 受付: #support / 09:00-18:00(期間中は延長運用あり)
|
|
264
|
+
- 一次対応: 既知不具合案内、ログ採取依頼、再現条件ヒアリング
|
|
265
|
+
- エスカレーション: P1は即時 #ops と #po に共有
|
|
266
|
+
|
|
267
|
+
#### 8.1.7. 障害対応フロー
|
|
268
|
+
|
|
269
|
+
- 指揮: 運用責任者(必要に応じてPO)
|
|
270
|
+
- 連絡: #ops → #po → 利用者告知(#comms)
|
|
271
|
+
|
|
272
|
+
#### 8.1.8. 初期増員体制(期間・当番・SLA)
|
|
273
|
+
|
|
274
|
+
| 期間 | 体制(当番/時間帯) | SLA目安 | 判断者 | 備考 |
|
|
275
|
+
| ----------- | ----------------------------------------------- | ---------------------- | ---------- | ------------------------ |
|
|
276
|
+
| 切替後2週間 | 8:00-20:00は常駐(Ops2 + Biz1)/ 夜間オンコール | P1:30分一次連絡、P2:2h | 運用責任者 | 延長はクローズ条件で判断 |
|
|
277
|
+
|
|
278
|
+
#### 8.1.9. 旧システムの停止/参照方針
|
|
279
|
+
|
|
280
|
+
- 参照依頼は一次窓口で受付し、参照手順に従い対応する
|
|
281
|
+
- 参照期間終了後は「アーカイブ照会手順」に切替える(リンク)
|
|
282
|
+
|
|
283
|
+
#### 8.1.10. 移行完了後のクローズ条件
|
|
284
|
+
|
|
285
|
+
- P1=0が30日、P2が収束傾向、問い合わせが基準以下
|
|
286
|
+
- 既知不具合一覧がクローズ/運用引継ぎ完了
|
|
287
|
+
|
|
288
|
+
#### 8.1.11. 関連ドキュメント
|
|
289
|
+
|
|
290
|
+
- `otp-index`:運用切替計画のSSOT(共通方針/期間/SLA/クローズ基準)
|
|
291
|
+
- `mip-index`:移行計画(ハイパーケア方針)
|
|
292
|
+
- `cop-index`:切替当日の計画(前提・影響)
|
|
293
|
+
- (必要に応じて)`mtp-index`:リハーサル計画(運用観点の検証)
|
|
@@ -0,0 +1,211 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:pjr-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: ready
|
|
6
|
+
target_format: markdown
|
|
7
|
+
recipe: not-needed
|
|
8
|
+
sample: not-needed
|
|
9
|
+
template: not-needed
|
|
10
|
+
based_on:
|
|
11
|
+
- specdojo:rulebook-authoring-standard
|
|
12
|
+
supersedes:
|
|
13
|
+
- pjr-index-rulebook
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
# プロジェクト登録簿 作成ルール
|
|
17
|
+
|
|
18
|
+
Project Register Documentation Rules
|
|
19
|
+
|
|
20
|
+
本ドキュメントは、プロジェクト登録簿の個別登録項目(`pjr-XXXX-<topic>.md`)、項目別イベントログ、そこから生成する一覧・派生ビューの記述ルールです。現在値の正本は個票の Frontmatter、監査履歴の正本は項目別イベントログとし、一覧は表示専用の生成物として扱います。
|
|
21
|
+
|
|
22
|
+
## 1. 全体方針
|
|
23
|
+
|
|
24
|
+
- TODO、要確認事項、リスク、課題、変更要求、決定事項、備忘の全登録項目は、それぞれ 1 件の個票を持つ。
|
|
25
|
+
- 個票 Frontmatter の現在値は、分類、処理状態、優先度、担当、日付、結論の唯一の正本である。
|
|
26
|
+
- `events/pjr-XXXX.yaml` は、起票・状態遷移・更新を追う監査履歴の正本である。現在値の再計算には使わず、個票の現在値との整合を検証する。
|
|
27
|
+
- 個票の H1 と本文は、それぞれタイトルと説明・根拠・経緯・対応内容の正本である。
|
|
28
|
+
- `generated/pjr-index.md` とすべての派生ビューは個票から `register build` で生成し、直接編集しない。
|
|
29
|
+
- `<project-id>:pjr-index` は `generated/pjr-index.md` の文書 ID とする。`controls/**/generated/` はdoc-indexの限定走査対象とし、`register build` の後に `index build` を実行する。
|
|
30
|
+
- 一覧と個票で同じ構造化フィールドを保持・同期する規則は設けない。
|
|
31
|
+
- type 別テンプレートの選択と初期生成は `register add` が担うため、本 rulebook は単一の template を参照しない。
|
|
32
|
+
|
|
33
|
+
## 2. ファイル命名・ID規則
|
|
34
|
+
|
|
35
|
+
### 2.1. ID規約
|
|
36
|
+
|
|
37
|
+
- 個別登録項目の表示 ID は `PJR-XXXX` 形式とする。`XXXX` には数字と英字から
|
|
38
|
+
`I` / `L` / `O` / `U` を除いた4文字を使う。例: `PJR-AB12`。
|
|
39
|
+
- 個別登録項目の文書 ID は `<project-id>:pjr-XXXX-<topic>` 形式とする。例: `prj-0001:pjr-ab12-auth-boundary`。
|
|
40
|
+
- 個別登録項目のファイル名は `pjr-XXXX-<topic>.md` 形式とし、文書 ID のローカル部分と拡張子を除くファイル名を一致させる。
|
|
41
|
+
- 文書 ID とファイル名では `XXXX` を小文字にする。
|
|
42
|
+
- `<topic>` は英小文字または数字で始まり、英小文字・数字・単一ハイフンだけで構成し、
|
|
43
|
+
ハイフンで終えたり連続ハイフンを含めたりしない。対象領域や論点が分かる短い名称にする。
|
|
44
|
+
- イベントファイル名は `pjr-XXXX.yaml` とし、topic を含めない。ID の小文字表記を用いる。
|
|
45
|
+
|
|
46
|
+
### 2.2. 配置規約
|
|
47
|
+
|
|
48
|
+
- 個票は `docs/ja/projects/<project-id>/controls/project-register/` 直下に置く。
|
|
49
|
+
- 項目別イベントログは同ディレクトリの `events/` 配下に置き、個票 1 件につき 1 ファイルとする。
|
|
50
|
+
- 登録項目一覧は `docs/ja/projects/<project-id>/controls/project-register/generated/pjr-index.md` に生成する。
|
|
51
|
+
- 状態別・優先度別・担当者別の補助一覧は同じ `generated/` 配下に生成する。
|
|
52
|
+
- controls 全体の type 別管理ビューは `controls/generated/` に生成する。生成物の別名コピーは作らない。
|
|
53
|
+
|
|
54
|
+
## 3. 推奨 Frontmatter 項目
|
|
55
|
+
|
|
56
|
+
個票には `register-item-frontmatter.schema.yaml` が定義する次の項目を置く。未定の担当、期限、完了日時、結論は表用のプレースホルダを保存せず、該当キーを省略する(期限なしだけは `due_on: null`)。
|
|
57
|
+
|
|
58
|
+
| 項目 | 説明 | 必須 |
|
|
59
|
+
| --------------- | -------------------------------------------- | ---- |
|
|
60
|
+
| `id` | `<project-id>:pjr-XXXX-<topic>` | ○ |
|
|
61
|
+
| `type` | `project` | ○ |
|
|
62
|
+
| `status` | 文書成熟度。`draft` / `ready` / `deprecated` | ○ |
|
|
63
|
+
| `rulebook` | `specdojo:pjr-rulebook` | ○ |
|
|
64
|
+
| `part_of` | `<project-id>:pjr-index` を要素に持つ配列 | ○ |
|
|
65
|
+
| `item_type` | 登録項目の分類 | ○ |
|
|
66
|
+
| `item_status` | 登録項目の処理状態 | ○ |
|
|
67
|
+
| `priority` | 対応優先度 | ○ |
|
|
68
|
+
| `owner` | 主担当者または役割 | 任意 |
|
|
69
|
+
| `registered_at` | 起票日時 | 任意 |
|
|
70
|
+
| `due_on` | 対応期限または判断期限 | 任意 |
|
|
71
|
+
| `completed_at` | 完了・却下・決定日時 | 条件 |
|
|
72
|
+
| `block_reason` | `waiting` へ遷移した直近の理由 | 任意 |
|
|
73
|
+
| `conclusion` | 終端時の結論要約 | 任意 |
|
|
74
|
+
|
|
75
|
+
- `status` は文書成熟度、`item_status` は処理状態であり、同じ状態軸として扱わない。
|
|
76
|
+
- `item_type`、`item_status`、`priority` の値は schema の enum だけを使用する。
|
|
77
|
+
- `block_reason` は途中の待機・失敗理由、`conclusion` は終端時の結論として用途を分ける。`register wait --reason` は前者だけを更新する。
|
|
78
|
+
- Frontmatter の構造化フィールドを本文や生成一覧へ手作業で複製しない。
|
|
79
|
+
|
|
80
|
+
### 3.1. 日時と日付の使い分け
|
|
81
|
+
|
|
82
|
+
- 起票と終端は瞬間として記録し、`registered_at` / `completed_at` に UTC の RFC 3339・秒精度(`YYYY-MM-DDTHH:MM:SSZ`)で保存する。
|
|
83
|
+
- 期限は瞬間ではなくプロジェクトタイムゾーン上の暦日であるため、`due_on` は `YYYY-MM-DD` のまま保持する。
|
|
84
|
+
- 一覧・派生ビューの「登録日」「完了日」は、保存した日時をプロジェクトの登録日タイムゾーンへ変換して導出する表示値であり、個票へ日付として重複保存しない。
|
|
85
|
+
- 日時は register コマンドが記録する。手書きで日時を入力する場合も、タイムゾーンを含む値から UTC へ変換した値だけを保存する。
|
|
86
|
+
|
|
87
|
+
### 3.2. Register event と責務境界
|
|
88
|
+
|
|
89
|
+
- 個票の現在値は `item_status` などの Frontmatter フィールド、変更履歴は `events/pjr-XXXX.yaml`、保存・配布・差分レビューは Git が担う。Git コミットはイベントの発生単位ではなく、履歴再構成の正本にしない。
|
|
90
|
+
- イベントファイルのルートは YAML 配列とし、イベントを古い順に追記する。項目ごとの配置により、イベントごとの追加ファイルを作らず、異なる項目を並行更新したときの共有ログ競合を避ける。
|
|
91
|
+
- 各イベントは version、イベント ID、UTC 発生日時、action、actor、遷移前後の `item_status`、reason、変更フィールド、直前イベント ID を保持する。Git から移行したイベントだけは移行元 commit も保持できる。
|
|
92
|
+
- action は `add` / `start` / `wait` / `review` / `close` / `reject` / `defer` / `reopen` / `update` / `renumber` / `migrate` のいずれかとする。詳細な型と enum は `register-events.schema.yaml` を正本とする。
|
|
93
|
+
- `register build` は個票とイベントファイルの 1 対 1 対応、イベント ID の一意性、時刻順、直前イベント参照、遷移前後状態の連鎖、最新イベントの状態と個票の `item_status` の一致を検証する。不正なイベントを無視して一覧を生成しない。
|
|
94
|
+
|
|
95
|
+
## 4. 本文構成(標準テンプレ)
|
|
96
|
+
|
|
97
|
+
### 4.1. 個別登録項目
|
|
98
|
+
|
|
99
|
+
| 順序 | 内容 | 必須 | 説明 |
|
|
100
|
+
| ---- | ---------------- | ---- | -------------------------------------- |
|
|
101
|
+
| 1 | type 固有の記録 | ○ | 対象、背景、評価、対応・判断、結果など |
|
|
102
|
+
| 末尾 | 関連ドキュメント | ○ | 根拠、影響先、追跡先を文書 ID で示す |
|
|
103
|
+
|
|
104
|
+
- H1 は `PJR-XXXX <タイトル>` 形式とする。
|
|
105
|
+
- type 固有の構成は `todo` の概要・完了条件・作業内容・対応結果など、各 type 用テンプレートに従う。
|
|
106
|
+
- ID、分類、処理状態、優先度、担当、期限、完了日時は本文へ重複記載せず、Frontmatter を参照する。
|
|
107
|
+
- 終端前に未確定の結果・結論がある場合は、`-` または共通ラベルを用い、確定済みの記述と混在させない。
|
|
108
|
+
|
|
109
|
+
### 4.2. 生成一覧と派生ビュー
|
|
110
|
+
|
|
111
|
+
| 生成物 | 内容 | 編集可否 |
|
|
112
|
+
| ------------------------------------ | ------------------- | -------- |
|
|
113
|
+
| `generated/pjr-index.md` | 全個票の一覧 | 不可 |
|
|
114
|
+
| `generated/pjr-views-by-status.md` | 状態別の補助一覧 | 不可 |
|
|
115
|
+
| `generated/pjr-views-by-priority.md` | 優先度別の補助一覧 | 不可 |
|
|
116
|
+
| `generated/pjr-views-by-owner.md` | 担当者別の補助一覧 | 不可 |
|
|
117
|
+
| `controls/generated/pm-*.md` | type 別の管理ビュー | 不可 |
|
|
118
|
+
|
|
119
|
+
- 一覧の標準列は ID、ステータス、タイトル、説明、分類、優先度、担当、登録日、期限、完了日、結論、個票とする。
|
|
120
|
+
- タイトルは個票の H1、説明は個票本文、その他の列は個票 Frontmatter から生成する。
|
|
121
|
+
- 登録日と完了日の列は、`registered_at` / `completed_at` をプロジェクトの登録日タイムゾーンへ変換した暦日として生成する。
|
|
122
|
+
- 生成ビューに独自の詳細情報や手作業の修正を追加しない。修正は個票に行い、`register build` を再実行する。
|
|
123
|
+
|
|
124
|
+
## 5. 記述ガイド
|
|
125
|
+
|
|
126
|
+
### 5.1. 個票の記述
|
|
127
|
+
|
|
128
|
+
- 背景には、登録が必要になった事実、制約、判断または対応の期限を記載する。
|
|
129
|
+
- 評価や選択肢には、比較可能な観点と根拠を記載し、結論だけを先に固定しない。
|
|
130
|
+
- 対応・判断内容には、実施または採択した範囲と、明示的に対象外とした範囲を記載する。
|
|
131
|
+
- 結果・結論には、完了を判定した根拠と後続対応を記載する。
|
|
132
|
+
- 関連ドキュメントには、判断根拠、変更対象、影響先、追跡先のうち該当する文書を記載する。
|
|
133
|
+
|
|
134
|
+
### 5.2. 構造化フィールドと生成
|
|
135
|
+
|
|
136
|
+
- 新しい項目は `register add` で作成し、個票の Frontmatter に初期値を書き込む。全 type で個票を省略しない。
|
|
137
|
+
- 担当・期限・結論・topic などを変更するときは `register update`、処理状態を変えるときは状態遷移コマンドを使用する。待機理由は `register wait --reason` で記録する。
|
|
138
|
+
- `register build` は個票を読み取り、一覧・派生ビューを再生成する。一覧を編集して個票へ反映する経路はない。
|
|
139
|
+
- `register add`、状態遷移、`register update`、`register renumber` は現在値を個票へ、イベントを対応する項目別ログへ記録する。`--by` で actor、`--reason` で理由を明示でき、省略時もコマンドが既定値を記録する。
|
|
140
|
+
- 同じ現在値へ同じ操作を再実行した場合は、新しいイベントを追加しない。イベント ID と直前イベント参照を保ったまま再実行し、既存イベントの置換や削除で重複を解消しない。
|
|
141
|
+
- ID の変更は `register renumber` で行い、個票のファイル名・Frontmatter・参照と生成ビューを整合させる。
|
|
142
|
+
- 主題の変化に伴う `<topic>` の変更は `register update --topic` で行う。個票のファイル名と Frontmatter の文書 ID、他文書中の旧文書 ID 参照を同時に更新し、生成ビューを再生成する。
|
|
143
|
+
|
|
144
|
+
### 5.3. 登録項目の item_status 遷移基準
|
|
145
|
+
|
|
146
|
+
#### 5.3.1. item_type 別の item_status 終端基準
|
|
147
|
+
|
|
148
|
+
`item_status` の通常終端は、登録した目的を達成したときに使用する。type ごとの通常終端と判定基準は次のとおりとする。
|
|
149
|
+
|
|
150
|
+
| `item_type` | 通常終端 | 遷移条件 | `conclusion` に残す内容 |
|
|
151
|
+
| ---------------- | --------- | ---------------------------------------------------------------------- | ---------------------------- |
|
|
152
|
+
| `todo` | `done` | 個票に記載した完了条件をすべて満たした | 実施内容と完了を確認した根拠 |
|
|
153
|
+
| `question` | `decided` | 問いへの回答を確認し、後続作業の要否を判断できる | 確定した回答 |
|
|
154
|
+
| `decision` | `decided` | 選択肢、採択理由、影響を記録し、必要な承認を得た | 決定内容 |
|
|
155
|
+
| `note` | なし | 終端させず、`open` のまま新しい事実・知見を追記する | 終端しないため使用しない |
|
|
156
|
+
| `risk` | `done` | リスクが顕在化しないまま消滅した、または対応を終えて追跡が不要になった | 消滅・対応完了の根拠 |
|
|
157
|
+
| `issue` | `done` | 問題を解消し、必要な確認を終えた | 解決内容と確認結果 |
|
|
158
|
+
| `change-request` | `done` | 採択した変更を対象へ反映し、必要な確認を終えた | 反映内容と確認結果 |
|
|
159
|
+
|
|
160
|
+
- `question` / `decision` の通常終端に `done` を使わず、回答・決定が確定したことを示す `decided` を使う。
|
|
161
|
+
- `todo` / `risk` / `issue` / `change-request` の通常終端に `decided` を使わず、対応または追跡が完了したことを示す `done` を使う。
|
|
162
|
+
- `note` の `open` は未対応を意味しない。内容を継続して更新できる、生きている記録であることを示す。
|
|
163
|
+
- `note` から対応・回答・判断が必要になった場合は、`todo` / `question` / `decision` など目的に合う別項目を起票し、note 自体は `open` のまま参照元として保持する。
|
|
164
|
+
- `note` の内容が陳腐化または置換された場合は、その事実と参照先を本文へ追記する。`done` / `decided` / `rejected` / `deferred` へ遷移させて閉じない。
|
|
165
|
+
|
|
166
|
+
#### 5.3.2. 例外的な追跡終了
|
|
167
|
+
|
|
168
|
+
`note` 以外では、通常終端に達していなくても、次の条件で追跡を終了できる。
|
|
169
|
+
|
|
170
|
+
| `item_status` | 使用条件 | 記録要件 |
|
|
171
|
+
| ------------- | -------------------------------------------------------------------------- | ------------------------------------------------ |
|
|
172
|
+
| `rejected` | 対応・回答・判断の対象外、前提不成立、または変更を採択しないことが確定した | 採択しない理由と、必要なら代替の追跡先を記録する |
|
|
173
|
+
| `deferred` | 現時点の追跡を停止し、再開条件または再評価時期を定めた | 再開条件または再評価時期を記録する |
|
|
174
|
+
|
|
175
|
+
- `rejected` は完了・決定の代用にせず、実施または採択しない判断が確定した場合だけ使う。
|
|
176
|
+
- `deferred` は状態遷移上の終端だが、完了を意味せず `completed_at` を持たない。再開するときは `register reopen` を使う。
|
|
177
|
+
- `question` / `decision` で回答または決定を得た場合は `rejected` ではなく `decided` を使う。問い・判断自体が不要になった場合だけ `rejected` を使う。
|
|
178
|
+
- `risk` を受容して監視を終える場合は、受容判断と残存影響を `conclusion` に記録したうえで `done` とする。リスクの前提が誤りだった場合は `rejected` とする。
|
|
179
|
+
|
|
180
|
+
#### 5.3.3. 中間状態を経ない終端
|
|
181
|
+
|
|
182
|
+
終端への遷移は、`in-progress` / `waiting` / `review` を経ていることを前提としない。`open` から直接終端させてよい。
|
|
183
|
+
|
|
184
|
+
- 人または対話型 orchestrator が対応した項目では、着手を記録する前に完了することがある。形式を揃えるために `start` を遡って記録すると、実際には行われていない時点の遷移がイベントログに残る。事実と異なる記録を避けるため、直接の終端を許す。
|
|
185
|
+
- agent が `exec run` で実行する項目は runner が `start` を記録するため、この経路では中間状態が必ず残る。
|
|
186
|
+
- 中間状態を経ない場合は、誰がどの経路で対応したかを終端イベントの `reason` へ記録する。exec の plan / result / evidence が存在しないため、実施内容と検証結果は個票の対応結果へ残す。
|
|
187
|
+
- 実行していない主体を actor とする遷移を、記録の体裁を整える目的で追加しない。
|
|
188
|
+
|
|
189
|
+
### 5.4. 個票 status の遷移基準
|
|
190
|
+
|
|
191
|
+
| `status` | 意味 | 遷移させる時点 |
|
|
192
|
+
| ------------ | ------------------------------------------------- | ------------------------------------------------- |
|
|
193
|
+
| `draft` | 作成直後。type 固有の必須節が未確定 | `register add` で個票を生成した時点 |
|
|
194
|
+
| `ready` | type 固有の必須節が固まり `_TODO_` が残っていない | `register close` 時に必須節を満たすと判定した時点 |
|
|
195
|
+
| `deprecated` | 却下・破棄され成熟度を追う必要がない | `register reject` 時点 |
|
|
196
|
+
|
|
197
|
+
- 遷移は register コマンドが担い、個票 Frontmatter を直接手書きで書き換えない。
|
|
198
|
+
- `ready` への昇格には、type 固有の必須節に `_TODO_` が残っていないことを要する。
|
|
199
|
+
- `reopen` は過去の結果を消さず、再開理由と新しい対応状況を個票本文へ追記する。
|
|
200
|
+
|
|
201
|
+
## 6. 禁止事項
|
|
202
|
+
|
|
203
|
+
- 生成された `pjr-index.md`、補助一覧、controls 全体の派生ビューを直接編集しない。
|
|
204
|
+
- 一覧と個票の同期、一覧から個票への書き戻し、または個票を作るかどうかの分離基準を設けない。
|
|
205
|
+
- 構造化フィールドを個票本文や別の正本へ重複管理しない。
|
|
206
|
+
- `type` / `item_status` / `priority` に schema 未定義の値を使用しない。
|
|
207
|
+
- `registered_at` / `completed_at` に、UTC 以外のオフセットやタイムゾーンを伴わない値、暦日だけの値を保存しない。
|
|
208
|
+
- 個票の文書 ID から `<topic>` を省略したり、ファイル名と異なるローカル ID を使用したりしない。
|
|
209
|
+
- type 固有の必須内容を、見出しだけ残した空欄のまま終端状態にしない。
|
|
210
|
+
- 実行していない主体を actor とする状態遷移を、記録の体裁を揃える目的で追加しない。
|
|
211
|
+
- `events/pjr-XXXX.yaml` を手書きで追加・修正・並べ替え・削除しない。履歴補正が必要な場合も register コマンドを使い、監査イベントを破壊しない。
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:pm-change-request-log-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
sample: specdojo:pm-change-request-log-sample
|
|
7
|
+
template: specdojo:pm-change-request-log-template
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# 変更要求ログ 作成ルール
|
|
11
|
+
|
|
12
|
+
Change Request Log Documentation Rules
|
|
13
|
+
|
|
14
|
+
本ドキュメントは、`変更要求ログ` を一貫した粒度で作成するためのルールを定義する。
|
|
15
|
+
|
|
16
|
+
## 1. 全体方針
|
|
17
|
+
|
|
18
|
+
- 変更要求の申請から審査、決定、実施追跡までを判定可能な形で管理する。
|
|
19
|
+
- 変更要求ごとに識別子、影響評価、決定結果、責任者、期限を明記する。
|
|
20
|
+
- 曖昧表現を避け、承認可否や実施条件が判断できる記述にする。
|
|
21
|
+
|
|
22
|
+
## 2. 位置づけと用語定義(必要に応じて)
|
|
23
|
+
|
|
24
|
+
- `pm-plan`: プロジェクト全体の管理方針。
|
|
25
|
+
- `pm-issue-log`: 顕在化した課題の管理。
|
|
26
|
+
- `pm-risk-register`: 潜在リスクの管理。
|
|
27
|
+
- `pm-change-request-log`: 変更要求の審査・決定と実施追跡。
|
|
28
|
+
|
|
29
|
+
## 3. ファイル命名・ID規則
|
|
30
|
+
|
|
31
|
+
- `id` は `pm-change-request-log` を使用する。
|
|
32
|
+
- ファイル名は `pm-change-request-log-変更要求ログ.md` など、プロジェクト内で一意にする。
|
|
33
|
+
|
|
34
|
+
## 4. 推奨 Frontmatter 項目
|
|
35
|
+
|
|
36
|
+
| 項目 | 説明 | 必須 |
|
|
37
|
+
| ---------- | -------------------------------- | ---- |
|
|
38
|
+
| id | `pm-change-request-log` | ○ |
|
|
39
|
+
| type | `project` 固定 | ○ |
|
|
40
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
41
|
+
| based_on | 根拠仕様ID(配列) | 任意 |
|
|
42
|
+
| supersedes | 置換関係ID(配列) | 任意 |
|
|
43
|
+
|
|
44
|
+
## 5. 本文構成(標準テンプレ)
|
|
45
|
+
|
|
46
|
+
| 番号 | 見出し | 必須 |
|
|
47
|
+
| ---- | ---------------- | ---- |
|
|
48
|
+
| 1 | 概要 | ○ |
|
|
49
|
+
| 2 | 変更要求一覧 | ○ |
|
|
50
|
+
| 3 | 影響評価 | ○ |
|
|
51
|
+
| 4 | 審査・決定 | ○ |
|
|
52
|
+
| 5 | 実施追跡 | ○ |
|
|
53
|
+
| 6 | 関連ドキュメント | ○ |
|
|
54
|
+
|
|
55
|
+
## 6. 記述ガイド
|
|
56
|
+
|
|
57
|
+
### 6.1. 概要
|
|
58
|
+
|
|
59
|
+
- 管理対象、運用期間、記録単位を 1〜3 行で示す。
|
|
60
|
+
|
|
61
|
+
### 6.2. 変更要求一覧
|
|
62
|
+
|
|
63
|
+
- 変更 ID、要求内容、申請者、申請日、状態を一覧化する。
|
|
64
|
+
|
|
65
|
+
推奨フォーマット(表):
|
|
66
|
+
|
|
67
|
+
| 変更ID | 要求内容 | 申請者 | 申請日 | 状態 |
|
|
68
|
+
| ------ | -------- | ------ | ------ | ---- |
|
|
69
|
+
|
|
70
|
+
### 6.3. 影響評価
|
|
71
|
+
|
|
72
|
+
- 影響範囲(スコープ、工数、品質、納期)と評価根拠を明記する。
|
|
73
|
+
|
|
74
|
+
### 6.4. 審査・決定
|
|
75
|
+
|
|
76
|
+
- 審査結果、決定日、承認者、実施条件を明記する。
|
|
77
|
+
|
|
78
|
+
### 6.5. 実施追跡
|
|
79
|
+
|
|
80
|
+
- 実施担当、期限、進捗、完了条件を明記する。
|
|
81
|
+
|
|
82
|
+
### 6.6. 関連ドキュメント
|
|
83
|
+
|
|
84
|
+
- `pm-plan`、`pm-issue-log`、`pm-risk-register` との導線を記載する。
|
|
85
|
+
- 関連がない場合でも `(本書のみ)` を明記する。
|
|
86
|
+
|
|
87
|
+
## 7. 禁止事項
|
|
88
|
+
|
|
89
|
+
| 禁止事項 | 理由 |
|
|
90
|
+
| -------------------------------------- | ------------------------ |
|
|
91
|
+
| 変更IDを未採番で記録する | 追跡不能になるため |
|
|
92
|
+
| 影響評価なしで承認可否を記載する | 判断根拠が欠落するため |
|
|
93
|
+
| 決定者・決定日を省略する | 監査性が失われるため |
|
|
94
|
+
| 実装詳細やコード差分を本文に貼り付ける | 管理対象が肥大化するため |
|