specdojo 0.7.0 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/agents/specdojo-orchestrator.md +7 -3
- package/CHANGELOG.md +217 -0
- package/dist/catalog/build.js +24 -1
- package/dist/catalog/catalog.js +16 -14
- package/dist/catalog/plan.js +1 -1
- package/dist/catalog/scaffold.js +4 -1
- package/dist/commands/agent.js +5 -3
- package/dist/commands/build.js +69 -10
- package/dist/commands/git.js +206 -0
- package/dist/commands/init.js +9 -3
- package/dist/commands/night-orchestrator.js +6 -4
- package/dist/commands/where.js +25 -0
- package/dist/dashboard/dashboard-timeline.js +18 -16
- package/dist/dashboard/dashboard.js +616 -261
- package/dist/dashboard/epic-plan.js +81 -0
- package/dist/dashboard/exec-records.js +16 -20
- package/dist/dashboard/routines.js +11 -12
- package/dist/dashboard/timeline-build.js +5 -9
- package/dist/dashboard/timeline.js +23 -18
- package/dist/devcontainer/scaffold.js +18 -0
- package/dist/docs/frontmatter-namespace.js +1 -48
- package/dist/docs/index-command.js +2 -2
- package/dist/docs/yaml-business-tables.js +243 -0
- package/dist/docs/yaml-interface-tables.js +106 -0
- package/dist/docs/yaml-pages-command.js +5 -3
- package/dist/docs/yaml-pages.js +268 -3
- package/dist/docs/yaml-table-shared.js +70 -0
- package/dist/docs/yaml-tables.js +39 -0
- package/dist/exec/agent-config.js +31 -0
- package/dist/exec/agent-plan.js +3 -2
- package/dist/exec/agent-protected-config.js +2 -0
- package/dist/exec/commands.js +100 -39
- package/dist/exec/commit-hook-skips.js +78 -0
- package/dist/exec/core.js +19 -7
- package/dist/exec/events.js +179 -8
- package/dist/exec/evidence.js +77 -19
- package/dist/exec/handoff.js +9 -13
- package/dist/exec/limit.js +1 -1
- package/dist/exec/mechanical-result.js +45 -0
- package/dist/exec/migrate-records.js +249 -0
- package/dist/exec/parent-validation.js +209 -15
- package/dist/exec/pipeline-state.js +27 -5
- package/dist/exec/plans-condense-findings.js +89 -0
- package/dist/exec/plans-core.js +45 -19
- package/dist/exec/plans-generation.js +52 -30
- package/dist/exec/plans-grade-findings.js +8 -3
- package/dist/exec/plans-kata-findings.js +61 -0
- package/dist/exec/plans-planning.js +3 -3
- package/dist/exec/plans-storage.js +12 -24
- package/dist/exec/post-integration.js +162 -0
- package/dist/exec/queue-command.js +166 -0
- package/dist/exec/queue.js +285 -0
- package/dist/exec/register-foreign-wait.js +84 -0
- package/dist/exec/register-resume.js +55 -56
- package/dist/exec/register.js +26 -22
- package/dist/exec/repo-integration-sync.js +21 -5
- package/dist/exec/repo-integration.js +21 -1
- package/dist/exec/reporter.js +121 -23
- package/dist/exec/results.js +106 -25
- package/dist/exec/review-completion.js +47 -0
- package/dist/exec/review-kata.js +112 -0
- package/dist/exec/run/agent-pipeline.js +78 -8
- package/dist/exec/run/agent.js +32 -13
- package/dist/exec/run/change-scope.js +365 -0
- package/dist/exec/run/deferred-cleanup.js +31 -0
- package/dist/exec/run/in-place.js +73 -33
- package/dist/exec/run/job-lock.js +66 -0
- package/dist/exec/run/job-sequence.js +137 -0
- package/dist/exec/run/job.js +135 -41
- package/dist/exec/run/lifecycle-commands.js +189 -37
- package/dist/exec/run/lock.js +22 -1
- package/dist/exec/run/mode-shared.js +11 -3
- package/dist/exec/run/register-command.js +14 -15
- package/dist/exec/run/register-core.js +20 -13
- package/dist/exec/run/register-mode.js +77 -17
- package/dist/exec/run/register-post-review.js +21 -9
- package/dist/exec/run/register-resume.js +95 -31
- package/dist/exec/run/register-state.js +23 -15
- package/dist/exec/run/register-worktree.js +184 -139
- package/dist/exec/run/schedule-mode.js +79 -18
- package/dist/exec/run/schedule-prepare.js +204 -59
- package/dist/exec/run/schedule-task.js +203 -49
- package/dist/exec/run/shared.js +9 -3
- package/dist/exec/run/trailing-records.js +35 -0
- package/dist/exec/run-records.js +2 -0
- package/dist/exec/schedule/schedule.js +116 -4
- package/dist/exec/shared.js +1 -1
- package/dist/exec/smoke.js +190 -0
- package/dist/exec/strategy.js +14 -3
- package/dist/exec/task-view.js +6 -4
- package/dist/exec/trailing-records.js +242 -0
- package/dist/exec/trial-commands.js +8 -4
- package/dist/exec/trial-core.js +6 -1
- package/dist/exec/validate-records-commit.js +110 -0
- package/dist/exec/validate-records.js +148 -0
- package/dist/exec/validation-metrics.js +181 -0
- package/dist/exec/worktree-cleanup-lock.js +26 -0
- package/dist/exec/worktree-command.js +38 -17
- package/dist/exec/worktree-ops-commit.js +119 -48
- package/dist/exec/worktree-ops-lifecycle.js +77 -48
- package/dist/exec/worktree-ops-merge.js +13 -2
- package/dist/exec/worktree-ops.js +2 -2
- package/dist/exec/worktree.js +32 -4
- package/dist/grade/apply.js +32 -6
- package/dist/grade/command-apply.js +3 -3
- package/dist/grade/command-inspect.js +7 -5
- package/dist/grade/command-plan.js +1 -1
- package/dist/grade/command-run.js +7 -1
- package/dist/grade/command-shared.js +1 -1
- package/dist/grade/core.js +18 -5
- package/dist/grade/markdown.js +3 -3
- package/dist/grade/pipeline-state.js +15 -11
- package/dist/grade/plan.js +37 -17
- package/dist/grade/result.js +3 -3
- package/dist/grade/run.js +87 -11
- package/dist/grade/target-discovery.js +17 -4
- package/dist/grade/targets.js +12 -11
- package/dist/job/definition.js +84 -8
- package/dist/job/job.js +109 -39
- package/dist/job/noop.js +104 -0
- package/dist/register/authoring-sources.js +22 -16
- package/dist/register/core.js +2 -0
- package/dist/register/create-commands.js +28 -3
- package/dist/register/deliverable-target.js +9 -1
- package/dist/register/epic.js +104 -26
- package/dist/register/event-merge.js +3 -0
- package/dist/register/events.js +4 -0
- package/dist/register/external-project.js +3 -0
- package/dist/register/item.js +6 -0
- package/dist/register/maintenance-commands.js +6 -3
- package/dist/register/planning.js +7 -14
- package/dist/register/register.js +74 -16
- package/dist/register/track-domains.js +34 -0
- package/dist/register/track-plan.js +78 -0
- package/dist/register/transition-commands.js +8 -0
- package/dist/register/work-table.js +64 -0
- package/dist/review/grade.js +35 -13
- package/dist/routine/definition.js +13 -3
- package/dist/routine/failure.js +30 -0
- package/dist/routine/routine.js +189 -71
- package/dist/routine/status.js +62 -0
- package/dist/routine/storage.js +33 -0
- package/dist/schedule/schedule.js +39 -39
- package/dist/schedule/strategy-generate-document.js +26 -14
- package/dist/schedule/strategy-generate-scope.js +17 -45
- package/dist/schedule/strategy-generate.js +33 -3
- package/dist/schedule/strategy-profiles.js +86 -12
- package/dist/shared/agent-types.js +7 -0
- package/dist/shared/condense-records.js +25 -0
- package/dist/shared/cross-process-lock.js +9 -1
- package/dist/shared/deprecation.js +8 -0
- package/dist/shared/dist-freshness.js +8 -2
- package/dist/shared/document-metadata.js +20 -0
- package/dist/shared/finding-cause.js +20 -0
- package/dist/shared/frontmatter-namespace.js +48 -0
- package/dist/shared/git-environment.js +2 -1
- package/dist/shared/git.js +186 -16
- package/dist/shared/grade-result.js +17 -1
- package/dist/shared/lefthook-scaffold.js +3 -0
- package/dist/shared/local-config.js +244 -0
- package/dist/shared/local-state.js +20 -0
- package/dist/shared/markdownlint-config.js +8 -3
- package/dist/shared/plan-conventions.js +129 -0
- package/dist/shared/plan-templates.js +57 -41
- package/dist/shared/run-records.js +224 -0
- package/dist/shared/specdojo-config.js +73 -41
- package/dist/shared/specdojo-gitignore.js +1 -0
- package/dist/shared/text.js +74 -6
- package/dist/shared/timeline-index.js +2 -0
- package/dist/shared/where-alias.js +13 -0
- package/dist/specdojo.js +4 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +11 -2
- package/docs/ja/specdojo/exec-templates/xep-common-conventions-template.md +4 -74
- package/docs/ja/specdojo/exec-templates/xep-condense-template.md +50 -0
- package/docs/ja/specdojo/exec-templates/xep-draft-template.md +17 -5
- package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +16 -3
- package/docs/ja/specdojo/exec-templates/xep-recipe-guided-template.md +15 -5
- package/docs/ja/specdojo/exec-templates/xep-recipe-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-register-template.md +1 -1
- package/docs/ja/specdojo/exec-templates/xep-rulebook-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-sample-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-template-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xer-condense-template.md +25 -0
- package/docs/ja/specdojo/exec-templates/xp-common-conventions-template.md +50 -0
- package/docs/ja/specdojo/exec-templates/xrp-common-conventions-template.md +30 -0
- package/docs/ja/specdojo/guides/branch-workflow-guide.md +1 -1
- package/docs/ja/specdojo/guides/docs-editing-guide.md +12 -0
- package/docs/ja/specdojo/guides/docs-structure-guide.md +48 -15
- package/docs/ja/specdojo/guides/exec-config-guide.md +69 -19
- package/docs/ja/specdojo/guides/exec-operation-guide.md +97 -18
- package/docs/ja/specdojo/guides/exec-worktree-guide.md +20 -11
- package/docs/ja/specdojo/guides/job-sequence-guide.md +77 -0
- package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +92 -55
- package/docs/ja/specdojo/guides/project-move-guide.md +381 -0
- package/docs/ja/specdojo/guides/quick-start-guide.md +73 -17
- package/docs/ja/specdojo/guides/register-operation-guide.md +26 -6
- package/docs/ja/specdojo/guides/remote-host-development-guide.md +2 -0
- package/docs/ja/specdojo/guides/review-guide.md +22 -19
- package/docs/ja/specdojo/guides/routine-operation-guide.md +23 -12
- package/docs/ja/specdojo/guides/ryu-guide.md +23 -13
- package/docs/ja/specdojo/guides/schedule-design-guide.md +27 -21
- package/docs/ja/specdojo/guides/schedule-operation-guide.md +27 -3
- package/docs/ja/specdojo/guides/specdojo-overview-guide.md +5 -4
- package/docs/ja/specdojo/guides/timeline-design-guide.md +27 -144
- package/docs/ja/specdojo/guides/use-case-guide.md +92 -155
- package/docs/ja/specdojo/guides/waza-guide.md +12 -8
- package/docs/ja/specdojo/recipes/bac-recipe.md +111 -0
- package/docs/ja/specdojo/recipes/bes-recipe.md +141 -0
- package/docs/ja/specdojo/recipes/bps-recipe.md +88 -139
- package/docs/ja/specdojo/recipes/br-recipe.md +77 -0
- package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +97 -109
- package/docs/ja/specdojo/recipes/cdfd-recipe.md +85 -146
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +92 -99
- package/docs/ja/specdojo/recipes/cnd-recipe.md +135 -0
- package/docs/ja/specdojo/recipes/cpd-recipe.md +140 -0
- package/docs/ja/specdojo/recipes/cxd-recipe.md +162 -0
- package/docs/ja/specdojo/recipes/ifd-recipe.md +145 -0
- package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +112 -90
- package/docs/ja/specdojo/recipes/ifx-index-recipe.md +164 -0
- package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +60 -49
- package/docs/ja/specdojo/recipes/pm-members-recipe.md +50 -51
- package/docs/ja/specdojo/recipes/pm-organization-recipe.md +59 -48
- package/docs/ja/specdojo/recipes/pm-plan-recipe.md +72 -50
- package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +40 -49
- package/docs/ja/specdojo/recipes/pm-raci-recipe.md +42 -48
- package/docs/ja/specdojo/recipes/pm-roles-recipe.md +52 -81
- package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +64 -91
- package/docs/ja/specdojo/recipes/prj-charter-recipe.md +71 -106
- package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +78 -156
- package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +62 -111
- package/docs/ja/specdojo/recipes/prj-scope-recipe.md +67 -123
- package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +60 -96
- package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +61 -105
- package/docs/ja/specdojo/recipes/stsd-recipe.md +88 -80
- package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +129 -0
- package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +146 -0
- package/docs/ja/specdojo/recipes/sysd-index-recipe.md +141 -0
- package/docs/ja/specdojo/recipes/tsd-recipe.md +149 -129
- package/docs/ja/specdojo/references/command-reference.md +303 -148
- package/docs/ja/specdojo/references/deliverables-reference.md +30 -16
- package/docs/ja/specdojo/references/directory-layout-reference.md +3 -2
- package/docs/ja/specdojo/references/specdojo-config-reference.md +54 -18
- package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +101 -257
- package/docs/ja/specdojo/rulebooks/atc-rulebook.md +102 -228
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +63 -290
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +162 -80
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +118 -155
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +128 -60
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +70 -94
- package/docs/ja/specdojo/rulebooks/bps-rulebook.md +24 -56
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +58 -103
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +103 -223
- package/docs/ja/specdojo/rulebooks/cdfd-d2-rulebook.md +18 -93
- package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +18 -52
- package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +109 -147
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +80 -108
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +51 -55
- package/docs/ja/specdojo/rulebooks/cdr-rulebook.md +144 -0
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +81 -68
- package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +139 -0
- package/docs/ja/specdojo/rulebooks/cld-rulebook.md +9 -184
- package/docs/ja/specdojo/rulebooks/clis-rulebook.md +170 -0
- package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +33 -86
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +79 -249
- package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +45 -131
- package/docs/ja/specdojo/rulebooks/cop-rulebook.md +69 -275
- package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +20 -112
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +79 -249
- package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +12 -145
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +115 -256
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +79 -109
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +119 -174
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +6 -14
- package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +22 -66
- package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +36 -94
- package/docs/ja/specdojo/rulebooks/dss-rulebook.md +171 -0
- package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +31 -131
- package/docs/ja/specdojo/rulebooks/etc-rulebook.md +50 -104
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +93 -57
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +63 -253
- package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +14 -20
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +79 -76
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +182 -237
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +111 -40
- package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +14 -22
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +23 -46
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +41 -64
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +16 -40
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +34 -61
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +27 -50
- package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +70 -199
- package/docs/ja/specdojo/rulebooks/itc-rulebook.md +65 -153
- package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +74 -150
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +12 -23
- package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +99 -176
- package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +35 -61
- package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +75 -117
- package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +31 -60
- package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +26 -81
- package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +32 -70
- package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +45 -87
- package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +48 -101
- package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +44 -80
- package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +59 -127
- package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +31 -50
- package/docs/ja/specdojo/rulebooks/opd-rulebook.md +42 -109
- package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +29 -42
- package/docs/ja/specdojo/rulebooks/opr-rulebook.md +29 -87
- package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +62 -84
- package/docs/ja/specdojo/rulebooks/otp-rulebook.md +11 -61
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +92 -102
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +25 -34
- package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +30 -53
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +23 -35
- package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +27 -45
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +45 -59
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +56 -66
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +54 -62
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +46 -65
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +28 -35
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +65 -97
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +6 -18
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +48 -78
- package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +23 -97
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +61 -153
- package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +43 -116
- package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +16 -51
- package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +47 -92
- package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +25 -84
- package/docs/ja/specdojo/rulebooks/sac-rulebook.md +44 -107
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +106 -32
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +111 -61
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +129 -59
- package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +90 -189
- package/docs/ja/specdojo/rulebooks/stc-rulebook.md +45 -105
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +46 -40
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +104 -68
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +64 -330
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +70 -263
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +58 -200
- package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +47 -60
- package/docs/ja/specdojo/rulebooks/tml-rulebook.md +4 -9
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +69 -71
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +65 -72
- package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +35 -46
- package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +49 -66
- package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +64 -139
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +91 -161
- package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +49 -144
- package/docs/ja/specdojo/rulebooks/utc-rulebook.md +67 -155
- package/docs/ja/specdojo/samples/bac-sample.md +106 -21
- package/docs/ja/specdojo/samples/bdd-sample.yaml +143 -35
- package/docs/ja/specdojo/samples/bds-sample.md +87 -21
- package/docs/ja/specdojo/samples/bes-index-sample.md +42 -20
- package/docs/ja/specdojo/samples/bes-sample.md +70 -21
- package/docs/ja/specdojo/samples/bps-sample.md +42 -54
- package/docs/ja/specdojo/samples/br-sample.md +57 -15
- package/docs/ja/specdojo/samples/ccd-sample.md +80 -19
- package/docs/ja/specdojo/samples/cdfd-sample.md +172 -99
- package/docs/ja/specdojo/samples/cdfd-uc-sample.md +9 -7
- package/docs/ja/specdojo/samples/cdr-sample.md +78 -0
- package/docs/ja/specdojo/samples/cdsd-sample.md +73 -20
- package/docs/ja/specdojo/samples/cdt-sample.md +116 -0
- package/docs/ja/specdojo/samples/cld-sample.md +3 -30
- package/docs/ja/specdojo/samples/clis-sample.md +125 -0
- package/docs/ja/specdojo/samples/cnd-sample.md +127 -21
- package/docs/ja/specdojo/samples/cpd-sample.md +136 -22
- package/docs/ja/specdojo/samples/cxd-sample.md +108 -22
- package/docs/ja/specdojo/samples/dct-index-sample.yaml +63 -17
- package/docs/ja/specdojo/samples/dec-sample.md +2 -3
- package/docs/ja/specdojo/samples/dss-sample.md +175 -0
- package/docs/ja/specdojo/samples/gl-sample.yaml +50 -14
- package/docs/ja/specdojo/samples/ifd-sample.md +105 -21
- package/docs/ja/specdojo/samples/ifx-api-sample.yaml +0 -2
- package/docs/ja/specdojo/samples/ifx-cmd-sample.yaml +91 -60
- package/docs/ja/specdojo/samples/ifx-file-sample.md +462 -21
- package/docs/ja/specdojo/samples/ifx-index-sample.yaml +87 -19
- package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +0 -2
- package/docs/ja/specdojo/samples/job-sequence.yaml +67 -0
- package/docs/ja/specdojo/samples/mip-index-sample.md +98 -20
- package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +26 -19
- package/docs/ja/specdojo/samples/pm-members-sample.yaml +37 -13
- package/docs/ja/specdojo/samples/pm-organization-sample.md +42 -21
- package/docs/ja/specdojo/samples/pm-plan-sample.md +78 -26
- package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +41 -22
- package/docs/ja/specdojo/samples/pm-raci-sample.md +63 -28
- package/docs/ja/specdojo/samples/pm-roles-sample.yaml +13 -12
- package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +33 -25
- package/docs/ja/specdojo/samples/prj-charter-sample.md +42 -59
- package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +83 -62
- package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +30 -33
- package/docs/ja/specdojo/samples/sf-index-sample.md +47 -20
- package/docs/ja/specdojo/samples/sf-sample.md +109 -21
- package/docs/ja/specdojo/samples/sld-sample.md +88 -21
- package/docs/ja/specdojo/samples/stsd-sample.md +54 -26
- package/docs/ja/specdojo/samples/sysd-critical-flows-sample.md +166 -21
- package/docs/ja/specdojo/samples/sysd-cross-cutting-policy-sample.md +178 -21
- package/docs/ja/specdojo/samples/sysd-index-sample.md +82 -21
- package/docs/ja/specdojo/samples/tml-sample.yaml +4 -1
- package/docs/ja/specdojo/samples/uis-sample.md +141 -20
- package/docs/ja/specdojo/standards/document-metadata-standard.md +33 -4
- package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +3 -1
- package/docs/ja/specdojo/standards/job-definition-standard.md +24 -9
- package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +1 -0
- package/docs/ja/specdojo/templates/bac-template.md +76 -0
- package/docs/ja/specdojo/templates/bes-template.md +56 -0
- package/docs/ja/specdojo/templates/br-template.md +64 -0
- package/docs/ja/specdojo/templates/cdfd-template.md +81 -54
- package/docs/ja/specdojo/templates/cdfd-uc-template.md +9 -5
- package/docs/ja/specdojo/templates/cdr-template.md +58 -0
- package/docs/ja/specdojo/templates/cnd-template.md +137 -0
- package/docs/ja/specdojo/templates/cpd-template.md +129 -0
- package/docs/ja/specdojo/templates/cxd-template.md +105 -0
- package/docs/ja/specdojo/templates/dct-data-model-cdt-template.yaml +40 -0
- package/docs/ja/specdojo/templates/dct-data-model-cld-template.yaml +7 -14
- package/docs/ja/specdojo/templates/dct-index-template.md +9 -20
- package/docs/ja/specdojo/templates/dct-project-management-template.yaml +5 -1
- package/docs/ja/specdojo/templates/ifd-template.md +86 -0
- package/docs/ja/specdojo/templates/ifx-cmd-template.yaml +44 -28
- package/docs/ja/specdojo/templates/ifx-index-template.yaml +40 -0
- package/docs/ja/specdojo/templates/opr-template.md +2 -4
- package/docs/ja/specdojo/templates/pm-organization-template.md +9 -3
- package/docs/ja/specdojo/templates/pm-plan-template.md +4 -4
- package/docs/ja/specdojo/templates/pm-quality-management-plan-template.md +17 -9
- package/docs/ja/specdojo/templates/pm-raci-template.md +24 -13
- package/docs/ja/specdojo/templates/pm-roles-template.yaml +3 -2
- package/docs/ja/specdojo/templates/prj-assumptions-constraints-dependencies-template.md +6 -3
- package/docs/ja/specdojo/templates/prj-comparison-of-alternatives-template.md +22 -19
- package/docs/ja/specdojo/templates/stsd-template.md +46 -21
- package/docs/ja/specdojo/templates/sysd-critical-flows-template.md +94 -0
- package/docs/ja/specdojo/templates/sysd-cross-cutting-policy-template.md +122 -0
- package/docs/ja/specdojo/templates/sysd-index-template.md +89 -0
- package/docs/specdojo/lib/yaml-metadata.cjs +7 -0
- package/docs/specdojo/schemas/v1/bdd.schema.yaml +25 -57
- package/docs/specdojo/schemas/v1/condense-records.schema.yaml +26 -0
- package/docs/specdojo/schemas/v1/dct.schema.yaml +10 -0
- package/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml +3 -0
- package/docs/specdojo/schemas/v1/esil.schema.yaml +7 -141
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +5 -1
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +95 -8
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +38 -0
- package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +14 -0
- package/docs/specdojo/schemas/v1/exec-result-frontmatter.schema.yaml +18 -0
- package/docs/specdojo/schemas/v1/finding-cause.schema.yaml +22 -0
- package/docs/specdojo/schemas/v1/grade-pipeline-state.schema.yaml +1 -1
- package/docs/specdojo/schemas/v1/grade-result.schema.yaml +2 -0
- package/docs/specdojo/schemas/v1/ifx-cmd.schema.yaml +65 -5
- package/docs/specdojo/schemas/v1/ifx-index.schema.yaml +142 -0
- package/docs/specdojo/schemas/v1/job-run.schema.yaml +23 -0
- package/docs/specdojo/schemas/v1/job.schema.yaml +63 -2
- package/docs/specdojo/schemas/v1/register-events.schema.yaml +2 -0
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +17 -1
- package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +2 -2
- package/package.json +10 -7
- package/templates/antigravity/orchestrator.md +7 -3
- package/templates/claude/agents/specdojo-orchestrator.md +7 -3
- package/templates/codex/agents/specdojo-orchestrator.toml +7 -3
- package/templates/codex/orchestrator.md +7 -3
- package/templates/devcontainer/tmux.conf +6 -0
- package/templates/init-exec-defaults.yaml +13 -0
- package/templates/lefthook/tools/specdojo-pre-commit.mjs +8 -0
- package/templates/opencode/agents/specdojo-orchestrator.md +8 -4
|
@@ -13,116 +13,71 @@ specdojo:
|
|
|
13
13
|
|
|
14
14
|
Non-Functional Requirements Index Documentation Rules
|
|
15
15
|
|
|
16
|
-
|
|
17
|
-
`nfr-index` は一次情報の入口であり、各カテゴリ(信頼性、可用性、保守性、完全性、機密性・安全性、性能、運用、操作性)への導線を管理する。
|
|
16
|
+
非機能要件(NFR)を8カテゴリ(信頼性、可用性、保守性、完全性、機密性・安全性、性能、運用、操作性)の分冊で管理する入口 `nfr-index` の作成ルールを定めます。
|
|
18
17
|
|
|
19
18
|
## 1. 全体方針
|
|
20
19
|
|
|
21
|
-
- `nfr-index`
|
|
22
|
-
-
|
|
23
|
-
-
|
|
24
|
-
-
|
|
20
|
+
- **目的と適用範囲**: `nfr-index` を対象とし、分冊と検証・運用・判断記録への導線を一か所に集めます。
|
|
21
|
+
- **責務境界**: 要求・合否基準・検証方法の正本は各 `nfr-<category>` 分冊とし、`nfr-index` は詳細要求を再掲しません。
|
|
22
|
+
- **記載レベル**: 分冊の要求は合否判定できる状態を前提とし、実装詳細は書きません。
|
|
23
|
+
- **変更の起点**: 分冊の追加・統廃合では `nfr-index` を最初に更新します。
|
|
24
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、本書と成果物で言い直しません。文書の整形・lint はリポジトリの検証で扱い、成果物の業務の検証に含めません。
|
|
25
25
|
|
|
26
|
-
## 2.
|
|
26
|
+
## 2. 位置づけ
|
|
27
27
|
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
- `
|
|
31
|
-
- `
|
|
32
|
-
- `sac-*` / `stc-*`:NFR の合否を検証する受入条件・試験仕様
|
|
33
|
-
- `opd-*` / `opr-*`:運用方針・運用手順への接続先
|
|
34
|
-
- `dec-*`:例外基準や判断記録
|
|
35
|
-
|
|
36
|
-
### 2.2. 用語定義
|
|
37
|
-
|
|
38
|
-
| 用語 | 定義 |
|
|
39
|
-
| --------- | -------------------------------------------------- |
|
|
40
|
-
| NFR | 非機能要件。性能、可用性、セキュリティ等の品質要求 |
|
|
41
|
-
| NFR Index | 各NFR分冊への導線を集約する文書 |
|
|
42
|
-
| 合否基準 | 要求を満たすか判定できる閾値・条件 |
|
|
28
|
+
- `nfr-<category>`: カテゴリ別の NFR 本文(分冊)。
|
|
29
|
+
- `sac-*` / `stc-*`: NFR の合否を検証する受入条件・試験仕様。
|
|
30
|
+
- `opd-*` / `opr-*`: 運用方針・運用手順。
|
|
31
|
+
- `dec-*`: 例外基準や判断記録。
|
|
43
32
|
|
|
44
33
|
## 3. ファイル命名・ID規則
|
|
45
34
|
|
|
46
|
-
-
|
|
47
|
-
-
|
|
48
|
-
- 分冊IDは `nfr-reliability` / `nfr-availability` などカテゴリ名を用いる。
|
|
49
|
-
- 1分冊 = 1カテゴリを原則とする。
|
|
35
|
+
- 文書 ID は `nfr-index`、ファイル名は `nfr-index.md` とします。
|
|
36
|
+
- 分冊の ID はカテゴリ名を用い(例: `nfr-reliability`)、1分冊 = 1カテゴリを原則とします。
|
|
50
37
|
|
|
51
38
|
## 4. 推奨 Frontmatter 項目
|
|
52
39
|
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
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))。
|
|
56
|
-
|
|
57
|
-
| 項目 | 説明 | 必須 |
|
|
58
|
-
| ---------- | -------------------------------------------- | ---- |
|
|
59
|
-
| id | NFR Index ID(推奨: `nfr-index`) | ○ |
|
|
60
|
-
| type | `requirement` 固定 | ○ |
|
|
61
|
-
| title | 非機能要件: インデックス | ○ |
|
|
62
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
63
|
-
| based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
|
|
64
|
-
| supersedes | 置き換え関係(ID配列。未指定は `[]` 可) | 任意 |
|
|
65
|
-
|
|
66
|
-
### 4.2. 推奨ルール
|
|
67
|
-
|
|
68
|
-
- `based_on` は NFR 策定根拠(業務仕様・アーキ方針・運用方針)だけを列挙する。
|
|
69
|
-
- `supersedes` は旧NFRを置換する場合のみ記載する。
|
|
70
|
-
|
|
71
|
-
## 5. 本文構成(標準テンプレ)
|
|
40
|
+
許可キー・必須項目・型制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
|
|
72
41
|
|
|
73
|
-
`nfr-index`
|
|
42
|
+
- `specdojo.type` は `requirement`、`specdojo.rulebook` は `specdojo:nfr-index-rulebook` とします。
|
|
43
|
+
- `specdojo.based_on` には NFR 策定の根拠(業務仕様・アーキテクチャ方針・運用方針)だけを列挙します。
|
|
74
44
|
|
|
75
|
-
|
|
76
|
-
| ---- | ------------------------------------------- | ---- |
|
|
77
|
-
| 1 | 概要(対象範囲・管理方針) | ○ |
|
|
78
|
-
| 2 | カテゴリ一覧(8カテゴリ) | ○ |
|
|
79
|
-
| 3 | 分冊ドキュメント一覧(ID/参照先/Owner) | ○ |
|
|
80
|
-
| 4 | 変更の入口(追加・統廃合・改定) | ○ |
|
|
81
|
-
| 5 | 関連ドキュメント導線(SAC/STC/OPD/OPR/DEC) | ○ |
|
|
45
|
+
## 5. 本文要件
|
|
82
46
|
|
|
83
|
-
|
|
47
|
+
本文は次の見出しを順序固定で配置します。
|
|
84
48
|
|
|
85
|
-
|
|
86
|
-
|
|
49
|
+
| 番号 | 見出し | 必須 | 受入条件 |
|
|
50
|
+
| ---- | ------------------------------------------- | ---- | --------------------------------------------------- |
|
|
51
|
+
| 1 | 概要(対象範囲・管理方針) | ○ | 分冊管理の目的と要求本文の正本が分かる |
|
|
52
|
+
| 2 | カテゴリ一覧(8カテゴリ) | ○ | 8カテゴリすべてに目的と代表指標がある |
|
|
53
|
+
| 3 | 分冊ドキュメント一覧(ID/参照先/Owner) | ○ | 各カテゴリの分冊 ID・参照先・更新責任が一意に辿れる |
|
|
54
|
+
| 4 | 変更の入口(追加・統廃合・改定) | ○ | 分冊の追加・削除・統合・分割の手順と完了条件がある |
|
|
55
|
+
| 5 | 関連ドキュメント導線(SAC/STC/OPD/OPR/DEC) | ○ | カテゴリごとの検証・運用・判断記録の導線がある |
|
|
87
56
|
|
|
88
57
|
## 6. 記述ガイド
|
|
89
58
|
|
|
90
59
|
### 6.1. 概要(対象範囲・管理方針)
|
|
91
60
|
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
- NFR を分冊管理する目的(探索性、保守性、レビュー効率)を 1〜3段落で示す。
|
|
95
|
-
- 本書が入口であり、要求本文は分冊が SSOT であることを明示する。
|
|
61
|
+
- 分冊管理の目的(探索性、保守性、レビュー効率)を 1〜3段落で示し、要求本文は分冊が正本であることを明示します。
|
|
96
62
|
|
|
97
63
|
### 6.2. カテゴリ一覧(8カテゴリ)
|
|
98
64
|
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
- 次の8カテゴリを固定で列挙する。
|
|
102
|
-
- 信頼性、可用性、保守性、完全性、機密性・安全性、性能、運用、操作性
|
|
103
|
-
- カテゴリごとに「目的」と「代表指標」を短く示す。
|
|
65
|
+
- 8カテゴリを固定で列挙し、カテゴリごとに「目的」と「代表指標」を短く示します。
|
|
66
|
+
- 良い例: 「可用性 / 利用可能性の維持 / 稼働率、RTO/RPO」。悪い例: 「可用性 / 止まらないこと / 高いこと」(指標が測れない)。
|
|
104
67
|
|
|
105
68
|
### 6.3. 分冊ドキュメント一覧
|
|
106
69
|
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
- 各カテゴリの分冊ID、参照先、更新責任、備考を表形式で記載する。
|
|
110
|
-
|
|
111
|
-
- 参照先はリポジトリ相対パスかIDで一意に辿れる形にする。
|
|
70
|
+
- 分冊 ID・参照先・更新責任(Role code)・備考を表で記載し、参照先はリポジトリ相対パスか ID で一意に辿れる形にします。
|
|
112
71
|
|
|
113
72
|
### 6.4. 変更の入口
|
|
114
73
|
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
- 分冊の追加・削除・統合・分割時の更新手順を記載する。
|
|
118
|
-
- 完了条件(リンク有効、重複排除、テスト導線更新)を明示する。
|
|
74
|
+
- 追加・削除・統合・分割ごとに、更新する文書(本書のカテゴリ一覧・分冊一覧、関連する `sac-*` / `stc-*`)を示します。
|
|
75
|
+
- 完了条件は、旧分冊の要求が新分冊へ重複なく移ったこと、検証導線が新分冊を指すことで判定します。
|
|
119
76
|
|
|
120
77
|
### 6.5. 関連ドキュメント導線
|
|
121
78
|
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
- カテゴリごとに検証(SAC/STC)・運用(OPD/OPR)・判断記録(DEC)への導線を置く。
|
|
125
|
-
- 導線がない場合は `(なし)` を明示する。
|
|
79
|
+
- カテゴリごとに検証(SAC/STC)・運用(OPD/OPR)・判断記録(DEC)への導線を置きます。
|
|
80
|
+
- 導線がない場合は `(なし)` を明示します。
|
|
126
81
|
|
|
127
82
|
## 7. 禁止事項
|
|
128
83
|
|
|
@@ -135,46 +90,49 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
135
90
|
|
|
136
91
|
## 8. サンプル
|
|
137
92
|
|
|
138
|
-
|
|
93
|
+
注: 形式の輪郭を示す最小例です。生成する `nfr-index` では `## 1.` から始まります。
|
|
139
94
|
|
|
140
|
-
```
|
|
95
|
+
```markdown
|
|
141
96
|
---
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
status: draft
|
|
146
|
-
|
|
147
|
-
|
|
97
|
+
specdojo:
|
|
98
|
+
id: nfr-index
|
|
99
|
+
type: requirement
|
|
100
|
+
status: draft
|
|
101
|
+
rulebook: specdojo:nfr-index-rulebook
|
|
102
|
+
based_on: []
|
|
148
103
|
---
|
|
149
|
-
```
|
|
150
104
|
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
|
160
|
-
|
|
|
161
|
-
|
|
|
162
|
-
|
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
105
|
+
# 非機能要件インデックス
|
|
106
|
+
|
|
107
|
+
## 1. 概要(対象範囲・管理方針)
|
|
108
|
+
|
|
109
|
+
本書は非機能要件をカテゴリ別に分冊管理するための入口である。要求本文の正本は各分冊に置く。
|
|
110
|
+
|
|
111
|
+
## 2. カテゴリ一覧(8カテゴリ)
|
|
112
|
+
|
|
113
|
+
| カテゴリ | 目的 | 代表指標 |
|
|
114
|
+
| -------- | -------------------- | ---------------- |
|
|
115
|
+
| 信頼性 | 障害抑止と誤動作防止 | 障害件数、失敗率 |
|
|
116
|
+
| 性能 | 応答性・処理能力 | P95/P99、RPS |
|
|
117
|
+
|
|
118
|
+
(8カテゴリすべてを記載する)
|
|
119
|
+
|
|
120
|
+
## 3. 分冊ドキュメント一覧(ID/参照先/Owner)
|
|
121
|
+
|
|
122
|
+
| ID | 参照先 | Owner | 備考 |
|
|
123
|
+
| --------------- | -------------------- | ------ | ---------- |
|
|
124
|
+
| nfr-reliability | `nfr-reliability.md` | QA/DEV | 信頼性要件 |
|
|
125
|
+
| nfr-performance | `nfr-performance.md` | DEV | 性能要件 |
|
|
126
|
+
|
|
127
|
+
(8カテゴリすべてを記載する)
|
|
128
|
+
|
|
129
|
+
## 4. 変更の入口(追加・統廃合・改定)
|
|
130
|
+
|
|
131
|
+
- 統合時は2章・3章を更新し、旧分冊の要求を新分冊へ重複なく移し、`sac-*` / `stc-*` の参照先を付け替える。
|
|
132
|
+
|
|
133
|
+
## 5. 関連ドキュメント導線(SAC/STC/OPD/OPR/DEC)
|
|
134
|
+
|
|
135
|
+
| カテゴリ | 検証 | 運用 | 判断記録 |
|
|
136
|
+
| -------- | ----------------- | ------------- | -------- |
|
|
137
|
+
| 性能 | `sac-performance` | `opr-monitor` | (なし) |
|
|
138
|
+
```
|
|
@@ -21,24 +21,15 @@ Non-Functional Requirements Integrity Documentation Rules
|
|
|
21
21
|
- 完全性はデータ整合性、改ざん検知、監査追跡性で定義する。
|
|
22
22
|
- 参照整合・重複防止・履歴保証を検証可能な条件で記述する。
|
|
23
23
|
- 業務上重要な記録の欠落・不整合を許容しない基準にする。
|
|
24
|
+
- 共通の運用: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、本書と成果物で言い直さない。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めない。
|
|
24
25
|
|
|
25
|
-
## 2.
|
|
26
|
-
|
|
27
|
-
### 2.1. 位置づけ
|
|
26
|
+
## 2. 位置づけ
|
|
28
27
|
|
|
29
28
|
- `nfr-integrity`:完全性要求の正本
|
|
30
29
|
- `nfr-index`:NFR全体の入口
|
|
31
30
|
- `sac-*` / `stc-*`:整合性検証の受入・試験仕様
|
|
32
31
|
- `dec-*`:例外判断記録
|
|
33
32
|
|
|
34
|
-
### 2.2. 用語定義
|
|
35
|
-
|
|
36
|
-
| 用語 | 定義 |
|
|
37
|
-
| ---------- | ------------------------------------------------ |
|
|
38
|
-
| 完全性 | データ・処理結果が正確かつ矛盾なく維持される性質 |
|
|
39
|
-
| 整合性違反 | 制約・業務ルールに反する不正状態 |
|
|
40
|
-
| 監査証跡 | 操作履歴を追跡可能にする記録 |
|
|
41
|
-
|
|
42
33
|
## 3. ファイル命名・ID規則
|
|
43
34
|
|
|
44
35
|
- ルールドキュメントIDは `specdojo:nfr-integrity-rulebook`。
|
|
@@ -49,15 +40,14 @@ Non-Functional Requirements Integrity Documentation Rules
|
|
|
49
40
|
|
|
50
41
|
### 4.1. 設定内容
|
|
51
42
|
|
|
52
|
-
|
|
43
|
+
許可キー・必須項目・型制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とする。
|
|
53
44
|
|
|
54
|
-
| 項目
|
|
55
|
-
|
|
|
56
|
-
| id
|
|
57
|
-
| type
|
|
58
|
-
|
|
|
59
|
-
|
|
|
60
|
-
| part_of | `nfr-index` | 任意 |
|
|
45
|
+
| 項目 | 説明 | 必須 |
|
|
46
|
+
| ---------- | --------------------------------- | ---- |
|
|
47
|
+
| `id` | `nfr-integrity` | ○ |
|
|
48
|
+
| `type` | `requirement` 固定 | ○ |
|
|
49
|
+
| `rulebook` | `specdojo:nfr-integrity-rulebook` | ○ |
|
|
50
|
+
| `part_of` | `nfr-index` | 任意 |
|
|
61
51
|
|
|
62
52
|
### 4.2. 推奨ルール
|
|
63
53
|
|
|
@@ -77,35 +67,27 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
77
67
|
|
|
78
68
|
## 6. 記述ガイド
|
|
79
69
|
|
|
80
|
-
|
|
70
|
+
生成する本文の見出しは「本文構成(標準テンプレ)」の番号と見出しをそのまま使う。
|
|
81
71
|
|
|
82
|
-
|
|
72
|
+
### 6.1. 概要(対象・目的)
|
|
83
73
|
|
|
84
74
|
- どの業務データの正確性を担保するかを明記する。
|
|
85
75
|
|
|
86
76
|
### 6.2. 適用範囲・前提条件
|
|
87
77
|
|
|
88
|
-
生成する本文の見出しは **## 2. 適用範囲・前提条件**
|
|
89
|
-
|
|
90
78
|
- 対象データ、整合性境界、例外条件を記述する。
|
|
91
79
|
|
|
92
80
|
### 6.3. 完全性要件一覧
|
|
93
81
|
|
|
94
|
-
生成する本文の見出しは **## 3. 完全性要件一覧**
|
|
95
|
-
|
|
96
82
|
- 表形式(`id` / `内容` / `指標` / `基準` / `備考`)で記述する。
|
|
97
83
|
- 指標例:整合性違反件数、監査証跡欠落率。
|
|
98
84
|
|
|
99
85
|
### 6.4. 測定・検証方法
|
|
100
86
|
|
|
101
|
-
生成する本文の見出しは **## 4. 測定・検証方法**
|
|
102
|
-
|
|
103
87
|
- 整合性チェック、監査レビュー、試験で判定する。
|
|
104
88
|
|
|
105
89
|
### 6.5. 関連ドキュメント導線
|
|
106
90
|
|
|
107
|
-
生成する本文の見出しは **## 5. 関連ドキュメント導線**
|
|
108
|
-
|
|
109
91
|
- `sac-*`、`stc-*`、`dec-*`、監査関連文書への導線を記載する。
|
|
110
92
|
|
|
111
93
|
## 7. 禁止事項
|
|
@@ -118,26 +100,22 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
118
100
|
|
|
119
101
|
## 8. サンプル
|
|
120
102
|
|
|
121
|
-
|
|
103
|
+
注:以下はルール文書内の最小例です。生成する `nfr-integrity` では `## 1...` から始まります。
|
|
122
104
|
|
|
123
105
|
```yaml
|
|
124
106
|
---
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
status: draft
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
supersedes: []
|
|
107
|
+
specdojo:
|
|
108
|
+
id: nfr-integrity
|
|
109
|
+
type: requirement
|
|
110
|
+
status: draft
|
|
111
|
+
rulebook: specdojo:nfr-integrity-rulebook
|
|
112
|
+
part_of: [nfr-index]
|
|
132
113
|
---
|
|
133
114
|
```
|
|
134
115
|
|
|
135
116
|
### 8.1. 概要(対象・目的)(例)
|
|
136
117
|
|
|
137
|
-
本書は、GCS
|
|
138
|
-
非機能要件を定義する。
|
|
139
|
-
業務上重要なデータ(受注・在庫・会計)の正確性を担保し、監査対応の
|
|
140
|
-
追跡可能性を確保することを目的とする。
|
|
118
|
+
本書は、GCS 基幹システムの受注・在庫・会計データについて、正確性と監査対応の追跡可能性を担保する完全性要件を定義する。
|
|
141
119
|
|
|
142
120
|
### 8.2. 適用範囲・前提条件(例)
|
|
143
121
|
|
|
@@ -151,28 +129,21 @@ supersedes: []
|
|
|
151
129
|
|
|
152
130
|
### 8.3. 完全性要件一覧(例)
|
|
153
131
|
|
|
154
|
-
| id | 内容
|
|
155
|
-
| ----------- |
|
|
156
|
-
| nfr-int-001 | 在庫残高データは整合性違反を許容しない
|
|
157
|
-
| nfr-int-002 | 監査対象操作は追跡可能であること
|
|
158
|
-
| nfr-int-
|
|
159
|
-
| nfr-int-
|
|
160
|
-
| nfr-int-005 | データ変更履歴は変更前後の値を保持すること | 履歴保持率 | 100% | before/after 形式 |
|
|
161
|
-
| nfr-int-006 | 重複トランザクションを防止すること | 重複発生件数 | 0 件/月 | 冔等キー(order_id)で排除 |
|
|
162
|
-
| nfr-int-007 | 外部連携データの取り込みは検証済みであること | 検証バイパス率 | 0% | スキーマ検証 + ビジネスルール |
|
|
132
|
+
| id | 内容 | 指標 | 基準 | 備考 |
|
|
133
|
+
| ----------- | -------------------------------------- | ---------------- | ------- | -------------------------- |
|
|
134
|
+
| nfr-int-001 | 在庫残高データは整合性違反を許容しない | 整合性違反件数 | 0 件/月 | 日次整合チェック |
|
|
135
|
+
| nfr-int-002 | 監査対象操作は追跡可能であること | 監査証跡欠落率 | 0% | who/when/what 必須 |
|
|
136
|
+
| nfr-int-004 | 金額データの改ざんを検知できること | 改ざん検知漏れ率 | 0% | HMAC / デジタル署名 |
|
|
137
|
+
| nfr-int-006 | 重複トランザクションを防止すること | 重複発生件数 | 0 件/月 | 冪等キー(order_id)で排除 |
|
|
163
138
|
|
|
164
139
|
### 8.4. 測定・検証方法(例)
|
|
165
140
|
|
|
166
|
-
| 要件ID | 測定方法
|
|
167
|
-
| ----------- |
|
|
168
|
-
| nfr-int-001 | 日次整合チェックバッチで不整合を検出
|
|
169
|
-
| nfr-int-002 | 監査ログ収集基盤で欠落操作を検知
|
|
170
|
-
| nfr-int-
|
|
171
|
-
|
|
172
|
-
| nfr-int-004 | 署名検証テストを CI で実行 | merge 毎 | QA |
|
|
173
|
-
| nfr-int-005 | 履歴テーブルの before/after 網羅率を検査 | 四半期監査 | QA / DBA |
|
|
174
|
-
| nfr-int-006 | 重複トランザクション検知アラートのカウント | リアルタイム監視 | SRE |
|
|
175
|
-
| nfr-int-007 | 外部データ取り込み時の検証ログを確認 | 日次確認 | Ops |
|
|
141
|
+
| 要件ID | 測定方法 | 判定タイミング | 判定者 |
|
|
142
|
+
| ----------- | ------------------------------------------ | ---------------- | --------- |
|
|
143
|
+
| nfr-int-001 | 日次整合チェックバッチで不整合を検出 | 日次自動実行 | DBA / SRE |
|
|
144
|
+
| nfr-int-002 | 監査ログ収集基盤で欠落操作を検知 | リアルタイム監視 | SRE |
|
|
145
|
+
| nfr-int-004 | 署名検証テストを CI で実行 | merge 毎 | QA |
|
|
146
|
+
| nfr-int-006 | 重複トランザクション検知アラートのカウント | リアルタイム監視 | SRE |
|
|
176
147
|
|
|
177
148
|
### 8.5. 関連ドキュメント導線(例)
|
|
178
149
|
|
|
@@ -13,14 +13,14 @@ specdojo:
|
|
|
13
13
|
|
|
14
14
|
Non-Functional Requirements Maintainability Documentation Rules
|
|
15
15
|
|
|
16
|
-
|
|
17
|
-
保守性要件は、修正・調査・復旧を継続的に行える運用品質を定量化する。
|
|
16
|
+
非機能要件のうち保守性(変更容易性・障害解析容易性)を定義する `nfr-maintainability` の作成ルールを定めます。
|
|
18
17
|
|
|
19
18
|
## 1. 全体方針
|
|
20
19
|
|
|
21
20
|
- 保守性は変更コストと復旧コストを下げる要求として定義する。
|
|
22
21
|
- MTTR、変更リードタイム、診断可能性などの指標を用いる。
|
|
23
22
|
- 実装方法ではなく、達成すべき運用可能性を記述する。
|
|
23
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、本書と成果物で言い直さない。文書の整形・lint はリポジトリの検証で扱い、「測定・検証方法」に含めない。
|
|
24
24
|
|
|
25
25
|
## 2. 位置づけと用語定義(必要に応じて)
|
|
26
26
|
|
|
@@ -33,11 +33,10 @@ Non-Functional Requirements Maintainability Documentation Rules
|
|
|
33
33
|
|
|
34
34
|
### 2.2. 用語定義
|
|
35
35
|
|
|
36
|
-
| 用語 | 定義
|
|
37
|
-
| ---------------- |
|
|
38
|
-
|
|
|
39
|
-
|
|
|
40
|
-
| 変更リードタイム | 要求受領から本番反映までの時間 |
|
|
36
|
+
| 用語 | 定義 |
|
|
37
|
+
| ---------------- | ------------------------------ |
|
|
38
|
+
| MTTR | 平均復旧時間 |
|
|
39
|
+
| 変更リードタイム | 要求受領から本番反映までの時間 |
|
|
41
40
|
|
|
42
41
|
## 3. ファイル命名・ID規則
|
|
43
42
|
|
|
@@ -47,21 +46,11 @@ Non-Functional Requirements Maintainability Documentation Rules
|
|
|
47
46
|
|
|
48
47
|
## 4. 推奨 Frontmatter 項目
|
|
49
48
|
|
|
50
|
-
|
|
49
|
+
許可キー・必須項目・型制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とする。
|
|
51
50
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
| ------- | -------------------------------- | ---- |
|
|
56
|
-
| id | `nfr-maintainability` | ○ |
|
|
57
|
-
| type | `requirement` 固定 | ○ |
|
|
58
|
-
| title | 非機能要件: 保守性 | ○ |
|
|
59
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
60
|
-
| part_of | `nfr-index` | 任意 |
|
|
61
|
-
|
|
62
|
-
### 4.2. 推奨ルール
|
|
63
|
-
|
|
64
|
-
- 調査ログ、監視、Runbook の整備水準を `based_on` と整合させる。
|
|
51
|
+
- `specdojo.type` は `requirement`、`specdojo.rulebook` は `specdojo:nfr-maintainability-rulebook` とする。
|
|
52
|
+
- `specdojo.part_of` は `nfr-index` とする。
|
|
53
|
+
- `specdojo.based_on` には、監視・ログ・Runbook の水準の根拠として実際に読んだ作成済み文書の ID を記載する。
|
|
65
54
|
|
|
66
55
|
## 5. 本文構成(標準テンプレ)
|
|
67
56
|
|
|
@@ -79,33 +68,23 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
79
68
|
|
|
80
69
|
### 6.1. 概要(対象・目的)
|
|
81
70
|
|
|
82
|
-
生成する本文の見出しは **## 1. 概要(対象・目的)**
|
|
83
|
-
|
|
84
71
|
- どの変更・障害対応の効率を担保するかを示す。
|
|
85
72
|
|
|
86
73
|
### 6.2. 適用範囲・前提条件
|
|
87
74
|
|
|
88
|
-
生成する本文の見出しは **## 2. 適用範囲・前提条件**
|
|
89
|
-
|
|
90
75
|
- 対象システム、対象運用時間、チーム体制前提を記述する。
|
|
91
76
|
|
|
92
77
|
### 6.3. 保守性要件一覧
|
|
93
78
|
|
|
94
|
-
生成する本文の見出しは **## 3. 保守性要件一覧**
|
|
95
|
-
|
|
96
79
|
- 表形式(`id` / `内容` / `指標` / `基準` / `備考`)で記述する。
|
|
97
80
|
- 指標例:MTTR、変更リードタイム、一次切り分け時間。
|
|
98
81
|
|
|
99
82
|
### 6.4. 測定・検証方法
|
|
100
83
|
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
- 監視記録、障害レポート、改善サイクルで測定する。
|
|
84
|
+
- 要件 ID ごとに、測定方法(監視記録、障害レポート、訓練、CI の計測など)・判定タイミング・判定者を示す。
|
|
104
85
|
|
|
105
86
|
### 6.5. 関連ドキュメント導線
|
|
106
87
|
|
|
107
|
-
生成する本文の見出しは **## 5. 関連ドキュメント導線**
|
|
108
|
-
|
|
109
88
|
- `opd-*`、`opr-*`、`dec-*` への導線を必ず置く。
|
|
110
89
|
|
|
111
90
|
## 7. 禁止事項
|
|
@@ -118,50 +97,29 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
118
97
|
|
|
119
98
|
## 8. サンプル
|
|
120
99
|
|
|
121
|
-
|
|
100
|
+
注:以下は形式の輪郭を示す最小例です。生成する `nfr-maintainability` では `## 1...` から始まります。
|
|
122
101
|
|
|
123
102
|
```yaml
|
|
124
103
|
---
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
status: draft
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
supersedes: []
|
|
104
|
+
specdojo:
|
|
105
|
+
id: nfr-maintainability
|
|
106
|
+
type: requirement
|
|
107
|
+
status: draft
|
|
108
|
+
rulebook: specdojo:nfr-maintainability-rulebook
|
|
109
|
+
part_of: [nfr-index]
|
|
132
110
|
---
|
|
133
111
|
```
|
|
134
112
|
|
|
135
|
-
### 8.1.
|
|
136
|
-
|
|
137
|
-
本書は、GCS 基幹システムにおいて保守性(変更容易性・障害解析容易性)に関する
|
|
138
|
-
非機能要件を定義する。
|
|
139
|
-
障害対応の迅速化と変更リードタイムの短縮を測定可能な基準で管理し、
|
|
140
|
-
システムの運用品質を継続的に改善することを目的とする。
|
|
141
|
-
|
|
142
|
-
### 8.2. 適用範囲・前提条件(例)
|
|
143
|
-
|
|
144
|
-
| 項目 | 内容 |
|
|
145
|
-
| ------------ | ------------------------------------------------- |
|
|
146
|
-
| 対象システム | GCS 基幹システム(受注・在庫・会計サブシステム) |
|
|
147
|
-
| 運用時間 | 24/365(オンコール体制あり) |
|
|
148
|
-
| チーム体制 | 開発 5 名・SRE 2 名・Ops 3 名(平日日勤) |
|
|
149
|
-
| ログ基盤 | 構造化ログ(JSON)・分散トレーシング導入済 |
|
|
150
|
-
| CI/CD | GitHub Actions + ArgoCD(トランクベースデプロイ) |
|
|
151
|
-
|
|
152
|
-
### 8.3. 保守性要件一覧(例)
|
|
113
|
+
### 8.1. 保守性要件一覧(例)
|
|
153
114
|
|
|
154
|
-
| id | 内容
|
|
155
|
-
| ----------- |
|
|
156
|
-
| nfr-mnt-001 | P1 障害は基準時間内に一次復旧する
|
|
157
|
-
| nfr-mnt-002 | 軽微変更は短期間で本番反映する
|
|
158
|
-
| nfr-mnt-003 | 障害の一次切り分けを基準時間内に完了する
|
|
159
|
-
| nfr-mnt-004 | デプロイのロールバックを基準時間内に完了する
|
|
160
|
-
| nfr-mnt-005 | テストカバレッジを基準以上に維持する | カバレッジ率 | 80% 以上 | ビジネスロジック対象 |
|
|
161
|
-
| nfr-mnt-006 | 障害原因調査に必要なログが従事者だけで追跡できること | 調査自己完結率 | 90% 以上 | trace_id で横断検索 |
|
|
162
|
-
| nfr-mnt-007 | API スキーマ変更は後方互換で行えること | 互換性維持期間 | 6 か月以上 | OpenAPI バージョニング |
|
|
115
|
+
| id | 内容 | 指標 | 基準 | 備考 |
|
|
116
|
+
| ----------- | -------------------------------------------- | ---------------- | ------------ | ---------------------------- |
|
|
117
|
+
| nfr-mnt-001 | P1 障害は基準時間内に一次復旧する | MTTR | 60 分以内 | 24/365 対象 |
|
|
118
|
+
| nfr-mnt-002 | 軽微変更は短期間で本番反映する | 変更リードタイム | 3 営業日以内 | 標準変更のみ |
|
|
119
|
+
| nfr-mnt-003 | 障害の一次切り分けを基準時間内に完了する | 一次切り分け時間 | 15 分以内 | Runbook + 監視ダッシュボード |
|
|
120
|
+
| nfr-mnt-004 | デプロイのロールバックを基準時間内に完了する | ロールバック時間 | 15 分以内 | トランクベース切り戻し |
|
|
163
121
|
|
|
164
|
-
### 8.
|
|
122
|
+
### 8.2. 測定・検証方法(例)
|
|
165
123
|
|
|
166
124
|
| 要件ID | 測定方法 | 判定タイミング | 判定者 |
|
|
167
125
|
| ----------- | ----------------------------------------------- | ---------------- | ------------ |
|
|
@@ -169,16 +127,3 @@ supersedes: []
|
|
|
169
127
|
| nfr-mnt-002 | PR マージ〜本番デプロイまでのリードタイムを計測 | 月次集計 | テックリード |
|
|
170
128
|
| nfr-mnt-003 | 障害レポートの切り分け完了時刻から算出 | 障害事後レビュー | SRE |
|
|
171
129
|
| nfr-mnt-004 | ロールバック訓練で切り戻し時間を計測 | 四半期訓練 | Infra / SRE |
|
|
172
|
-
| nfr-mnt-005 | CI カバレッジレポートで確認 | merge 毎 | QA |
|
|
173
|
-
| nfr-mnt-006 | 障害対応で外部支援なく解決できた割合を集計 | 月次運用レビュー | SRE |
|
|
174
|
-
| nfr-mnt-007 | API バージョンの後方互換テストを CI で実行 | merge 毎 | QA |
|
|
175
|
-
|
|
176
|
-
### 8.5. 関連ドキュメント導線(例)
|
|
177
|
-
|
|
178
|
-
| 種別 | ドキュメントID | 目的 | 備考 |
|
|
179
|
-
| -------- | -------------- | ------------------------------- | ---- |
|
|
180
|
-
| NFR 入口 | nfr-index | 非機能要件全体の俯瞰 | 必須 |
|
|
181
|
-
| 受入条件 | sac-\* | 保守性要件の合否判定基準 | 必須 |
|
|
182
|
-
| 運用設計 | opd-\* | 監視・アラート・ログ運用設計 | 必須 |
|
|
183
|
-
| 運用手順 | opr-\* | Runbook・障害対応・ロールバック | 必須 |
|
|
184
|
-
| 判断記録 | dec-\* | 保守性に関する設計判断の追跡 | 任意 |
|