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,179 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:nfr-index-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
recipe: undecided
|
|
7
|
+
sample: specdojo:nfr-index-sample
|
|
8
|
+
template: undecided
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# 非機能要件インデックス 作成ルール
|
|
12
|
+
|
|
13
|
+
Non-Functional Requirements Index Documentation Rules
|
|
14
|
+
|
|
15
|
+
本ドキュメントは、非機能要件(NFR)をカテゴリ別に分冊管理するための `nfr-index` 作成ルールを定義する。
|
|
16
|
+
`nfr-index` は一次情報の入口であり、各カテゴリ(信頼性、可用性、保守性、完全性、機密性・安全性、性能、運用、操作性)への導線を管理する。
|
|
17
|
+
|
|
18
|
+
## 1. 全体方針
|
|
19
|
+
|
|
20
|
+
- `nfr-index` は NFR 分冊(8カテゴリ)の入口とし、重複記述を避ける。
|
|
21
|
+
- 各カテゴリの要求は「測定可能・検証可能」で記述し、合否判定ができる状態を維持する。
|
|
22
|
+
- 実装詳細は書かず、要求・基準・検証方法・導線に集中する。
|
|
23
|
+
- 分冊追加や統廃合時は `nfr-index` を最初に更新する。
|
|
24
|
+
|
|
25
|
+
## 2. 位置づけと用語定義(必要に応じて)
|
|
26
|
+
|
|
27
|
+
### 2.1. 位置づけ
|
|
28
|
+
|
|
29
|
+
- `nfr-index`:NFR 全体の入口(本体)
|
|
30
|
+
- `nfr-<category>`:カテゴリ別 NFR 本文(分冊)
|
|
31
|
+
- `sac-*` / `stc-*`:NFR の合否を検証する受入条件・試験仕様
|
|
32
|
+
- `opd-*` / `opr-*`:運用方針・運用手順への接続先
|
|
33
|
+
- `dec-*`:例外基準や判断記録
|
|
34
|
+
|
|
35
|
+
### 2.2. 用語定義
|
|
36
|
+
|
|
37
|
+
| 用語 | 定義 |
|
|
38
|
+
| --------- | -------------------------------------------------- |
|
|
39
|
+
| NFR | 非機能要件。性能、可用性、セキュリティ等の品質要求 |
|
|
40
|
+
| NFR Index | 各NFR分冊への導線を集約する文書 |
|
|
41
|
+
| 合否基準 | 要求を満たすか判定できる閾値・条件 |
|
|
42
|
+
|
|
43
|
+
## 3. ファイル命名・ID規則
|
|
44
|
+
|
|
45
|
+
- ルールドキュメントIDは `specdojo:nfr-index-rulebook` を用いる。
|
|
46
|
+
- 生成対象ドキュメントIDは `nfr-index` を推奨する。
|
|
47
|
+
- 分冊IDは `nfr-reliability` / `nfr-availability` などカテゴリ名を用いる。
|
|
48
|
+
- 1分冊 = 1カテゴリを原則とする。
|
|
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 | NFR Index ID(推奨: `nfr-index`) | ○ |
|
|
59
|
+
| type | `architecture` など共通スキーマで許容される種別 | ○ |
|
|
60
|
+
| title | 非機能要件: インデックス | ○ |
|
|
61
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
62
|
+
| based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
|
|
63
|
+
| supersedes | 置き換え関係(ID配列。未指定は `[]` 可) | 任意 |
|
|
64
|
+
|
|
65
|
+
### 4.2. 推奨ルール
|
|
66
|
+
|
|
67
|
+
- `based_on` は NFR 策定根拠(業務仕様・アーキ方針・運用方針)だけを列挙する。
|
|
68
|
+
- `supersedes` は旧NFRを置換する場合のみ記載する。
|
|
69
|
+
|
|
70
|
+
## 5. 本文構成(標準テンプレ)
|
|
71
|
+
|
|
72
|
+
`nfr-index` は以下の見出し構成を **順序固定** で配置する。
|
|
73
|
+
|
|
74
|
+
| 番号 | 見出し | 必須 |
|
|
75
|
+
| ---- | ------------------------------------------- | ---- |
|
|
76
|
+
| 1 | 概要(対象範囲・管理方針) | ○ |
|
|
77
|
+
| 2 | カテゴリ一覧(8カテゴリ) | ○ |
|
|
78
|
+
| 3 | 分冊ドキュメント一覧(ID/参照先/Owner) | ○ |
|
|
79
|
+
| 4 | 変更の入口(追加・統廃合・改定) | ○ |
|
|
80
|
+
| 5 | 関連ドキュメント導線(SAC/STC/OPD/OPR/DEC) | ○ |
|
|
81
|
+
|
|
82
|
+
補足:
|
|
83
|
+
|
|
84
|
+
- `nfr-index` 自体は詳細要求本文を持たない。
|
|
85
|
+
- 詳細要求は各 `nfr-<category>` 分冊に記述する。
|
|
86
|
+
|
|
87
|
+
## 6. 記述ガイド
|
|
88
|
+
|
|
89
|
+
### 6.1. 概要(対象範囲・管理方針)
|
|
90
|
+
|
|
91
|
+
生成する本文の見出しは **## 1. 概要(対象範囲・管理方針)**
|
|
92
|
+
|
|
93
|
+
- NFR を分冊管理する目的(探索性、保守性、レビュー効率)を 1〜3段落で示す。
|
|
94
|
+
- 本書が入口であり、要求本文は分冊が SSOT であることを明示する。
|
|
95
|
+
|
|
96
|
+
### 6.2. カテゴリ一覧(8カテゴリ)
|
|
97
|
+
|
|
98
|
+
生成する本文の見出しは **## 2. カテゴリ一覧(8カテゴリ)**
|
|
99
|
+
|
|
100
|
+
- 次の8カテゴリを固定で列挙する。
|
|
101
|
+
- 信頼性、可用性、保守性、完全性、機密性・安全性、性能、運用、操作性
|
|
102
|
+
- カテゴリごとに「目的」と「代表指標」を短く示す。
|
|
103
|
+
|
|
104
|
+
### 6.3. 分冊ドキュメント一覧
|
|
105
|
+
|
|
106
|
+
生成する本文の見出しは **## 3. 分冊ドキュメント一覧(ID/参照先/Owner)**
|
|
107
|
+
|
|
108
|
+
- 各カテゴリの分冊ID、参照先、更新責任、備考を表形式で記載する。
|
|
109
|
+
|
|
110
|
+
- 参照先はリポジトリ相対パスかIDで一意に辿れる形にする。
|
|
111
|
+
|
|
112
|
+
### 6.4. 変更の入口
|
|
113
|
+
|
|
114
|
+
生成する本文の見出しは **## 4. 変更の入口(追加・統廃合・改定)**
|
|
115
|
+
|
|
116
|
+
- 分冊の追加・削除・統合・分割時の更新手順を記載する。
|
|
117
|
+
- 完了条件(リンク有効、重複排除、テスト導線更新)を明示する。
|
|
118
|
+
|
|
119
|
+
### 6.5. 関連ドキュメント導線
|
|
120
|
+
|
|
121
|
+
生成する本文の見出しは **## 5. 関連ドキュメント導線(SAC/STC/OPD/OPR/DEC)**
|
|
122
|
+
|
|
123
|
+
- カテゴリごとに検証(SAC/STC)・運用(OPD/OPR)・判断記録(DEC)への導線を置く。
|
|
124
|
+
- 導線がない場合は `(なし)` を明示する。
|
|
125
|
+
|
|
126
|
+
## 7. 禁止事項
|
|
127
|
+
|
|
128
|
+
| 禁止事項 | 理由 |
|
|
129
|
+
| ---------------------------------------- | -------------------------------- |
|
|
130
|
+
| `nfr-index` にカテゴリ詳細要求を記述する | 分冊との重複・不整合を招くため |
|
|
131
|
+
| 8カテゴリ定義を欠落させる | 網羅性と比較可能性が低下するため |
|
|
132
|
+
| 参照先が不明なIDだけを並べる | 追跡不能になるため |
|
|
133
|
+
| 合否判定不可の曖昧表現を残す | 要件として検証不能になるため |
|
|
134
|
+
|
|
135
|
+
## 8. サンプル
|
|
136
|
+
|
|
137
|
+
注:以下はルール文書内の例示です。生成する `nfr-index` では `## 1...` から始まります。
|
|
138
|
+
|
|
139
|
+
```yaml
|
|
140
|
+
---
|
|
141
|
+
id: nfr-index
|
|
142
|
+
type: architecture
|
|
143
|
+
title: 非機能要件: インデックス
|
|
144
|
+
status: draft
|
|
145
|
+
based_on: []
|
|
146
|
+
supersedes: []
|
|
147
|
+
---
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
### 8.1. 概要(対象範囲・管理方針)
|
|
151
|
+
|
|
152
|
+
本書は非機能要件をカテゴリ別に分冊管理するための入口である。
|
|
153
|
+
要求本文の正本は各カテゴリ分冊に置き、重複記述を避ける。
|
|
154
|
+
|
|
155
|
+
### 8.2. カテゴリ一覧(8カテゴリ)
|
|
156
|
+
|
|
157
|
+
| カテゴリ | 目的 | 代表指標 |
|
|
158
|
+
| -------------- | ---------------------- | --------------------------- |
|
|
159
|
+
| 信頼性 | 障害抑止と誤動作防止 | 障害件数、失敗率 |
|
|
160
|
+
| 可用性 | 利用可能性の維持 | 稼働率、RTO/RPO |
|
|
161
|
+
| 保守性 | 変更容易性と復旧容易性 | MTTR、変更リードタイム |
|
|
162
|
+
| 完全性 | 正確性・改ざん防止 | 整合性違反件数、監査証跡率 |
|
|
163
|
+
| 機密性・安全性 | 不正利用防止 | 権限逸脱件数、脆弱性対応SLA |
|
|
164
|
+
| 性能 | 応答性・処理能力 | P95/P99、RPS |
|
|
165
|
+
| 運用 | 監視・手順・継続運用 | アラート検知率、復旧達成率 |
|
|
166
|
+
| 操作性 | 使いやすさ・誤操作防止 | タスク完了率、誤操作率 |
|
|
167
|
+
|
|
168
|
+
### 8.3. 分冊ドキュメント一覧(例)
|
|
169
|
+
|
|
170
|
+
| ID | 参照先 | Owner | 備考 |
|
|
171
|
+
| ------------------- | ----------------------------------------- | -------- | ------------------ |
|
|
172
|
+
| nfr-reliability | `docs/ja/specdojo/nfr-reliability.md` | QA/Dev | 信頼性要件 |
|
|
173
|
+
| nfr-availability | `docs/ja/specdojo/nfr-availability.md` | Ops | 可用性要件 |
|
|
174
|
+
| nfr-maintainability | `docs/ja/specdojo/nfr-maintainability.md` | Dev/Ops | 保守性要件 |
|
|
175
|
+
| nfr-integrity | `docs/ja/specdojo/nfr-integrity.md` | Dev/QA | 完全性要件 |
|
|
176
|
+
| nfr-security-safety | `docs/ja/specdojo/nfr-security-safety.md` | Security | 機密性・安全性要件 |
|
|
177
|
+
| nfr-performance | `docs/ja/specdojo/nfr-performance.md` | Dev | 性能要件 |
|
|
178
|
+
| nfr-operations | `docs/ja/specdojo/nfr-operations.md` | Ops | 運用要件 |
|
|
179
|
+
| nfr-usability | `docs/ja/specdojo/nfr-usability.md` | UX/QA | 操作性要件 |
|
|
@@ -0,0 +1,184 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:nfr-integrity-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
recipe: undecided
|
|
7
|
+
sample: specdojo:nfr-integrity-sample
|
|
8
|
+
template: undecided
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# 非機能要件 / 完全性 作成ルール
|
|
12
|
+
|
|
13
|
+
Non-Functional Requirements Integrity Documentation Rules
|
|
14
|
+
|
|
15
|
+
本ドキュメントは、非機能要件のうち完全性(正確性・整合性・改ざん耐性)を定義する `nfr-integrity` の作成ルールを定義する。
|
|
16
|
+
完全性要件は、データと処理結果が正しく追跡可能であることを基準化する。
|
|
17
|
+
|
|
18
|
+
## 1. 全体方針
|
|
19
|
+
|
|
20
|
+
- 完全性はデータ整合性、改ざん検知、監査追跡性で定義する。
|
|
21
|
+
- 参照整合・重複防止・履歴保証を検証可能な条件で記述する。
|
|
22
|
+
- 業務上重要な記録の欠落・不整合を許容しない基準にする。
|
|
23
|
+
|
|
24
|
+
## 2. 位置づけと用語定義(必要に応じて)
|
|
25
|
+
|
|
26
|
+
### 2.1. 位置づけ
|
|
27
|
+
|
|
28
|
+
- `nfr-integrity`:完全性要求の正本
|
|
29
|
+
- `nfr-index`:NFR全体の入口
|
|
30
|
+
- `sac-*` / `stc-*`:整合性検証の受入・試験仕様
|
|
31
|
+
- `dec-*`:例外判断記録
|
|
32
|
+
|
|
33
|
+
### 2.2. 用語定義
|
|
34
|
+
|
|
35
|
+
| 用語 | 定義 |
|
|
36
|
+
| ---------- | ------------------------------------------------ |
|
|
37
|
+
| 完全性 | データ・処理結果が正確かつ矛盾なく維持される性質 |
|
|
38
|
+
| 整合性違反 | 制約・業務ルールに反する不正状態 |
|
|
39
|
+
| 監査証跡 | 操作履歴を追跡可能にする記録 |
|
|
40
|
+
|
|
41
|
+
## 3. ファイル命名・ID規則
|
|
42
|
+
|
|
43
|
+
- ルールドキュメントIDは `specdojo:nfr-integrity-rulebook`。
|
|
44
|
+
- 生成対象ドキュメントIDは `nfr-integrity` を推奨する。
|
|
45
|
+
- 要件IDは `nfr-int-<連番>` を推奨する。
|
|
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-integrity` | ○ |
|
|
56
|
+
| type | `architecture` など共通スキーマ準拠 | ○ |
|
|
57
|
+
| title | 非機能要件: 完全性 | ○ |
|
|
58
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
59
|
+
| part_of | `nfr-index` | 任意 |
|
|
60
|
+
|
|
61
|
+
### 4.2. 推奨ルール
|
|
62
|
+
|
|
63
|
+
- 改ざん防止・監査要件は運用/監査ポリシーとの整合を取る。
|
|
64
|
+
|
|
65
|
+
## 5. 本文構成(標準テンプレ)
|
|
66
|
+
|
|
67
|
+
`nfr-integrity` は以下の見出し構成を **順序固定** で配置する。
|
|
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
|
+
- 指標例:整合性違反件数、監査証跡欠落率。
|
|
97
|
+
|
|
98
|
+
### 6.4. 測定・検証方法
|
|
99
|
+
|
|
100
|
+
生成する本文の見出しは **## 4. 測定・検証方法**
|
|
101
|
+
|
|
102
|
+
- 整合性チェック、監査レビュー、試験で判定する。
|
|
103
|
+
|
|
104
|
+
### 6.5. 関連ドキュメント導線
|
|
105
|
+
|
|
106
|
+
生成する本文の見出しは **## 5. 関連ドキュメント導線**
|
|
107
|
+
|
|
108
|
+
- `sac-*`、`stc-*`、`dec-*`、監査関連文書への導線を記載する。
|
|
109
|
+
|
|
110
|
+
## 7. 禁止事項
|
|
111
|
+
|
|
112
|
+
| 禁止事項 | 理由 |
|
|
113
|
+
| ---------------------------------- | ------------------------ |
|
|
114
|
+
| 整合性違反を「原則なし」で済ませる | 監査不能になるため |
|
|
115
|
+
| 改ざん防止要件に検証方法がない | 実効性が担保できないため |
|
|
116
|
+
| 監査証跡の保持基準を省略する | 追跡不能になるため |
|
|
117
|
+
|
|
118
|
+
## 8. サンプル
|
|
119
|
+
|
|
120
|
+
注:以下はルール文書内の例示です。生成する `nfr-integrity` では `## 1...` から始まります。
|
|
121
|
+
|
|
122
|
+
```yaml
|
|
123
|
+
---
|
|
124
|
+
id: nfr-integrity
|
|
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
|
+
| 対象データ | 受注・在庫・会計トランザクションデータ |
|
|
146
|
+
| 整合性境界 | サブシステム間(受注⇔在庫、在庫⇔会計) |
|
|
147
|
+
| 監査要件 | SOC2 Type II 相当の操作履歴保持 |
|
|
148
|
+
| 例外条件 | テスト環境・開発環境のデータは対象外 |
|
|
149
|
+
| データ保持期間 | 監査証跡: 7 年、トランザクションログ: 3 年 |
|
|
150
|
+
|
|
151
|
+
### 8.3. 完全性要件一覧(例)
|
|
152
|
+
|
|
153
|
+
| id | 内容 | 指標 | 基準 | 備考 |
|
|
154
|
+
| ----------- | -------------------------------------------- | ------------------ | -------- | ----------------------------- |
|
|
155
|
+
| nfr-int-001 | 在庫残高データは整合性違反を許容しない | 整合性違反件数 | 0 件/月 | 日次整合チェック |
|
|
156
|
+
| nfr-int-002 | 監査対象操作は追跡可能であること | 監査証跡欠落率 | 0% | who/when/what 必須 |
|
|
157
|
+
| nfr-int-003 | 受注・在庫間の数量整合を日次で確認できること | クロス整合チェック | 日次完了 | 不整合時はアラート発報 |
|
|
158
|
+
| nfr-int-004 | 金額データの改ざんを検知できること | 改ざん検知漏れ率 | 0% | HMAC / デジタル署名 |
|
|
159
|
+
| nfr-int-005 | データ変更履歴は変更前後の値を保持すること | 履歴保持率 | 100% | before/after 形式 |
|
|
160
|
+
| nfr-int-006 | 重複トランザクションを防止すること | 重複発生件数 | 0 件/月 | 冔等キー(order_id)で排除 |
|
|
161
|
+
| nfr-int-007 | 外部連携データの取り込みは検証済みであること | 検証バイパス率 | 0% | スキーマ検証 + ビジネスルール |
|
|
162
|
+
|
|
163
|
+
### 8.4. 測定・検証方法(例)
|
|
164
|
+
|
|
165
|
+
| 要件ID | 測定方法 | 判定タイミング | 判定者 |
|
|
166
|
+
| ----------- | ------------------------------------ | ---------------- | --------- |
|
|
167
|
+
| nfr-int-001 | 日次整合チェックバッチで不整合を検出 | 日次自動実行 | DBA / SRE |
|
|
168
|
+
| nfr-int-002 | 監査ログ収集基盤で欠落操作を検知 | リアルタイム監視 | SRE |
|
|
169
|
+
| nfr-int-003 | 受注↔在庫クロスチェックスクリプト | 日次バッチ完了後 | Ops |
|
|
170
|
+
|
|
171
|
+
| nfr-int-004 | 署名検証テストを CI で実行 | merge 毎 | QA |
|
|
172
|
+
| nfr-int-005 | 履歴テーブルの before/after 網羅率を検査 | 四半期監査 | QA / DBA |
|
|
173
|
+
| nfr-int-006 | 重複トランザクション検知アラートのカウント | リアルタイム監視 | SRE |
|
|
174
|
+
| nfr-int-007 | 外部データ取り込み時の検証ログを確認 | 日次確認 | Ops |
|
|
175
|
+
|
|
176
|
+
### 8.5. 関連ドキュメント導線(例)
|
|
177
|
+
|
|
178
|
+
| 種別 | ドキュメントID | 目的 | 備考 |
|
|
179
|
+
| ------------ | ---------------- | ---------------------------- | ---- |
|
|
180
|
+
| NFR 入口 | nfr-index | 非機能要件全体の俯瞰 | 必須 |
|
|
181
|
+
| 受入条件 | sac-\* | 完全性要件の合否判定基準 | 必須 |
|
|
182
|
+
| システム試験 | stc-\* | 整合性検証・改ざん検知試験 | 必須 |
|
|
183
|
+
| 判断記録 | dec-\* | 完全性に関する例外判断の追跡 | 必須 |
|
|
184
|
+
| 監査文書 | (外部監査基準) | SOC2 等の適合確認 | 任意 |
|
|
@@ -0,0 +1,183 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:nfr-maintainability-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
recipe: undecided
|
|
7
|
+
sample: specdojo:nfr-maintainability-sample
|
|
8
|
+
template: undecided
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# 非機能要件 / 保守性 作成ルール
|
|
12
|
+
|
|
13
|
+
Non-Functional Requirements Maintainability Documentation Rules
|
|
14
|
+
|
|
15
|
+
本ドキュメントは、非機能要件のうち保守性(変更容易性・障害解析容易性)を定義する `nfr-maintainability` の作成ルールを定義する。
|
|
16
|
+
保守性要件は、修正・調査・復旧を継続的に行える運用品質を定量化する。
|
|
17
|
+
|
|
18
|
+
## 1. 全体方針
|
|
19
|
+
|
|
20
|
+
- 保守性は変更コストと復旧コストを下げる要求として定義する。
|
|
21
|
+
- MTTR、変更リードタイム、診断可能性などの指標を用いる。
|
|
22
|
+
- 実装方法ではなく、達成すべき運用可能性を記述する。
|
|
23
|
+
|
|
24
|
+
## 2. 位置づけと用語定義(必要に応じて)
|
|
25
|
+
|
|
26
|
+
### 2.1. 位置づけ
|
|
27
|
+
|
|
28
|
+
- `nfr-maintainability`:保守性要求の正本
|
|
29
|
+
- `nfr-index`:NFR全体の入口
|
|
30
|
+
- `opd-*` / `opr-*`:運用と変更手順
|
|
31
|
+
- `sac-*`:受入時の判定基準
|
|
32
|
+
|
|
33
|
+
### 2.2. 用語定義
|
|
34
|
+
|
|
35
|
+
| 用語 | 定義 |
|
|
36
|
+
| ---------------- | ---------------------------------------- |
|
|
37
|
+
| 保守性 | 修正・改修・障害対応を効率よく行える性質 |
|
|
38
|
+
| MTTR | 平均復旧時間 |
|
|
39
|
+
| 変更リードタイム | 要求受領から本番反映までの時間 |
|
|
40
|
+
|
|
41
|
+
## 3. ファイル命名・ID規則
|
|
42
|
+
|
|
43
|
+
- ルールドキュメントIDは `specdojo:nfr-maintainability-rulebook`。
|
|
44
|
+
- 生成対象ドキュメントIDは `nfr-maintainability` を推奨する。
|
|
45
|
+
- 要件IDは `nfr-mnt-<連番>` を推奨する。
|
|
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-maintainability` | ○ |
|
|
56
|
+
| type | `architecture` など共通スキーマ準拠 | ○ |
|
|
57
|
+
| title | 非機能要件: 保守性 | ○ |
|
|
58
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
59
|
+
| part_of | `nfr-index` | 任意 |
|
|
60
|
+
|
|
61
|
+
### 4.2. 推奨ルール
|
|
62
|
+
|
|
63
|
+
- 調査ログ、監視、Runbook の整備水準を `based_on` と整合させる。
|
|
64
|
+
|
|
65
|
+
## 5. 本文構成(標準テンプレ)
|
|
66
|
+
|
|
67
|
+
`nfr-maintainability` は以下の見出し構成を **順序固定** で配置する。
|
|
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
|
+
- 指標例:MTTR、変更リードタイム、一次切り分け時間。
|
|
97
|
+
|
|
98
|
+
### 6.4. 測定・検証方法
|
|
99
|
+
|
|
100
|
+
生成する本文の見出しは **## 4. 測定・検証方法**
|
|
101
|
+
|
|
102
|
+
- 監視記録、障害レポート、改善サイクルで測定する。
|
|
103
|
+
|
|
104
|
+
### 6.5. 関連ドキュメント導線
|
|
105
|
+
|
|
106
|
+
生成する本文の見出しは **## 5. 関連ドキュメント導線**
|
|
107
|
+
|
|
108
|
+
- `opd-*`、`opr-*`、`dec-*` への導線を必ず置く。
|
|
109
|
+
|
|
110
|
+
## 7. 禁止事項
|
|
111
|
+
|
|
112
|
+
| 禁止事項 | 理由 |
|
|
113
|
+
| ------------------------------------ | -------------------- |
|
|
114
|
+
| 「保守しやすい」だけで閾値を示さない | 判定不能のため |
|
|
115
|
+
| 体制依存の一時運用を恒久要件化する | 再現性がないため |
|
|
116
|
+
| 測定データの取得方法を書かない | 継続評価できないため |
|
|
117
|
+
|
|
118
|
+
## 8. サンプル
|
|
119
|
+
|
|
120
|
+
注:以下はルール文書内の例示です。生成する `nfr-maintainability` では `## 1...` から始まります。
|
|
121
|
+
|
|
122
|
+
```yaml
|
|
123
|
+
---
|
|
124
|
+
id: nfr-maintainability
|
|
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
|
+
| チーム体制 | 開発 5 名・SRE 2 名・Ops 3 名(平日日勤) |
|
|
148
|
+
| ログ基盤 | 構造化ログ(JSON)・分散トレーシング導入済 |
|
|
149
|
+
| CI/CD | GitHub Actions + ArgoCD(トランクベースデプロイ) |
|
|
150
|
+
|
|
151
|
+
### 8.3. 保守性要件一覧(例)
|
|
152
|
+
|
|
153
|
+
| id | 内容 | 指標 | 基準 | 備考 |
|
|
154
|
+
| ----------- | ---------------------------------------------------- | ---------------- | ------------ | ---------------------------- |
|
|
155
|
+
| nfr-mnt-001 | P1 障害は基準時間内に一次復旧する | MTTR | 60 分以内 | 24/365 対象 |
|
|
156
|
+
| nfr-mnt-002 | 軽微変更は短期間で本番反映する | 変更リードタイム | 3 営業日以内 | 標準変更のみ |
|
|
157
|
+
| nfr-mnt-003 | 障害の一次切り分けを基準時間内に完了する | 一次切り分け時間 | 15 分以内 | Runbook + 監視ダッシュボード |
|
|
158
|
+
| nfr-mnt-004 | デプロイのロールバックを基準時間内に完了する | ロールバック時間 | 15 分以内 | トランクベース切り戻し |
|
|
159
|
+
| nfr-mnt-005 | テストカバレッジを基準以上に維持する | カバレッジ率 | 80% 以上 | ビジネスロジック対象 |
|
|
160
|
+
| nfr-mnt-006 | 障害原因調査に必要なログが従事者だけで追跡できること | 調査自己完結率 | 90% 以上 | trace_id で横断検索 |
|
|
161
|
+
| nfr-mnt-007 | API スキーマ変更は後方互換で行えること | 互換性維持期間 | 6 か月以上 | OpenAPI バージョニング |
|
|
162
|
+
|
|
163
|
+
### 8.4. 測定・検証方法(例)
|
|
164
|
+
|
|
165
|
+
| 要件ID | 測定方法 | 判定タイミング | 判定者 |
|
|
166
|
+
| ----------- | ----------------------------------------------- | ---------------- | ------------ |
|
|
167
|
+
| nfr-mnt-001 | インシデント記録から検知〜復旧までの時間を算出 | 障害事後レビュー | SRE / PM |
|
|
168
|
+
| nfr-mnt-002 | PR マージ〜本番デプロイまでのリードタイムを計測 | 月次集計 | テックリード |
|
|
169
|
+
| nfr-mnt-003 | 障害レポートの切り分け完了時刻から算出 | 障害事後レビュー | SRE |
|
|
170
|
+
| nfr-mnt-004 | ロールバック訓練で切り戻し時間を計測 | 四半期訓練 | Infra / SRE |
|
|
171
|
+
| nfr-mnt-005 | CI カバレッジレポートで確認 | merge 毎 | QA |
|
|
172
|
+
| nfr-mnt-006 | 障害対応で外部支援なく解決できた割合を集計 | 月次運用レビュー | SRE |
|
|
173
|
+
| nfr-mnt-007 | API バージョンの後方互換テストを CI で実行 | merge 毎 | QA |
|
|
174
|
+
|
|
175
|
+
### 8.5. 関連ドキュメント導線(例)
|
|
176
|
+
|
|
177
|
+
| 種別 | ドキュメントID | 目的 | 備考 |
|
|
178
|
+
| -------- | -------------- | ------------------------------- | ---- |
|
|
179
|
+
| NFR 入口 | nfr-index | 非機能要件全体の俯瞰 | 必須 |
|
|
180
|
+
| 受入条件 | sac-\* | 保守性要件の合否判定基準 | 必須 |
|
|
181
|
+
| 運用設計 | opd-\* | 監視・アラート・ログ運用設計 | 必須 |
|
|
182
|
+
| 運用手順 | opr-\* | Runbook・障害対応・ロールバック | 必須 |
|
|
183
|
+
| 判断記録 | dec-\* | 保守性に関する設計判断の追跡 | 任意 |
|