specdojo 0.1.0 → 0.2.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/LICENSE +22 -0
- package/README.md +82 -38
- 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 +980 -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 +45 -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 +15 -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 +55 -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 +473 -0
- package/docs/ja/specdojo/guides/register-operation-guide.md +418 -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 +120 -24
- 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/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/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/dist/exec-schedule-timeline-render.js +0 -201
- package/dist/exec-schedule-timeline.js +0 -2
|
@@ -0,0 +1,242 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:prj-issues-and-approach-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: ready
|
|
6
|
+
target_format: markdown
|
|
7
|
+
recipe: specdojo:prj-issues-and-approach-recipe
|
|
8
|
+
sample: specdojo:prj-issues-and-approach-sample
|
|
9
|
+
template: specdojo:prj-issues-and-approach-template
|
|
10
|
+
based_on:
|
|
11
|
+
- specdojo:rulebook-authoring-standard
|
|
12
|
+
supersedes: []
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# プロジェクト課題と解決アプローチ 作成ルール
|
|
16
|
+
|
|
17
|
+
Project Issues and Approach Documentation Rules
|
|
18
|
+
|
|
19
|
+
本ドキュメントは、**プロジェクト課題と解決アプローチ(Project Issues and Approach)** を統一形式で記述するためのルールです。
|
|
20
|
+
関係者が「何が課題で、どれを、どう解く方針か(なぜその方針か)」を短時間で合意できる粒度に整えます。
|
|
21
|
+
|
|
22
|
+
## 1. 全体方針
|
|
23
|
+
|
|
24
|
+
- 本ルールの対象は **プロジェクト課題と解決アプローチ**(課題の整理と、採用アプローチの合意)です。
|
|
25
|
+
- 目的は「意思決定の前提を揃える」ことです。詳細な設計・実装・テスト設計は、本書の対象外とします。
|
|
26
|
+
- 曖昧表現(例:「適切に」「可能な限り」「十分に」)は避け、合意できる表現にします。
|
|
27
|
+
- “事実/観察” と “推測/仮説” を混ぜないでください(混ざる場合はラベルで区別)。
|
|
28
|
+
- 解決策は 2 件以上の方針を挙げ、相互に代替する案か、異なる課題・原因を扱う補完策かを区別して採用理由を明記します(単一案の押し付けは禁止)。
|
|
29
|
+
|
|
30
|
+
## 2. 位置づけと用語定義
|
|
31
|
+
|
|
32
|
+
### 2.1. 位置づけ(他ドキュメントとの関係)
|
|
33
|
+
|
|
34
|
+
プロジェクト課題と解決アプローチと他ドキュメントの関係を示します。
|
|
35
|
+
|
|
36
|
+
```mermaid
|
|
37
|
+
flowchart LR
|
|
38
|
+
POV["プロジェクト概要"]
|
|
39
|
+
PSC["プロジェクトスコープ"]
|
|
40
|
+
ACD["前提・制約・依存関係"]
|
|
41
|
+
PIA["プロジェクト課題と<br>解決アプローチ"]
|
|
42
|
+
|
|
43
|
+
POV --> PSC
|
|
44
|
+
PSC --> ACD
|
|
45
|
+
POV --> PIA
|
|
46
|
+
PSC --> PIA
|
|
47
|
+
ACD --> PIA
|
|
48
|
+
|
|
49
|
+
classDef target stroke-width:4px
|
|
50
|
+
class PIA target
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### 2.2. 用語定義(本ルール内)
|
|
54
|
+
|
|
55
|
+
| 用語 | 定義 |
|
|
56
|
+
| ------------------------ | --------------------------------------------------------------------------------- |
|
|
57
|
+
| **課題** | 困っている現象(観察できる問題)。解決策の先取り(例:「自動発注がない」)にしない |
|
|
58
|
+
| **影響** | 課題が放置された場合に起きる損失/リスク(業務・顧客・コスト・期日など) |
|
|
59
|
+
| **原因** | 課題の発生要因(事実と仮説を区別する) |
|
|
60
|
+
| **解決策候補** | 課題を解決するための方針。相互に代替する案と、異なる課題・原因を扱う補完策を含む |
|
|
61
|
+
| **案の関係** | 候補同士が同じ判断を置き換える「代替」か、役割を分けて併用する「補完」かの区分 |
|
|
62
|
+
| **判断軸** | 採否判断に使う観点(効果/コスト/期間/リスク/現場適合など) |
|
|
63
|
+
| **採用アプローチ** | 採用する案と、その実行方針(なぜそれを選ぶかを含む) |
|
|
64
|
+
| **トレードオフ** | 採用の代償として失うもの/我慢するもの |
|
|
65
|
+
| **リスク** | 失敗/遅延/品質低下などの可能性と、その軽減策 |
|
|
66
|
+
| **次の検討事項(ToDo)** | 未確定事項、追加調査、意思決定が必要な事項 |
|
|
67
|
+
|
|
68
|
+
## 3. ファイル命名・ID規則
|
|
69
|
+
|
|
70
|
+
### 3.1. 配置(推奨)
|
|
71
|
+
|
|
72
|
+
- `docs/ja/projects/<project-id>/020-project-definition/prj-issues-and-approach.md` への配置を推奨します。
|
|
73
|
+
- プロジェクト配下の章構成は [docs-structure-guide.md](../guides/docs-structure-guide.md) に従います。
|
|
74
|
+
- 課題と方針の根拠となる関連資料を別ファイルにする場合は、本文から参照リンクで紐付けます。
|
|
75
|
+
|
|
76
|
+
### 3.2. ドキュメントID(推奨)
|
|
77
|
+
|
|
78
|
+
メタ情報(Frontmatter)を付ける場合、ID は一意である必要があります。
|
|
79
|
+
|
|
80
|
+
- 推奨: `<project-id>:prj-issues-and-approach`
|
|
81
|
+
- 例: `prj-0001:prj-issues-and-approach`
|
|
82
|
+
|
|
83
|
+
### 3.3. ファイル名(推奨)
|
|
84
|
+
|
|
85
|
+
- 推奨: `prj-issues-and-approach.md`
|
|
86
|
+
- 日本語ファイル名を使う場合も、Frontmatter の `id` は 3.2 の形式で一意にします。
|
|
87
|
+
|
|
88
|
+
## 4. 推奨 Frontmatter 項目
|
|
89
|
+
|
|
90
|
+
### 4.1. 設定内容
|
|
91
|
+
|
|
92
|
+
- プロジェクト課題と解決アプローチでも、機械可読性が必要な場合は YAML Frontmatter を付与します。
|
|
93
|
+
- 参照スキーマ: [docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml](../../../specdojo/schemas/v1/deliverable-frontmatter.schema.yaml)
|
|
94
|
+
- メタ情報標準: [document-metadata-standard.md](../standards/document-metadata-standard.md)
|
|
95
|
+
|
|
96
|
+
| 項目 | 説明 | 必須 |
|
|
97
|
+
| ---------- | ------------------------------------------------------------ | ---- |
|
|
98
|
+
| id | `<project-id>:prj-issues-and-approach` | ○ |
|
|
99
|
+
| type | `project` 固定 | ○ |
|
|
100
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
101
|
+
| rulebook | `specdojo:prj-issues-and-approach-rulebook` | ○ |
|
|
102
|
+
| based_on | 概要、スコープ、前提・制約・依存関係など、直接根拠にした文書 | 任意 |
|
|
103
|
+
| supersedes | 置き換え対象の旧文書 ID | 任意 |
|
|
104
|
+
|
|
105
|
+
### 4.2. 推奨ルール
|
|
106
|
+
|
|
107
|
+
- `based_on` は、根拠として直接参照するものがある場合のみ列挙します(なければ `[]`)。
|
|
108
|
+
- 課題とアプローチを、概要で示した背景・必要性・基本的な考え方、スコープで定めた対象範囲、前提・制約・依存関係で定めた成立条件に対応させます。
|
|
109
|
+
|
|
110
|
+
### 4.3. 推奨例
|
|
111
|
+
|
|
112
|
+
```yaml
|
|
113
|
+
---
|
|
114
|
+
specdojo:
|
|
115
|
+
id: prj-0001:prj-issues-and-approach
|
|
116
|
+
type: project
|
|
117
|
+
status: draft
|
|
118
|
+
rulebook: specdojo:prj-issues-and-approach-rulebook
|
|
119
|
+
based_on:
|
|
120
|
+
- prj-0001:prj-overview
|
|
121
|
+
- prj-0001:prj-scope
|
|
122
|
+
- prj-0001:prj-assumptions-constraints-dependencies
|
|
123
|
+
supersedes: []
|
|
124
|
+
---
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
## 5. 本文構成(標準テンプレ)
|
|
128
|
+
|
|
129
|
+
プロジェクト課題と解決アプローチは以下の見出し構成を **順序固定** で配置します。
|
|
130
|
+
|
|
131
|
+
### 5.1. プロジェクト課題と解決アプローチ(Project Issues and Approach)
|
|
132
|
+
|
|
133
|
+
| 番号 | 見出し | 必須 | 内容(要点) |
|
|
134
|
+
| ---- | ------ | ---- | ------------ |
|
|
135
|
+
|
|
136
|
+
| 1 | 課題一覧 | ○ | 課題、影響、優先度(最小でも課題の列挙) |
|
|
137
|
+
| 2 | 原因(仮説でも可) | ○ | 課題の原因(事実と仮説を分ける) |
|
|
138
|
+
| 3 | 解決策候補 | ○ | 複数の方針、案の関係、対応する課題・原因 |
|
|
139
|
+
| 4 | 採用アプローチと理由 | ○ | 採用方針、組み合わせる理由、非採用案と理由 |
|
|
140
|
+
| 5 | トレードオフ/リスク | 任意 | 代償、リスク、前提が崩れた場合の対応 |
|
|
141
|
+
| 6 | 次の検討事項(ToDo) | 任意 | 未確定事項、追加調査、意思決定が必要な事項等 |
|
|
142
|
+
| 7 | 見直しと変更管理 | 任意 | 見直しの契機、確認観点、対応方針、記録先 |
|
|
143
|
+
|
|
144
|
+
## 6. 記述ガイド
|
|
145
|
+
|
|
146
|
+
### 6.1. 共通
|
|
147
|
+
|
|
148
|
+
- 見出し配下は「箇条書き+必要最小限の表」を基本とします。
|
|
149
|
+
- “事実/観察” と “推測/仮説” を混ぜないでください(混ざる場合はラベルで区別)。
|
|
150
|
+
- 読み手が「次に何を決めればよいか」が分かるように、未確定は未確定として明示します。
|
|
151
|
+
|
|
152
|
+
### 6.2. 課題一覧
|
|
153
|
+
|
|
154
|
+
- 課題は「困っている現象」を書き、解決策の先取り(例:「自動発注がない」)にしないでください。
|
|
155
|
+
- 各課題には、最低限「影響」と「優先度」を添えます。
|
|
156
|
+
- 推奨: 課題IDを振って、議論や DEC 参照に使えるようにします。
|
|
157
|
+
|
|
158
|
+
推奨(課題表):
|
|
159
|
+
|
|
160
|
+
| 課題ID | 課題 | 影響 | 優先度 | 備考 |
|
|
161
|
+
| ------ | ---- | ---- | ------ | ---- |
|
|
162
|
+
| P-01 | | | High | |
|
|
163
|
+
|
|
164
|
+
### 6.3. 原因(仮説でも可)
|
|
165
|
+
|
|
166
|
+
- 原因は分解して書きます(例: 情報不足、判断基準の不在、手順のばらつき、システム制約)。
|
|
167
|
+
- 事実として確認できているものと、推測/仮説を混ぜないでください。
|
|
168
|
+
- 原因には、根拠文書、観察事実、補足説明を添えます。
|
|
169
|
+
|
|
170
|
+
推奨(原因表):
|
|
171
|
+
|
|
172
|
+
| 課題ID | 原因区分 | 内容 | 根拠 / 補足 |
|
|
173
|
+
| ------ | -------- | ---- | ----------- |
|
|
174
|
+
|
|
175
|
+
### 6.4. 解決策候補
|
|
176
|
+
|
|
177
|
+
- 2 件以上の方針を挙げ、各案を `代替` または `補完` に区分します。
|
|
178
|
+
- 案ごとに「概要」と「期待できる効果」を 1〜3 行で書きます。
|
|
179
|
+
- 各案が扱う課題 ID または原因を示します。補完策は、ほかの案と役割が重複しないことを確認します。
|
|
180
|
+
- 案 ID を振り、採用アプローチ、代替案比較、決定記録から参照できるようにします。
|
|
181
|
+
- 同じ意思決定を置き換える一式の案を評価軸で詳細比較する場合は `prj-comparison-of-alternatives` へ委譲し、本書では課題との対応と比較が必要な論点までを示します。
|
|
182
|
+
|
|
183
|
+
推奨(解決策候補表):
|
|
184
|
+
|
|
185
|
+
| 案ID | 案 | 関係 | 概要 | 期待できる効果 | 対応課題 |
|
|
186
|
+
| ---- | --- | ---- | ---- | -------------- | -------- |
|
|
187
|
+
|
|
188
|
+
### 6.5. 採用アプローチと理由
|
|
189
|
+
|
|
190
|
+
- 採用案を明記し、採用理由を判断軸で説明します。
|
|
191
|
+
- 代替案のうち採用しない案がある場合は、採用しない理由も 1 行で添えます。
|
|
192
|
+
- 推奨: 判断軸(効果/コスト/期間/リスク/現場適合)のうち、今回重視する順序を示します。
|
|
193
|
+
- 補完策を組み合わせる場合は、各案が担う課題・原因と、単独では不足する理由を説明します。中核・補助または実行順序がある場合だけ、その関係も示します。
|
|
194
|
+
|
|
195
|
+
推奨(採用判定表):
|
|
196
|
+
|
|
197
|
+
| 採用対象 | 判定 | 理由 |
|
|
198
|
+
| -------- | ---- | ---- |
|
|
199
|
+
|
|
200
|
+
### 6.6. トレードオフ/リスク(任意)
|
|
201
|
+
|
|
202
|
+
- トレードオフは「何を捨てる/先送りする/我慢するか」を明示します。
|
|
203
|
+
- リスクは「起きうること」と「軽減策」をセットで書きます。
|
|
204
|
+
- 区分は `トレードオフ` / `リスク` などで揃え、課題ログやリスク登録簿へ転記しやすい粒度にします。
|
|
205
|
+
|
|
206
|
+
推奨(トレードオフ/リスク表):
|
|
207
|
+
|
|
208
|
+
| 区分 | 内容 | 軽減策 |
|
|
209
|
+
| ---- | ---- | ------ |
|
|
210
|
+
|
|
211
|
+
### 6.7. 次の検討事項(ToDo)(任意)
|
|
212
|
+
|
|
213
|
+
- 次の意思決定に必要な情報(追加調査、確認事項、承認事項)を列挙します。
|
|
214
|
+
- 責任者は、プロジェクトの体制定義で採用済みのロールまたは担当単位で記述します。
|
|
215
|
+
|
|
216
|
+
推奨(ToDo 表):
|
|
217
|
+
|
|
218
|
+
| ToDo | 目的 | 責任ロール |
|
|
219
|
+
| ---- | ---- | ---------- |
|
|
220
|
+
|
|
221
|
+
### 6.8. 見直しと変更管理(任意)
|
|
222
|
+
|
|
223
|
+
- 本書を暫定的な合意として扱い、見直す契機(仮説の反証、スコープ・前提制約の変更、採用アプローチに影響する決定、リスクの顕在化など)を挙げます。
|
|
224
|
+
- 契機ごとに、確認する観点と対応方針をセットで書きます。
|
|
225
|
+
- 見直し結果と判断根拠の記録先(プロジェクト登録簿、決定記録など)を示します。
|
|
226
|
+
- 責任は、各項目の所有者が監視し、全体の取りまとめと最終判断を行うロールを明記します。
|
|
227
|
+
|
|
228
|
+
推奨(見直しと変更管理表):
|
|
229
|
+
|
|
230
|
+
| 見直しの契機 | 確認する観点 | 対応方針 |
|
|
231
|
+
| ------------ | ------------ | -------- |
|
|
232
|
+
|
|
233
|
+
## 7. 禁止事項
|
|
234
|
+
|
|
235
|
+
| 項目 | 理由 |
|
|
236
|
+
| ----------------------------------------------------- | ------------------------------------------ |
|
|
237
|
+
| 設計詳細(DB設計、API設計、画面詳細等) | プロダクト仕様/設計ドキュメントへ委譲 |
|
|
238
|
+
| “だいたい/適切に” 等の曖昧表現 | 合意・検証ができない |
|
|
239
|
+
| 課題を解決策の欠落として書く(例:「自動発注がない」) | 問題の同定ができず、手段が固定化する |
|
|
240
|
+
| 方針を 1 件しか出さず、代替または補完の検討をしない | 判断と課題への対応関係が不透明になる |
|
|
241
|
+
| 補完策を代替案として非採用扱いにする | 異なる課題・原因を同時に扱う必要性を失う |
|
|
242
|
+
| 理由のない採用(判断軸が書かれていない) | 後から説明できず、意思決定がやり直しになる |
|
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:prj-overview-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: ready
|
|
6
|
+
target_format: markdown
|
|
7
|
+
recipe: specdojo:prj-overview-recipe
|
|
8
|
+
sample: specdojo:prj-overview-sample
|
|
9
|
+
template: specdojo:prj-overview-template
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# プロジェクト概要 作成ルール
|
|
13
|
+
|
|
14
|
+
Project Overview Documentation Rulebook
|
|
15
|
+
|
|
16
|
+
本ドキュメントは、**プロジェクト概要(Project Overview)** を統一形式で記述するためのルールです。
|
|
17
|
+
関係者が「何を、なぜ、どの考え方で進めるのか」を短時間で合意できる粒度に整えます。
|
|
18
|
+
|
|
19
|
+
## 1. 全体方針
|
|
20
|
+
|
|
21
|
+
- 本ルールの対象は **プロジェクト概要**(背景、必要性、基本方針、狙いの共有)です。
|
|
22
|
+
- 目的は「プロジェクトの立ち上げ判断と後続成果物作成の前提を揃える」ことです。
|
|
23
|
+
- 背景、必要性、基本的な考え方、実現したいこと、期待効果、前提条件を概要レベルで記述します。
|
|
24
|
+
- 詳細なスコープ、成功基準、受入条件、設計、実装、テスト設計は、本書の対象外とします。
|
|
25
|
+
- 正式認可、権限委譲、承認証跡などのガバナンス情報は `prj-charter` を正とし、本書では扱いません。
|
|
26
|
+
- 具体的な成功判定や受入条件は `prj-success-criteria-and-acceptance-criteria` を正とし、本書では期待効果と初期仮説に留めます。
|
|
27
|
+
- 曖昧表現(例:「適切に」「可能な限り」「十分に」)は避け、合意できる表現にします。
|
|
28
|
+
- 数値目標を置く場合は、測定方法、判定時期、初期仮説か確定目標かを明示します。
|
|
29
|
+
|
|
30
|
+
## 2. 位置づけ
|
|
31
|
+
|
|
32
|
+
本書(`prj-overview`)は、ステークホルダー登録簿(`prj-stakeholder-register`)とプロジェクト憲章(`prj-charter`)の起点となる構想・概要文書です。本書を扱う立ち上げトラックの位置づけは [[specdojo:track-design-guide|トラック設計ガイド]]、立ち上げで扱う成果物の一覧は [[specdojo:deliverables-reference|成果物リファレンス]] を参照してください。
|
|
33
|
+
|
|
34
|
+
## 3. ファイル命名・ID規則
|
|
35
|
+
|
|
36
|
+
### 3.1. 配置(推奨)
|
|
37
|
+
|
|
38
|
+
- `docs/ja/projects/<project-id>/` のように、プロジェクト単位のフォルダ配下に配置します。
|
|
39
|
+
- 配下の章ディレクトリは `020-project-definition/` を用います(構成は [[specdojo:docs-structure-guide]] に従う)。
|
|
40
|
+
- 章ディレクトリには、サブディレクトリを切って、プロジェクトの背景や目的に関わる関連資料(図表、参考資料など)を置いてもよい。
|
|
41
|
+
|
|
42
|
+
### 3.2. ドキュメントID(推奨)
|
|
43
|
+
|
|
44
|
+
メタ情報(Frontmatter)を付ける場合、ID は一意である必要があります。
|
|
45
|
+
|
|
46
|
+
- 推奨: `<project-id>:prj-overview`
|
|
47
|
+
- 例: `prj-0001:prj-overview`
|
|
48
|
+
- YAML Frontmatter では、必要に応じてコロンを含む ID をクォートします。
|
|
49
|
+
|
|
50
|
+
### 3.3. ファイル名(推奨)
|
|
51
|
+
|
|
52
|
+
ファイル名は`prj-overview.md` を推奨。日本語の場合は、`プロジェクト概要.md` 。
|
|
53
|
+
|
|
54
|
+
## 4. 推奨 Frontmatter 項目
|
|
55
|
+
|
|
56
|
+
### 4.1. 設定内容
|
|
57
|
+
|
|
58
|
+
Frontmatter は共通スキーマに従います(あわせてドキュメントのメタ情報の記述ルールも参照)。
|
|
59
|
+
|
|
60
|
+
- 参照スキーマ: [deliverable-frontmatter.schema.yaml](/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml)
|
|
61
|
+
- メタ情報標準: [[specdojo:document-metadata-standard]]
|
|
62
|
+
|
|
63
|
+
| 項目 | 説明 | 必須 |
|
|
64
|
+
| ---------- | ---------------------------------- | ---- |
|
|
65
|
+
| id | `<project-id>:prj-overview` | ○ |
|
|
66
|
+
| type | `project` 固定 | ○ |
|
|
67
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
68
|
+
| rulebook | `specdojo:prj-overview-rulebook` | ○ |
|
|
69
|
+
| based_on | 既存の経営方針・制度資料・過去 DEC | 任意 |
|
|
70
|
+
| supersedes | 置き換え関係 | 任意 |
|
|
71
|
+
|
|
72
|
+
### 4.2. 推奨ルール
|
|
73
|
+
|
|
74
|
+
- `based_on` は、既存の経営方針・制度資料・過去 DEC など、根拠として直接参照するものがある場合のみ列挙します。
|
|
75
|
+
- ドキュメント名は Frontmatter ではなく本文 H1 に記述します(例: `# プロジェクト概要: <プロジェクト名>`)。
|
|
76
|
+
- H1 直下には、対象プロジェクトまたはフレームワークを一文で説明する導入文を置きます。
|
|
77
|
+
|
|
78
|
+
## 5. 本文構成(標準テンプレ)
|
|
79
|
+
|
|
80
|
+
プロジェクト概要は以下の見出し構成を基本とし、順序固定で配置します。
|
|
81
|
+
|
|
82
|
+
### 5.1. プロジェクト概要(Project Overview)
|
|
83
|
+
|
|
84
|
+
| 番号 | 見出し | 必須 | 内容(要点) |
|
|
85
|
+
| ---- | -------------- | ---- | ------------------------------------------------------ |
|
|
86
|
+
| 冒頭 | 導入文 | ○ | 対象プロジェクトまたはフレームワークの一文定義 |
|
|
87
|
+
| 1 | 背景 | ○ | 現状、文脈、構造的な問題 |
|
|
88
|
+
| 2 | 必要性 | ○ | なぜ取り組む必要があるか、放置した場合の課題 |
|
|
89
|
+
| 3 | 基本的な考え方 | ○ | 進め方の原則、判断軸、工程や成果物に対する考え方 |
|
|
90
|
+
| 4 | 実現したいこと | ○ | 整備・提供したい成果、対象利用者、適用領域 |
|
|
91
|
+
| 5 | 期待効果 | ○ | 初期公開・短期・中長期の効果、指標、初期仮説、測定方法 |
|
|
92
|
+
| 5.1 | 初期公開指標 | 任意 | 提供開始前に代表利用者の試行等で確認する価値・成立条件 |
|
|
93
|
+
| 5.2 | 短期指標 | 任意 | 提供後の利用、定着、再利用、直接的な利用者課題の改善 |
|
|
94
|
+
| 5.3 | 中長期指標 | 任意 | 事業・活動の成果、継続性、参加機会、透明性等の波及効果 |
|
|
95
|
+
| 6 | 前提条件 | ○ | 依存条件、制約、変えないこと、適用上の前提 |
|
|
96
|
+
|
|
97
|
+
## 6. 記述ガイド
|
|
98
|
+
|
|
99
|
+
### 6.1. 共通
|
|
100
|
+
|
|
101
|
+
- 見出し配下は「箇条書き+必要最小限の表」を基本とします。
|
|
102
|
+
- “事実/観察” と “推測/仮説” を混ぜないでください(混ざる場合はラベルで区別)。
|
|
103
|
+
- 読み手が「次に何を決めればよいか」が分かるように、未確定は未確定として明示します。
|
|
104
|
+
- 本書は概要文書であるため、後続文書で詳細化する内容は要約に留め、必要に応じて文書名を示します。
|
|
105
|
+
|
|
106
|
+
### 6.2. 導入文
|
|
107
|
+
|
|
108
|
+
- H1 直下に、対象プロジェクトまたはフレームワークを一文で説明します。
|
|
109
|
+
- 「何を通じて」「誰を支援し」「何を実現するか」が分かる粒度にします。
|
|
110
|
+
- 導入文では詳細な効果、指標、実装方式を列挙しません。
|
|
111
|
+
|
|
112
|
+
### 6.3. 背景
|
|
113
|
+
|
|
114
|
+
- 何が起きているか(現状)と、何が困りごとか(問題)を分けて書きます。
|
|
115
|
+
- 推奨: 事実は具体例(頻度・件数・影響)を添える。
|
|
116
|
+
|
|
117
|
+
### 6.4. 必要性
|
|
118
|
+
|
|
119
|
+
- 期限、制度/契約、競合、障害、属人化など「今やる理由」を明確にします。
|
|
120
|
+
- 背景で述べた可能性や課題に対し、なぜ既存のやり方では足りないかを説明します。
|
|
121
|
+
- 問題を列挙する場合は、後続の「基本的な考え方」や「実現したいこと」につながる粒度にします。
|
|
122
|
+
- プロジェクトの成立仮説を一文で表せる場合は、「誰のどの課題に、どの働きかけを行うと、どの変化が生じるか」を中心仮説として置きます。仮説を事実として断定せず、必要に応じて 2〜4 件の価値仮説へ分解します。
|
|
123
|
+
|
|
124
|
+
### 6.5. 基本的な考え方
|
|
125
|
+
|
|
126
|
+
- プロジェクトの設計思想や判断軸を 2〜5 件程度に絞って記述します。
|
|
127
|
+
- 原則には、名称、短い説明、プロジェクト上の意味を含めます。
|
|
128
|
+
- 原則は中心仮説や価値仮説を成立させるための判断軸とし、学習や検証結果に応じて見直せる表現にします。
|
|
129
|
+
- 特定の開発手法、ツール、製品に過度に寄せず、後続文書で再利用できる表現にします。
|
|
130
|
+
|
|
131
|
+
### 6.6. 実現したいこと
|
|
132
|
+
|
|
133
|
+
- 整備・提供したい成果を箇条書きで記述します。
|
|
134
|
+
- 対象利用者、適用領域、公開・再利用方針を必要に応じて含めます。
|
|
135
|
+
- 詳細な対象範囲や対象外は `prj-scope` に委譲し、本書では概要に留めます。
|
|
136
|
+
|
|
137
|
+
### 6.7. 期待効果
|
|
138
|
+
|
|
139
|
+
- 可能なら、以下のような最小の計測定義を置きます(不明なら空欄ではなく「未確定」)。
|
|
140
|
+
- 中心仮説を置いた場合は、価値仮説ごとに初期検証または後続時期の確認方法があるかを確かめます。
|
|
141
|
+
- 初期公開前に試行できる価値、公開・運用開始後の短期的な利用成果、中長期の事業・社会的な成果を分けます。すべての時間軸が必要でない場合は、省略理由または別の判定時期を明示します。
|
|
142
|
+
- 初期公開指標は、成果物や機能の完成率だけでなく、対象利用者が主要な利用場面を完遂できるかを確認します。
|
|
143
|
+
- 短期指標は、実際の利用、定着、再利用、利用者が認識する直接的な改善を扱います。
|
|
144
|
+
- 中長期指標は、プロジェクトが最終的に寄与したい事業・業務・社会的成果を扱います。成果を当該プロジェクトだけに帰属できない場合は「寄与」として記述します。
|
|
145
|
+
- 数値目標は、初期公開時点、運用開始後、ベースライン確定後のどこで判定するかを明示します。
|
|
146
|
+
- QCD は必要に応じて補助指標にできますが、成果物の完成、工数、納期だけで利用者価値を代替しません。
|
|
147
|
+
- 成功基準や受入条件として確定管理する値は `prj-success-criteria-and-acceptance-criteria` に委譲します。
|
|
148
|
+
|
|
149
|
+
推奨表(初期公開指標):
|
|
150
|
+
|
|
151
|
+
| 観点 | 指標 | 目標 | 測定方法 |
|
|
152
|
+
| ---- | ---- | ---- | -------- |
|
|
153
|
+
|
|
154
|
+
推奨表(短期指標):
|
|
155
|
+
|
|
156
|
+
| 観点 | 指標 | 目標 | 測定方法 |
|
|
157
|
+
| ---- | ---- | ---- | -------- |
|
|
158
|
+
|
|
159
|
+
推奨表(中長期指標):
|
|
160
|
+
|
|
161
|
+
| 観点 | 指標 | 初期目標 | 測定方法 |
|
|
162
|
+
| ---- | ---- | -------- | -------- |
|
|
163
|
+
|
|
164
|
+
### 6.8. 前提条件
|
|
165
|
+
|
|
166
|
+
- 変えない前提(例: 運用体制は当面変えない)と、依存前提(例: 他部門の協力が必要)を区別します。
|
|
167
|
+
- 人間の判断責任、AI Agent の役割、適用範囲、公開方針、利用時の取捨選択方針などを明示します。
|
|
168
|
+
|
|
169
|
+
### 6.9. プロジェクト憲章・成功基準との分担
|
|
170
|
+
|
|
171
|
+
- 本書では、背景・必要性・基本的な考え方・実現したいこと・期待効果を中心に記述します。
|
|
172
|
+
- 承認者、承認日、権限委譲、承認経路、証跡リンクは `prj-charter` 側で管理します。
|
|
173
|
+
- 受入条件、完了定義、GO / Not GO 判断は `prj-success-criteria-and-acceptance-criteria` 側で管理します。
|
|
174
|
+
- 同一情報を両文書に重複記載する場合は、本文を複製せず、要約 + 参照リンクで整合を保ちます。
|
|
175
|
+
|
|
176
|
+
## 7. 禁止事項
|
|
177
|
+
|
|
178
|
+
| 項目 | 理由 |
|
|
179
|
+
| -------------------------------------------------------- | ------------------------------------------ |
|
|
180
|
+
| 設計詳細(DB設計、API設計等) | プロダクト仕様/設計ドキュメントへ委譲 |
|
|
181
|
+
| “だいたい/適切に” 等の曖昧表現 | 合意・検証ができない |
|
|
182
|
+
| 根拠のない数値目標 | 誤った期待形成・炎上の原因になる |
|
|
183
|
+
| 成果物数・機能数・作業完了率だけを業務価値として扱う | 利用者や事業に生じる変化を判定できないため |
|
|
184
|
+
| 短期の利用件数だけで中長期の事業・社会的成果を置き換える | プロジェクトの最終的な目的を矮小化するため |
|
|
185
|
+
| 認可・権限委譲の詳細管理 | プロジェクト憲章との責務重複を防ぐため |
|
|
186
|
+
| 受入条件や GO / Not GO 判定の詳細 | 成功基準と受入条件との責務重複を防ぐため |
|
|
187
|
+
| 個人名・連絡先等の公開不適切情報 | 公開リポジトリでの利用を想定するため |
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:prj-scope-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: ready
|
|
6
|
+
target_format: markdown
|
|
7
|
+
recipe: specdojo:prj-scope-recipe
|
|
8
|
+
sample: specdojo:prj-scope-sample
|
|
9
|
+
template: specdojo:prj-scope-template
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# プロジェクトスコープ 作成ルール
|
|
13
|
+
|
|
14
|
+
Project Scope Documentation Rulebook
|
|
15
|
+
|
|
16
|
+
本ドキュメントは、**プロジェクトスコープ(Project Scope)** を統一形式で記述するためのルールです。
|
|
17
|
+
関係者が「今回やること、やらないこと、境界変更時の判断方法」を短時間で合意できる粒度に整えます。
|
|
18
|
+
|
|
19
|
+
## 1. 全体方針
|
|
20
|
+
|
|
21
|
+
- 本ルールの対象は **プロジェクトスコープ**(対象範囲、対象外、境界判断、変更方針)です。
|
|
22
|
+
- 目的は、対象範囲と除外範囲を利用者視点で確認できる状態にし、後続の成功基準、前提・制約、課題整理、計画作成の前提を揃えることです。
|
|
23
|
+
- スコープは “やること” だけでなく “やらないこと” を明示します。スコープ外の未記載は禁止します。
|
|
24
|
+
- スコープは設計詳細ではなく、業務価値、利用者影響、合意対象、責務境界を確認するための境界定義です。
|
|
25
|
+
- 詳細な成功判定や受入条件は `prj-success-criteria-and-acceptance-criteria`、前提・制約・依存は `prj-assumptions-constraints-dependencies`、課題と解決方針は `prj-issues-and-approach` へ委譲します。
|
|
26
|
+
- 曖昧表現(例:「適切に」「可能な限り」「十分に」)は避け、含める・含めないを判断できる表現にします。
|
|
27
|
+
|
|
28
|
+
## 2. 位置づけと用語定義
|
|
29
|
+
|
|
30
|
+
### 2.1. 位置づけ
|
|
31
|
+
|
|
32
|
+
プロジェクトスコープは、プロジェクト概要で示した背景・必要性・期待効果を受け、対象範囲と対象外を定義する文書です。後続文書は、本書の境界を前提に詳細化します。
|
|
33
|
+
|
|
34
|
+
```mermaid
|
|
35
|
+
flowchart LR
|
|
36
|
+
POV["prj-overview<br/>プロジェクト概要"]
|
|
37
|
+
PSC["prj-scope<br/>プロジェクトスコープ"]
|
|
38
|
+
SAC["prj-success-criteria-and-acceptance-criteria<br/>成功基準と受入条件"]
|
|
39
|
+
ACD["prj-assumptions-constraints-dependencies<br/>前提・制約・依存関係"]
|
|
40
|
+
PIA["prj-issues-and-approach<br/>課題と解決アプローチ"]
|
|
41
|
+
|
|
42
|
+
POV --> PSC
|
|
43
|
+
PSC --> SAC
|
|
44
|
+
PSC --> ACD
|
|
45
|
+
PSC --> PIA
|
|
46
|
+
|
|
47
|
+
classDef target stroke-width:4px
|
|
48
|
+
class PSC target
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### 2.2. 用語定義
|
|
52
|
+
|
|
53
|
+
| 用語 | 定義 |
|
|
54
|
+
| ---------------- | ------------------------------------------------------------------------ |
|
|
55
|
+
| スコープ内 | 今回やること、成果物に含めること、または対象にする活動領域 |
|
|
56
|
+
| 対象業務 | 対象とする業務、活動、プロセス、利用場面 |
|
|
57
|
+
| 対象システム | 対象とするシステム、成果物、文書体系、基盤、補助ツール、外部連携 |
|
|
58
|
+
| 対象期間 | 本スコープを適用する期間。日付が未確定の場合はイベント基準で定義してよい |
|
|
59
|
+
| スコープ外 | 意図的にやらないこと。理由、補足、後続で扱う条件を添える |
|
|
60
|
+
| 境界の判断基準 | 含める・含めないで迷ったときの判断順序、優先原則、SSOT |
|
|
61
|
+
| スコープ変更方針 | スコープを追加・削除・変更するときの入口、確認観点、承認者、記録方法 |
|
|
62
|
+
|
|
63
|
+
## 3. ファイル命名・ID規則
|
|
64
|
+
|
|
65
|
+
### 3.1. 配置(推奨)
|
|
66
|
+
|
|
67
|
+
- `docs/ja/projects/<project-id>/020-project-definition/prj-scope.md` へ配置します。
|
|
68
|
+
- プロジェクト配下の章構成は [[specdojo:docs-structure-guide]] に従います。
|
|
69
|
+
- 参考図表や補足資料を別ファイルにする場合は、スコープ本文から参照リンクで紐付けます。
|
|
70
|
+
|
|
71
|
+
### 3.2. ドキュメントID(推奨)
|
|
72
|
+
|
|
73
|
+
- 推奨: `<project-id>:prj-scope`
|
|
74
|
+
- 例: `prj-0001:prj-scope`
|
|
75
|
+
- YAML Frontmatter では、必要に応じてコロンを含む ID をクォートします。
|
|
76
|
+
|
|
77
|
+
### 3.3. ファイル名(推奨)
|
|
78
|
+
|
|
79
|
+
- 推奨: `prj-scope.md`
|
|
80
|
+
- 日本語ファイル名を使う場合も、Frontmatter の `id` は推奨形式で一意にします。
|
|
81
|
+
|
|
82
|
+
## 4. 推奨 Frontmatter 項目
|
|
83
|
+
|
|
84
|
+
### 4.1. 設定内容
|
|
85
|
+
|
|
86
|
+
Frontmatter は共通スキーマに従います。
|
|
87
|
+
|
|
88
|
+
- 参照スキーマ: [deliverable-frontmatter.schema.yaml](/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml)
|
|
89
|
+
- メタ情報標準: [[specdojo:document-metadata-standard]]
|
|
90
|
+
|
|
91
|
+
| 項目 | 説明 | 必須 |
|
|
92
|
+
| ---------- | ---------------------------------- | ---- |
|
|
93
|
+
| id | `<project-id>:prj-scope` | ○ |
|
|
94
|
+
| type | `project` 固定 | ○ |
|
|
95
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
96
|
+
| rulebook | `specdojo:prj-scope-rulebook` | ○ |
|
|
97
|
+
| based_on | `prj-overview`、上位方針、憲章など | 任意 |
|
|
98
|
+
| supersedes | 置き換え対象の旧文書 ID | 任意 |
|
|
99
|
+
|
|
100
|
+
### 4.2. 推奨ルール
|
|
101
|
+
|
|
102
|
+
- `based_on` は、根拠として直接参照するものがある場合のみ列挙します。
|
|
103
|
+
- `prj-overview` が存在する場合は、背景、必要性、期待効果とスコープが対応するように `based_on` へ含めます。
|
|
104
|
+
- ドキュメント名は Frontmatter ではなく本文 H1 に記述します(例: `# プロジェクトスコープ: <プロジェクト名>`)。
|
|
105
|
+
|
|
106
|
+
## 5. 本文構成(標準テンプレ)
|
|
107
|
+
|
|
108
|
+
プロジェクトスコープは以下の見出し構成を基本とし、順序固定で配置します。
|
|
109
|
+
|
|
110
|
+
### 5.1. プロジェクトスコープ(Project Scope)
|
|
111
|
+
|
|
112
|
+
| 番号 | 見出し | 必須 | 内容(要点) |
|
|
113
|
+
| ---- | ---------------- | ---- | -------------------------------------------------------- |
|
|
114
|
+
| 1 | 対象業務 | ○ | 対象とする業務、活動領域、利用場面、利用者影響 |
|
|
115
|
+
| 2 | 対象システム | ○ | 対象となるシステム、成果物、文書体系、基盤、外部連携範囲 |
|
|
116
|
+
| 3 | 対象期間 | ○ | 初期対象期間、判断イベント、継続改善との切り分け |
|
|
117
|
+
| 4 | スコープ外 | ○ | 明示的にやらないこと、理由、後続で扱う条件 |
|
|
118
|
+
| 5 | 境界の判断基準 | 任意 | 迷ったときの判断原則、優先順位、SSOT |
|
|
119
|
+
| 6 | スコープ変更方針 | 任意 | 変更入口、影響評価、承認者、記録方法 |
|
|
120
|
+
|
|
121
|
+
## 6. 記述ガイド
|
|
122
|
+
|
|
123
|
+
### 6.1. 共通
|
|
124
|
+
|
|
125
|
+
- 見出し配下は「箇条書き + 必要最小限の表」を基本とします。
|
|
126
|
+
- 対象範囲、対象外、利用者影響、合意対象が読み取れる粒度で記述します。
|
|
127
|
+
- “事実/決定済み” と “推測/仮説/未決” を混ぜないでください。未確定の内容は _UNDECIDED_: を優先し、作業待ちの項目だけ _TODO_:、仮置きの前提は _ASSUMPTION_: で明示します。
|
|
128
|
+
- UI、API、DB、テストケース、運用手順などの詳細は、対象となる後続文書へ委譲します。
|
|
129
|
+
|
|
130
|
+
### 6.2. 対象業務
|
|
131
|
+
|
|
132
|
+
- “業務” は機能名ではなく、現場で行う作業、判断、活動領域の単位で書きます。
|
|
133
|
+
- 推奨: 対象者、利用場面、利用者に生じる影響を添えます。
|
|
134
|
+
- 文書体系、ルール整備、公開準備などを目的とするプロジェクトでは、対象業務を「対象とする活動領域」として記述してよいです。
|
|
135
|
+
- 対象業務には、何を作るかだけでなく、何を運用・管理できる状態にするかを含めます。
|
|
136
|
+
|
|
137
|
+
### 6.3. 対象システム
|
|
138
|
+
|
|
139
|
+
- 対象機能、対象成果物、対象基盤は粒度を揃えます。
|
|
140
|
+
- 業務アプリケーションを作らないプロジェクトでは、対象となる文書体系、管理台帳、サンプル、補助ツール、公開基盤などを表で示してよいです。
|
|
141
|
+
- 実行可能なツールや CLI、正本となる管理データ、正本から生成する成果物は、プロジェクトが整備・変更・運用するなら対象システムに含めます。所有者、編集方法、責務が異なる場合は別の行に分けます。
|
|
142
|
+
- 生成物を含める場合は、生成元となる正本と、直接編集の可否を境界に記述します。
|
|
143
|
+
- 外部連携、公開基盤、補助ツールを含める場合は、プロジェクトが担う設定・接続・利用と、外部サービスや外部ツール本体の責務を分けて記述します。
|
|
144
|
+
- UI/画面遷移、API一覧、DB 定義、個別テンプレートの詳細は、本ドキュメントでは書きません。
|
|
145
|
+
|
|
146
|
+
推奨表:
|
|
147
|
+
|
|
148
|
+
| 対象 | 内容 | 境界 |
|
|
149
|
+
| ---- | ---- | ---- |
|
|
150
|
+
|
|
151
|
+
### 6.4. 対象期間
|
|
152
|
+
|
|
153
|
+
- 日付が確定していない場合は、イベント基準で書いてよいです。
|
|
154
|
+
- 初期リリース、初回公開、運用開始、継続改善など、どの期間までを本スコープに含めるかを明示します。
|
|
155
|
+
- マイルストーンやスケジュール定義がある場合は、期間判断の根拠として参照リンクを付けます。
|
|
156
|
+
- 未確定なら未確定と明記し、決めるための条件または意思決定ポイントを添えます。
|
|
157
|
+
|
|
158
|
+
### 6.5. スコープ外
|
|
159
|
+
|
|
160
|
+
- スコープ外は “やらない宣言” です。曖昧にしないでください。
|
|
161
|
+
- 推奨: スコープ外にした理由(コスト、効果、責務境界、公開適性、後続フェーズ等)を添えます。
|
|
162
|
+
- 利用者影響が大きい対象外項目は、後続で扱う条件や再検討タイミングも示します。
|
|
163
|
+
|
|
164
|
+
推奨表:
|
|
165
|
+
|
|
166
|
+
| 対象(Out) | 理由 | 補足 |
|
|
167
|
+
| ----------- | ---- | ---- |
|
|
168
|
+
|
|
169
|
+
### 6.6. 境界の判断基準
|
|
170
|
+
|
|
171
|
+
- 迷ったときに参照できる SSOT(判断原則)を書きます。
|
|
172
|
+
- 判断順序が重要な場合は、優先順位付きの箇条書きにします。
|
|
173
|
+
- 業務価値、利用者影響、公開適性、保守容易性、AI 利用可能性など、プロジェクトの性質に合う判断軸を選びます。
|
|
174
|
+
|
|
175
|
+
### 6.7. スコープ変更方針
|
|
176
|
+
|
|
177
|
+
- 変更の入口(誰が、どこへ提案するか)
|
|
178
|
+
- 影響評価の観点(業務価値、利用者影響、工数、費用、期日、運用、リスク)
|
|
179
|
+
- 承認者
|
|
180
|
+
- 影響を受ける成果物(成果物カタログ、スケジュール、RACI、管理計画など)
|
|
181
|
+
- 判断理由の記録先(DEC、課題一覧、Issue、PR、変更要求ログなど)
|
|
182
|
+
|
|
183
|
+
推奨表:
|
|
184
|
+
|
|
185
|
+
| 項目 | 内容 |
|
|
186
|
+
| -------- | ---- |
|
|
187
|
+
| 変更入口 | |
|
|
188
|
+
| 影響評価 | |
|
|
189
|
+
| 承認者 | |
|
|
190
|
+
| 記録先 | |
|
|
191
|
+
|
|
192
|
+
## 7. 禁止事項
|
|
193
|
+
|
|
194
|
+
| 項目 | 理由 |
|
|
195
|
+
| ----------------------------------- | ----------------------------------------- |
|
|
196
|
+
| 設計詳細(DB設計、API設計等) | プロダクト仕様/設計ドキュメントへ委譲する |
|
|
197
|
+
| “だいたい/適切に” 等の曖昧表現 | 合意・検証ができない |
|
|
198
|
+
| スコープ外の未記載 | 境界が曖昧になり手戻りの原因になる |
|
|
199
|
+
| 対象業務と対象システムの粒度不一致 | 見積、優先度、責務境界の認識が崩れる |
|
|
200
|
+
| 受入条件や GO / Not GO 判定の詳細化 | 成功基準と受入条件との責務重複を防ぐ |
|
|
201
|
+
| 個人名・連絡先等の公開不適切情報 | 公開リポジトリでの利用を想定するため |
|