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,297 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:ifd-mermaid-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
target_format: markdown
|
|
7
|
+
recipe: undecided
|
|
8
|
+
sample: specdojo:ifd-sample
|
|
9
|
+
template: undecided
|
|
10
|
+
based_on:
|
|
11
|
+
- specdojo:rulebook-authoring-standard
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
# Mermaidを用いたインフラ構成図 作成ルール
|
|
15
|
+
|
|
16
|
+
Infrastructure Flow Diagram (IFD) Documentation Rules using Mermaid
|
|
17
|
+
|
|
18
|
+
本ドキュメントは、アーキテクチャ検討・合意形成のために **インフラ構成図** を Mermaid の `flowchart` で記述するための標準ルールを定義します。
|
|
19
|
+
|
|
20
|
+
IFD は、インフラの **論理的な境界(環境 / ネットワーク / ゾーン)** と、主要コンポーネント間の **通信の流れ** を示すことを目的とします。
|
|
21
|
+
|
|
22
|
+
以下の内容は IFD の責務外とし、別ドキュメントで扱います。
|
|
23
|
+
|
|
24
|
+
- 物理構成(CIDR、IP、ポート、AZ)
|
|
25
|
+
- スケーリング、冗長化、台数
|
|
26
|
+
- セキュリティ設定(FW / SG / IAM)
|
|
27
|
+
- 技術選定・製品名の詳細
|
|
28
|
+
|
|
29
|
+
## 1. 設計思想(最重要)
|
|
30
|
+
|
|
31
|
+
- Mermaid は図ではなく **「構造化テキスト」** として扱う。
|
|
32
|
+
- 生成 AI は特に以下を **意味として解釈** する:
|
|
33
|
+
- **ノード名**(役割)
|
|
34
|
+
- **境界(subgraph)**(実行環境 / ネットワーク / ゾーン)
|
|
35
|
+
- **矢印の方向**(入口 → 処理 → 永続化)
|
|
36
|
+
- 見栄えは **配置・命名・色の一貫性** によって担保する。
|
|
37
|
+
|
|
38
|
+
指針:**「装飾より構造」**
|
|
39
|
+
|
|
40
|
+
## 2. 図タイプ・方向の固定(必須)
|
|
41
|
+
|
|
42
|
+
IFD は以下の形式に固定します。
|
|
43
|
+
|
|
44
|
+
````markdown
|
|
45
|
+
```mermaid
|
|
46
|
+
flowchart LR
|
|
47
|
+
```
|
|
48
|
+
````
|
|
49
|
+
|
|
50
|
+
### 2.1. 理由
|
|
51
|
+
|
|
52
|
+
- `flowchart LR` に固定することで **通信方向 = 左 → 右** が一貫し、生成AIが推論しやすくなる。
|
|
53
|
+
|
|
54
|
+
### 2.2. 禁止
|
|
55
|
+
|
|
56
|
+
- `TB` / `RL` / `BT`
|
|
57
|
+
- 図中での方向混在
|
|
58
|
+
|
|
59
|
+
## 3. 境界(subgraph)ルール(最大3階層)
|
|
60
|
+
|
|
61
|
+
境界は **最大3階層** までとし、意味を固定します。
|
|
62
|
+
|
|
63
|
+
| レベル | 意味 | 例 |
|
|
64
|
+
| ------ | ------------ | ----------------------- |
|
|
65
|
+
| Lv1 | 実行環境 | Cloud / On-Prem / SaaS |
|
|
66
|
+
| Lv2 | ネットワーク | VPC / Project / Segment |
|
|
67
|
+
| Lv3 | 論理ゾーン | Public / Private |
|
|
68
|
+
|
|
69
|
+
### 3.1. 例
|
|
70
|
+
|
|
71
|
+
```mermaid
|
|
72
|
+
flowchart LR
|
|
73
|
+
subgraph Cloud["Cloud Environment"]
|
|
74
|
+
subgraph VPC["VPC"]
|
|
75
|
+
subgraph Public["Public Zone"]
|
|
76
|
+
end
|
|
77
|
+
subgraph Private["Private Zone"]
|
|
78
|
+
end
|
|
79
|
+
end
|
|
80
|
+
end
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### 3.2. 禁止
|
|
84
|
+
|
|
85
|
+
- Lv4 以上の subgraph
|
|
86
|
+
- Subnet CIDR、AZ 名、IP、ポート番号などの物理情報
|
|
87
|
+
- 業務概念(例:Order Management)を境界名に使うこと
|
|
88
|
+
|
|
89
|
+
## 4. ノード命名規約(最重要)
|
|
90
|
+
|
|
91
|
+
### 4.1. 表示名は「役割名」で統一する
|
|
92
|
+
|
|
93
|
+
- 表示名は **役割(Role)** を表す
|
|
94
|
+
- 製品名 / サービス名 / 略語は使用しない
|
|
95
|
+
- 英語・単数形を基本とする
|
|
96
|
+
|
|
97
|
+
#### 4.1.1. OK
|
|
98
|
+
|
|
99
|
+
- `Load Balancer`
|
|
100
|
+
- `Web App`
|
|
101
|
+
- `API Server`
|
|
102
|
+
- `Relational Database`
|
|
103
|
+
- `Object Storage`
|
|
104
|
+
- `Cache`
|
|
105
|
+
- `Message Queue`
|
|
106
|
+
|
|
107
|
+
#### 4.1.2. NG
|
|
108
|
+
|
|
109
|
+
- `ALB`
|
|
110
|
+
- `EC2`
|
|
111
|
+
- `Cloud Run`
|
|
112
|
+
- `RDS`
|
|
113
|
+
- `Redis` / `Kafka`(※技術選定は別ドキュメント)
|
|
114
|
+
|
|
115
|
+
### 4.2. 絵文字アイコン(任意)
|
|
116
|
+
|
|
117
|
+
絵文字は **人間の視認性向上** には有効ですが、表示差や幅崩れが起きる環境もあるため、次のルールで運用します。
|
|
118
|
+
|
|
119
|
+
- 絵文字は **任意**(なくても成立する)
|
|
120
|
+
- 絵文字は **表示名(Label)のみに付ける**(IDには付けない)
|
|
121
|
+
- **1ノード1個まで**、表示名の **先頭に付ける**
|
|
122
|
+
- 絵文字だけに頼らず、必ず役割名テキストも併記する
|
|
123
|
+
|
|
124
|
+
OK:
|
|
125
|
+
|
|
126
|
+
```mermaid
|
|
127
|
+
flowchart LR
|
|
128
|
+
lb["🧭 Load Balancer"]
|
|
129
|
+
db[("🗄️ Relational Database")]
|
|
130
|
+
cache{{"⚡ Cache"}}
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
NG:
|
|
134
|
+
|
|
135
|
+
```text
|
|
136
|
+
flowchart LR
|
|
137
|
+
🧭lb["Load Balancer"]
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
## 5. ノードIDと表示名を分離する(必須)
|
|
141
|
+
|
|
142
|
+
Mermaid のノードは **ID(参照用)と表示名(意味)を分離** します。
|
|
143
|
+
|
|
144
|
+
```mermaid
|
|
145
|
+
flowchart LR
|
|
146
|
+
lb["🧭 Load Balancer"]
|
|
147
|
+
web["🖥️ Web App"]
|
|
148
|
+
api["⚙️ API Server"]
|
|
149
|
+
db[("🗄️ Relational Database")]
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
### 5.1. 狙い
|
|
153
|
+
|
|
154
|
+
- ノード参照が安定する
|
|
155
|
+
- 生成AIがノード同士の関係を誤解しにくくなる
|
|
156
|
+
|
|
157
|
+
## 6. 記法(形=意味を固定)
|
|
158
|
+
|
|
159
|
+
ノード形状を **意味として固定** します(役割名だけでなく形でも読み取れるようにする)。
|
|
160
|
+
|
|
161
|
+
| 種類 | 意味(役割) | 記法 | 表示名の例 |
|
|
162
|
+
| -------------- | ----------------------------- | ---------------- | ------------------------ |
|
|
163
|
+
| 🗄️ Database | 永続DB | `db[("...")]` | `🗄️ Relational Database` |
|
|
164
|
+
| 🪣 Storage | オブジェクト/ファイル保管 | `storage("...")` | `🪣 Object Storage` |
|
|
165
|
+
| 📨 Queue/Topic | 非同期連携(キュー/トピック) | `queue[["..."]]` | `📨 Message Queue` |
|
|
166
|
+
| ⚡ Cache | 参照高速化(任意) | `cache{{"..."}}` | `⚡ Cache` |
|
|
167
|
+
|
|
168
|
+
### 6.1. 例
|
|
169
|
+
|
|
170
|
+
```mermaid
|
|
171
|
+
flowchart LR
|
|
172
|
+
db[("🗄️ Relational Database")]
|
|
173
|
+
storage("🪣 Object Storage")
|
|
174
|
+
queue[["📨 Message Queue"]]
|
|
175
|
+
cache{{"⚡ Cache"}}
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
補足:
|
|
179
|
+
|
|
180
|
+
- Cache と Storage を分けるかは、図で合意したい論点(境界/経路/責務)がある場合のみ分ければ十分です。
|
|
181
|
+
- Cache を描かない場合も、このルールに反しません。
|
|
182
|
+
|
|
183
|
+
## 7. 通信矢印のルール(意味重視)
|
|
184
|
+
|
|
185
|
+
### 7.1. 原則は片方向
|
|
186
|
+
|
|
187
|
+
```mermaid
|
|
188
|
+
flowchart LR
|
|
189
|
+
A --> B
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
### 7.2. 双方向通信
|
|
193
|
+
|
|
194
|
+
```mermaid
|
|
195
|
+
flowchart LR
|
|
196
|
+
A --> B
|
|
197
|
+
B --> A
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
### 7.3. 矢印ラベルのルール
|
|
201
|
+
|
|
202
|
+
- ラベルは **通信の意味** を表す場合のみ使用する
|
|
203
|
+
- プロトコル名・ポート番号は記載しない
|
|
204
|
+
|
|
205
|
+
#### 7.3.1. OK
|
|
206
|
+
|
|
207
|
+
```mermaid
|
|
208
|
+
flowchart LR
|
|
209
|
+
api -->|Authenticate| auth
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
#### 7.3.2. NG
|
|
213
|
+
|
|
214
|
+
```mermaid
|
|
215
|
+
flowchart LR
|
|
216
|
+
api -->|HTTPS 443| db
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
## 8. 見栄えを整える最小限スタイル(任意)
|
|
220
|
+
|
|
221
|
+
### 8.1. 原則
|
|
222
|
+
|
|
223
|
+
- 色は **境界単位** または **役割の大分類** で付ける
|
|
224
|
+
- ノード単位でバラバラな色付けはしない
|
|
225
|
+
- `classDef` のみ使用可、`style` は原則使用しない
|
|
226
|
+
|
|
227
|
+
### 8.2. 例
|
|
228
|
+
|
|
229
|
+
```mermaid
|
|
230
|
+
flowchart LR
|
|
231
|
+
lb["🧭 Load Balancer"]
|
|
232
|
+
web["🖥️ Web App"]
|
|
233
|
+
api["⚙️ API Server"]
|
|
234
|
+
cache{{"⚡ Cache"}}
|
|
235
|
+
db[("🗄️ Relational Database")]
|
|
236
|
+
storage("🪣 Object Storage")
|
|
237
|
+
|
|
238
|
+
classDef boundary fill:#f5f7fa,stroke:#999,color:#000
|
|
239
|
+
classDef compute fill:#e3f2fd,stroke:#1e88e5,color:#000
|
|
240
|
+
classDef data fill:#e8f5e9,stroke:#43a047,color:#000
|
|
241
|
+
|
|
242
|
+
class lb,web,api compute
|
|
243
|
+
class cache,db,storage data
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
## 9. 完成例(推奨テンプレート)
|
|
247
|
+
|
|
248
|
+
```mermaid
|
|
249
|
+
flowchart LR
|
|
250
|
+
classDef boundary fill:#f5f7fa,stroke:#999,color:#000
|
|
251
|
+
classDef compute fill:#e3f2fd,stroke:#1e88e5,color:#000
|
|
252
|
+
classDef data fill:#e8f5e9,stroke:#43a047,color:#000
|
|
253
|
+
|
|
254
|
+
user["👤 User"] --> internet["🌐 Internet"]
|
|
255
|
+
|
|
256
|
+
subgraph Cloud["☁️ Cloud Environment"]
|
|
257
|
+
subgraph VPC["🛡️ VPC"]
|
|
258
|
+
subgraph Public["🌍 Public Zone"]
|
|
259
|
+
lb["🧭 Load Balancer"]
|
|
260
|
+
end
|
|
261
|
+
|
|
262
|
+
subgraph Private["🔒 Private Zone"]
|
|
263
|
+
web["🖥️ Web App"]
|
|
264
|
+
api["⚙️ API Server"]
|
|
265
|
+
cache{{"⚡ Cache"}}
|
|
266
|
+
db[("🗄️ Relational Database")]
|
|
267
|
+
storage("🪣 Object Storage")
|
|
268
|
+
end
|
|
269
|
+
end
|
|
270
|
+
end
|
|
271
|
+
|
|
272
|
+
internet --> lb
|
|
273
|
+
lb --> web
|
|
274
|
+
web --> api
|
|
275
|
+
api --> cache
|
|
276
|
+
api --> db
|
|
277
|
+
api --> storage
|
|
278
|
+
|
|
279
|
+
class user,internet boundary
|
|
280
|
+
class lb,web,api compute
|
|
281
|
+
class cache,db,storage data
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
### 9.1. この図で合意できること
|
|
285
|
+
|
|
286
|
+
- ネットワーク境界(Public / Private)
|
|
287
|
+
- 主要コンポーネントの役割分担
|
|
288
|
+
- 主要な通信フロー
|
|
289
|
+
- 永続化先の種別(🗄️/🪣)と非同期の有無(📨)
|
|
290
|
+
|
|
291
|
+
## 10. 禁止事項
|
|
292
|
+
|
|
293
|
+
- 物理構成の詳細(CIDR、IP、ポート、AZ、台数、Auto Scaling 等)
|
|
294
|
+
- 技術選定の詳細(特定クラウドサービス名、製品名)
|
|
295
|
+
- 意味のないラベル(HTTPS / TCP / 443 等)
|
|
296
|
+
- 方向の混在
|
|
297
|
+
- 矢印の過剰な交差(読みづらくなった場合は境界整理または図を分割する)
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:ifx-api-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
target_format: yaml
|
|
7
|
+
recipe: not-needed
|
|
8
|
+
sample: specdojo:ifx-api-sample
|
|
9
|
+
template: not-needed
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# 外部API仕様(External API Specification: EAPIS)作成ルール
|
|
13
|
+
|
|
14
|
+
外部システム(仕入先、会計、物流、決済など)と連携する **1つのREST APIインターフェース**を、**OpenAPI形式**(YAML 1ファイル)で定義します。
|
|
15
|
+
|
|
16
|
+
EAPIS は ESIL(外部システムIF一覧)から参照される「詳細仕様」です。
|
|
17
|
+
ESIL 側の `spec_ref: ifx-api-...` は、このEAPISのID(およびファイル名)と対応させます。
|
|
18
|
+
|
|
19
|
+
## 1. ファイル規約
|
|
20
|
+
|
|
21
|
+
- ファイル名: `ifx-api-<短い英小文字ハイフン>.yaml`
|
|
22
|
+
- ESILからの参照: `spec_ref: ifx-api-...`(例: `ifx-api-payment`)
|
|
23
|
+
- 1ファイル = 1つのAPI(1つの外部連携インターフェース)
|
|
24
|
+
|
|
25
|
+
## 2. OpenAPIバージョン
|
|
26
|
+
|
|
27
|
+
- **OpenAPI 3.0.3**(推奨)または **OpenAPI 3.1.x** を利用する
|
|
28
|
+
- 本リポジトリでは互換性のため **3.0.3** を第一候補とする
|
|
29
|
+
|
|
30
|
+
## 3. 記載方針(必須)
|
|
31
|
+
|
|
32
|
+
- **外部との合意に必要な最小十分**を記載する(内部実装の都合は書かない)
|
|
33
|
+
- `paths` は **実際に提供/利用するエンドポイントのみ**定義する
|
|
34
|
+
- `operationId` は英字で一意にする(例: `createPayment`)
|
|
35
|
+
- スキーマは `components/schemas` に集約し、`$ref` で参照して使い回す
|
|
36
|
+
- 認証は `components/securitySchemes` に定義し、`security` で適用する
|
|
37
|
+
- **メタ情報は `x-spec-meta` に集約**し、トレーサビリティを確保する
|
|
38
|
+
- **payloadのプロパティ名は snake_case を推奨**(例: `order_id`, `payment_status`)
|
|
39
|
+
|
|
40
|
+
禁止(書かない):
|
|
41
|
+
|
|
42
|
+
- DB物理テーブル名・物理カラム名・SQL全文
|
|
43
|
+
- 実装クラス/関数名・内部モジュール構成
|
|
44
|
+
- UI操作の逐語列挙
|
|
45
|
+
|
|
46
|
+
## 4. 必須構造(OpenAPI YAML)
|
|
47
|
+
|
|
48
|
+
最低限、以下を必ず含めます。
|
|
49
|
+
|
|
50
|
+
- `openapi`
|
|
51
|
+
- `info`(`title`を含む)
|
|
52
|
+
- `x-spec-meta`(`id`, `type`, `status` を含む)
|
|
53
|
+
- `servers`(少なくとも1つ)
|
|
54
|
+
- `paths`(少なくとも1つ)
|
|
55
|
+
|
|
56
|
+
## 4.1 メタ情報(x-spec-meta)
|
|
57
|
+
|
|
58
|
+
仕様のトレーサビリティ管理のため、以下を `x-spec-meta` に含めます。
|
|
59
|
+
|
|
60
|
+
| キー | 説明 | 必須 |
|
|
61
|
+
| ---- | ---- | ---- |
|
|
62
|
+
|
|
63
|
+
| id | API仕様ID(`ifx-api-...`)、ESILの `spec_ref` と対応 | ○ |
|
|
64
|
+
| type | `api` 固定 | ○ |
|
|
65
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
66
|
+
| based_on | 根拠となる他仕様のIDリスト(例: `["ifx-api-auth"]`) | 任意 |
|
|
67
|
+
|
|
68
|
+
## 5. エラー定義(推奨)
|
|
69
|
+
|
|
70
|
+
外部連携では、少なくとも以下のエラーレスポンスを定義します。
|
|
71
|
+
|
|
72
|
+
- `400`(入力不正)
|
|
73
|
+
- `401`(認証)/ `403`(認可)
|
|
74
|
+
- `404`(リソースなし)
|
|
75
|
+
- `409`(競合)
|
|
76
|
+
- `429`(レート制限)
|
|
77
|
+
- `500`(内部エラー)
|
|
78
|
+
|
|
79
|
+
共通形式(例: `components/schemas/ErrorResponse`)を用意し、各operationから参照する運用を推奨します。
|
|
@@ -0,0 +1,213 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:ifx-cmd-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
status: draft
|
|
6
|
+
target_format: yaml
|
|
7
|
+
recipe: specdojo:ifx-cmd-recipe
|
|
8
|
+
sample: specdojo:ifx-cmd-sample
|
|
9
|
+
template: specdojo:ifx-cmd-template
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# 外部コマンド連携仕様作成ルール
|
|
13
|
+
|
|
14
|
+
External Command Interface Specification (ECIS) Documentation Rules
|
|
15
|
+
|
|
16
|
+
外部 CLI プロセスを起動する連携について、実行契約、入出力、終了状態、認証注入、失敗時の扱いを YAML 1 ファイルで定義します。ESIL の `kind: コマンド` から参照される、1 つの外部コマンド連携の詳細仕様です。
|
|
17
|
+
|
|
18
|
+
## 1. 全体方針
|
|
19
|
+
|
|
20
|
+
- 1 ファイルで、1 つの実行目的と共通の入出力契約を持つコマンド連携を定義する。サブコマンドや出力契約が異なる場合はファイルを分ける。
|
|
21
|
+
- 呼び出し元と外部 CLI の合意境界に必要な項目を記載し、内部クラス、関数、プロセス起動ライブラリの実装詳細は含めない。
|
|
22
|
+
- 実行可能ファイルと引数は配列要素として分離し、既定ではシェルを経由しない。パイプ、リダイレクト、コマンド置換は 1 つのコマンド契約に埋め込まない。
|
|
23
|
+
- 認証情報は値ではなく注入方式と参照名だけを定義し、仕様、引数、標準入力、出力例に秘密値を記載しない。
|
|
24
|
+
|
|
25
|
+
## 2. 位置づけと用語定義
|
|
26
|
+
|
|
27
|
+
| 用語 | 定義 |
|
|
28
|
+
| -------------- | ------------------------------------------------------------------------------------------------------- |
|
|
29
|
+
| 外部コマンド | 対象システムのプロセス境界外にあり、実行可能ファイルと引数を指定して起動する CLI |
|
|
30
|
+
| 起動契約 | 実行可能ファイル、サブコマンド、引数、実行ディレクトリ、タイムアウトの合意 |
|
|
31
|
+
| ストリーム契約 | stdin、stdout、stderr それぞれの使用有無、形式、文字コード、成功時・失敗時の意味 |
|
|
32
|
+
| 認証注入 | シークレットストアや CLI 認証プロファイルから、プロセスに認証状態を渡す方式。秘密値自体は仕様に含めない |
|
|
33
|
+
| 終了カテゴリ | CLI 固有の終了コードを、成功、入力不正、認証失敗、一時失敗など呼び出し元が扱える意味へ分類した値 |
|
|
34
|
+
|
|
35
|
+
ESIL は連携の存在と方向を一覧化し、本仕様は対応する `spec_ref` の先でプロセス起動の契約を定義します。API、ファイル転送、メッセージングが連携の本体であり CLI が単なる操作ツールの場合は、対応する API/ファイル/メッセージ仕様を正本とし、本仕様との責務の重複を避けます。
|
|
36
|
+
|
|
37
|
+
## 3. ファイル命名・ID規則
|
|
38
|
+
|
|
39
|
+
- ファイル名は `ifx-cmd-<term>.yaml`、`id` は `ifx-cmd-<term>` とし、`<term>` は連携目的または外部 CLI を表す kebab-case にする。
|
|
40
|
+
- ESIL の `interfaces[].kind` は `コマンド`、`interfaces[].spec_ref` は本仕様の `id` と一致させる。詳細仕様が未作成の間だけ `TBD` を使用できる。
|
|
41
|
+
- 1 つの CLI で複数の実行目的を持つ場合は、`ifx-cmd-git-read` と `ifx-cmd-git-write` のように連携契約単位で分割する。バージョンや状態は ID に含めない。
|
|
42
|
+
- package に同梱する sample の ID `specdojo:ifx-cmd-sample` は記述例を識別するための例外であり、ESIL の `spec_ref` には使用しない。
|
|
43
|
+
|
|
44
|
+
## 4. 先頭メタ項目
|
|
45
|
+
|
|
46
|
+
YAML の先頭に次のメタ項目を置きます。
|
|
47
|
+
|
|
48
|
+
| キー | 説明 | 必須 |
|
|
49
|
+
| -------- | ------------------------------------------------ | ---- |
|
|
50
|
+
| id | コマンド連携仕様 ID。成果物では `ifx-cmd-<term>` | ○ |
|
|
51
|
+
| type | `command` 固定 | ○ |
|
|
52
|
+
| title | 対象と実行目的が分かる仕様名 | ○ |
|
|
53
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
54
|
+
| rulebook | `specdojo:ifx-cmd-rulebook` | ○ |
|
|
55
|
+
|
|
56
|
+
| version | 呼び出し契約の変更を追跡する整数または SemVer | 任意 |
|
|
57
|
+
| based_on | 作成時に直接確認した設計・運用文書の ID 配列 | 任意 |
|
|
58
|
+
| supersedes | 置き換え対象の文書 ID 配列 | 任意 |
|
|
59
|
+
|
|
60
|
+
`based_on` は実際に内容を確認した文書だけとします。コマンドのバージョン制約はメタ項目の `version` ではなく、`command.version_constraint` に記載します。
|
|
61
|
+
|
|
62
|
+
## 5. YAML構成(標準テンプレ)
|
|
63
|
+
|
|
64
|
+
| ルートキー | 定義内容 | 必須 |
|
|
65
|
+
| -------------- | -------------------------------------------------------------------------------- | ---- |
|
|
66
|
+
| command | 実行可能ファイル、サブコマンド、用途、バージョン制約、シェル経由の有無 | ○ |
|
|
67
|
+
| arguments | option/positional の種別、必須性、型、値の供給元、説明 | ○ |
|
|
68
|
+
| streams | stdin、stdout、stderr の使用有無、データ形式、文字コード、契約 | ○ |
|
|
69
|
+
| exit_codes | 終了コードと意味、共通カテゴリ、リトライ可否 | ○ |
|
|
70
|
+
| authentication | 認証方式、注入機構、参照名、秘密値の供給元、ログのマスク方針 | ○ |
|
|
71
|
+
| execution | 実行ディレクトリ、タイムアウト、ネットワーク要否、並列実行数、冪等性 | ○ |
|
|
72
|
+
| error_handling | 再試行対象、試行上限、待機方式、タイムアウト時、出力解析失敗時、認証失敗時の処置 | ○ |
|
|
73
|
+
|
|
74
|
+
引数が無いコマンドは `arguments: []` を明示できます。`exit_codes` は空配列にせず、少なくとも成功と代表的な失敗を記載します。
|
|
75
|
+
|
|
76
|
+
## 6. 記述ガイド
|
|
77
|
+
|
|
78
|
+
### 6.1. command と arguments
|
|
79
|
+
|
|
80
|
+
- `command.executable` は実行可能ファイル名または配布済みパスを記載し、引数やパイプを連結しない。`command.subcommands` は起動順の文字列配列とする。
|
|
81
|
+
- `command.shell` は `false` 固定とする。複数コマンドの連携は実行側のワークフローで表し、文字列のシェルスクリプトとして仕様化しない。
|
|
82
|
+
|
|
83
|
+
- `arguments[].kind` は `option` / `positional`、`value_type` は `string` / `integer` / `boolean` / `path` / `json`、`value_source` は `literal` / `config` / `generated` のいずれかとする。
|
|
84
|
+
- positional 引数は `position` を 1 始まりで付け、option 引数は `name` に CLI の表記を記載する。可変値は `example` に実値ではなく公開可能な例を置く。
|
|
85
|
+
|
|
86
|
+
### 6.2. stdin/stdout/stderr
|
|
87
|
+
|
|
88
|
+
- `streams.stdin.mode` は `none` / `optional` / `required` とし、`required` または `optional` の場合は `format`、`encoding`、入力の意味を記載する。
|
|
89
|
+
- `streams.stdout` は成功時に呼び出し元が解析する形式と最小契約を記載する。機械処理する場合は `json` または `jsonl` を優先し、人向けの可変文言に依存しない。
|
|
90
|
+
- `streams.stderr` は進捗、警告、失敗詳細のどれが出力されるかを記載する。stderr の文言だけで成否を判定せず、終了コードと構造化出力を優先する。
|
|
91
|
+
- 形式は `text` / `json` / `jsonl` / `yaml` / `binary` / `none` から選び、テキスト形式には原則 `UTF-8` を指定する。
|
|
92
|
+
|
|
93
|
+
### 6.3. exit_codes
|
|
94
|
+
|
|
95
|
+
| キー | 記載内容 | 必須 |
|
|
96
|
+
| ------- | ------------------------------------------ | ---- |
|
|
97
|
+
| code | CLI が返す整数の終了コード | ○ |
|
|
98
|
+
| meaning | CLI 固有の意味と呼び出し元が識別できる条件 | ○ |
|
|
99
|
+
|
|
100
|
+
| category | `success` / `input_error` / `authentication_error` / `authorization_error` / `rate_limit` / `transient_failure` / `permanent_failure` | ○ |
|
|
101
|
+
| retryable | 同じ入力で自動再試行してよいか | ○ |
|
|
102
|
+
|
|
103
|
+
複数の意味に使われる終了コードは、追加の判定条件を `meaning` に記載します。汎用的な非 0 のみを `rate_limit` や `transient_failure` とみなさず、専用コードまたは構造化出力で識別できる場合だけその category を使用します。
|
|
104
|
+
|
|
105
|
+
### 6.4. authentication
|
|
106
|
+
|
|
107
|
+
- `method` は `none` / `api_token` / `oauth` / `ssh_key` / `provider_login` から選び、連携先が要求する認証の種類を示す。
|
|
108
|
+
- `injection.mechanism` は `none` / `environment_variable` / `credential_store` / `workload_identity` / `cli_profile` から選び、必要な参照名を `injection.names` に列挙する。
|
|
109
|
+
- `secret_source` に値を供給する管理境界を記載し、`log_policy` に引数、環境変数、stdout/stderr のマスク条件を記載する。
|
|
110
|
+
- 認証トークン、秘密鍵、パスワード、認証プロファイルの実パスを記載しない。コマンド引数への秘密値の埋め込みも許可しない。
|
|
111
|
+
|
|
112
|
+
### 6.5. execution と error_handling
|
|
113
|
+
|
|
114
|
+
- `execution.timeout_seconds` は 1 回の起動上限、`max_parallel` は同時実行上限とし、コマンドの公開契約や実測根拠から決める。
|
|
115
|
+
- `execution.idempotency` は `guaranteed` とその条件を記載する。副作用のあるコマンドを再試行する場合は、リクエスト ID など重複実行を防ぐ条件を明示する。
|
|
116
|
+
- `error_handling.retry.on_categories` は `exit_codes` の category と一致させ、`max_attempts` と `backoff` を記載する。認証失敗や入力不正は自動再試行しない。
|
|
117
|
+
|
|
118
|
+
- タイムアウト時のプロセス終了、不完全出力の破棄、stdout の解析失敗、認証失敗の再認証依頼をそれぞれ別のキーで記載する。
|
|
119
|
+
|
|
120
|
+
## 7. 禁止事項
|
|
121
|
+
|
|
122
|
+
- 実行可能ファイル、サブコマンド、引数を 1 本のシェル文字列として記載しない。`command.shell: true`、パイプ、リダイレクト、コマンド置換は使用しない。
|
|
123
|
+
- トークン、パスワード、秘密鍵、秘密値を含む URL、個人環境に固有の認証パスを本文や例に記載しない。
|
|
124
|
+
- 標準出力と標準エラーを混同したり、出力形式を「CLI の既定」とだけ記載したり、終了コードの意味を定義せずに成否判定を文言解析に依存しない。
|
|
125
|
+
- 副作用があるコマンドを冪等性条件なしで自動再試行対象にしない。認証失敗、認可失敗、入力不正を一時失敗として扱わない。
|
|
126
|
+
- DB 物理構造、内部クラス名、プロセス起動ライブラリの API 呼び出し、スクリプト全文などの実装詳細を含めない。
|
|
127
|
+
|
|
128
|
+
## 8. サンプル
|
|
129
|
+
|
|
130
|
+
```yaml
|
|
131
|
+
id: ifx-cmd-supplier-order
|
|
132
|
+
type: command
|
|
133
|
+
title: 仕入先への発注登録コマンド連携仕様
|
|
134
|
+
status: draft
|
|
135
|
+
rulebook: specdojo:ifx-cmd-rulebook
|
|
136
|
+
version: 1
|
|
137
|
+
|
|
138
|
+
command:
|
|
139
|
+
executable: supplier-cli
|
|
140
|
+
subcommands: [orders, submit]
|
|
141
|
+
purpose: 確定した発注データを仕入先サービスへ登録する
|
|
142
|
+
version_constraint: ">=2.1.0 <3.0.0"
|
|
143
|
+
shell: false
|
|
144
|
+
|
|
145
|
+
arguments:
|
|
146
|
+
- name: --file
|
|
147
|
+
kind: option
|
|
148
|
+
required: true
|
|
149
|
+
value_type: path
|
|
150
|
+
value_source: generated
|
|
151
|
+
description: 発注データ JSON のパス
|
|
152
|
+
example: tmp/orders/ORD-0001.json
|
|
153
|
+
- name: --request-id
|
|
154
|
+
kind: option
|
|
155
|
+
required: true
|
|
156
|
+
value_type: string
|
|
157
|
+
value_source: generated
|
|
158
|
+
description: 重複登録を防ぐリクエスト ID
|
|
159
|
+
example: req-order-0001
|
|
160
|
+
|
|
161
|
+
streams:
|
|
162
|
+
stdin:
|
|
163
|
+
mode: none
|
|
164
|
+
format: none
|
|
165
|
+
stdout:
|
|
166
|
+
format: json
|
|
167
|
+
encoding: UTF-8
|
|
168
|
+
description: order_id と accepted_at を含む登録結果
|
|
169
|
+
stderr:
|
|
170
|
+
format: text
|
|
171
|
+
encoding: UTF-8
|
|
172
|
+
description: 診断情報。認証情報は出力しない
|
|
173
|
+
|
|
174
|
+
exit_codes:
|
|
175
|
+
- code: 0
|
|
176
|
+
meaning: 発注を登録した、または同じ request_id の登録済み結果を返した
|
|
177
|
+
category: success
|
|
178
|
+
retryable: false
|
|
179
|
+
- code: 2
|
|
180
|
+
meaning: 引数または発注データが不正
|
|
181
|
+
category: input_error
|
|
182
|
+
retryable: false
|
|
183
|
+
- code: 75
|
|
184
|
+
meaning: 仕入先サービスが一時的に利用できない
|
|
185
|
+
category: transient_failure
|
|
186
|
+
retryable: true
|
|
187
|
+
|
|
188
|
+
authentication:
|
|
189
|
+
method: api_token
|
|
190
|
+
injection:
|
|
191
|
+
mechanism: environment_variable
|
|
192
|
+
names: [SUPPLIER_CLI_TOKEN]
|
|
193
|
+
secret_source: 実行環境のシークレットストア
|
|
194
|
+
log_policy: 環境変数の値をコマンド表示、stdout、stderr、エラー記録に出力しない
|
|
195
|
+
|
|
196
|
+
execution:
|
|
197
|
+
working_directory: repository_root
|
|
198
|
+
timeout_seconds: 60
|
|
199
|
+
network_required: true
|
|
200
|
+
max_parallel: 1
|
|
201
|
+
idempotency:
|
|
202
|
+
guaranteed: true
|
|
203
|
+
condition: 同じ --request-id を再送する
|
|
204
|
+
|
|
205
|
+
error_handling:
|
|
206
|
+
retry:
|
|
207
|
+
on_categories: [transient_failure]
|
|
208
|
+
max_attempts: 3
|
|
209
|
+
backoff: exponential
|
|
210
|
+
timeout_action: 子プロセスを終了し、不完全な stdout を破棄する
|
|
211
|
+
malformed_output_action: 再試行せず、出力解析失敗として停止する
|
|
212
|
+
authentication_failure_action: 再試行せず、認証状態の確認を依頼する
|
|
213
|
+
```
|