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,327 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:docs-editing-guide
|
|
4
|
+
type: guide
|
|
5
|
+
status: ready
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# ドキュメント編集ガイド
|
|
9
|
+
|
|
10
|
+
Document Editing Guide
|
|
11
|
+
|
|
12
|
+
SpecDojo で扱うドキュメントの編集に役立つ、Visual Studio Code(VS Code)や各種ツールの設定や操作方法について説明します。
|
|
13
|
+
|
|
14
|
+
**対象読者**
|
|
15
|
+
|
|
16
|
+
- VS Code で SpecDojo の Markdown 文書を作成・編集する利用者
|
|
17
|
+
|
|
18
|
+
**この文書で分かること**
|
|
19
|
+
|
|
20
|
+
- 文書編集に役立つ VS Code 拡張と SpecDojo 拡張の導入方法・役割
|
|
21
|
+
- 見出し番号の付け方、Markdown プレビューの使い方、表の整形方法
|
|
22
|
+
|
|
23
|
+
**次に読む文書**
|
|
24
|
+
|
|
25
|
+
- 文書の配置は [ドキュメント構成ガイド](docs-structure-guide.md)、成果物の記述内容は対象の rulebook を参照してください。
|
|
26
|
+
|
|
27
|
+
## 1. VS Code 拡張を準備する
|
|
28
|
+
|
|
29
|
+
VS Code を使う場合は、次の拡張を用途に応じて導入してください。拡張の利用は推奨であり、
|
|
30
|
+
SpecDojo 文書そのものを VS Code 以外のエディタで編集することもできます。
|
|
31
|
+
|
|
32
|
+
| 拡張 | 拡張 ID | 役割 | 扱い |
|
|
33
|
+
| ------------------- | -------------------------------- | ---------------------------------------------------------- | -------------------------------------------- |
|
|
34
|
+
| remark | `unifiedjs.vscode-remark` | Markdown を remark の設定に従って整形します | このリポジトリの推奨拡張 |
|
|
35
|
+
| markdownlint | `davidanson.vscode-markdownlint` | Markdown の記法違反を編集中に表示します | このリポジトリの推奨拡張 |
|
|
36
|
+
| Markdown All in One | `yzhang.markdown-all-in-one` | 見出し番号を追加・更新します | 「見出しに番号を付与」の手順を使う場合に導入 |
|
|
37
|
+
| SpecDojo | `specdojo.vscode-specdojo` | 文書 ID のリンク表示・遷移と Markdown 表の整形を提供します | Marketplace 公開までは VSIX から手動で導入 |
|
|
38
|
+
|
|
39
|
+
リポジトリを VS Code で開くと、`.vscode/extensions.json` に記載された remark と markdownlint の
|
|
40
|
+
インストールが提案されます。Markdown All in One は、「見出しに番号を付与」の操作を使う場合に Marketplace
|
|
41
|
+
で拡張 ID を検索してインストールしてください。
|
|
42
|
+
|
|
43
|
+
### 1.1. SpecDojo 拡張を VSIX から導入する
|
|
44
|
+
|
|
45
|
+
現時点では SpecDojo 拡張を Marketplace で公開していないため、リポジトリのルートで次を実行して
|
|
46
|
+
VSIX を作成し、VS Code へインストールします。
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
cd packages/vscode-specdojo
|
|
50
|
+
npm ci
|
|
51
|
+
npm run package
|
|
52
|
+
code --install-extension vscode-specdojo-0.1.0.vsix
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
拡張のバージョンが変わった場合は、`npm run package` が出力した VSIX のファイル名を指定してください。
|
|
56
|
+
インストール後は、必要に応じて VS Code のウィンドウを再読み込みします。Marketplace 公開後は、
|
|
57
|
+
この手順を Marketplace からのインストールへ差し替え、`.vscode/extensions.json` の推奨拡張へ
|
|
58
|
+
SpecDojo を追加します。
|
|
59
|
+
|
|
60
|
+
### 1.2. SpecDojo 拡張でできること
|
|
61
|
+
|
|
62
|
+
SpecDojo 拡張は、ワークスペースの `.specdojo/doc-index.json` を使って文書 ID を解決します。
|
|
63
|
+
リンクが解決されない場合は、リポジトリのルートで `npx tsx src/specdojo.ts index build` を実行して
|
|
64
|
+
インデックスを更新してください。
|
|
65
|
+
|
|
66
|
+
| 機能 | 操作 |
|
|
67
|
+
| ---------------------- | --------------------------------------------------------------------------------------------------- |
|
|
68
|
+
| 文書リンクの表示・遷移 | Markdown の SpecDojo 文書リンクをクリックして対象文書を開きます。プレビュー内のリンクにも対応します |
|
|
69
|
+
| ID で文書を開く | コマンドパレットで `SpecDojo: Open Document by ID` を実行し、文書 ID を入力します |
|
|
70
|
+
| Markdown 表の整形 | 表内へカーソルを置き、コマンドパレットで `SpecDojo: Format Markdown Table` を実行します |
|
|
71
|
+
|
|
72
|
+
文書リンクは、本文では `[[id]]` または `[[id|表示名]]` と記述します。Markdown 表のセル内では、
|
|
73
|
+
列区切りとの衝突を避けるため `[[id\|表示名]]` と記述してください。
|
|
74
|
+
|
|
75
|
+
表整形の詳細と Prettier を併用する場合の注意点は「Markdown 表フォーマットガイド」を参照してください。
|
|
76
|
+
|
|
77
|
+
## 2. 見出しに番号を付与
|
|
78
|
+
|
|
79
|
+
### 2.1. コマンドで一括付与(いちばん簡単)
|
|
80
|
+
|
|
81
|
+
1. コマンドパレットを開く
|
|
82
|
+
- Windows / Linux: `Ctrl + Shift + P`
|
|
83
|
+
- macOS: `Cmd + Shift + P`
|
|
84
|
+
|
|
85
|
+
2. `section numbers` と入力
|
|
86
|
+
3. `Markdown All in One: Add/Update section numbers` を実行
|
|
87
|
+
|
|
88
|
+
これで例えば、
|
|
89
|
+
|
|
90
|
+
```md
|
|
91
|
+
## セクション1
|
|
92
|
+
|
|
93
|
+
### 小見出し
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
が、
|
|
97
|
+
|
|
98
|
+
```md
|
|
99
|
+
## 1. セクション1
|
|
100
|
+
|
|
101
|
+
### 1.1. 小見出し
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### 2.2. 「#(タイトル)は番号なし、## から番号にしたい」場合
|
|
105
|
+
|
|
106
|
+
「ドキュメントのタイトル(`#`)は番号を付けず、`##` から 1, 1.1…にしたい」ケースが多いです。
|
|
107
|
+
その場合は見出しレベルの対象範囲を設定してから、上の `Add/Update section numbers` を実行します。
|
|
108
|
+
|
|
109
|
+
`settings.json` に例としてこれを追加:
|
|
110
|
+
|
|
111
|
+
```json
|
|
112
|
+
"markdown.extension.toc.levels": "2..6"
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
これで `##`〜`######` を対象にしやすくなります(タイトル `#` を“番号の起点”にしない運用)。
|
|
116
|
+
|
|
117
|
+
### 2.3. 注意点(地味にハマりどころ)
|
|
118
|
+
|
|
119
|
+
- この機能は「表示だけで番号を出す」のではなく、見出しテキスト自体を書き換えます(`## 1. 見出し` のように)。
|
|
120
|
+
→ 見出しへのリンク(`[...](#見出し)`)を手で書いていると、番号付与後にズレることがあります。
|
|
121
|
+
|
|
122
|
+
## 3. Markdown プレビューの使い方
|
|
123
|
+
|
|
124
|
+
VS Code では、Markdown ファイルを編集しながら、
|
|
125
|
+
リアルタイムで表示結果を確認できます。
|
|
126
|
+
|
|
127
|
+
ドキュメント作成・レビュー時には、必ずプレビューを併用してください。
|
|
128
|
+
|
|
129
|
+
### 3.1. 基本操作
|
|
130
|
+
|
|
131
|
+
#### 3.1.1. プレビューを開く
|
|
132
|
+
|
|
133
|
+
- Windows / Linux: `Ctrl + Shift + V`
|
|
134
|
+
- macOS: `Cmd + Shift + V`
|
|
135
|
+
|
|
136
|
+
現在の Markdown ファイルのプレビューが開きます。
|
|
137
|
+
|
|
138
|
+
#### 3.1.2. 編集画面とプレビューを並べて表示(推奨)
|
|
139
|
+
|
|
140
|
+
- Windows / Linux: `Ctrl + K` → `V`
|
|
141
|
+
- macOS: `Cmd + K` → `V`
|
|
142
|
+
|
|
143
|
+
画面が左右に分割され、
|
|
144
|
+
|
|
145
|
+
- 左:Markdown 編集
|
|
146
|
+
- 右:プレビュー
|
|
147
|
+
|
|
148
|
+
という構成になります。
|
|
149
|
+
|
|
150
|
+
このモードで編集すると、変更内容が即座にプレビューへ反映されるため、
|
|
151
|
+
レイアウト・表・見出し構成を確認しながら作業できます。
|
|
152
|
+
|
|
153
|
+
### 3.2. おすすめの使い方
|
|
154
|
+
|
|
155
|
+
1. ドキュメントを開く
|
|
156
|
+
2. `Ctrl/Cmd + K` → `V` で分割プレビュー
|
|
157
|
+
3. 表や見出しを編集
|
|
158
|
+
4. プレビューで表示を最終確認
|
|
159
|
+
|
|
160
|
+
### 3.3. よくあるミス
|
|
161
|
+
|
|
162
|
+
| ミス | 防止策 |
|
|
163
|
+
| ------------------------------ | -------------------------- |
|
|
164
|
+
| 表のレイアウト崩れに気づかない | 常に分割プレビューを使う |
|
|
165
|
+
| 見出し階層の誤り | プレビューの目次表示で確認 |
|
|
166
|
+
| 空行不足による段落崩れ | プレビューで段落境界を確認 |
|
|
167
|
+
|
|
168
|
+
### 3.4. なぜプレビューが重要か
|
|
169
|
+
|
|
170
|
+
Markdown は書いた内容=表示結果ではありません。
|
|
171
|
+
特に以下は、必ずプレビューで確認してください。
|
|
172
|
+
|
|
173
|
+
- 表の崩れ
|
|
174
|
+
- 箇条書きのネスト
|
|
175
|
+
- 見出しレベル
|
|
176
|
+
- 改行位置
|
|
177
|
+
|
|
178
|
+
## 4. Markdown 表フォーマットガイド
|
|
179
|
+
|
|
180
|
+
本プロジェクトでは、Markdown の表を常に読みやすく・統一された形式に保つため、
|
|
181
|
+
専用の表フォーマット機能を用意しています。
|
|
182
|
+
|
|
183
|
+
VS Code の拡張機能で用意されている表のフォーマッターは多々ありますが、
|
|
184
|
+
列幅を合わせるために一行の変更が表全てに及ぶことがあり、Git の差分が大きくなりがちです。
|
|
185
|
+
本機能は、表内の不要な差分を最小化することに特化しています。
|
|
186
|
+
|
|
187
|
+
- 列数が少ない表(5列以下が目安)については、VS Code 標準の表フォーマッターを使ってください。
|
|
188
|
+
- 列数が多い表については、本機能を使ってください。なお、本プロジェクトでは Prettier を使っているため、競合を避けるには表の直前に `<!-- prettier-ignore -->` のコメントを挿入してください。
|
|
189
|
+
|
|
190
|
+
このガイドでは、本機能の使い方と設計思想を説明します。
|
|
191
|
+
|
|
192
|
+
この機能は SpecDojo VS Code 拡張の `SpecDojo: Format Markdown Table` コマンドとして提供します。
|
|
193
|
+
|
|
194
|
+
### 4.1. この機能で何が起きるか
|
|
195
|
+
|
|
196
|
+
表をフォーマットすると、以下のルールが適用されます。
|
|
197
|
+
|
|
198
|
+
- 左寄せ
|
|
199
|
+
|
|
200
|
+
- 各セルの左右に必ず1スペース
|
|
201
|
+
|
|
202
|
+
- 区切り行は必ず次の形式に統一
|
|
203
|
+
|
|
204
|
+
```text
|
|
205
|
+
| --- | --- | --- |
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
- 列幅の自動調整は行わない
|
|
209
|
+
- (Git の差分が不要に大きくならないため)
|
|
210
|
+
|
|
211
|
+
- セルの内容は一切変更されない
|
|
212
|
+
- `_` や `*` などの文字もそのまま保持されます
|
|
213
|
+
|
|
214
|
+
#### 4.1.1. 例
|
|
215
|
+
|
|
216
|
+
フォーマット前:
|
|
217
|
+
|
|
218
|
+
```text
|
|
219
|
+
|a|bbb|c|
|
|
220
|
+
|-|--|----|
|
|
221
|
+
|1| 2|3|
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
フォーマット後:
|
|
225
|
+
|
|
226
|
+
```text
|
|
227
|
+
| a | bbb | c |
|
|
228
|
+
| --- | --- | --- |
|
|
229
|
+
| 1 | 2 | 3 |
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
### 4.2. 使い方
|
|
233
|
+
|
|
234
|
+
#### 4.2.1. Step 1:カーソルを表の中に置く
|
|
235
|
+
|
|
236
|
+
Markdown ファイルを開き、
|
|
237
|
+
フォーマットしたい表の中にカーソルを置きます。
|
|
238
|
+
|
|
239
|
+
> このとき、カーソルが置かれている表だけが整形されます。
|
|
240
|
+
> ファイル内の他の表は一切変更されません。
|
|
241
|
+
|
|
242
|
+
#### 4.2.2. Step 2:コマンドを実行
|
|
243
|
+
|
|
244
|
+
コマンドパレットを開きます。
|
|
245
|
+
|
|
246
|
+
- Windows / Linux: `Ctrl + Shift + P`
|
|
247
|
+
- macOS: `Cmd + Shift + P`
|
|
248
|
+
|
|
249
|
+
次のコマンドを実行してください。
|
|
250
|
+
|
|
251
|
+
```text
|
|
252
|
+
SpecDojo: Format Markdown Table
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
即座に表が整形されます。
|
|
256
|
+
|
|
257
|
+
### 4.3. この仕組みを使う理由
|
|
258
|
+
|
|
259
|
+
この方式により、次のメリットがあります。
|
|
260
|
+
|
|
261
|
+
- ドキュメントの可読性が向上
|
|
262
|
+
- 表の形式がチーム全体で統一
|
|
263
|
+
- Git の差分が最小化
|
|
264
|
+
- フォーマッタによる意図しない変換(`\_` など)を防止
|
|
265
|
+
|
|
266
|
+
### 4.4. (任意)ショートカットの設定
|
|
267
|
+
|
|
268
|
+
よく使う場合は、各自でショートカットを設定できます。
|
|
269
|
+
|
|
270
|
+
1. `Keyboard Shortcuts` を開く
|
|
271
|
+
|
|
272
|
+
2. 次のコマンドを検索
|
|
273
|
+
|
|
274
|
+
```text
|
|
275
|
+
SpecDojo: Format Markdown Table
|
|
276
|
+
```
|
|
277
|
+
|
|
278
|
+
3. 好きなキーを割り当てる
|
|
279
|
+
|
|
280
|
+
### 4.5. 注意事項
|
|
281
|
+
|
|
282
|
+
- 標準的な GitHub Flavored Markdown の表に対応しています
|
|
283
|
+
- Prettier と競合するため、この機能を使う場合は、表の直前に `<!-- prettier-ignore -->` のコメントを挿入して Prettier の整形を無効化してください
|
|
284
|
+
- 表以外の文章には影響しません
|
|
285
|
+
|
|
286
|
+
## 5. 文書 lint を導入する
|
|
287
|
+
|
|
288
|
+
SpecDojo の schema と文書 lint を利用するリポジトリでは、CLI 本体と lint パッケージを開発依存へ追加します。
|
|
289
|
+
|
|
290
|
+
```bash
|
|
291
|
+
npm install --save-dev specdojo @specdojo/docs-lint
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
リポジトリルートの `.remarkrc.yaml` では、remark プラグインを公開 export から参照します。次の例は、山括弧プレースホルダ、文書構成 schema、frontmatter schema を検査する構成です。
|
|
295
|
+
|
|
296
|
+
```yaml
|
|
297
|
+
plugins:
|
|
298
|
+
- remark-parse
|
|
299
|
+
- - remark-frontmatter
|
|
300
|
+
- type: yaml
|
|
301
|
+
marker: "-"
|
|
302
|
+
- remark-gfm
|
|
303
|
+
- remark-lint
|
|
304
|
+
- "@specdojo/docs-lint/remark/no-unescaped-angle-placeholder"
|
|
305
|
+
- - "@specdojo/docs-lint/remark/md-content"
|
|
306
|
+
- schemas:
|
|
307
|
+
docs/ja/specdojo/schemas/v1/guide-content.schema.yaml:
|
|
308
|
+
- docs/ja/specdojo/guides/*-guide.md
|
|
309
|
+
- - "@specdojo/docs-lint/remark/frontmatter-ajv2020"
|
|
310
|
+
- strict: true
|
|
311
|
+
schemaRules:
|
|
312
|
+
- glob: docs/ja/specdojo/guides/**/*.md
|
|
313
|
+
schema: docs/specdojo/schemas/v1/guide-frontmatter.schema.yaml
|
|
314
|
+
require_frontmatter: true
|
|
315
|
+
```
|
|
316
|
+
|
|
317
|
+
設定内の `docs/specdojo/` または `docs/ja/specdojo/` 配下の schema がリポジトリ内にない場合、プラグインと CLI は `specdojo` パッケージに同梱された schema を解決します。検証コマンドは次のように実行します。
|
|
318
|
+
|
|
319
|
+
```bash
|
|
320
|
+
npx remark "docs/**/*.{md,mdx}" --quiet --frail
|
|
321
|
+
npx specdojo-docs-lint yaml-schema --modeline
|
|
322
|
+
npx specdojo-docs-lint rulebook-schema-enums
|
|
323
|
+
npx specdojo-docs-lint history-links
|
|
324
|
+
npx specdojo-docs-lint md-content \
|
|
325
|
+
--schema docs/ja/specdojo/schemas/v1/guide-content.schema.yaml \
|
|
326
|
+
--data "docs/ja/specdojo/guides/*-guide.md"
|
|
327
|
+
```
|