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,311 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:cxd-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
recipe: undecided
|
|
7
|
+
sample: specdojo:cxd-sample
|
|
8
|
+
template: undecided
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# C4コンテキスト図 ドキュメント作成ルール
|
|
12
|
+
|
|
13
|
+
C4 Contextual Diagram (CXD) Documentation Rules
|
|
14
|
+
|
|
15
|
+
本ドキュメントは、アーキテクチャ設計のために **C4コンテキスト図と、その図を説明する文章**を、統一した粒度・表現で作成するためのルールです。
|
|
16
|
+
|
|
17
|
+
この章の成果物は、次の2つをセットで扱います。
|
|
18
|
+
|
|
19
|
+
- **C4コンテキスト図(Mermaid)**: 対象システムと「境界外」の人・外部システムとの関係を俯瞰で合意する
|
|
20
|
+
- **説明(Markdown)**: 図の要素(人/対象/外部/境界/関係)の意味を文章で合意する
|
|
21
|
+
|
|
22
|
+
Mermaid 記法そのもののルールは [cxd-mermaid-rulebook.md](cxd-mermaid-rulebook.md) を参照してください。
|
|
23
|
+
|
|
24
|
+
## 1. 全体方針
|
|
25
|
+
|
|
26
|
+
- CXDは「対象システムが、誰に/何と関わるか」を合意するための図である。
|
|
27
|
+
- 図に入れるのは **システム境界の外側との関係**までとし、内部構造(コンテナ/コンポーネント)や実装詳細は含めない。
|
|
28
|
+
- 1つの図には **対象システムを1つ**だけ置く(複数対象がある場合は図を分ける)。
|
|
29
|
+
- 図は「正確さ(過剰な詳細)」よりも「解釈が割れないこと(合意)」を優先する。
|
|
30
|
+
|
|
31
|
+
## 2. ファイル命名・ID規則
|
|
32
|
+
|
|
33
|
+
- ファイル名: `cxd-<番号>-<短い日本語名>.md`
|
|
34
|
+
|
|
35
|
+
- 例: `cxd-010-駄菓子屋きぬや販売管理システム-コンテキスト.md`
|
|
36
|
+
|
|
37
|
+
- Frontmatter:
|
|
38
|
+
|
|
39
|
+
- `id`: 小文字ハイフン形式(例: `cxd-candy-shop-sales-context`)
|
|
40
|
+
- `title`: 「〇〇のC4コンテキスト図」のように対象が分かる表現
|
|
41
|
+
|
|
42
|
+
## 3. 推奨 Frontmatter 項目
|
|
43
|
+
|
|
44
|
+
Frontmatter の共通ルールは [document-metadata-standard.md](../standards/document-metadata-standard.md) に従います。
|
|
45
|
+
|
|
46
|
+
| 項目 | 説明 | 必須 |
|
|
47
|
+
| ---------- | ---------------------------------------------- | ---- |
|
|
48
|
+
| id | ドキュメントID(小文字ハイフン) | ○ |
|
|
49
|
+
| type | `architecture` 固定 | ○ |
|
|
50
|
+
| title | ドキュメント名 | ○ |
|
|
51
|
+
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
52
|
+
| part_of | 上位ドキュメントID(分割している場合) | 任意 |
|
|
53
|
+
| based_on | 根拠となる定義(用語集、外部IF、上位方針など) | 任意 |
|
|
54
|
+
| supersedes | 置き換え関係(古い図→新しい図) | 任意 |
|
|
55
|
+
|
|
56
|
+
### 3.1. `based_on` の考え方(例)
|
|
57
|
+
|
|
58
|
+
- 用語集(`gl-...`)や業務データ辞書(`bdd-...`)
|
|
59
|
+
- 外部システムIFの仕様(IF章のドキュメント)
|
|
60
|
+
- 参照する上位の方針(DEC、非機能要件など)
|
|
61
|
+
|
|
62
|
+
## 4. CXDで合意すること(スコープ)
|
|
63
|
+
|
|
64
|
+
### 4.1. 合意したいこと
|
|
65
|
+
|
|
66
|
+
- 対象システムの名前と、責務の一言(何をするシステムか)
|
|
67
|
+
- 利用者(Person)と、その利用目的(何のために使うか)
|
|
68
|
+
- 外部システム(External Software System)と、連携の意図(何をやり取りするか)
|
|
69
|
+
- 関係(Relationship)の向きと意味(誰が主に呼び出す/依存するか)
|
|
70
|
+
- 対象システムの「境界」の考え方(何を含み、何を含まないか)
|
|
71
|
+
|
|
72
|
+
### 4.2. 合意しないこと(この図で扱わない)
|
|
73
|
+
|
|
74
|
+
- 対象システムの内部の分解(コンテナ/コンポーネント、内部プロセス、内部データストア)
|
|
75
|
+
- APIエンドポイント、HTTPメソッド、リクエスト/レスポンスJSONなどのIF詳細
|
|
76
|
+
- 物理テーブル名・物理カラム名・SQL全文
|
|
77
|
+
- 実装クラス/関数名、ライブラリ名、具体的な技術選定の列挙
|
|
78
|
+
|
|
79
|
+
## 5. CXDの要素定義(図と文章の両方で説明する)
|
|
80
|
+
|
|
81
|
+
この章では、図に描いた要素について **最低限の説明**を併記し、レビュー可能にします。
|
|
82
|
+
|
|
83
|
+
### 5.1. Person(人/ロール)
|
|
84
|
+
|
|
85
|
+
Personは、対象システムに対して目的をもって関わる主体(人/役割/組織)です。
|
|
86
|
+
|
|
87
|
+
- 書くこと(推奨):
|
|
88
|
+
- ロール名(例: 店員、店主、経理担当)
|
|
89
|
+
- 対象システムに何をしに来るか(例: 売上登録を行う、在庫を確認する)
|
|
90
|
+
- 重要な前提(ある場合のみ。例: 店舗内からのみ利用)
|
|
91
|
+
- 書かないこと:
|
|
92
|
+
- 個人名、組織の詳細階層、UI操作手順の逐語列挙
|
|
93
|
+
|
|
94
|
+
### 5.2. Software System(対象システム)
|
|
95
|
+
|
|
96
|
+
この図の中心に置くシステムです。CXDでは **対象システムは1つ**に限定します。
|
|
97
|
+
|
|
98
|
+
- 書くこと(推奨):
|
|
99
|
+
- システム名(短く一意)
|
|
100
|
+
- システムの責務(1文。例: 店舗の販売・仕入・在庫・簡易会計を一元管理する)
|
|
101
|
+
- 「境界」に含める範囲の補足(ある場合のみ)
|
|
102
|
+
- 書かないこと:
|
|
103
|
+
- 内部モジュール/サブシステムの列挙、画面一覧、DBスキーマ
|
|
104
|
+
|
|
105
|
+
### 5.3. External Software System(外部システム)
|
|
106
|
+
|
|
107
|
+
対象システムの外側にあり、対象システムが連携する相手(既存の別システム、SaaS、決済、会計など)です。
|
|
108
|
+
|
|
109
|
+
- 書くこと(推奨):
|
|
110
|
+
- 外部システム名(一般名でよい)
|
|
111
|
+
- 連携の目的(例: 決済を依頼する、仕訳を送る、マスタを参照する)
|
|
112
|
+
- 連携の方向性(誰が主に呼び出す/依存するか)
|
|
113
|
+
- 書かないこと:
|
|
114
|
+
- API仕様の詳細、データ項目一覧(それらはIF仕様へ)
|
|
115
|
+
|
|
116
|
+
### 5.4. System Boundary(システム境界)
|
|
117
|
+
|
|
118
|
+
境界は「対象システムが責任を持つ範囲」を表します。境界の内外が曖昧だと、責任分界(運用・障害・変更)が曖昧になります。
|
|
119
|
+
|
|
120
|
+
- 書くこと(推奨):
|
|
121
|
+
- 境界に含めるもの(例: 店舗内の販売管理)
|
|
122
|
+
- 境界に含めないもの(例: 決済そのもの、会計システムの処理)
|
|
123
|
+
- 注意:
|
|
124
|
+
- 境界内に「対象システムのノード1つだけ」を置く運用を基本とし、内部構造は別図(コンテナ図など)へ委譲します。
|
|
125
|
+
|
|
126
|
+
### 5.5. Relationship(関係)
|
|
127
|
+
|
|
128
|
+
関係は「やり取りの意味」を合意するための線です。CXDでは **すべての関係にラベル**を付けます。
|
|
129
|
+
|
|
130
|
+
- 書くこと(必須):
|
|
131
|
+
- 方向(誰が主に利用/依存/送信するか)
|
|
132
|
+
- ラベル(短い日本語。名詞句または短い動詞句)
|
|
133
|
+
- 書くこと(推奨):
|
|
134
|
+
- やり取りの意図(例: 売上登録、決済依頼、仕訳連携)
|
|
135
|
+
- 重要な前提(ある場合のみ。例: 非同期、日次バッチ)
|
|
136
|
+
- 書かないこと:
|
|
137
|
+
- HTTP詳細、データ項目列挙、SQL、実装条件式
|
|
138
|
+
|
|
139
|
+
## 6. 本文構成(標準テンプレ)
|
|
140
|
+
|
|
141
|
+
各 CXD 成果物は、以下見出しを順番に並べます。
|
|
142
|
+
|
|
143
|
+
1. 概要
|
|
144
|
+
2. C4コンテキスト図(Mermaid)
|
|
145
|
+
3. 要素の説明
|
|
146
|
+
4. 補足
|
|
147
|
+
|
|
148
|
+
## 7. 記述ガイド詳細
|
|
149
|
+
|
|
150
|
+
### 7.1. 概要
|
|
151
|
+
|
|
152
|
+
- 「この図が何を表すか」「対象システム」「前提」を1〜3文で書きます。
|
|
153
|
+
|
|
154
|
+
### 7.2. C4コンテキスト図(Mermaid)
|
|
155
|
+
|
|
156
|
+
- Mermaid のコードブロックで図を記述します。
|
|
157
|
+
- Mermaid 記法ルールは [cxd-mermaid-rulebook.md](cxd-mermaid-rulebook.md) に従います。
|
|
158
|
+
- 図には、少なくとも以下を含めます。
|
|
159
|
+
- Person(人/ロール)
|
|
160
|
+
- 対象システム(Software System)
|
|
161
|
+
- 外部システム(External Software System)
|
|
162
|
+
- 関係(Relationship。全矢印にラベル)
|
|
163
|
+
|
|
164
|
+
### 7.3. 要素の説明
|
|
165
|
+
|
|
166
|
+
- 図に登場する要素を、レビューしやすい粒度で説明します。
|
|
167
|
+
- 推奨スタイル:
|
|
168
|
+
- `###` レベルの小見出しで要素名(人/対象/外部/境界/関係)
|
|
169
|
+
- 1〜3文で意味・前提・境界条件(含む/含まない)を説明
|
|
170
|
+
|
|
171
|
+
### 7.4. 補足
|
|
172
|
+
|
|
173
|
+
- 未確定な外部連携、境界が揺れている論点、図を分ける必要がありそうな論点を列挙します。
|
|
174
|
+
|
|
175
|
+
## 8. 命名・記述スタイル
|
|
176
|
+
|
|
177
|
+
- 用語はこの図の中で揺らさない(同じ相手を別名で呼ばない)。
|
|
178
|
+
- ラベルは短くし、長い場合は改行(`<br>`)で読みやすくする(詳細はIF仕様へ)。
|
|
179
|
+
- Personは「役割」を優先し、個人名ではなくロール名にする。
|
|
180
|
+
|
|
181
|
+
## 9. 禁止事項
|
|
182
|
+
|
|
183
|
+
次の記述は、CXDの粒度を超えるため避けます。
|
|
184
|
+
|
|
185
|
+
| 項目 | 理由 |
|
|
186
|
+
| ------------------------------------------- | --------------------------------- |
|
|
187
|
+
| 物理テーブル名・物理カラム名・SQL全文 | 図の粒度を超える(DB設計に記述) |
|
|
188
|
+
| APIエンドポイント/HTTP/JSON等の詳細 | IF仕様に記述する |
|
|
189
|
+
| 実装クラス/関数名、技術スタック列挙 | 変更に弱い・合意の対象がずれる |
|
|
190
|
+
| 対象システム内部の詳細プロセス/データストア | コンテナ図/コンポーネント図で表す |
|
|
191
|
+
| 矢印ラベルなしの関係 | 何の関係か合意できない |
|
|
192
|
+
|
|
193
|
+
## 10. レビュー観点(チェックリスト)
|
|
194
|
+
|
|
195
|
+
- 対象システムは1つに絞れているか
|
|
196
|
+
- PersonとExternal Software Systemが含まれているか(無い場合は理由が書かれているか)
|
|
197
|
+
- すべての関係にラベルがあり、意味が解釈一致するか
|
|
198
|
+
- 境界の内外が説明され、責任分界が曖昧でないか
|
|
199
|
+
- 図が「内部設計」や「IF詳細」に踏み込んでいないか
|
|
200
|
+
|
|
201
|
+
## 11. サンプル(簡易)
|
|
202
|
+
|
|
203
|
+
### 11.1. メタ情報(Frontmatter)
|
|
204
|
+
|
|
205
|
+
```yaml
|
|
206
|
+
---
|
|
207
|
+
id: cxd-candy-shop-sales-context
|
|
208
|
+
type: architecture
|
|
209
|
+
title: 駄菓子屋きぬや販売管理システムのC4コンテキスト図
|
|
210
|
+
status: draft
|
|
211
|
+
part_of: []
|
|
212
|
+
based_on: []
|
|
213
|
+
---
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
### 11.2. 概要
|
|
217
|
+
|
|
218
|
+
この図は「駄菓子屋きぬや販売管理システム」が、利用者と外部システムとどのように関わるかを俯瞰します。
|
|
219
|
+
|
|
220
|
+
### 11.3. C4コンテキスト図(Mermaid)
|
|
221
|
+
|
|
222
|
+
```mermaid
|
|
223
|
+
flowchart LR
|
|
224
|
+
%% Person
|
|
225
|
+
店員["👤店員"]
|
|
226
|
+
店主["👤店主"]
|
|
227
|
+
|
|
228
|
+
%% External Systems
|
|
229
|
+
会計システム["会計システム"]
|
|
230
|
+
決済サービス["決済サービス"]
|
|
231
|
+
|
|
232
|
+
%% Target System Boundary
|
|
233
|
+
subgraph 境界["対象システム"]
|
|
234
|
+
販売管理システム("駄菓子屋きぬや<br>販売管理システム")
|
|
235
|
+
end
|
|
236
|
+
|
|
237
|
+
%% Relationships
|
|
238
|
+
店員 -->|"売上登録"| 販売管理システム
|
|
239
|
+
店主 -->|"商品・在庫管理"| 販売管理システム
|
|
240
|
+
販売管理システム -->|"会計仕訳連携"| 会計システム
|
|
241
|
+
販売管理システム -->|"決済依頼"| 決済サービス
|
|
242
|
+
決済サービス -->|"決済結果"| 販売管理システム
|
|
243
|
+
|
|
244
|
+
%% Styles
|
|
245
|
+
classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
|
|
246
|
+
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
247
|
+
classDef external fill:#e9ecef,stroke:#495057,color:#000;
|
|
248
|
+
class 店員,店主 person;
|
|
249
|
+
class 販売管理システム system;
|
|
250
|
+
class 会計システム,決済サービス external;
|
|
251
|
+
style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
```plaintext
|
|
255
|
+
flowchart LR
|
|
256
|
+
%% Person
|
|
257
|
+
店員["👤店員"]
|
|
258
|
+
店主["👤店主"]
|
|
259
|
+
|
|
260
|
+
%% External Systems
|
|
261
|
+
会計システム["会計システム"]
|
|
262
|
+
決済サービス["決済サービス"]
|
|
263
|
+
|
|
264
|
+
%% Target System Boundary
|
|
265
|
+
subgraph 境界["対象システム"]
|
|
266
|
+
販売管理システム("駄菓子屋きぬや<br>販売管理システム")
|
|
267
|
+
|
|
268
|
+
end
|
|
269
|
+
|
|
270
|
+
%% Relationships
|
|
271
|
+
店員 -->|"売上登録"| 販売管理システム
|
|
272
|
+
店主 -->|"商品・在庫管理"| 販売管理システム
|
|
273
|
+
販売管理システム -->|"会計仕訳連携"| 会計システム
|
|
274
|
+
販売管理システム -->|"決済依頼"| 決済サービス
|
|
275
|
+
決済サービス -->|"決済結果"| 販売管理システム
|
|
276
|
+
|
|
277
|
+
%% Styles
|
|
278
|
+
classDef person fill:#fff3bf,stroke:#f08c00,color:#000;
|
|
279
|
+
classDef system fill:#d0ebff,stroke:#1c7ed6,color:#000;
|
|
280
|
+
classDef external fill:#e9ecef,stroke:#495057,color:#000;
|
|
281
|
+
class 店員,店主 person;
|
|
282
|
+
class 販売管理システム system;
|
|
283
|
+
class 会計システム,決済サービス external;
|
|
284
|
+
style 境界 fill:#ffffff,fill-opacity:0,stroke:#868e96,stroke-width:1px,stroke-dasharray: 5 5;
|
|
285
|
+
```
|
|
286
|
+
|
|
287
|
+
### 11.4. 要素の説明
|
|
288
|
+
|
|
289
|
+
#### 11.4.1. Person(人/ロール)
|
|
290
|
+
|
|
291
|
+
店員・店主が、販売登録や在庫・商品管理のために対象システムを利用します。
|
|
292
|
+
|
|
293
|
+
#### 11.4.2. 対象システム(Software System)
|
|
294
|
+
|
|
295
|
+
店舗の販売・仕入・在庫に関する情報を一元管理し、会計・決済などの外部連携を行います。
|
|
296
|
+
|
|
297
|
+
#### 11.4.3. 外部システム(External Software System)
|
|
298
|
+
|
|
299
|
+
会計システムへは仕訳相当情報を連携し、決済サービスへは決済を依頼して結果を受信します(詳細はIF仕様に記載)。
|
|
300
|
+
|
|
301
|
+
#### 11.4.4. 境界(System Boundary)
|
|
302
|
+
|
|
303
|
+
境界には販売管理システム本体を含みます。決済処理や会計処理そのものは境界の外側です。
|
|
304
|
+
|
|
305
|
+
### 11.5. 補足
|
|
306
|
+
|
|
307
|
+
- 会計連携の頻度(リアルタイム/日次)を確定する。
|
|
308
|
+
|
|
309
|
+
## 12. 参照
|
|
310
|
+
|
|
311
|
+
- Mermaid 記法(CXD): [cxd-mermaid-rulebook.md](../rulebooks/cxd-mermaid-rulebook.md)
|
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:dct-index-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
target_format: yaml
|
|
7
|
+
recipe: not-needed
|
|
8
|
+
sample: specdojo:dct-index-sample
|
|
9
|
+
template: specdojo:dct-index-template
|
|
10
|
+
based_on:
|
|
11
|
+
- specdojo:rulebook-authoring-standard
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
# 成果物カタログ(インデックス)作成ルール
|
|
15
|
+
|
|
16
|
+
Deliverables Catalog Index Documentation Rules
|
|
17
|
+
|
|
18
|
+
本ドキュメントは、成果物カタログ索引の正本 `dct-index.yaml` と、そこから生成する `generated/dct-index.md` の記述ルールです。プロジェクト横断の表示順・グループ・名称・概要・規模を宣言へ集約し、ドメイン別カタログとの整合を機械的に検証できる状態を保ちます。
|
|
19
|
+
|
|
20
|
+
## 1. 全体方針
|
|
21
|
+
|
|
22
|
+
- `dct-index.yaml` は、プロジェクト規模とドメイン一覧の表示意図を保持する唯一の正本とする。
|
|
23
|
+
- `generated/dct-index.md` は `catalog build` が生成する表示専用ビューとし、直接編集しない。
|
|
24
|
+
- 各ドメインの成果物定義は `dct-<domain>.yaml` に置き、索引には表示名・概要・順序・グループだけを置く。
|
|
25
|
+
- 共通ルールなどの散文と生成物の外枠は `dct-index-template.md` が保持し、YAML の文字列へ複製しない。
|
|
26
|
+
- `dct-index.yaml` の宣言ドメイン集合と実在する `dct-*.yaml` の `domain` 集合を一致させる。
|
|
27
|
+
|
|
28
|
+
## 2. 位置づけと用語定義
|
|
29
|
+
|
|
30
|
+
| 用語 | 正本・生成物 | 役割 |
|
|
31
|
+
| ------------ | --------------------------- | ---------------------------------------------------------- |
|
|
32
|
+
| 索引宣言 | `dct-index.yaml` | 規模、グループ、ドメイン順、表示名、概要を宣言する |
|
|
33
|
+
| 本文テンプレ | `dct-index-template.md` | Frontmatter 雛形、共通ルール、一覧挿入スロットを保持する |
|
|
34
|
+
| 索引ビュー | `generated/dct-index.md` | 宣言と実在カタログから生成されるプロジェクトの参照起点 |
|
|
35
|
+
| ドメイン正本 | `dct-<domain>.yaml` | ドメインに属する成果物、配置、依存関係、完了条件を定義する |
|
|
36
|
+
| ドメイン表示 | `generated/dct-<domain>.md` | 1 ドメインの成果物定義を読みやすい Markdown として表示する |
|
|
37
|
+
|
|
38
|
+
- `domain` は論理的な管理単位であり、物理ファイル名ではなく各 `dct-*.yaml` の `domain` 値で識別する。
|
|
39
|
+
- 同じ `domain` を持つ物理分割ファイルが複数あっても、索引宣言と索引ビューでは 1 ドメインとして扱う。
|
|
40
|
+
- `group` は索引ビューの分類見出しを表す。ルートのグループは `domains` または子 `groups` のどちらか一方を持つ。
|
|
41
|
+
- `subgroup` はルートグループ直下の表分割を表し、`domains` を持つ。Markdown 見出しを H4 までに収めるため、さらに子 `groups` は持てない。
|
|
42
|
+
- グループとサブグループの順序は、成果物定義の依存順や Schedule の実行順を意味しない。
|
|
43
|
+
|
|
44
|
+
## 3. ファイル命名・ID規則
|
|
45
|
+
|
|
46
|
+
- 索引宣言はカタログディレクトリ直下の `dct-index.yaml` とする。
|
|
47
|
+
- 索引ビューは同ディレクトリの `generated/dct-index.md` に生成する。
|
|
48
|
+
- 索引ビューの文書 ID は `<project-id>:dct-index` とし、宣言の `project_id` と一致させる。
|
|
49
|
+
- ドメイン表示へのリンクは `./dct-<domain>.md` とし、索引ビューと同じ `generated/` ディレクトリ内で解決する。
|
|
50
|
+
- ドメイン識別子は英小文字・数字・ハイフンからなる kebab-case とする。
|
|
51
|
+
|
|
52
|
+
## 4. YAML 構成
|
|
53
|
+
|
|
54
|
+
構造・必須キー・型制約は `dct-index.schema.yaml` を SSOT とし、本ルールは各項目の運用意図を補う。
|
|
55
|
+
|
|
56
|
+
### 4.1. ルート項目
|
|
57
|
+
|
|
58
|
+
| 項目 | 必須 | 説明 |
|
|
59
|
+
| ------------ | ---- | ------------------------------------------------------------ |
|
|
60
|
+
| `id` | ○ | `<project-id>:dct-index` |
|
|
61
|
+
| `type` | ○ | `project` 固定 |
|
|
62
|
+
| `status` | ○ | `draft` / `ready` / `deprecated` |
|
|
63
|
+
| `title` | ○ | 生成ビューの文書名 |
|
|
64
|
+
| `rulebook` | ○ | `specdojo:dct-index-rulebook` 固定 |
|
|
65
|
+
| `project_id` | ○ | 対象プロジェクト ID |
|
|
66
|
+
| `size` | ○ | scaffold に用いる `small` / `medium` / `large` |
|
|
67
|
+
| `groups` | ○ | 索引ビューに出すグループの配列。配列順を表示順として使用する |
|
|
68
|
+
|
|
69
|
+
### 4.2. `groups[]`(ルートグループ)
|
|
70
|
+
|
|
71
|
+
| 項目 | 必須 | 説明 |
|
|
72
|
+
| --------- | ---- | --------------------------------------------------------------- |
|
|
73
|
+
| `name` | ○ | 索引ビューの H3 グループ見出し |
|
|
74
|
+
| `domains` | 選択 | グループ内のドメイン配列。`groups` と同時には指定できない |
|
|
75
|
+
| `groups` | 選択 | H4 で出力するサブグループ配列。`domains` と同時には指定できない |
|
|
76
|
+
|
|
77
|
+
`domains` と `groups` はどちらか一方だけを必須とする。従来の 1 段構造では `domains` を、分類を 2 段に分ける場合は `groups` を指定する。
|
|
78
|
+
|
|
79
|
+
### 4.3. `groups[].groups[]`(サブグループ)
|
|
80
|
+
|
|
81
|
+
| 項目 | 必須 | 説明 |
|
|
82
|
+
| --------- | ---- | ------------------------------------------------------------ |
|
|
83
|
+
| `name` | ○ | 索引ビューの H4 サブグループ見出し |
|
|
84
|
+
| `domains` | ○ | サブグループ内のドメイン配列。配列順を表の行順として使用する |
|
|
85
|
+
|
|
86
|
+
サブグループは `groups` を持てない。これにより、`## 2. 成果物カタログ一覧`、H3 グループ、H4 サブグループの 2 段までに制限する。
|
|
87
|
+
|
|
88
|
+
### 4.4. `domains[]`
|
|
89
|
+
|
|
90
|
+
| 項目 | 必須 | 説明 |
|
|
91
|
+
| ---------- | ---- | ------------------------------------------------------ |
|
|
92
|
+
| `domain` | ○ | 実在する `dct-*.yaml` の `domain` と一致する論理識別子 |
|
|
93
|
+
| `name` | ○ | 利用者向けの日本語表示名 |
|
|
94
|
+
| `overview` | ○ | ドメインが管理する成果物の関心領域を示す 1 文の概要 |
|
|
95
|
+
|
|
96
|
+
## 5. 生成物の本文構成(標準テンプレ)
|
|
97
|
+
|
|
98
|
+
| 章 | 内容 | 必須 | 生成元 |
|
|
99
|
+
| --- | ------------------ | ---- | ------------------------------------------------- |
|
|
100
|
+
| 1 | 共通ルール | ○ | `dct-index-template.md` |
|
|
101
|
+
| 2 | 成果物カタログ一覧 | ○ | template のスロットへ `groups` ごとの表を生成する |
|
|
102
|
+
|
|
103
|
+
一覧の見出しと表は次の規則で生成する。
|
|
104
|
+
|
|
105
|
+
- `domains` を持つルートグループは、`### 2.<グループ番号>. <名称>` と表を 1 組生成する。
|
|
106
|
+
- `groups` を持つルートグループは H3 見出しだけを生成し、各サブグループを `#### 2.<グループ番号>.<サブグループ番号>. <名称>` と表の組で生成する。
|
|
107
|
+
- グループ番号とサブグループ番号は、それぞれの配列順に 1 から採番する。
|
|
108
|
+
|
|
109
|
+
各表は次の標準列をこの順序で持つ。
|
|
110
|
+
|
|
111
|
+
| 列名 | 生成内容 |
|
|
112
|
+
| -------------- | ------------------------------------------------ |
|
|
113
|
+
| ドメイン | `domain` をバッククォートで囲んだ値 |
|
|
114
|
+
| 名称 | 宣言の `name` |
|
|
115
|
+
| 成果物カタログ | `generated/dct-<domain>.md` へ解決する相対リンク |
|
|
116
|
+
| 概要 | 宣言の `overview` |
|
|
117
|
+
|
|
118
|
+
## 6. 記述・生成・検証ガイド
|
|
119
|
+
|
|
120
|
+
### 6.1. 宣言の書き方
|
|
121
|
+
|
|
122
|
+
- グループとドメインは、索引を読む人が探索しやすい順序で配列へ並べる。
|
|
123
|
+
- グループ分類の正本は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] の文書構成図とする。ルートグループはプロジェクト成果物とプロダクト成果物のような文書分類、サブグループは構成図が示す論理的なまとまり(要件〜設計、品質保証、運用など)に対応させる。
|
|
124
|
+
- 成果物リファレンスは個別成果物を引くための一覧であり、章の粒度は rulebook 単位で索引のグループとは一致しない。分類が食い違う場合は構成ガイドを正として宣言する。
|
|
125
|
+
- ルートグループ内に表を直接置く場合は `domains`、サブグループへ分割する場合は `groups` を使い、両方を同じグループへ記載しない。
|
|
126
|
+
- `name` はドメインの表示名に限定し、状態や担当など変動する情報を含めない。
|
|
127
|
+
- `overview` は管理対象の関心領域を 1 文で記述し、個別成果物を列挙しない。
|
|
128
|
+
- `size` はプロジェクト全体の scaffold 方針として決め、生成 Markdown へ重複記載しない。
|
|
129
|
+
|
|
130
|
+
### 6.2. 生成規則
|
|
131
|
+
|
|
132
|
+
- `catalog build` は宣言順を保持し、`domains` を持つグループまたはサブグループごとに表を分割する。
|
|
133
|
+
- サブグループの章番号は親グループの番号を継承し、H4 で出力する。
|
|
134
|
+
- 複数の物理ファイルが同じ `domain` を持つ場合、索引には 1 行だけ生成する。
|
|
135
|
+
- 生成前に宣言ドメインと実在ドメインを突き合わせ、不一致があれば索引ビューを生成しない。
|
|
136
|
+
- 同じ入力からは同じ見出し順・行順・リンクを生成する。
|
|
137
|
+
|
|
138
|
+
### 6.3. 検証規則
|
|
139
|
+
|
|
140
|
+
- schema 検証で必須項目、列挙値、文字種、空配列を検出する。
|
|
141
|
+
- グループが `domains` と `groups` の両方またはどちらも持たない場合と、サブグループがさらに `groups` を持つ場合を schema 違反にする。
|
|
142
|
+
- `catalog validate` で宣言だけのドメインと実在ファイルだけのドメインをともにエラーにする。
|
|
143
|
+
- 入れ子全体での同一ドメインの重複宣言、同一階層の同名グループ、表を壊す改行・`|` をエラーにする。
|
|
144
|
+
- `catalog build` 後に索引ビューと各ドメイン表示への相対リンクが同じ `generated/` 配下で解決することを確認する。
|
|
145
|
+
|
|
146
|
+
## 7. 禁止事項
|
|
147
|
+
|
|
148
|
+
| 禁止事項 | 理由 |
|
|
149
|
+
| ---------------------------------------------------- | ------------------------------------------------------ |
|
|
150
|
+
| `generated/dct-index.md` を直接編集する | 次回生成で失われ、正本と差異が生じるため |
|
|
151
|
+
| 表示順や表示名を各 `dct-*.yaml` へ分散して持たせる | ドメイン横断の編集意図が複数ファイルへ分散するため |
|
|
152
|
+
| 同じ `domain` を複数のグループへ宣言する | 索引上の所属と行が重複するため |
|
|
153
|
+
| 1 グループへ `domains` と `groups` の両方を記載する | 見出し直下の表とサブグループの責務が曖昧になるため |
|
|
154
|
+
| サブグループの下にさらに `groups` を記載する | H5 以下の見出しが必要になり、Markdown 規約に反するため |
|
|
155
|
+
| 実在しないドメインを宣言する | 生成リンクの参照先を作れないため |
|
|
156
|
+
| 実在するドメインを索引宣言から省略する | 管理対象カタログを参照起点から辿れなくなるため |
|
|
157
|
+
| `name` / `overview` に改行または `\|` を含める | Markdown 表の列構造を壊すため |
|
|
158
|
+
| 個別成果物の配置・依存・完了条件を索引宣言へ記載する | ドメイン正本との二重管理になるため |
|