specdojo 0.7.0 → 0.9.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/.github/agents/specdojo-orchestrator.md +7 -3
- package/CHANGELOG.md +217 -0
- package/dist/catalog/build.js +24 -1
- package/dist/catalog/catalog.js +16 -14
- package/dist/catalog/plan.js +1 -1
- package/dist/catalog/scaffold.js +4 -1
- package/dist/commands/agent.js +5 -3
- package/dist/commands/build.js +69 -10
- package/dist/commands/git.js +206 -0
- package/dist/commands/init.js +9 -3
- package/dist/commands/night-orchestrator.js +6 -4
- package/dist/commands/where.js +25 -0
- package/dist/dashboard/dashboard-timeline.js +18 -16
- package/dist/dashboard/dashboard.js +616 -261
- package/dist/dashboard/epic-plan.js +81 -0
- package/dist/dashboard/exec-records.js +16 -20
- package/dist/dashboard/routines.js +11 -12
- package/dist/dashboard/timeline-build.js +5 -9
- package/dist/dashboard/timeline.js +23 -18
- package/dist/devcontainer/scaffold.js +18 -0
- package/dist/docs/frontmatter-namespace.js +1 -48
- package/dist/docs/index-command.js +2 -2
- package/dist/docs/yaml-business-tables.js +243 -0
- package/dist/docs/yaml-interface-tables.js +106 -0
- package/dist/docs/yaml-pages-command.js +5 -3
- package/dist/docs/yaml-pages.js +268 -3
- package/dist/docs/yaml-table-shared.js +70 -0
- package/dist/docs/yaml-tables.js +39 -0
- package/dist/exec/agent-config.js +31 -0
- package/dist/exec/agent-plan.js +3 -2
- package/dist/exec/agent-protected-config.js +2 -0
- package/dist/exec/commands.js +100 -39
- package/dist/exec/commit-hook-skips.js +78 -0
- package/dist/exec/core.js +19 -7
- package/dist/exec/events.js +179 -8
- package/dist/exec/evidence.js +77 -19
- package/dist/exec/handoff.js +9 -13
- package/dist/exec/limit.js +1 -1
- package/dist/exec/mechanical-result.js +45 -0
- package/dist/exec/migrate-records.js +249 -0
- package/dist/exec/parent-validation.js +209 -15
- package/dist/exec/pipeline-state.js +27 -5
- package/dist/exec/plans-condense-findings.js +89 -0
- package/dist/exec/plans-core.js +45 -19
- package/dist/exec/plans-generation.js +52 -30
- package/dist/exec/plans-grade-findings.js +8 -3
- package/dist/exec/plans-kata-findings.js +61 -0
- package/dist/exec/plans-planning.js +3 -3
- package/dist/exec/plans-storage.js +12 -24
- package/dist/exec/post-integration.js +162 -0
- package/dist/exec/queue-command.js +166 -0
- package/dist/exec/queue.js +285 -0
- package/dist/exec/register-foreign-wait.js +84 -0
- package/dist/exec/register-resume.js +55 -56
- package/dist/exec/register.js +26 -22
- package/dist/exec/repo-integration-sync.js +21 -5
- package/dist/exec/repo-integration.js +21 -1
- package/dist/exec/reporter.js +121 -23
- package/dist/exec/results.js +106 -25
- package/dist/exec/review-completion.js +47 -0
- package/dist/exec/review-kata.js +112 -0
- package/dist/exec/run/agent-pipeline.js +78 -8
- package/dist/exec/run/agent.js +32 -13
- package/dist/exec/run/change-scope.js +365 -0
- package/dist/exec/run/deferred-cleanup.js +31 -0
- package/dist/exec/run/in-place.js +73 -33
- package/dist/exec/run/job-lock.js +66 -0
- package/dist/exec/run/job-sequence.js +137 -0
- package/dist/exec/run/job.js +135 -41
- package/dist/exec/run/lifecycle-commands.js +189 -37
- package/dist/exec/run/lock.js +22 -1
- package/dist/exec/run/mode-shared.js +11 -3
- package/dist/exec/run/register-command.js +14 -15
- package/dist/exec/run/register-core.js +20 -13
- package/dist/exec/run/register-mode.js +77 -17
- package/dist/exec/run/register-post-review.js +21 -9
- package/dist/exec/run/register-resume.js +95 -31
- package/dist/exec/run/register-state.js +23 -15
- package/dist/exec/run/register-worktree.js +184 -139
- package/dist/exec/run/schedule-mode.js +79 -18
- package/dist/exec/run/schedule-prepare.js +204 -59
- package/dist/exec/run/schedule-task.js +203 -49
- package/dist/exec/run/shared.js +9 -3
- package/dist/exec/run/trailing-records.js +35 -0
- package/dist/exec/run-records.js +2 -0
- package/dist/exec/schedule/schedule.js +116 -4
- package/dist/exec/shared.js +1 -1
- package/dist/exec/smoke.js +190 -0
- package/dist/exec/strategy.js +14 -3
- package/dist/exec/task-view.js +6 -4
- package/dist/exec/trailing-records.js +242 -0
- package/dist/exec/trial-commands.js +8 -4
- package/dist/exec/trial-core.js +6 -1
- package/dist/exec/validate-records-commit.js +110 -0
- package/dist/exec/validate-records.js +148 -0
- package/dist/exec/validation-metrics.js +181 -0
- package/dist/exec/worktree-cleanup-lock.js +26 -0
- package/dist/exec/worktree-command.js +38 -17
- package/dist/exec/worktree-ops-commit.js +119 -48
- package/dist/exec/worktree-ops-lifecycle.js +77 -48
- package/dist/exec/worktree-ops-merge.js +13 -2
- package/dist/exec/worktree-ops.js +2 -2
- package/dist/exec/worktree.js +32 -4
- package/dist/grade/apply.js +32 -6
- package/dist/grade/command-apply.js +3 -3
- package/dist/grade/command-inspect.js +7 -5
- package/dist/grade/command-plan.js +1 -1
- package/dist/grade/command-run.js +7 -1
- package/dist/grade/command-shared.js +1 -1
- package/dist/grade/core.js +18 -5
- package/dist/grade/markdown.js +3 -3
- package/dist/grade/pipeline-state.js +15 -11
- package/dist/grade/plan.js +37 -17
- package/dist/grade/result.js +3 -3
- package/dist/grade/run.js +87 -11
- package/dist/grade/target-discovery.js +17 -4
- package/dist/grade/targets.js +12 -11
- package/dist/job/definition.js +84 -8
- package/dist/job/job.js +109 -39
- package/dist/job/noop.js +104 -0
- package/dist/register/authoring-sources.js +22 -16
- package/dist/register/core.js +2 -0
- package/dist/register/create-commands.js +28 -3
- package/dist/register/deliverable-target.js +9 -1
- package/dist/register/epic.js +104 -26
- package/dist/register/event-merge.js +3 -0
- package/dist/register/events.js +4 -0
- package/dist/register/external-project.js +3 -0
- package/dist/register/item.js +6 -0
- package/dist/register/maintenance-commands.js +6 -3
- package/dist/register/planning.js +7 -14
- package/dist/register/register.js +74 -16
- package/dist/register/track-domains.js +34 -0
- package/dist/register/track-plan.js +78 -0
- package/dist/register/transition-commands.js +8 -0
- package/dist/register/work-table.js +64 -0
- package/dist/review/grade.js +35 -13
- package/dist/routine/definition.js +13 -3
- package/dist/routine/failure.js +30 -0
- package/dist/routine/routine.js +189 -71
- package/dist/routine/status.js +62 -0
- package/dist/routine/storage.js +33 -0
- package/dist/schedule/schedule.js +39 -39
- package/dist/schedule/strategy-generate-document.js +26 -14
- package/dist/schedule/strategy-generate-scope.js +17 -45
- package/dist/schedule/strategy-generate.js +33 -3
- package/dist/schedule/strategy-profiles.js +86 -12
- package/dist/shared/agent-types.js +7 -0
- package/dist/shared/condense-records.js +25 -0
- package/dist/shared/cross-process-lock.js +9 -1
- package/dist/shared/deprecation.js +8 -0
- package/dist/shared/dist-freshness.js +8 -2
- package/dist/shared/document-metadata.js +20 -0
- package/dist/shared/finding-cause.js +20 -0
- package/dist/shared/frontmatter-namespace.js +48 -0
- package/dist/shared/git-environment.js +2 -1
- package/dist/shared/git.js +186 -16
- package/dist/shared/grade-result.js +17 -1
- package/dist/shared/lefthook-scaffold.js +3 -0
- package/dist/shared/local-config.js +244 -0
- package/dist/shared/local-state.js +20 -0
- package/dist/shared/markdownlint-config.js +8 -3
- package/dist/shared/plan-conventions.js +129 -0
- package/dist/shared/plan-templates.js +57 -41
- package/dist/shared/run-records.js +224 -0
- package/dist/shared/specdojo-config.js +73 -41
- package/dist/shared/specdojo-gitignore.js +1 -0
- package/dist/shared/text.js +74 -6
- package/dist/shared/timeline-index.js +2 -0
- package/dist/shared/where-alias.js +13 -0
- package/dist/specdojo.js +4 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +11 -2
- package/docs/ja/specdojo/exec-templates/xep-common-conventions-template.md +4 -74
- package/docs/ja/specdojo/exec-templates/xep-condense-template.md +50 -0
- package/docs/ja/specdojo/exec-templates/xep-draft-template.md +17 -5
- package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +16 -3
- package/docs/ja/specdojo/exec-templates/xep-recipe-guided-template.md +15 -5
- package/docs/ja/specdojo/exec-templates/xep-recipe-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-register-template.md +1 -1
- package/docs/ja/specdojo/exec-templates/xep-rulebook-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-sample-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-template-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xer-condense-template.md +25 -0
- package/docs/ja/specdojo/exec-templates/xp-common-conventions-template.md +50 -0
- package/docs/ja/specdojo/exec-templates/xrp-common-conventions-template.md +30 -0
- package/docs/ja/specdojo/guides/branch-workflow-guide.md +1 -1
- package/docs/ja/specdojo/guides/docs-editing-guide.md +12 -0
- package/docs/ja/specdojo/guides/docs-structure-guide.md +48 -15
- package/docs/ja/specdojo/guides/exec-config-guide.md +69 -19
- package/docs/ja/specdojo/guides/exec-operation-guide.md +97 -18
- package/docs/ja/specdojo/guides/exec-worktree-guide.md +20 -11
- package/docs/ja/specdojo/guides/job-sequence-guide.md +77 -0
- package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +92 -55
- package/docs/ja/specdojo/guides/project-move-guide.md +381 -0
- package/docs/ja/specdojo/guides/quick-start-guide.md +73 -17
- package/docs/ja/specdojo/guides/register-operation-guide.md +26 -6
- package/docs/ja/specdojo/guides/remote-host-development-guide.md +2 -0
- package/docs/ja/specdojo/guides/review-guide.md +22 -19
- package/docs/ja/specdojo/guides/routine-operation-guide.md +23 -12
- package/docs/ja/specdojo/guides/ryu-guide.md +23 -13
- package/docs/ja/specdojo/guides/schedule-design-guide.md +27 -21
- package/docs/ja/specdojo/guides/schedule-operation-guide.md +27 -3
- package/docs/ja/specdojo/guides/specdojo-overview-guide.md +5 -4
- package/docs/ja/specdojo/guides/timeline-design-guide.md +27 -144
- package/docs/ja/specdojo/guides/use-case-guide.md +92 -155
- package/docs/ja/specdojo/guides/waza-guide.md +12 -8
- package/docs/ja/specdojo/recipes/bac-recipe.md +111 -0
- package/docs/ja/specdojo/recipes/bes-recipe.md +141 -0
- package/docs/ja/specdojo/recipes/bps-recipe.md +88 -139
- package/docs/ja/specdojo/recipes/br-recipe.md +77 -0
- package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +97 -109
- package/docs/ja/specdojo/recipes/cdfd-recipe.md +85 -146
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +92 -99
- package/docs/ja/specdojo/recipes/cnd-recipe.md +135 -0
- package/docs/ja/specdojo/recipes/cpd-recipe.md +140 -0
- package/docs/ja/specdojo/recipes/cxd-recipe.md +162 -0
- package/docs/ja/specdojo/recipes/ifd-recipe.md +145 -0
- package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +112 -90
- package/docs/ja/specdojo/recipes/ifx-index-recipe.md +164 -0
- package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +60 -49
- package/docs/ja/specdojo/recipes/pm-members-recipe.md +50 -51
- package/docs/ja/specdojo/recipes/pm-organization-recipe.md +59 -48
- package/docs/ja/specdojo/recipes/pm-plan-recipe.md +72 -50
- package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +40 -49
- package/docs/ja/specdojo/recipes/pm-raci-recipe.md +42 -48
- package/docs/ja/specdojo/recipes/pm-roles-recipe.md +52 -81
- package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +64 -91
- package/docs/ja/specdojo/recipes/prj-charter-recipe.md +71 -106
- package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +78 -156
- package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +62 -111
- package/docs/ja/specdojo/recipes/prj-scope-recipe.md +67 -123
- package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +60 -96
- package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +61 -105
- package/docs/ja/specdojo/recipes/stsd-recipe.md +88 -80
- package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +129 -0
- package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +146 -0
- package/docs/ja/specdojo/recipes/sysd-index-recipe.md +141 -0
- package/docs/ja/specdojo/recipes/tsd-recipe.md +149 -129
- package/docs/ja/specdojo/references/command-reference.md +303 -148
- package/docs/ja/specdojo/references/deliverables-reference.md +30 -16
- package/docs/ja/specdojo/references/directory-layout-reference.md +3 -2
- package/docs/ja/specdojo/references/specdojo-config-reference.md +54 -18
- package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +101 -257
- package/docs/ja/specdojo/rulebooks/atc-rulebook.md +102 -228
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +63 -290
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +162 -80
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +118 -155
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +128 -60
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +70 -94
- package/docs/ja/specdojo/rulebooks/bps-rulebook.md +24 -56
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +58 -103
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +103 -223
- package/docs/ja/specdojo/rulebooks/cdfd-d2-rulebook.md +18 -93
- package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +18 -52
- package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +109 -147
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +80 -108
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +51 -55
- package/docs/ja/specdojo/rulebooks/cdr-rulebook.md +144 -0
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +81 -68
- package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +139 -0
- package/docs/ja/specdojo/rulebooks/cld-rulebook.md +9 -184
- package/docs/ja/specdojo/rulebooks/clis-rulebook.md +170 -0
- package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +33 -86
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +79 -249
- package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +45 -131
- package/docs/ja/specdojo/rulebooks/cop-rulebook.md +69 -275
- package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +20 -112
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +79 -249
- package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +12 -145
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +115 -256
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +79 -109
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +119 -174
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +6 -14
- package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +22 -66
- package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +36 -94
- package/docs/ja/specdojo/rulebooks/dss-rulebook.md +171 -0
- package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +31 -131
- package/docs/ja/specdojo/rulebooks/etc-rulebook.md +50 -104
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +93 -57
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +63 -253
- package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +14 -20
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +79 -76
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +182 -237
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +111 -40
- package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +14 -22
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +23 -46
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +41 -64
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +16 -40
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +34 -61
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +27 -50
- package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +70 -199
- package/docs/ja/specdojo/rulebooks/itc-rulebook.md +65 -153
- package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +74 -150
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +12 -23
- package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +99 -176
- package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +35 -61
- package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +75 -117
- package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +31 -60
- package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +26 -81
- package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +32 -70
- package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +45 -87
- package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +48 -101
- package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +44 -80
- package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +59 -127
- package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +31 -50
- package/docs/ja/specdojo/rulebooks/opd-rulebook.md +42 -109
- package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +29 -42
- package/docs/ja/specdojo/rulebooks/opr-rulebook.md +29 -87
- package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +62 -84
- package/docs/ja/specdojo/rulebooks/otp-rulebook.md +11 -61
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +92 -102
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +25 -34
- package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +30 -53
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +23 -35
- package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +27 -45
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +45 -59
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +56 -66
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +54 -62
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +46 -65
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +28 -35
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +65 -97
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +6 -18
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +48 -78
- package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +23 -97
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +61 -153
- package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +43 -116
- package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +16 -51
- package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +47 -92
- package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +25 -84
- package/docs/ja/specdojo/rulebooks/sac-rulebook.md +44 -107
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +106 -32
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +111 -61
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +129 -59
- package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +90 -189
- package/docs/ja/specdojo/rulebooks/stc-rulebook.md +45 -105
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +46 -40
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +104 -68
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +64 -330
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +70 -263
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +58 -200
- package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +47 -60
- package/docs/ja/specdojo/rulebooks/tml-rulebook.md +4 -9
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +69 -71
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +65 -72
- package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +35 -46
- package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +49 -66
- package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +64 -139
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +91 -161
- package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +49 -144
- package/docs/ja/specdojo/rulebooks/utc-rulebook.md +67 -155
- package/docs/ja/specdojo/samples/bac-sample.md +106 -21
- package/docs/ja/specdojo/samples/bdd-sample.yaml +143 -35
- package/docs/ja/specdojo/samples/bds-sample.md +87 -21
- package/docs/ja/specdojo/samples/bes-index-sample.md +42 -20
- package/docs/ja/specdojo/samples/bes-sample.md +70 -21
- package/docs/ja/specdojo/samples/bps-sample.md +42 -54
- package/docs/ja/specdojo/samples/br-sample.md +57 -15
- package/docs/ja/specdojo/samples/ccd-sample.md +80 -19
- package/docs/ja/specdojo/samples/cdfd-sample.md +172 -99
- package/docs/ja/specdojo/samples/cdfd-uc-sample.md +9 -7
- package/docs/ja/specdojo/samples/cdr-sample.md +78 -0
- package/docs/ja/specdojo/samples/cdsd-sample.md +73 -20
- package/docs/ja/specdojo/samples/cdt-sample.md +116 -0
- package/docs/ja/specdojo/samples/cld-sample.md +3 -30
- package/docs/ja/specdojo/samples/clis-sample.md +125 -0
- package/docs/ja/specdojo/samples/cnd-sample.md +127 -21
- package/docs/ja/specdojo/samples/cpd-sample.md +136 -22
- package/docs/ja/specdojo/samples/cxd-sample.md +108 -22
- package/docs/ja/specdojo/samples/dct-index-sample.yaml +63 -17
- package/docs/ja/specdojo/samples/dec-sample.md +2 -3
- package/docs/ja/specdojo/samples/dss-sample.md +175 -0
- package/docs/ja/specdojo/samples/gl-sample.yaml +50 -14
- package/docs/ja/specdojo/samples/ifd-sample.md +105 -21
- package/docs/ja/specdojo/samples/ifx-api-sample.yaml +0 -2
- package/docs/ja/specdojo/samples/ifx-cmd-sample.yaml +91 -60
- package/docs/ja/specdojo/samples/ifx-file-sample.md +462 -21
- package/docs/ja/specdojo/samples/ifx-index-sample.yaml +87 -19
- package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +0 -2
- package/docs/ja/specdojo/samples/job-sequence.yaml +67 -0
- package/docs/ja/specdojo/samples/mip-index-sample.md +98 -20
- package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +26 -19
- package/docs/ja/specdojo/samples/pm-members-sample.yaml +37 -13
- package/docs/ja/specdojo/samples/pm-organization-sample.md +42 -21
- package/docs/ja/specdojo/samples/pm-plan-sample.md +78 -26
- package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +41 -22
- package/docs/ja/specdojo/samples/pm-raci-sample.md +63 -28
- package/docs/ja/specdojo/samples/pm-roles-sample.yaml +13 -12
- package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +33 -25
- package/docs/ja/specdojo/samples/prj-charter-sample.md +42 -59
- package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +83 -62
- package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +30 -33
- package/docs/ja/specdojo/samples/sf-index-sample.md +47 -20
- package/docs/ja/specdojo/samples/sf-sample.md +109 -21
- package/docs/ja/specdojo/samples/sld-sample.md +88 -21
- package/docs/ja/specdojo/samples/stsd-sample.md +54 -26
- package/docs/ja/specdojo/samples/sysd-critical-flows-sample.md +166 -21
- package/docs/ja/specdojo/samples/sysd-cross-cutting-policy-sample.md +178 -21
- package/docs/ja/specdojo/samples/sysd-index-sample.md +82 -21
- package/docs/ja/specdojo/samples/tml-sample.yaml +4 -1
- package/docs/ja/specdojo/samples/uis-sample.md +141 -20
- package/docs/ja/specdojo/standards/document-metadata-standard.md +33 -4
- package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +3 -1
- package/docs/ja/specdojo/standards/job-definition-standard.md +24 -9
- package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +1 -0
- package/docs/ja/specdojo/templates/bac-template.md +76 -0
- package/docs/ja/specdojo/templates/bes-template.md +56 -0
- package/docs/ja/specdojo/templates/br-template.md +64 -0
- package/docs/ja/specdojo/templates/cdfd-template.md +81 -54
- package/docs/ja/specdojo/templates/cdfd-uc-template.md +9 -5
- package/docs/ja/specdojo/templates/cdr-template.md +58 -0
- package/docs/ja/specdojo/templates/cnd-template.md +137 -0
- package/docs/ja/specdojo/templates/cpd-template.md +129 -0
- package/docs/ja/specdojo/templates/cxd-template.md +105 -0
- package/docs/ja/specdojo/templates/dct-data-model-cdt-template.yaml +40 -0
- package/docs/ja/specdojo/templates/dct-data-model-cld-template.yaml +7 -14
- package/docs/ja/specdojo/templates/dct-index-template.md +9 -20
- package/docs/ja/specdojo/templates/dct-project-management-template.yaml +5 -1
- package/docs/ja/specdojo/templates/ifd-template.md +86 -0
- package/docs/ja/specdojo/templates/ifx-cmd-template.yaml +44 -28
- package/docs/ja/specdojo/templates/ifx-index-template.yaml +40 -0
- package/docs/ja/specdojo/templates/opr-template.md +2 -4
- package/docs/ja/specdojo/templates/pm-organization-template.md +9 -3
- package/docs/ja/specdojo/templates/pm-plan-template.md +4 -4
- package/docs/ja/specdojo/templates/pm-quality-management-plan-template.md +17 -9
- package/docs/ja/specdojo/templates/pm-raci-template.md +24 -13
- package/docs/ja/specdojo/templates/pm-roles-template.yaml +3 -2
- package/docs/ja/specdojo/templates/prj-assumptions-constraints-dependencies-template.md +6 -3
- package/docs/ja/specdojo/templates/prj-comparison-of-alternatives-template.md +22 -19
- package/docs/ja/specdojo/templates/stsd-template.md +46 -21
- package/docs/ja/specdojo/templates/sysd-critical-flows-template.md +94 -0
- package/docs/ja/specdojo/templates/sysd-cross-cutting-policy-template.md +122 -0
- package/docs/ja/specdojo/templates/sysd-index-template.md +89 -0
- package/docs/specdojo/lib/yaml-metadata.cjs +7 -0
- package/docs/specdojo/schemas/v1/bdd.schema.yaml +25 -57
- package/docs/specdojo/schemas/v1/condense-records.schema.yaml +26 -0
- package/docs/specdojo/schemas/v1/dct.schema.yaml +10 -0
- package/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml +3 -0
- package/docs/specdojo/schemas/v1/esil.schema.yaml +7 -141
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +5 -1
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +95 -8
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +38 -0
- package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +14 -0
- package/docs/specdojo/schemas/v1/exec-result-frontmatter.schema.yaml +18 -0
- package/docs/specdojo/schemas/v1/finding-cause.schema.yaml +22 -0
- package/docs/specdojo/schemas/v1/grade-pipeline-state.schema.yaml +1 -1
- package/docs/specdojo/schemas/v1/grade-result.schema.yaml +2 -0
- package/docs/specdojo/schemas/v1/ifx-cmd.schema.yaml +65 -5
- package/docs/specdojo/schemas/v1/ifx-index.schema.yaml +142 -0
- package/docs/specdojo/schemas/v1/job-run.schema.yaml +23 -0
- package/docs/specdojo/schemas/v1/job.schema.yaml +63 -2
- package/docs/specdojo/schemas/v1/register-events.schema.yaml +2 -0
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +17 -1
- package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +2 -2
- package/package.json +10 -7
- package/templates/antigravity/orchestrator.md +7 -3
- package/templates/claude/agents/specdojo-orchestrator.md +7 -3
- package/templates/codex/agents/specdojo-orchestrator.toml +7 -3
- package/templates/codex/orchestrator.md +7 -3
- package/templates/devcontainer/tmux.conf +6 -0
- package/templates/init-exec-defaults.yaml +13 -0
- package/templates/lefthook/tools/specdojo-pre-commit.mjs +8 -0
- package/templates/opencode/agents/specdojo-orchestrator.md +8 -4
|
@@ -11,196 +11,216 @@ specdojo:
|
|
|
11
11
|
|
|
12
12
|
Technology Stack Detail Definition (TSD) Writing Recipe
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
採用した技術や実行基盤を、別の担当者が対象環境で再現し、利用できる状態か判断できる文書に仕上げるための作り方を示す。
|
|
15
15
|
|
|
16
16
|
## 1. このレシピの使い方
|
|
17
17
|
|
|
18
|
-
-
|
|
19
|
-
-
|
|
20
|
-
-
|
|
21
|
-
- 最後に、利用目的に対する採用設定、設定を反映する操作、確認結果の対応をたどる。文書 ID、設定項目名、確認項目名で根拠を追跡し、未実施の確認は残る作業として示す。
|
|
18
|
+
- TSD は、上位設計・非機能要件が求める利用場面と品質条件(Why)を引き継ぎ、採用する設定値と到達状態(What)を定め、導入・接続・確認・復旧の操作(How)で実現する。設定項目名と確認項目名で、採用値から反映操作と確認結果までたどれるようにする(Trace)。
|
|
19
|
+
- 「作成前に集める情報」をメモでそろえてから、「全体の作成手順」の順に書く。
|
|
20
|
+
- 書き終えたら「レビュー観点」で読み直し、「仕上げチェック」で確かめる。
|
|
22
21
|
|
|
23
22
|
## 2. 作成前に集める情報
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
秘密値は集めない。確かめられない点は _TODO_、決まっていない点は _UNDECIDED_、仮に置いた前提は _ASSUMPTION_ を付けてメモに残す。
|
|
26
25
|
|
|
27
|
-
|
|
26
|
+
| 項目 | 集める情報 | 取り出し元 |
|
|
27
|
+
| ------------------ | ------------------------------------------------------------------ | -------------------------------------------- |
|
|
28
|
+
| 利用目的 | 誰が何をできるようにするか、応える責務と品質条件 | 上位設計、非機能要件 |
|
|
29
|
+
| 文書の境界 | 技術一覧・基盤定義・接続設定・利用手順のどこに正本があるか | 技術一覧、既存の TSD |
|
|
30
|
+
| 環境と権限 | 実行場所ごとの OS、ランタイム、ユーザー、権限、依存の版、資源 | 対象環境での確認、構築担当者への確認 |
|
|
31
|
+
| 配置と経路 | プロセスの配置、通信方向、待受と接続先のアドレス、公開範囲 | 構成図、ネットワーク設定 |
|
|
32
|
+
| 設定の事実 | 導入済みの版、有効な設定値、保存先、優先順位、再起動の要否 | 対象環境での表示・照会の結果 |
|
|
33
|
+
| 採用の判断 | 決定済みの値と推奨候補、互換性・ライセンス・資源の制約 | 決定記録、公式情報、技術選定の担当者への確認 |
|
|
34
|
+
| 認証の仕組み | 認証方式、秘密の取得・保存・注入の方法、固有の接続先を公開できるか | 基盤の管理者への確認 |
|
|
35
|
+
| 確認の記録 | 最小の利用成功、期待結果、確認した環境・版・日付 | 確認の実行記録 |
|
|
36
|
+
| 継続利用と変更影響 | 切断・再起動・再構築で残る状態、旧方式との競合、撤去で失う状態 | 対象環境での試行、運用担当者への確認 |
|
|
28
37
|
|
|
29
|
-
|
|
30
|
-
| ------------------ | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
|
31
|
-
| 利用目的と根拠 | 誰が何をできるようにするか。上位設計のどの責務・品質条件に応えるか | カタログの `brief` または個票の `--input` |
|
|
32
|
-
| 文書の境界 | 技術一覧、既存の基盤定義、接続設定、利用手順のどこに正本があるか | カタログの `brief` または第 1 章(概要・位置づけ)の `_CONTEXT_:` |
|
|
33
|
-
| 環境と権限 | OS、実行環境、ユーザー、権限、依存の版、必要な CPU・メモリ・ディスクは何か。特別な条件がない項目はどれか | カタログの `brief`(共通基盤条件)または第 2 章(対象環境・前提条件)の `_CONTEXT_:` |
|
|
34
|
-
| 配置と経路 | 接続元、ホスト、コンテナ、サービスはどこで動き、どの方向へ通信するか。公開範囲はどこまでか | 第 3 章(全体構成・接続経路)の `_CONTEXT_:` または個票の `--input` |
|
|
35
|
-
| 設定の事実 | 導入済みの版、有効な設定、保存先、優先順位、再起動の要否を何で確認できるか | 第 5 章(導入・初期設定)の `_CONTEXT_:` または個票の `--input` |
|
|
36
|
-
| 採用の判断 | 決定済みの値と推奨候補は何か。互換性、ライセンス、資源の制約と採否の根拠は何か | カタログの `brief`(決定方針)または第 4 章(採用技術・設定)の `_CONTEXT_:`・`--input` |
|
|
37
|
-
| 認証と公開範囲 | 認証方式、秘密情報の取得・保存・参照の仕組みは何か。固有の接続先や識別子を公開できるか | 第 6 章(接続設定と秘密情報の扱い)の `_CONTEXT_:` または個票の `--input` |
|
|
38
|
-
| 確認と証跡 | 最小の利用成功は何か。確認場所、期待結果、確認環境・版・日付、記録先は何か | カタログの `done_criteria`(完了条件)または第 7 章(動作確認)の `_CONTEXT_:` |
|
|
39
|
-
| 継続利用と変更影響 | 切断、再起動、再構築で何が残るか。旧方式との競合、切り戻し、撤去で失う状態は何か | 第 8 章(継続利用・運用)・第 10 章(更新・復旧・撤去)の `_CONTEXT_:` |
|
|
40
|
-
|
|
41
|
-
### 2.1. 文脈の置き場所の使い分けの目安
|
|
42
|
-
|
|
43
|
-
- **カタログの `brief`**: プロジェクトや成果物群で共通する技術スタック・基盤前提(例: 「静的サイト構成とし、主流の技術スタック(Astro 等)を採用する」)。YAML アンカーで複数成果物へ共有できる。
|
|
44
|
-
- **個票の `入力`(`--input`)**: 起票時や対話で決まった前提、または agent に技術スタックの調査や選定を任せる範囲(例: `--input "静的サイトで主流の技術スタックを調べて選定する"`)。
|
|
45
|
-
- **成果物内の `_CONTEXT_:`**: `deliverable scaffold --project <project-id> --target <doc-id>` で生成した雛形の各章見出し直下に書く局所的な指示(カタログにない成果物は `--target-path` と `--target-rulebook` を指定。例: 第 4 章で `_CONTEXT_: 主流のフレームワークを比較し、選定理由と採用値を提案してください`)。`draft` が本文へ反映後に削除する。
|
|
38
|
+
agent に技術の調査や選定を任せる場合は、任せる範囲を起票時の入力に書き、特定の章への指示は雛形のその章に書く(例: 「採用技術・設定」に `_CONTEXT_: 主流のフレームワークを比較し、選定理由と採用値を提案してください`)。
|
|
46
39
|
|
|
47
40
|
## 3. 全体の作成手順
|
|
48
41
|
|
|
49
|
-
1.
|
|
50
|
-
2.
|
|
51
|
-
3.
|
|
52
|
-
4.
|
|
53
|
-
5.
|
|
54
|
-
6.
|
|
55
|
-
7.
|
|
56
|
-
8.
|
|
57
|
-
9.
|
|
58
|
-
10.
|
|
59
|
-
11.
|
|
42
|
+
1. 利用目的を一文にし、読み始める人の状態と、読み終えて確認する到達状態を書き出す。独立した目的が混ざっていたら、ここで別文書へ分ける。ほかの章の範囲はこの到達状態で決まる。
|
|
43
|
+
2. 初期構築・接続設定・日常利用を一冊にまとめるか分けるかを決める。同じ読み手が同じ前提で一続きに作業するならまとめ、構築済みの基盤へ複数のクライアントが接続する、または接続と再開だけを繰り返すなら分ける。
|
|
44
|
+
3. 接続元・ホスト・コンテナに呼び名を付け、「全体構成・接続経路」を先に描く。以降の章で実行場所と保存先をこの呼び名でそろえられる。
|
|
45
|
+
4. 「対象環境・前提条件」に、呼び名ごとの環境と権限を書く。
|
|
46
|
+
5. 「採用技術・設定」で採用値を決め、推奨候補・任意の選択肢・未決と分ける。
|
|
47
|
+
6. 「導入・初期設定」「接続設定と秘密情報の扱い」で、採用値を反映する順序を組み立てる。
|
|
48
|
+
7. 「動作確認」を基盤の起動から最終利用まで段階に分け、各段階の失敗が戻る先を決める。
|
|
49
|
+
8. 「継続利用・運用」「更新・復旧・撤去」に、切断・再起動・再構築・移行の影響を書く。
|
|
50
|
+
9. 「制約・トラブルシュート」を、動作確認の失敗先から症状別に組み立てる。動作確認を先に書くと、症状と確認箇所が対応する。
|
|
51
|
+
10. 「参照情報」に、採用判断と手順の根拠を集める。
|
|
52
|
+
11. 最後に「概要・位置づけ」を書く。担当範囲と別冊の開始条件は、ほかの章が決まってから書くと実態とずれない。
|
|
53
|
+
12. 本文・設定例・出力例を公開できるか読み直す。
|
|
60
54
|
|
|
61
55
|
## 4. 各章の書き方
|
|
62
56
|
|
|
63
|
-
以下は下書きを具体化するための順序である。各章を独立させるか、関連する章へまとめるかは、読み手が行う作業に合わせて選ぶ。
|
|
64
|
-
|
|
65
57
|
### 4.1. 概要・位置づけ
|
|
66
58
|
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
-
|
|
59
|
+
問い:
|
|
60
|
+
|
|
61
|
+
- 初期構築・接続・日常利用のどこを扱い、読み手は何を済ませてから読み始めるか。
|
|
62
|
+
- 扱わない作業は、どの文書で済ませるか。
|
|
63
|
+
|
|
64
|
+
コツ:
|
|
65
|
+
|
|
66
|
+
- 技術一覧の採用理由や上位設計の目的は写さず、参照に置き換える。
|
|
67
|
+
- 「関連技術の設定をまとめる」のように担当が決まらない書き方になったら、手順 1 の到達状態へ戻る。
|
|
70
68
|
|
|
71
69
|
### 4.2. 対象環境・前提条件
|
|
72
70
|
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
-
|
|
71
|
+
問い:
|
|
72
|
+
|
|
73
|
+
- コマンドを、どこで、誰が、どの shell と作業ディレクトリで実行するか。
|
|
74
|
+
- OS や版によって変わる条件はあるか。
|
|
75
|
+
|
|
76
|
+
コツ:
|
|
77
|
+
|
|
78
|
+
- 「ローカルで」と書きかけたら、端末・ホスト・コンテナのどれかを構築担当者に聞く。
|
|
79
|
+
- 実測した環境と一般的な推奨環境は聞き分けて別の行に書く。
|
|
76
80
|
|
|
77
81
|
### 4.3. 全体構成・接続経路
|
|
78
82
|
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
-
|
|
83
|
+
問い:
|
|
84
|
+
|
|
85
|
+
- どのプロセスがどこで動き、どこからどこへ接続するか。
|
|
86
|
+
- 待受アドレス、接続先アドレス、公開範囲は対応するか。
|
|
87
|
+
|
|
88
|
+
コツ:
|
|
89
|
+
|
|
90
|
+
- 端末・ホスト・コンテナの境界を先に描き、名前解決・ポート転送・トンネルは経路ごとに入口と出口を結ぶ。
|
|
91
|
+
- すべてを `localhost` と書くと、どの環境のアドレスか分からなくなる。
|
|
82
92
|
|
|
83
93
|
### 4.4. 採用技術・設定
|
|
84
94
|
|
|
85
|
-
|
|
86
|
-
- 書き方: 次の表へ、設定の適用範囲と確認方法まで一行でつなぐ。GUI 設定も画面項目・保存先・反映条件を調べる。推奨値を適用する場合は、採用を決めた記録を別に残す。
|
|
87
|
-
- 良い例: 「推奨候補の並列数は評価後に採否を決める。現行の採用値は有効値の確認結果に基づく」。避けたい例: 推奨値を無条件に採用済みの表へ混ぜる。
|
|
95
|
+
問い:
|
|
88
96
|
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
| 利用場面と構成要素 | 製品上の項目名 | 決定した値・単位・版 | 環境・ユーザー・プロセス | 根拠と適用条件 | 保存先・反映操作・有効値の確認 |
|
|
97
|
+
- その値は何を満たすために採用したか。
|
|
98
|
+
- 設定ファイルと環境変数のどちらが、実行中のプロセスへ届くか。
|
|
92
99
|
|
|
93
|
-
|
|
100
|
+
コツ:
|
|
94
101
|
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
| 推奨値 | 推奨する条件と採否の判断方法を添え、現行の採用値と分ける |
|
|
99
|
-
| 任意の選択肢 | 利用する場合の前提と追加確認を示し、共通手順から分岐させる |
|
|
100
|
-
| 確認不足 | _TODO_: 確認対象・方法・担当・確認時期を記す |
|
|
101
|
-
| 意思決定待ち | _UNDECIDED_: 選択肢・判断基準・担当・判断期限・未決による影響を記す |
|
|
102
|
-
| 仮の前提 | _ASSUMPTION_: 仮置きの根拠・成立条件・検証方法・担当・見直し時期を記す |
|
|
102
|
+
- 値ごとに「実測・決定・公式情報」のどれが根拠かを聞く。根拠が出ない版・容量・並列数は採用値に入れない。
|
|
103
|
+
- 推奨値を採る場合は、採用を決めた記録があるかを確かめる。
|
|
104
|
+
- GUI で設定する項目は、画面項目名と保存先を実際に開いて確かめる。
|
|
103
105
|
|
|
104
106
|
### 4.5. 導入・初期設定
|
|
105
107
|
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
-
|
|
108
|
+
問い:
|
|
109
|
+
|
|
110
|
+
- 何を先に導入し、どの保存先を変えるか。
|
|
111
|
+
- 既存の利用者設定を残せるか。再起動で何が影響を受けるか。
|
|
112
|
+
|
|
113
|
+
コツ:
|
|
114
|
+
|
|
115
|
+
- 変更ごとに「追加・部分変更・全体置換」のどれかを決めてから手順を書く。決めずに設定例を置くと、全体の上書きとして読まれやすい。
|
|
116
|
+
- 反映前に取るバックアップと、再起動が既存のセッションへ与える影響を管理者に聞く。
|
|
109
117
|
|
|
110
118
|
### 4.6. 接続設定と秘密情報の扱い
|
|
111
119
|
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
-
|
|
120
|
+
問い:
|
|
121
|
+
|
|
122
|
+
- 接続先の登録名、クライアントの選択名、リクエスト中の識別子は対応するか。
|
|
123
|
+
- 例に含める値を公開できるか。
|
|
115
124
|
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
125
|
+
コツ:
|
|
126
|
+
|
|
127
|
+
- 秘密値を読まずに、設定の仕組みと公開できるかを管理者に聞く。
|
|
128
|
+
- ポートや汎用ホスト名は、接続情報という理由だけで一律に隠さない。公開できるか不明な固有名は _TODO_ にして確認先を書く。
|
|
120
129
|
|
|
121
130
|
### 4.7. 動作確認
|
|
122
131
|
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
-
|
|
132
|
+
問い:
|
|
133
|
+
|
|
134
|
+
- 起動、疎通、認証、識別子の解決、実際の利用のうち、何を確かめたか。
|
|
135
|
+
- 失敗したら、一つ前のどの前提へ戻るか。
|
|
126
136
|
|
|
127
|
-
|
|
128
|
-
| -------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
|
129
|
-
| 基盤・プロセス | 基盤側で依存と起動状態、必要な有効値を確認する | 対象プロセスが稼働し、有効値が採用値に一致する。起動設定・反映操作・ログへ戻る |
|
|
130
|
-
| 名前解決・疎通 | 実際の接続元から対象の入口へ到達できるか確認する | 接続でき、所定の応答項目が返る。名前解決・待受・転送・公開範囲を調べる |
|
|
131
|
-
| 認証・識別子 | 認証方式と利用対象の登録名・選択名を確認する | 対象の権限と識別子で利用できる。認証の参照先・権限・登録名の対応へ戻る |
|
|
132
|
-
| 最小利用 | 小さい入力で一機能を実行し、クライアント経由でも確認する | 意図した結果が得られる。直接利用が成功するならクライアント固有設定を調べる |
|
|
137
|
+
コツ:
|
|
133
138
|
|
|
134
|
-
|
|
139
|
+
- 有効値や版は専用の表示・照会で確かめる。疎通の成功から設定の反映は推定できない。
|
|
140
|
+
- 負荷や応答時間を扱うなら、入力サイズ、並列数、初回か再実行か、測定方法、合否を決める時点をそろえて測る。
|
|
135
141
|
|
|
136
142
|
### 4.8. 継続利用・運用
|
|
137
143
|
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
-
|
|
144
|
+
問い:
|
|
145
|
+
|
|
146
|
+
- 切断の後にどこへ戻り、再接続だけで再開しないものは何か。
|
|
147
|
+
- 設定、認証状態、作業データ、実行中のセッションはどこに保存されるか。
|
|
148
|
+
|
|
149
|
+
コツ:
|
|
150
|
+
|
|
151
|
+
- 通信切断・プロセス再起動・環境再構築を、一つずつ仮に起こして確かめる。
|
|
152
|
+
- 組織の監視体制やバックアップ方針は書き始めず、運用設計の担当へ渡す。
|
|
141
153
|
|
|
142
154
|
### 4.9. 制約・トラブルシュート
|
|
143
155
|
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
-
|
|
156
|
+
問い:
|
|
157
|
+
|
|
158
|
+
- どの症状から、どの段階の失敗を疑うか。
|
|
159
|
+
- 確かめた制約と、まだ確かめていない条件はどれか。
|
|
160
|
+
|
|
161
|
+
コツ:
|
|
162
|
+
|
|
163
|
+
- 設定の削除や再インストールより先に、観測できる情報を確かめる順に並べる。
|
|
164
|
+
- 原因が確定していないものは仮説として書く。
|
|
147
165
|
|
|
148
166
|
### 4.10. 更新・復旧・撤去
|
|
149
167
|
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
-
|
|
168
|
+
問い:
|
|
169
|
+
|
|
170
|
+
- 旧方式と共存できるか。何を止め、何を保存してから変えるか。
|
|
171
|
+
- どの確認の結果で切り戻すか。
|
|
172
|
+
|
|
173
|
+
コツ:
|
|
174
|
+
|
|
175
|
+
- 競合する待受、自動起動、保存先を先に洗い出す。
|
|
176
|
+
- データの削除は撤去と別の選択として、影響と復元できるかを聞く。
|
|
153
177
|
|
|
154
178
|
### 4.11. 参照情報
|
|
155
179
|
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
-
|
|
180
|
+
問い:
|
|
181
|
+
|
|
182
|
+
- 採用判断や手順の主張を、どの資料や確認記録で確かめ直せるか。
|
|
183
|
+
- 適用した版や確認日は分かるか。
|
|
184
|
+
|
|
185
|
+
コツ:
|
|
186
|
+
|
|
187
|
+
- 参考に読んだ資料をすべて根拠に並べない。製品のトップページだけでは何を裏付けるか分からない。
|
|
159
188
|
|
|
160
189
|
## 5. 深掘り手順
|
|
161
190
|
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
191
|
+
内容が浅いときは、次の順で対応のない主張を探す。
|
|
192
|
+
|
|
193
|
+
1. 採用設定の各行が、どの利用目的・品質条件に応えるかを確かめる。戻れない行は、値を足すより先に採用理由を聞く。
|
|
194
|
+
2. 採用値ごとに、反映する操作と有効値の確認があるかを確かめる。shell で見える値と常駐プロセスが受け取る値は分けて見る。
|
|
195
|
+
3. 識別子を、登録・選択・確認の要求の三か所で照合し、食い違いを探す。
|
|
196
|
+
4. 確認済みに見える記述ごとに確認記録があるかを確かめ、なければ _TODO_ か _ASSUMPTION_ に戻す。
|
|
197
|
+
5. 別冊と同じ設定値を持つ箇所を探し、正本の側へ寄せて、参照側には差分だけを残す。
|
|
168
198
|
|
|
169
199
|
## 6. 良い例 / 悪い例
|
|
170
200
|
|
|
171
|
-
| 観点 | 良い例
|
|
172
|
-
| ---------------- |
|
|
173
|
-
| 文書の分け方 | 基盤導入と接続を分け、接続側に基盤の完了確認と差分だけを書く
|
|
174
|
-
| 実行場所 | ホストで起動し、接続元コンテナから疎通を確認する
|
|
175
|
-
| 値の根拠 | 現行の採用値と推奨候補を分け、未決には判断条件を付ける
|
|
176
|
-
| 設定の反映 | 保存先と優先順位を示し、反映後に対象プロセスの有効値を調べる
|
|
177
|
-
| 既存設定との統合 | 既存の接続先を保持して対象項目を追加する
|
|
178
|
-
|
|
|
179
|
-
|
|
|
180
|
-
| 秘密情報 | 公開可能な経路を示し、秘密値は保存・参照方法で説明する | 認証設定やログの全文を実値のまま貼る |
|
|
181
|
-
| 撤去 | 自動起動・本体・設定・データの扱いと復元可否を分ける | アンインストールに全データ削除を含める |
|
|
201
|
+
| 観点 | 良い例 | 悪い例 |
|
|
202
|
+
| ---------------- | -------------------------------------------------------------- | --------------------------------------------------- |
|
|
203
|
+
| 文書の分け方 | 基盤導入と接続を分け、接続側に基盤の完了確認と差分だけを書く | 分冊した双方へ同じ導入・設定を転載する |
|
|
204
|
+
| 実行場所 | ホストで起動し、接続元コンテナから疎通を確認する | 「端末で実行する」だけで場所を特定しない |
|
|
205
|
+
| 値の根拠 | 現行の採用値と推奨候補を分け、未決には判断条件を付ける | 手本の版・容量・並列数をそのまま必須にする |
|
|
206
|
+
| 設定の反映 | 保存先と優先順位を示し、反映後に対象プロセスの有効値を調べる | shell の値や API の応答だけで全設定の反映を断定する |
|
|
207
|
+
| 既存設定との統合 | 既存の接続先を保持して対象項目を追加する | 設定例で既存ファイル全体を無条件に置換する |
|
|
208
|
+
| 継続利用 | 切断後の再接続と処理の再開を区別する | 履歴が保存されれば進行中の処理も自動再開するとする |
|
|
209
|
+
| 秘密情報 | `<TOKEN>` を置き、実行時に credential store から渡す方法を示す | 実トークン付きの URL や認証設定の全文を貼る |
|
|
182
210
|
|
|
183
211
|
## 7. レビュー観点
|
|
184
212
|
|
|
185
|
-
| 観点 | 確認内容
|
|
186
|
-
| ------------ |
|
|
187
|
-
|
|
|
188
|
-
|
|
|
189
|
-
|
|
|
190
|
-
|
|
|
191
|
-
|
|
|
192
|
-
| 継続性と復旧 | 切断・再起動・再構築で保持・喪失する状態と、再開・切り戻し操作が対応するか |
|
|
193
|
-
| 公開適性 | 接続経路の説明を残しつつ、秘密値や機密の固有情報を本文・設定例・出力例から除けているか |
|
|
194
|
-
| 委譲と追跡 | 詳細 API・内部設計・組織的な運用方針を担当文書へ委ね、採用判断と確認の根拠を追跡できるか |
|
|
213
|
+
| 観点 | 確認内容 |
|
|
214
|
+
| ------------ | ---------------------------------------------------------------------------- |
|
|
215
|
+
| 文書の境界 | 一冊の開始状態と到達状態が分かり、分冊した設定の正本と差分をたどれるか |
|
|
216
|
+
| 再現性 | 別の担当者が、実行場所・shell・変更先を特定して同じ手順を進められるか |
|
|
217
|
+
| 判断の確度 | 採用値・推奨候補・任意の選択肢・未決・仮説が混ざっていないか |
|
|
218
|
+
| 継続性と復旧 | 切断・再起動・再構築で保持・喪失する状態と、再開・切り戻しの操作が対応するか |
|
|
219
|
+
| 委譲の境界 | 内部設計・詳細 API・組織の運用方針を書きすぎていないか |
|
|
195
220
|
|
|
196
221
|
## 8. 仕上げチェック
|
|
197
222
|
|
|
198
|
-
-
|
|
199
|
-
-
|
|
200
|
-
-
|
|
201
|
-
-
|
|
202
|
-
- 確認に期待結果と失敗時の確認先があり、疎通と設定反映、最小利用を別々に判定できる。未実施の確認を成功としていない。
|
|
203
|
-
- 継続利用や変更を扱う箇所には、状態の保存、再開、切り戻し、削除の影響が対応している。
|
|
204
|
-
- 秘密値を含めず、機密情報のプレースホルダーと実行時の取得・参照方法が対応している。
|
|
205
|
-
- 参照先の存在、表内の wikilink の区切りのエスケープ、見出し名による章参照を確かめた。未作成の文書はコード表記で仮置きしている。
|
|
206
|
-
- 確認不足・未決・仮の前提には担当と確認・判断の時期があり、判断や再現を妨げる点を読み手が識別できる。
|
|
223
|
+
- 採用設定の各行が利用目的に対応し、反映する操作と確認結果までたどれる。
|
|
224
|
+
- 構成の呼び名と、各操作の実行場所が一致している。
|
|
225
|
+
- 確認記録のない確認を、成功と書いていない。
|
|
226
|
+
- 本文・設定例・出力例・ログ例に秘密値がない。
|