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