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,407 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:deliverables-reference
|
|
4
|
+
type: reference
|
|
5
|
+
status: draft
|
|
6
|
+
supersedes:
|
|
7
|
+
- docs-contents-guide
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# 成果物リファレンス
|
|
11
|
+
|
|
12
|
+
Deliverables Reference
|
|
13
|
+
|
|
14
|
+
SpecDojo で扱う成果物の種類、目的、推奨ファイル名、主な内容を一覧します。
|
|
15
|
+
|
|
16
|
+
**対象範囲**
|
|
17
|
+
|
|
18
|
+
- SpecDojo で扱うプロジェクト成果物とプロダクト成果物の全種別
|
|
19
|
+
|
|
20
|
+
**ここで引けるもの**
|
|
21
|
+
|
|
22
|
+
- 成果物の名称、英語名称、推奨ファイル名、目的、主な内容と、記述規則の正本である rulebook への導線
|
|
23
|
+
- ドキュメント名は rulebook へのリンクです。作成手順を示す recipe がある成果物は `作成レシピ` 列から辿れます。
|
|
24
|
+
|
|
25
|
+
**詳細の参照先**
|
|
26
|
+
|
|
27
|
+
- 成果物をどのトラックで扱うかは [トラック設計ガイド](../guides/track-design-guide.md)、rulebook・recipe・sample・template の使い分けは [実践の型活用ガイド](../guides/kata-guide.md) を参照してください。
|
|
28
|
+
- 各成果物がどの概念(要求 / 要件 / 仕様 / 設計 / 実装)にあたるかは [要求から実装までの考え方](../philosophy/needs-to-implementation-philosophy.md) を参照してください。
|
|
29
|
+
- 本書の章は個別成果物を引きやすい単位(rulebook 単位)で構成しており、成果物カタログ(`dct-index.yaml`)のグループとは粒度が異なります。文書分類の正本は [ドキュメント構成ガイド](../guides/docs-structure-guide.md) です。
|
|
30
|
+
|
|
31
|
+
## 1. プロジェクト成果物
|
|
32
|
+
|
|
33
|
+
プロダクトの構築や改修時に、何を達成したいか、どの範囲を対象にするか、どの成果物をどう管理するかを関係者で共有します。
|
|
34
|
+
`docs/ja/projects/<project-id>` 配下で扱う主なプロジェクト成果物の目的と主な内容は以下の通りです。
|
|
35
|
+
|
|
36
|
+
### 1.1. 成果物カタログ
|
|
37
|
+
|
|
38
|
+
<!-- prettier-ignore -->
|
|
39
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
40
|
+
| --- | --- | --- | --- | --- |
|
|
41
|
+
| [成果物カタログ索引](../rulebooks/dct-index-rulebook.md) | Deliverables Catalog Index | `dct-index` | プロジェクトで管理する成果物カタログの入口を示す | 成果物カタログ一覧、対象範囲、生成ビューへの導線 |
|
|
42
|
+
| [成果物カタログ](../rulebooks/dct-rulebook.md) | Deliverables Catalog | `dct-<domain>.yaml` | プロジェクト成果物の一覧と配置・派生関係をYAML正本として管理する | 成果物一覧、目的、配置先、生成元、依存関係、完了条件 |
|
|
43
|
+
| 成果物カタログ生成ビュー | Generated Deliverables Catalog View | `generated/dct-<domain>` | YAML正本から読みやすい一覧・確認用ビューを生成する | 成果物一覧、状態、担当、関連タスク、参照リンク |
|
|
44
|
+
|
|
45
|
+
### 1.2. 立ち上げ
|
|
46
|
+
|
|
47
|
+
<!-- prettier-ignore -->
|
|
48
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 | 作成レシピ |
|
|
49
|
+
| --- | --- | --- | --- | --- | --- |
|
|
50
|
+
| [プロジェクト概要](../rulebooks/prj-overview-rulebook.md) | Project Overview | `prj-overview` | プロジェクトの背景・目的・ゴールを共有する | 背景、目的、必要性、期待効果、前提条件 | [レシピ](../recipes/prj-overview-recipe.md) |
|
|
51
|
+
| [プロジェクト憲章](../rulebooks/prj-charter-rulebook.md) | Project Charter | `prj-charter` | プロジェクトの正式な認可と権限委譲を文書化する | プロジェクトの目的、スポンサー、権限、成功条件、承認事項 | [レシピ](../recipes/prj-charter-recipe.md) |
|
|
52
|
+
| [ステークホルダー登録簿](../rulebooks/prj-stakeholder-register-rulebook.md) | Stakeholder Register | `prj-stakeholder-register` | 関係者の役割・関心・影響度を整理する | 関係者一覧、役割、期待、影響度、コミュニケーション上の留意点 | [レシピ](../recipes/prj-stakeholder-register-recipe.md) |
|
|
53
|
+
|
|
54
|
+
### 1.3. プロジェクト定義
|
|
55
|
+
|
|
56
|
+
<!-- prettier-ignore -->
|
|
57
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 | 作成レシピ |
|
|
58
|
+
| --- | --- | --- | --- | --- | --- |
|
|
59
|
+
| [プロジェクトスコープ](../rulebooks/prj-scope-rulebook.md) | Project Scope | `prj-scope` | 対象範囲と対象外を明確にする | 対象業務、対象システム、対象期間、スコープ外 | [レシピ](../recipes/prj-scope-recipe.md) |
|
|
60
|
+
| [成功基準と受入条件](../rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md) | Success Criteria and Acceptance Criteria | `prj-success-criteria-and-acceptance-criteria` | プロジェクト成功の判定基準と受入条件を明確化する | 成功指標、完了定義、受入条件、判定方法、承認者 | [レシピ](../recipes/prj-success-criteria-and-acceptance-criteria-recipe.md) |
|
|
61
|
+
| [前提・制約・依存関係](../rulebooks/prj-assumptions-constraints-dependencies-rulebook.md) | Assumptions, Constraints and Dependencies | `prj-assumptions-constraints-dependencies` | 実行上の前提条件・制約事項・外部依存を明示する | 前提条件、制約事項、依存先、影響、対応方針 | [レシピ](../recipes/prj-assumptions-constraints-dependencies-recipe.md) |
|
|
62
|
+
| [プロジェクト課題と解決アプローチ](../rulebooks/prj-issues-and-approach-rulebook.md) | Project Issues and Approach | `prj-issues-and-approach` | 主要課題と解決方針を整理する | 課題一覧、原因、解決策候補、選択したアプローチと理由 | [レシピ](../recipes/prj-issues-and-approach-recipe.md) |
|
|
63
|
+
| [代替案比較](../rulebooks/prj-comparison-of-alternatives-rulebook.md) | Comparison of Alternatives | `prj-comparison-of-alternatives` | 複数案を比較し、採択理由を残す | 比較対象、評価観点、メリット・デメリット、採択案、採択理由 | [レシピ](../recipes/prj-comparison-of-alternatives-recipe.md) |
|
|
64
|
+
|
|
65
|
+
### 1.4. 現状
|
|
66
|
+
|
|
67
|
+
<!-- prettier-ignore -->
|
|
68
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
69
|
+
| --- | --- | --- | --- | --- |
|
|
70
|
+
| 現状定義 | Current State Definition | `040-current-state/` | 導入・変更前の状態を定義し、比較の基準を固定する | 現行の業務・システム・運用の対象範囲、前提、参照元、凍結時点 |
|
|
71
|
+
|
|
72
|
+
現状の定義については、`010-business-specs` などの子ディレクトリを切り、プロダクトドキュメントと同様の構成で管理することを推奨します。既存プロダクトがない初期開発でも、現行業務・手作業・外部システム・運用実態を必要な範囲で記録できます。現状として必要な成果物だけを作成し、プロダクトドキュメントへ混在させません。対象はプロジェクトごとに異なるため、固定の `dct-current-state-template.yaml` は提供せず、必要なプロダクト成果物のカタログ項目を選んで `dct-current-state.yaml` を定義します。
|
|
73
|
+
|
|
74
|
+
### 1.5. 影響調査
|
|
75
|
+
|
|
76
|
+
<!-- prettier-ignore -->
|
|
77
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
78
|
+
| --- | --- | --- | --- | --- |
|
|
79
|
+
| [影響調査(業務)](../rulebooks/imp-business-rulebook.md) | Impact Analysis (Business) | `imp-business` | 変更要求が業務へ与える影響を整理する | 影響対象業務、変更要否、影響度、対応方針、未解決事項 |
|
|
80
|
+
| [影響調査(データ)](../rulebooks/imp-data-rulebook.md) | Impact Analysis (Data) | `imp-data` | 変更要求がデータへ与える影響を整理する | 影響対象データ、変更要否、影響度、対応方針、未解決事項 |
|
|
81
|
+
| [影響調査(I/F)](../rulebooks/imp-interface-rulebook.md) | Impact Analysis (Interface) | `imp-interface` | 変更要求がインターフェースへ与える影響を整理する | 影響対象I/F、変更要否、影響度、対応方針、未解決事項 |
|
|
82
|
+
| [影響調査(テスト)](../rulebooks/imp-test-rulebook.md) | Impact Analysis (Test) | `imp-test` | 変更要求がテストへ与える影響を整理する | 影響対象テスト、変更要否、影響度、対応方針、未解決事項 |
|
|
83
|
+
| [影響調査(運用)](../rulebooks/imp-operations-rulebook.md) | Impact Analysis (Operations) | `imp-operations` | 変更要求が運用へ与える影響を整理する | 影響対象運用、変更要否、影響度、対応方針、未解決事項 |
|
|
84
|
+
|
|
85
|
+
トレーサビリティは独立した成果物カテゴリとしません。各成果物のIDと型付き参照を正本とし、要求から仕様・テストへの対応表や未充足項目は必要に応じて `controls/generated/traceability/` へ派生ビューとして出力します。
|
|
86
|
+
|
|
87
|
+
### 1.6. 移行計画
|
|
88
|
+
|
|
89
|
+
<!-- prettier-ignore -->
|
|
90
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
91
|
+
| --- | --- | --- | --- | --- |
|
|
92
|
+
| [移行計画](../rulebooks/mip-index-rulebook.md) | Migration Plan | `mip-index` | 変更対象の移行方針と全体計画を定義し、切替リスクを管理する | 移行範囲、移行方式、体制、スケジュール、リスクと対策 |
|
|
93
|
+
| [データ移行設計](../rulebooks/dmd-index-rulebook.md) | Data Migration Design | `dmd-index`, `dmd-<term>` | データ移行の設計内容を定義し、移行時の整合性を確保する | 移行対象データ、変換方針、マッピング、検証方法、ロールバック方針 |
|
|
94
|
+
| [移行テスト計画(リハーサル計画)](../rulebooks/mtp-rulebook.md) | Migration Test Plan | `mtp-index`, `mtp-<term>` | 移行リハーサルの実施計画を定義し、切替前に妥当性を検証する | テスト範囲、シナリオ、環境、判定基準、是正計画 |
|
|
95
|
+
| [カットオーバー計画(本番切替手順)](../rulebooks/cop-index-rulebook.md) | Cutover Plan | `cop-index`, `cop-<term>` | 本番切替の手順を定義し、停止時間と障害リスクを最小化する | 切替手順、実施順序、判定ポイント、エスカレーション、切戻し手順 |
|
|
96
|
+
| [運用切替計画(ハイパーケア含む)](../rulebooks/otp-index-rulebook.md) | Operations Transition Plan | `otp-index`, `otp-<term>` | 切替後の運用移管計画を定義し、安定稼働へ移行する | 運用引継ぎ、体制、監視強化期間、問い合わせ対応、安定化完了条件 |
|
|
97
|
+
|
|
98
|
+
### 1.7. プロジェクトマネジメント
|
|
99
|
+
|
|
100
|
+
プロジェクトの計画・管理・実行に関するドキュメントです。
|
|
101
|
+
|
|
102
|
+
#### 1.7.1. 管理計画
|
|
103
|
+
|
|
104
|
+
<!-- prettier-ignore -->
|
|
105
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 | 作成レシピ |
|
|
106
|
+
| --- | --- | --- | --- | --- | --- |
|
|
107
|
+
| [プロジェクト管理計画](../rulebooks/pm-plan-rulebook.md) | Project Management Plan | `pm-plan` | プロジェクト全体の管理方針・プロセスを定義する | スコープ管理、スケジュール管理、コスト管理、品質管理、リスク管理、コミュニケーション管理の方針 | [レシピ](../recipes/pm-plan-recipe.md) |
|
|
108
|
+
| [コミュニケーション計画](../rulebooks/pm-communication-plan-rulebook.md) | Communication Plan | `pm-communication-plan` | 報告・連絡・会議体の計画を定義する | 報告頻度、会議体一覧、連絡系統、エスカレーションルール | [レシピ](../recipes/pm-communication-plan-recipe.md) |
|
|
109
|
+
| [品質管理計画](../rulebooks/pm-quality-management-plan-rulebook.md) | Quality Management Plan | `pm-quality-management-plan` | 品質目標・レビュー方針・品質基準を定義する | 品質目標、レビュープロセス、品質メトリクス、検査基準 | [レシピ](../recipes/pm-quality-management-plan-recipe.md) |
|
|
110
|
+
|
|
111
|
+
#### 1.7.2. 組織体制
|
|
112
|
+
|
|
113
|
+
<!-- prettier-ignore -->
|
|
114
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 | 作成レシピ |
|
|
115
|
+
| --- | --- | --- | --- | --- | --- |
|
|
116
|
+
| [組織とロールの定義](../rulebooks/pm-organization-rulebook.md) | Organization and Role Definition | `pm-organization` | プロジェクトの体制・関係者構造・意思決定構造を明確にする | プロジェクト全体の体制図、チーム構成、ロール構成 | [レシピ](../recipes/pm-organization-recipe.md) |
|
|
117
|
+
| [ロール定義](../rulebooks/pm-roles-rulebook.md) | Role Definition | `pm-roles.yaml` | プロジェクトで利用するロールを機械処理しやすい形で定義する | ロールコード、ロール名、責務、権限 | [レシピ](../recipes/pm-roles-recipe.md) |
|
|
118
|
+
| [メンバー定義](../rulebooks/pm-members-rulebook.md) | Member Definition | `pm-members.yaml` | メンバーとロールの対応を管理する | メンバー、所属、担当ロール、連絡先、稼働条件 | [レシピ](../recipes/pm-members-recipe.md) |
|
|
119
|
+
| [RACI](../rulebooks/pm-raci-rulebook.md) | RACI | `pm-raci` | 作業や成果物に対する責任分担マトリクスを定義する | 成果物ごとの RACI マトリクス | [レシピ](../recipes/pm-raci-recipe.md) |
|
|
120
|
+
|
|
121
|
+
#### 1.7.3. 管理台帳・管理ビュー
|
|
122
|
+
|
|
123
|
+
<!-- prettier-ignore -->
|
|
124
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
125
|
+
| --- | --- | --- | --- | --- |
|
|
126
|
+
| [プロジェクト登録簿](../rulebooks/pjr-rulebook.md) | Project Register | `pjr-index`, `pjr-<NNNN>-<term>` | リスク・課題・変更要求・意思決定などの統合管理台帳を正本として管理する | 登録項目ID、種別、タイトル、優先度、担当、期限、ステータス、関連成果物 |
|
|
127
|
+
| 台帳ビュー | Project Register View | `pjr-views` | プロジェクト登録簿から状態別・優先度別・担当者別の補助ビューを生成する | 未完了項目、状態別一覧、優先度別一覧、担当者別一覧 |
|
|
128
|
+
| [リスク登録簿](../rulebooks/pm-risk-register-rulebook.md) | Risk Register | `pm-risk-register` | `type=risk` の登録項目を抽出してリスク管理ビューを提供する | リスク ID、発生確率、影響度、対応策、担当、ステータス |
|
|
129
|
+
| [課題ログ](../rulebooks/pm-issue-log-rulebook.md) | Issue Log | `pm-issue-log` | `type=issue` の登録項目を抽出して課題管理ビューを提供する | 課題 ID、発生日、内容、優先度、対応策、担当、期限、ステータス |
|
|
130
|
+
| [変更要求ログ](../rulebooks/pm-change-request-log-rulebook.md) | Change Request Log | `pm-change-request-log` | `type=change-request` の登録項目を抽出して変更要求ビューを提供する | 変更 ID、要求内容、影響範囲、審査結果、決定日 |
|
|
131
|
+
| 決定ログ | Decision Log | `pm-decision-log` | `type=decision` の登録項目を抽出して意思決定ビューを提供する | 背景、決定した内容、検討した選択肢、採択理由、影響範囲 |
|
|
132
|
+
|
|
133
|
+
登録簿の運用手順は [登録簿運用ガイド](../guides/register-operation-guide.md) を参照します。
|
|
134
|
+
|
|
135
|
+
#### 1.7.4. レポート
|
|
136
|
+
|
|
137
|
+
<!-- prettier-ignore -->
|
|
138
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
139
|
+
| --- | --- | --- | --- | --- |
|
|
140
|
+
| [進捗報告](../rulebooks/pr-rulebook.md) | Progress Report | `pr-<yyyy-mm-dd>-<nn>` | 定期的な進捗状況を報告する | 報告期間、完了タスク、遅延・リスク、次期予定、課題・依頼事項 |
|
|
141
|
+
| [議事録](../rulebooks/mm-rulebook.md) | Meeting Minutes | `mm-<yyyy-mm-dd>-<nn>` | 会議の決定事項・アクションを記録する | 会議名、日時、参加者、議題、決定事項、アクションアイテム |
|
|
142
|
+
|
|
143
|
+
#### 1.7.5. Schedule
|
|
144
|
+
|
|
145
|
+
<!-- prettier-ignore -->
|
|
146
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
147
|
+
| --- | --- | --- | --- | --- |
|
|
148
|
+
| マイルストーン定義 | Milestones Definition | `sch-milestones.yaml` | プロジェクト全体のマイルストーンを定義する | マイルストーン名、期日、判定基準(YAML 形式) |
|
|
149
|
+
| 共通デフォルト設定 | Schedule Defaults | `sch-defaults.yaml` | Schedule 共通のカレンダー・開始日などを定義する | カレンダー、タイムゾーン、開始日、既定設定 |
|
|
150
|
+
| トラック別Schedule定義 | Schedule Track Definition | `sch-track-<track>.yaml` | トラックごとのタスク・マイルストーンを定義する | タスク、開始日、終了日、依存関係、担当、実行形態 |
|
|
151
|
+
| トラック別タスク生成戦略 | Schedule Strategy Definition | `sch-strategy-<track>.yaml` | トラックごとのタスク生成戦略を定義する | 対象カタログ、生成フェーズ、担当ルール、依存補完 |
|
|
152
|
+
|
|
153
|
+
Schedule 定義全体の記述ルールは [スケジュール作成ルール](../rulebooks/sch-rulebook.md)、設計の考え方は [Schedule設計ガイド](../guides/schedule-design-guide.md) を参照します。
|
|
154
|
+
|
|
155
|
+
#### 1.7.6. 実行管理
|
|
156
|
+
|
|
157
|
+
<!-- prettier-ignore -->
|
|
158
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
159
|
+
| --- | --- | --- | --- | --- |
|
|
160
|
+
| タスク実行ワークスペース | Task Execution Workspace | `execution/exec/` | `specdojo` コマンドによるタスク実行とイベント記録を管理する | タスク定義、実行結果、イベントログ、実行ロック |
|
|
161
|
+
| 自動生成成果物 | Generated Artifacts | `execution/generated/` | タスク実行結果から自動生成された成果物を出力する | 生成されたドキュメント、レポート、ブリーフ、実行状態 |
|
|
162
|
+
|
|
163
|
+
## 2. プロダクト成果物
|
|
164
|
+
|
|
165
|
+
SpecDojo で扱うプロダクト成果物(`docs/ja/product/` 配下、または各プロジェクトが変更対象とするプロダクト文書)の目的と主な内容は以下のとおりです。
|
|
166
|
+
|
|
167
|
+
### 2.1. 業務仕様
|
|
168
|
+
|
|
169
|
+
業務仕様は、[三要素分析法](https://dbc.in.coocan.jp/methodology.html)(データフロー図を頂点に、データモデル・業務モデル・インターフェースモデルの3要素で業務とシステムを分析・設計する方法論)に基づいて構成しています。現行の業務やあるべき業務を概念的なモデルとして整理・可視化し、各要素とドキュメントとの関係は次のとおりです。
|
|
170
|
+
|
|
171
|
+
本体系では、外部システムとのインターフェースを扱う「外部I/F仕様」と区別するため、三要素分析法のインターフェースモデルを「ユーザーインターフェースモデル」と呼びます。
|
|
172
|
+
|
|
173
|
+
```mermaid
|
|
174
|
+
flowchart
|
|
175
|
+
subgraph データフロー
|
|
176
|
+
概念データフロー図[概念データフロー図]
|
|
177
|
+
end
|
|
178
|
+
|
|
179
|
+
subgraph データモデル
|
|
180
|
+
業務データ辞書[業務データ辞書]
|
|
181
|
+
概念クラス図[概念クラス図]
|
|
182
|
+
ステータス定義[ステータス定義<br>状態一覧・状態遷移図]
|
|
183
|
+
end
|
|
184
|
+
|
|
185
|
+
subgraph 業務モデル
|
|
186
|
+
業務プロセス仕様[業務プロセス仕様]
|
|
187
|
+
ビジネスルール[ビジネスルール]
|
|
188
|
+
業務イベント一覧[業務イベント一覧]
|
|
189
|
+
end
|
|
190
|
+
|
|
191
|
+
subgraph userInterfaceModelGroup[ユーザーインターフェースモデル]
|
|
192
|
+
画面仕様[画面仕様]
|
|
193
|
+
帳票仕様[帳票仕様]
|
|
194
|
+
end
|
|
195
|
+
|
|
196
|
+
subgraph supportingDeliverables[システム化機能と用語集]
|
|
197
|
+
システム化機能一覧[システム化機能一覧]
|
|
198
|
+
用語集定義[用語集]
|
|
199
|
+
end
|
|
200
|
+
|
|
201
|
+
データフロー --> データモデル
|
|
202
|
+
データフロー --> 業務モデル
|
|
203
|
+
データフロー --> userInterfaceModelGroup
|
|
204
|
+
業務モデル --> supportingDeliverables
|
|
205
|
+
データモデル --> supportingDeliverables
|
|
206
|
+
userInterfaceModelGroup --> supportingDeliverables
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
システム化機能と用語集は、図の可読性のため同じ枠内に表示していますが、成果物カタログではそれぞれ独立したdomainとして管理します。
|
|
210
|
+
|
|
211
|
+
#### 2.1.1. データフロー
|
|
212
|
+
|
|
213
|
+
<!-- prettier-ignore -->
|
|
214
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
215
|
+
| --- | --- | --- | --- | --- |
|
|
216
|
+
| [概念データフロー図](../rulebooks/cdfd-rulebook.md) | Conceptual Data Flow Diagram | `cdfd-<group>` | 一つのプロセスグループに属する領域内部と領域間の流れを可視化し、グループ外との責任境界を定義する | 対象プロセス領域、内部プロセス、情報・物の流れ、起点イベント、データストア、主要例外、STSD 参照、グループ外委譲 |
|
|
217
|
+
| [概念データフロー図(ユースケース別)](../rulebooks/cdfd-uc-rulebook.md) | Conceptual Data Flow Diagram (Use Case) | `cdfd-uc-<topic>` | 複数のプロセスグループをまたぐ一つの業務について、グループ間の順序と引き渡し条件を定義する | ケース ID、開始・終了条件、参加グループ、引き渡す情報と条件、関連データストア、例外時の戻り先、プロセスグループ別 CDFD 参照 |
|
|
218
|
+
|
|
219
|
+
#### 2.1.2. データモデル
|
|
220
|
+
|
|
221
|
+
<!-- prettier-ignore -->
|
|
222
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
223
|
+
| --- | --- | --- | --- | --- |
|
|
224
|
+
| [業務データ辞書 / 業務データ辞書](../rulebooks/bdd-rulebook.md) | Business Data Dictionary | `bdd-<term>` | データの意味や構造に関する共通理解を作る | 業務上の管理単位(エンティティ)とその属性(項目)の論理名・物理名・説明・制約 など |
|
|
225
|
+
| [業務データ辞書 / 概念データストア定義](../rulebooks/cdsd-rulebook.md) | Conceptual Data Store Definition | `cdsd-<term>` | 概念データストア(情報の保管場所)を一覧で定義する | データストア名、対応プロセス、内容、更新タイミング、粒度、主な用途 など |
|
|
226
|
+
| [業務データ辞書 / 保管場所定義](../rulebooks/sld-rulebook.md) | Storage Location Definition | `sld-<term>` | 業務対象となる物の物理的な保管場所を一覧で定義する | 保管場所名、保管対象、内容・目的、関連プロセス、管理頻度 など |
|
|
227
|
+
| [業務データ辞書 / ステータス定義](../rulebooks/stsd-rulebook.md) | Status Definition | `stsd-<term>` | 業務上のエンティティが取り得る状態と状態間の遷移を一文書で定義する | 対象、状態名、通称、意味、成立条件、管理場所、状態遷移図、イベント、遷移条件など |
|
|
228
|
+
| [業務データ辞書 / 分類定義](../rulebooks/cld-rulebook.md) | Classification Definition | `cld-<term>` | 業務上の分類(カテゴリ、種別、区分など)を一覧で定義する | 分類定義名、種別、分類名、説明など |
|
|
229
|
+
| [概念クラス図](../rulebooks/ccd-mermaid-rulebook.md) | Conceptual Class Diagram | `ccd-<term>` | 業務上のエンティティ関係を図で定義する | 商品・在庫・発注・店舗などの概念と属性、関連(継承/親子/参照) など |
|
|
230
|
+
|
|
231
|
+
#### 2.1.3. 業務モデル
|
|
232
|
+
|
|
233
|
+
<!-- prettier-ignore -->
|
|
234
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
235
|
+
| --- | --- | --- | --- | --- |
|
|
236
|
+
| [業務プロセス仕様](../rulebooks/bps-rulebook.md) | Business Process Specification | `bps-<term>` | 業務プロセスの処理内容を定義する | 業務プロセス概要、トリガー、前提、入力、処理、出力 など |
|
|
237
|
+
| [ビジネスルール](../rulebooks/br-rulebook.md) | Business Rule | `br-<term>` | 複数プロセスから参照される横断的な判断を定義する | ルール概要、入力、ルール、出力、例外 など |
|
|
238
|
+
| [業務イベント / 業務イベント仕様 全体構成](../rulebooks/bes-index-rulebook.md) | Business Event Specification Index | `bes-index` | 業務上で発生する主要なイベントを一覧で定義する | イベントID、イベント名、何が起きたか、いつ、発生条件 など |
|
|
239
|
+
| [業務イベント / 業務イベント仕様](../rulebooks/bes-rulebook.md) | Business Event Specification | `bes-<term>` | 業務上で発生する主要なイベントを個別に定義する | イベントID、イベント名、何が起きたか、いつ、発生条件 など |
|
|
240
|
+
|
|
241
|
+
#### 2.1.4. ユーザーインターフェースモデル
|
|
242
|
+
|
|
243
|
+
<!-- prettier-ignore -->
|
|
244
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
245
|
+
| --- | --- | --- | --- | --- |
|
|
246
|
+
| [画面仕様](../rulebooks/uis-rulebook.md) | UI Specification | `uis-<term>` | 業務ユーザー視点の画面の利用目的や表示項目、操作を定義する | 画面概要、利用目的、表示項目、操作、遷移、エラー表示 など |
|
|
247
|
+
| [帳票仕様](../rulebooks/bds-rulebook.md) | Business Document Specification | `bds-<term>` | 業務ユーザー視点の帳票の利用目的や表示項目を定義する | 帳票概要、利用目的、表示項目、出力タイミング など |
|
|
248
|
+
|
|
249
|
+
#### 2.1.5. システム化機能
|
|
250
|
+
|
|
251
|
+
<!-- prettier-ignore -->
|
|
252
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
253
|
+
| --- | --- | --- | --- | --- |
|
|
254
|
+
| [システム化機能一覧 / 全体構成](../rulebooks/sf-rulebook.md) | System Functions Index | `sf-index` | システムで実現する機能の全体構成と一覧を定義する | 機能ID、機能名、概要、関連プロセス、関連仕様ID など |
|
|
255
|
+
| [システム化機能一覧 / 個別](../rulebooks/sf-rulebook.md) | System Function | `sf-<term>` | 個別のシステム化機能の概要・関連仕様を定義する | 機能概要、関連プロセス、関連画面、関連IF、関連ルール など |
|
|
256
|
+
|
|
257
|
+
#### 2.1.6. 用語集
|
|
258
|
+
|
|
259
|
+
<!-- prettier-ignore -->
|
|
260
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
261
|
+
| --- | --- | --- | --- | --- |
|
|
262
|
+
| [用語集](../rulebooks/gl-rulebook.md) | Glossary | `gl-<domain>` | 用語の意味を統一的に定義する | 用語、定義、別名、分類、関連用語 など |
|
|
263
|
+
|
|
264
|
+
### 2.2. 外部I/F仕様
|
|
265
|
+
|
|
266
|
+
#### 2.2.1. ドキュメント一覧と概要
|
|
267
|
+
|
|
268
|
+
<!-- prettier-ignore -->
|
|
269
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
270
|
+
| --- | --- | --- | --- | --- |
|
|
271
|
+
| [外部システムI/F一覧](../rulebooks/ifx-index-rulebook.md) | External System Interface | `ifx-index.yaml` | 外部システムとの連携を一覧(YAML)で定義する | 連携名、連携元、連携先(外部システム)、伝送方式、フォーマット、タイミング |
|
|
272
|
+
| [外部API仕様](../rulebooks/ifx-api-rulebook.md) | External API Specification | `ifx-api-<term>.yaml` | 外部システムとのAPI連携をOpenAPI形式(YAML)で定義する | エンドポイント、HTTPメソッド、リクエスト/レスポンス、ステータスコード |
|
|
273
|
+
| [外部ファイル連携仕様](../rulebooks/ifx-file-rulebook.md) | External File Exchange Specification | `ifx-file-<term>.yaml` | 外部システムとのファイル連携をYAMLで定義する | ファイル形式、伝送方法、スケジュール、ファイル項目一覧 |
|
|
274
|
+
| [外部メッセージ仕様](../rulebooks/ifx-msg-rulebook.md) | External Message Specification | `ifx-msg-<term>.yaml` | 他システムとのイベント/キューのメッセージ連携をAsyncAPI + CloudEvents(YAML)で定義する | チャネル名、メッセージ構造、エンドポイント、プロトコル |
|
|
275
|
+
| [外部コマンド連携仕様](../rulebooks/ifx-cmd-rulebook.md) | External Command Interface Specification | `ifx-cmd-<term>.yaml` | 外部CLIコマンドの起動契約をYAMLで定義する | コマンド名、引数、stdin/stdout/stderr、終了コード、認証注入方式、エラー処理 |
|
|
276
|
+
|
|
277
|
+
### 2.3. アーキテクチャ
|
|
278
|
+
|
|
279
|
+
#### 2.3.1. C4(構造・依存関係)
|
|
280
|
+
|
|
281
|
+
<!-- prettier-ignore -->
|
|
282
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
283
|
+
| --- | --- | --- | --- | --- |
|
|
284
|
+
| [C4コンテキスト図](../rulebooks/cxd-rulebook.md) | C4 Context Diagram | `cxd-<context>` | 対象システムと「境界外」の人・外部システムとの関係を俯瞰的に定義する | ユーザー、外部システム、本システムの関係図 |
|
|
285
|
+
| [C4コンテナ図](../rulebooks/cnd-rulebook.md) | C4 Container Diagram | `cnd-<container>` | 対象システムを主要実行/配備単位に分割し、利用者・外部システム・データストアとの関係を定義する | Webアプリ、API、バッチ、DB、メッセージ基盤など |
|
|
286
|
+
| [C4コンポーネント図](../rulebooks/cpd-rulebook.md) | C4 Component Diagram | `cpd-<component>` | 対象コンテナ内の主要コンポーネントに分解し、外部要素との関係を定義 | 人/ロール、対象コンテナ境界、DB、外部システムなど、と主要コンポーネントとの依存関係 |
|
|
287
|
+
|
|
288
|
+
#### 2.3.2. インフラ・技術選定(実行基盤)
|
|
289
|
+
|
|
290
|
+
<!-- prettier-ignore -->
|
|
291
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
292
|
+
| --- | --- | --- | --- | --- |
|
|
293
|
+
| [インフラ構成図](../rulebooks/ifd-mermaid-rulebook.md) | Infrastructure Diagram | `ifd-<term>` | インフラの論理的な境界(環境 / ネットワーク / ゾーン)と、主要コンポーネント間の通信の流れを定義する | 実行環境、ネットワーク、論理ゾーン、Webアプリ、API Server、DB など |
|
|
294
|
+
| [技術スタック一覧](../rulebooks/tsd-rulebook.md) | Technology Stack Definition | `tsd-<term>` | システムで採用する技術(言語、フレームワーク、DB、メッセージ基盤、キャッシュ等)を、一覧として定義する | プログラミング言語、フレームワーク、ミドルウェア など |
|
|
295
|
+
|
|
296
|
+
### 2.4. システム設計
|
|
297
|
+
|
|
298
|
+
システム設計は **“コードに寄せる(Code as Spec)”** 方針とし、設計ドキュメントは最小限に留めます。
|
|
299
|
+
本章では、実装詳細を文章で重複させず、以下のみを扱います。
|
|
300
|
+
|
|
301
|
+
- **System Design Index**:設計のSSOT(OpenAPI / AsyncAPI / migration / job定義 / config schema 等)への導線
|
|
302
|
+
- **System Design Critical Flows**:事故や仕様誤解の原因になりやすい“重要フロー”だけを少数(最大5件)定義
|
|
303
|
+
- **System Design Cross-cutting Policy**:エラー・冪等・リトライ・監査・トレーシング等の横断ルール(実装の共通前提)
|
|
304
|
+
|
|
305
|
+
#### 2.4.1. ドキュメント一覧と概要(最小構成)
|
|
306
|
+
|
|
307
|
+
<!-- prettier-ignore -->
|
|
308
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
309
|
+
| --- | --- | --- | --- | --- |
|
|
310
|
+
| 全体構成(リンク集) | System Design Index | `sysd-index` | システム設計のSSOTへの導線を1箇所に集約し、設計情報を迷子にしない | 内部API定義(OpenAPI等)/イベント定義(AsyncAPI等)/DBスキーマ(migration等)/バッチ定義(workflow/cron等)/設定スキーマ(config schema等)/コード配置規約(モジュール境界) |
|
|
311
|
+
| 重要フロー | System Design Critical Flows | `sysd-critical-flows` | “読まないと事故る”フローだけを可視化し、実装・テスト・運用の共通理解を作る | 最大5フロー(冪等/補償/非同期/順序/整合性/外部I/F障害など)について、境界・永続化点・再実行性・失敗時挙動を図または箇条書きで定義 |
|
|
312
|
+
| 横断ルール | System Design Cross-cutting Policy | `sysd-cross-cutting-policy` | 実装全体に影響する共通ルールをSSOT化し、各所の実装ブレを防ぐ | エラー形式/例外分類、タイムアウト・リトライ、冪等キー、トランザクション境界、ログ/監査ログ、トレーシング、セキュリティ(認証・認可の実装原則)、バージョニング、設定の上書き階層 |
|
|
313
|
+
|
|
314
|
+
> 補足:従来の「実装データフロー図/実装クラス図/DB論理・物理/実装画面仕様/内部I/F/バッチ設計/設定一覧」は、
|
|
315
|
+
> **“SSOTをコード(定義ファイル)に寄せる”** 方針により、個別ドキュメントとしては作りません。
|
|
316
|
+
> 必要な場合は **SYSD Index(リンク集)から一次情報へ到達**できる状態を維持します。
|
|
317
|
+
|
|
318
|
+
カテゴリ別に何を SSOT とし、何を個別ドキュメントとして書かないかの判断基準は [システム設計-全体構成 作成ルール](../rulebooks/sysd-index-rulebook.md) の `カテゴリ別の書き分け方針` を正本とします。
|
|
319
|
+
|
|
320
|
+
### 2.5. 業務受入条件
|
|
321
|
+
|
|
322
|
+
<!-- prettier-ignore -->
|
|
323
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
324
|
+
| --- | --- | --- | --- | --- |
|
|
325
|
+
| [業務受入条件](../rulebooks/bac-rulebook.md) | Business Acceptance Criteria | `bac-<term>` | 業務として受け入れ可能であることを示す条件を定義する | 業務シナリオ、受入条件、前提、操作、期待結果 など |
|
|
326
|
+
|
|
327
|
+
### 2.6. 非機能要件
|
|
328
|
+
|
|
329
|
+
<!-- prettier-ignore -->
|
|
330
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
331
|
+
| --- | --- | --- | --- | --- |
|
|
332
|
+
| [非機能要件](../rulebooks/nfr-index-rulebook.md) | Non-Functional Requirements | `nfr-index` | 非機能要件を8カテゴリに分冊管理し、測定可能・検証可能な形で一元化する | 信頼性、可用性、保守性、完全性、機密性・安全性、性能、運用、操作性(各カテゴリの目的・代表指標・検証導線) |
|
|
333
|
+
| [非機能要件 / 信頼性](../rulebooks/nfr-reliability-rulebook.md) | Non-functional Requirements / Reliability | `nfr-reliability` | 障害抑止と誤動作防止を定義する | 故障率、平均故障間隔(MTBF)、エラー率、データ検証ルール |
|
|
334
|
+
| [非機能要件 / 可用性](../rulebooks/nfr-availability-rulebook.md) | Non-functional Requirements / Availability | `nfr-availability` | システム稼働の継続性を定義する | 稼働率、RTO/RPO、フェイルオーバー、冗長化、バックアップ |
|
|
335
|
+
| [非機能要件 / 保守性](../rulebooks/nfr-maintainability-rulebook.md) | Non-functional Requirements / Maintainability | `nfr-maintainability` | 変更容易性と復旧容易性を定義する | 平均修復時間(MTTR)、変更リードタイム、ログ粒度 |
|
|
336
|
+
| [非機能要件 / 完全性](../rulebooks/nfr-integrity-rulebook.md) | Non-functional Requirements / Integrity | `nfr-integrity` | データ正確性と改ざん防止を定義する | 整合性検証、監査証跡、トランザクション境界 |
|
|
337
|
+
| [非機能要件 / 機密性・安全性](../rulebooks/nfr-security-safety-rulebook.md) | Non-functional Requirements / Security and Safety | `nfr-security-safety` | 不正利用防止とセキュリティを定義する | 認証・認可、脆弱性対応SLA、暗号化、アクセス制御 |
|
|
338
|
+
| [非機能要件 / 性能](../rulebooks/nfr-performance-rulebook.md) | Non-functional Requirements / Performance | `nfr-performance` | 応答性と処理能力を定義する | P95/P99レイテンシ、RPS(吞吐量)、リソース効率 |
|
|
339
|
+
| [非機能要件 / 運用](../rulebooks/nfr-operations-rulebook.md) | Non-functional Requirements / Operations | `nfr-operations` | 監視・手順・継続運用を定義する | アラート検知率、復旧達成率、運用手順充実度 |
|
|
340
|
+
| [非機能要件 / 操作性](../rulebooks/nfr-usability-rulebook.md) | Non-functional Requirements / Usability | `nfr-usability` | 使いやすさと誤操作防止を定義する | タスク完了率、誤操作率、エラーメッセージ明確性 |
|
|
341
|
+
|
|
342
|
+
### 2.7. システム受入条件
|
|
343
|
+
|
|
344
|
+
<!-- prettier-ignore -->
|
|
345
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
346
|
+
| --- | --- | --- | --- | --- |
|
|
347
|
+
| [システム受入条件](../rulebooks/sac-rulebook.md) | System Acceptance Criteria | `sac-<term>` | システム全体としての合格基準を定義する | 機能・非機能・障害・移行などの受け入れ条件 |
|
|
348
|
+
|
|
349
|
+
### 2.8. テスト
|
|
350
|
+
|
|
351
|
+
※ 個別仕様のサフィックスは、対象ドキュメントの目的に合わせて「用語集」のtermから命名します。リンクされる可能性も鑑みなるべく固定できる名前を選びます。
|
|
352
|
+
|
|
353
|
+
#### 2.8.1. 共通
|
|
354
|
+
|
|
355
|
+
<!-- prettier-ignore -->
|
|
356
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
357
|
+
| --- | --- | --- | --- | --- |
|
|
358
|
+
| [テスト戦略・方針](../rulebooks/tsp-index-rulebook.md) | Test Strategy and Policy | `tsp-index` | 全体テストの考え方を示す(要件) | テストレベルと目的、対象/対象外(スコープ)、品質目標、体制/役割、環境、使用ツール、テストデータ方針、入口/出口条件、進め方・優先度、リスクと対策 |
|
|
359
|
+
|
|
360
|
+
#### 2.8.2. 単体テストカタログ
|
|
361
|
+
|
|
362
|
+
<!-- prettier-ignore -->
|
|
363
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
364
|
+
| --- | --- | --- | --- | --- |
|
|
365
|
+
| [単体テスト](../rulebooks/utc-index-rulebook.md) | Unit Test Catalog | `utc-index` | 単体テストとして確認する観点・条件と分配を定義する | 対象単位、テスト範囲と対象外、境界(モック/スタブ方針)、TPC の観点・条件の分配、合格基準とエビデンス(共通) |
|
|
366
|
+
| [単体テスト対象別](../rulebooks/utc-rulebook.md) | Unit Test Specification | `utc-<target>` | 単体テスト仕様を対象ごとに分割して定義する | 個別対象の範囲、観点、代表条件(状態レベル)、合格基準とエビデンス(参照) |
|
|
367
|
+
|
|
368
|
+
#### 2.8.3. 内部結合テストカタログ
|
|
369
|
+
|
|
370
|
+
<!-- prettier-ignore -->
|
|
371
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
372
|
+
| --- | --- | --- | --- | --- |
|
|
373
|
+
| [内部結合テスト](../rulebooks/itc-index-rulebook.md) | Internal Integration Test Catalog | `itc-index` | 内部コンポーネント間の連携を確認する観点・条件を定義する | 対象コンポーネントと結合範囲、インターフェース(API/イベント/DB)観点、主要フロー/例外フロー、トランザクション・整合性、エラー処理、ログ/監視観点、合格基準 |
|
|
374
|
+
| [内部結合テスト対象別](../rulebooks/itc-rulebook.md) | Internal Integration Test Specification | `itc-<target>` | 内部結合テスト仕様を対象(機能/連携)ごとに分割して定義する | 個別結合範囲、前提、テスト条件(シナリオ)一覧、合格基準、関連する仕様ID/機能ID |
|
|
375
|
+
|
|
376
|
+
#### 2.8.4. 外部結合テストカタログ
|
|
377
|
+
|
|
378
|
+
<!-- prettier-ignore -->
|
|
379
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
380
|
+
| --- | --- | --- | --- | --- |
|
|
381
|
+
| [外部結合テスト](../rulebooks/etc-index-rulebook.md) | External Integration Test Catalog | `etc-index` | 外部システム連携を含む結合観点・条件を定義する(仕様) | 対象I/F(API/ファイル/メッセージ)、契約(スキーマ/コード/制約)、正常/異常(タイムアウト・リトライ・冪等・順序)、セキュリティ(認証/認可)、性能/レート制限、監査ログ、合格基準 |
|
|
382
|
+
| [外部結合テスト対象別](../rulebooks/etc-rulebook.md) | External Integration Test Specification | `etc-<target>` | 外部結合テスト仕様を連携単位で分割して定義する(仕様) | I/Fごとのテスト条件一覧(入力/期待/エラー)、前提(接続先・認証・テストデータ)、合格基準、関連する外部I/F仕様ID |
|
|
383
|
+
|
|
384
|
+
#### 2.8.5. 総合結合テストカタログ
|
|
385
|
+
|
|
386
|
+
<!-- prettier-ignore -->
|
|
387
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
388
|
+
| --- | --- | --- | --- | --- |
|
|
389
|
+
| [総合テスト](../rulebooks/stc-index-rulebook.md) | System Test Catalog | `stc-index` | システム全体として業務シナリオが成立することを定義する(仕様) | エンドツーエンドの業務シナリオ、画面/API/バッチ/外部連携の通し観点、運用観点(ジョブ・監視・障害時)、非機能の観点(代表値)、合格基準 |
|
|
390
|
+
| [総合テスト対象別](../rulebooks/stc-rulebook.md) | System Test Specification | `stc-<scenario>` | 総合テスト仕様をシナリオ/業務単位で分割して定義する(仕様) | 個別シナリオの前提、データ準備、テスト条件、期待結果、合格基準、関連する業務仕様ID/受入条件ID/入条件ID |
|
|
391
|
+
|
|
392
|
+
#### 2.8.6. 受入結合テストカタログ
|
|
393
|
+
|
|
394
|
+
<!-- prettier-ignore -->
|
|
395
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
396
|
+
| --- | --- | --- | --- | --- |
|
|
397
|
+
| [受入テスト](../rulebooks/atc-index-rulebook.md) | Acceptance Test Catalog | `atc-index` | 業務として受け入れ可能であることを確認する観点・条件を定義する(仕様) | 業務受入シナリオ、受入条件(合格基準)、利用者視点の操作・期待結果、例外時の扱い、データ準備、役割分担、エビデンス要件、判定/承認フロー |
|
|
398
|
+
| [受入テスト対象別](../rulebooks/atc-rulebook.md) | Acceptance Test Specification | `atc-<scenario>` | 受入テスト仕様を業務シナリオ/受入条件単位で分割して定義する(仕様) | 個別受入シナリオの前提、テスト条件、期待結果、合格基準、関連する業務受入条件ID/システム受入条件ID |
|
|
399
|
+
|
|
400
|
+
### 2.9. 運用
|
|
401
|
+
|
|
402
|
+
#### 2.9.1. ドキュメント一覧と概要
|
|
403
|
+
|
|
404
|
+
| ドキュメント | 英語名称 | 推奨ファイル名 | 目的 | 主な内容 |
|
|
405
|
+
| ---------------------------------------------- | ---------------------------- | -------------- | --------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
406
|
+
| [運用方針・設計](../rulebooks/opd-rulebook.md) | Operations Policy and Design | `opd-index` | 切替後の恒常運用を「あるべき姿」として定義し、運用品質(SLO/SLA・責任分界・統制)をSSOT化する | 運用の範囲・前提/SLO・SLA・KPI/体制・責任分界(RACI・当番・エスカレーション)/監視・アラート方針(指標・閾値・通知先・初動)/障害対応方針(優先度・停止判断・周知)/変更管理(リリース・設定変更・承認・ロールバック)/バックアップ・リストア方針(RTO/RPO)/権限・アカウント運用(棚卸し・監査ログ)/定期運用方針(バッチ・点検)/問い合わせ運用方針(窓口・分類・SLA)/関連ドキュメント導線(**opr-index/otp-index/cop-index** 等) |
|
|
407
|
+
| [運用手順](../rulebooks/opr-rulebook.md) | Operations Runbook | `opr-index` | 運用作業を再現可能な手順として定義し、誰がやっても同じ結果になる状態を作る(属人化防止) | 日次/週次/月次点検手順/障害対応手順(P1/P2…、切り分け、一次対応、復旧)/アラート対応手順(確認→暫定対応→恒久対応)/バックアップ確認・リストア手順(演習含む)/バッチ再実行・失敗時対応/運用変更作業(設定変更・デプロイ・ロールバック)/アカウント付与/剥奪手順/問い合わせ一次対応手順(テンプレ・ナレッジ)/証跡(ログ、チケット、チェックリスト、実施記録)/関連ドキュメント(**opd-index参照、mip-index/otp-index/cop-index連携**) |
|