specdojo 0.4.6 → 0.5.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 +14 -9
- package/CHANGELOG.md +62 -0
- package/dist/catalog/document-target.js +75 -0
- package/dist/commands/agent.js +2 -80
- package/dist/commands/init.js +3 -0
- package/dist/commands/night-orchestrator.js +33 -4
- package/dist/dashboard/dashboard.js +5 -6
- package/dist/dashboard/timeline-build.js +5 -1
- package/dist/dashboard/timeline.js +6 -3
- package/dist/docs/yaml-pages.js +17 -17
- package/dist/exec/agent-config.js +28 -16
- package/dist/exec/agent-plan.js +108 -0
- package/dist/exec/commands.js +3 -3
- package/dist/exec/core.js +2 -0
- package/dist/exec/grade-checkpoint.js +12 -0
- package/dist/exec/pipeline-state.js +5 -2
- package/dist/exec/plans-core.js +7 -67
- package/dist/exec/plans-generation.js +28 -7
- package/dist/exec/plans-grade-findings.js +16 -0
- package/dist/exec/plans-planning.js +43 -0
- package/dist/exec/plans-storage.js +5 -2
- package/dist/exec/project.js +4 -1
- package/dist/exec/register.js +82 -6
- package/dist/exec/repo-integration-sync.js +9 -0
- package/dist/exec/repo-integration.js +17 -2
- package/dist/exec/repo-trace.js +17 -4
- package/dist/exec/results.js +2 -0
- package/dist/exec/run/lifecycle-commands.js +2 -0
- package/dist/exec/run/register-core.js +11 -0
- package/dist/exec/run/register-mode.js +19 -1
- package/dist/exec/run/register-resume.js +23 -0
- package/dist/exec/run/register-state.js +4 -1
- package/dist/exec/run/register-worktree.js +28 -1
- package/dist/exec/run/schedule-prepare.js +7 -1
- package/dist/exec/strategy.js +2 -0
- package/dist/exec/task-repos.js +18 -4
- package/dist/exec/worktree-command.js +8 -1
- package/dist/exec/worktree-ops-commit.js +7 -1
- package/dist/exec/worktree-ops-merge.js +40 -1
- package/dist/grade/apply.js +13 -7
- package/dist/grade/command-inspect.js +2 -1
- package/dist/grade/command-run.js +39 -0
- package/dist/grade/grade.js +3 -1
- package/dist/grade/markdown.js +11 -6
- package/dist/grade/pipeline-state.js +8 -6
- package/dist/grade/plan.js +14 -10
- package/dist/grade/run.js +307 -0
- package/dist/grade/target-discovery.js +1 -1
- package/dist/grade/targets.js +44 -22
- package/dist/register/approach.js +35 -0
- package/dist/register/catalog-status.js +49 -0
- package/dist/register/core.js +5 -0
- package/dist/register/create-commands.js +83 -5
- package/dist/register/deliverable-target.js +215 -0
- package/dist/register/dependency.js +123 -0
- package/dist/register/derivation.js +2 -2
- package/dist/register/epic.js +42 -0
- package/dist/register/event-merge.js +5 -2
- package/dist/register/events.js +8 -0
- package/dist/register/external-project.js +4 -0
- package/dist/register/item.js +18 -0
- package/dist/register/maintenance-commands.js +7 -1
- package/dist/register/planning.js +37 -0
- package/dist/register/register.js +5 -1
- package/dist/register/renumber.js +12 -4
- package/dist/register/views.js +55 -4
- package/dist/review/grade.js +19 -17
- package/dist/schedule/schedule.js +3 -1
- package/dist/schedule/strategy-generate-scope.js +5 -1
- package/dist/schedule/strategy-generate.js +1 -0
- package/dist/schedule/strategy-profiles.js +1 -1
- package/dist/shared/agent-plan.js +1 -0
- package/dist/shared/agent-types.js +3 -0
- package/dist/shared/grade-result.js +23 -5
- package/dist/shared/markdownlint-config.js +38 -0
- package/dist/shared/markdownlint-scaffold.js +2 -9
- package/dist/shared/provider-scaffold.js +5 -3
- package/dist/shared/specdojo-config.js +10 -3
- package/dist/shared/specdojo-gitignore.js +4 -0
- package/dist/specdojo.js +5 -1
- package/docs/ja/specdojo/exec-templates/xep-catalog-planning-template.md +24 -0
- package/docs/ja/specdojo/exec-templates/xep-strategy-planning-template.md +24 -0
- package/docs/ja/specdojo/exec-templates/xrp-freeform-template.md +2 -2
- package/docs/ja/specdojo/exec-templates/xrp-fully-guided-template.md +2 -2
- package/docs/ja/specdojo/exec-templates/xrp-recipe-guided-template.md +2 -2
- package/docs/ja/specdojo/exec-templates/xrp-recipe-maintenance-template.md +2 -2
- package/docs/ja/specdojo/exec-templates/xrp-retrofit-template.md +2 -2
- package/docs/ja/specdojo/exec-templates/xrp-rulebook-maintenance-template.md +2 -2
- package/docs/ja/specdojo/exec-templates/xrp-sample-maintenance-template.md +2 -2
- package/docs/ja/specdojo/exec-templates/xrp-template-maintenance-template.md +2 -2
- package/docs/ja/specdojo/exec-templates/xrp-template.md +2 -2
- package/docs/ja/specdojo/guides/docs-editing-guide.md +14 -1
- package/docs/ja/specdojo/guides/docs-structure-guide.md +10 -8
- package/docs/ja/specdojo/guides/exec-config-guide.md +44 -12
- package/docs/ja/specdojo/guides/exec-operation-guide.md +20 -15
- package/docs/ja/specdojo/guides/orchestrator-operation-guide.md +19 -1
- package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +3 -1
- package/docs/ja/specdojo/guides/practice-system-composition-guide.md +2 -0
- package/docs/ja/specdojo/guides/quick-start-guide.md +59 -16
- package/docs/ja/specdojo/guides/register-operation-guide.md +44 -15
- package/docs/ja/specdojo/guides/remote-host-development-guide.md +15 -1
- package/docs/ja/specdojo/guides/review-guide.md +2 -2
- package/docs/ja/specdojo/guides/ryu-guide.md +12 -0
- package/docs/ja/specdojo/guides/specdojo-overview-guide.md +16 -16
- package/docs/ja/specdojo/guides/timeline-design-guide.md +37 -33
- package/docs/ja/specdojo/recipes/tsd-recipe.md +198 -0
- package/docs/ja/specdojo/references/command-reference.md +92 -29
- package/docs/ja/specdojo/references/specdojo-config-reference.md +49 -16
- package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/atc-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +5 -4
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +3 -2
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +4 -3
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +8 -7
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +4 -3
- package/docs/ja/specdojo/rulebooks/bps-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +3 -2
- package/docs/ja/specdojo/rulebooks/cld-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/cop-rulebook.md +3 -2
- package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/cstd-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/etc-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +9 -6
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +3 -1
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +2 -0
- package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +4 -2
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/itc-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +4 -3
- package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +9 -8
- package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +10 -9
- package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +9 -8
- package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +9 -8
- package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +9 -8
- package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +9 -8
- package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +10 -9
- package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +9 -8
- package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +9 -8
- package/docs/ja/specdojo/rulebooks/ntp-rulebook.md +7 -6
- package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/opd-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/opr-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/otp-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +56 -36
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/prj-overview-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/sac-rulebook.md +3 -2
- package/docs/ja/specdojo/rulebooks/sch-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +7 -6
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +4 -3
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/stc-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +9 -8
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/tml-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +80 -61
- package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +111 -63
- package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +3 -2
- package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +1 -0
- package/docs/ja/specdojo/rulebooks/utc-rulebook.md +1 -0
- package/docs/ja/specdojo/samples/atc-index-sample.md +1 -1
- package/docs/ja/specdojo/samples/atc-sample.md +1 -1
- package/docs/ja/specdojo/samples/bac-sample.md +1 -1
- package/docs/ja/specdojo/samples/bdd-sample.yaml +1 -1
- package/docs/ja/specdojo/samples/bds-sample.md +1 -1
- package/docs/ja/specdojo/samples/bes-index-sample.md +1 -1
- package/docs/ja/specdojo/samples/bes-sample.md +1 -1
- package/docs/ja/specdojo/samples/ccd-sample.md +1 -1
- package/docs/ja/specdojo/samples/cdfd-sample.md +1 -1
- package/docs/ja/specdojo/samples/cdfd-uc-sample.md +1 -1
- package/docs/ja/specdojo/samples/cdsd-sample.md +1 -1
- package/docs/ja/specdojo/samples/cld-sample.md +1 -1
- package/docs/ja/specdojo/samples/cnd-sample.md +1 -1
- package/docs/ja/specdojo/samples/cop-index-sample.md +1 -1
- package/docs/ja/specdojo/samples/cop-sample.md +1 -1
- package/docs/ja/specdojo/samples/cpd-sample.md +1 -1
- package/docs/ja/specdojo/samples/cstd-sample.md +1 -1
- package/docs/ja/specdojo/samples/cxd-sample.md +1 -1
- package/docs/ja/specdojo/samples/dmd-index-sample.md +1 -1
- package/docs/ja/specdojo/samples/dmd-sample.md +1 -1
- package/docs/ja/specdojo/samples/etc-index-sample.md +1 -1
- package/docs/ja/specdojo/samples/etc-sample.md +1 -1
- package/docs/ja/specdojo/samples/gl-sample.yaml +2 -0
- package/docs/ja/specdojo/samples/ifd-sample.md +1 -1
- package/docs/ja/specdojo/samples/ifx-api-sample.yaml +1 -0
- package/docs/ja/specdojo/samples/ifx-cmd-sample.yaml +1 -1
- package/docs/ja/specdojo/samples/ifx-file-sample.md +1 -1
- package/docs/ja/specdojo/samples/ifx-index-sample.yaml +1 -0
- package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +2 -1
- package/docs/ja/specdojo/samples/itc-index-sample.md +1 -1
- package/docs/ja/specdojo/samples/itc-sample.md +1 -1
- package/docs/ja/specdojo/samples/mtp-sample.md +1 -1
- package/docs/ja/specdojo/samples/nfr-availability-sample.md +1 -1
- package/docs/ja/specdojo/samples/nfr-index-sample.md +1 -1
- package/docs/ja/specdojo/samples/nfr-integrity-sample.md +1 -1
- package/docs/ja/specdojo/samples/nfr-maintainability-sample.md +1 -1
- package/docs/ja/specdojo/samples/nfr-operations-sample.md +1 -1
- package/docs/ja/specdojo/samples/nfr-performance-sample.md +1 -1
- package/docs/ja/specdojo/samples/nfr-reliability-sample.md +1 -1
- package/docs/ja/specdojo/samples/nfr-security-safety-sample.md +1 -1
- package/docs/ja/specdojo/samples/nfr-usability-sample.md +1 -1
- package/docs/ja/specdojo/samples/ntp-sample.md +1 -1
- package/docs/ja/specdojo/samples/opd-sample.md +1 -1
- package/docs/ja/specdojo/samples/opr-sample.md +1 -1
- package/docs/ja/specdojo/samples/otp-index-sample.md +1 -1
- package/docs/ja/specdojo/samples/otp-sample.md +1 -1
- package/docs/ja/specdojo/samples/prj-stakeholder-register-sample.md +1 -1
- package/docs/ja/specdojo/samples/sac-sample.md +1 -1
- package/docs/ja/specdojo/samples/sf-index-sample.md +1 -1
- package/docs/ja/specdojo/samples/sf-sample.md +1 -1
- package/docs/ja/specdojo/samples/sld-sample.md +1 -1
- package/docs/ja/specdojo/samples/stc-index-sample.md +1 -1
- package/docs/ja/specdojo/samples/stc-sample.md +1 -1
- package/docs/ja/specdojo/samples/stsd-sample.md +1 -1
- package/docs/ja/specdojo/samples/sysd-critical-flows-sample.md +1 -1
- package/docs/ja/specdojo/samples/sysd-cross-cutting-policy-sample.md +1 -1
- package/docs/ja/specdojo/samples/sysd-index-sample.md +1 -1
- package/docs/ja/specdojo/samples/tsd-index-sample.md +22 -16
- package/docs/ja/specdojo/samples/tsd-sample.md +241 -21
- package/docs/ja/specdojo/samples/tsp-index-sample.md +1 -1
- package/docs/ja/specdojo/samples/uis-sample.md +1 -1
- package/docs/ja/specdojo/samples/utc-index-sample.md +1 -1
- package/docs/ja/specdojo/samples/utc-sample.md +1 -1
- package/docs/ja/specdojo/standards/document-metadata-standard.md +28 -3
- package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +2 -0
- package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +16 -11
- package/docs/ja/specdojo/standards/sample-authoring-standard.md +1 -0
- package/docs/ja/specdojo/templates/ifx-cmd-template.yaml +1 -1
- package/docs/ja/specdojo/templates/pjr-dependent-items-template.md +22 -0
- package/docs/ja/specdojo/templates/pjr-epic-items-template.md +22 -0
- package/docs/ja/specdojo/templates/pjr-epic-template.md +44 -0
- package/docs/ja/specdojo/templates/pjr-index-template.md +4 -2
- package/docs/specdojo/schemas/v1/bdd.schema.yaml +1 -1
- package/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml +24 -16
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +4 -1
- package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +1 -1
- package/docs/specdojo/schemas/v1/gl.schema.yaml +8 -0
- package/docs/specdojo/schemas/v1/grade-pipeline-state.schema.yaml +1 -1
- package/docs/specdojo/schemas/v1/ifx-cmd.schema.yaml +5 -1
- package/docs/specdojo/schemas/v1/pipeline-state.schema.yaml +2 -1
- package/docs/specdojo/schemas/v1/register-events.schema.yaml +20 -0
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +73 -4
- package/docs/specdojo/schemas/v1/rulebook-frontmatter.schema.yaml +5 -0
- package/docs/specdojo/schemas/v1/specdojo-config.schema.yaml +21 -3
- package/package.json +2 -2
- package/templates/antigravity/orchestrator.md +14 -9
- package/templates/claude/agents/specdojo-orchestrator.md +14 -9
- package/templates/codex/agents/specdojo-orchestrator.toml +14 -9
- package/templates/codex/orchestrator.md +14 -9
- package/templates/copilot/README.md +2 -1
- package/templates/devcontainer/devcontainer.json +1 -0
- package/templates/init-agent-members.yaml +46 -3
- package/templates/opencode/README.md +118 -14
- package/templates/opencode/agents/specdojo-orchestrator.md +15 -10
- package/templates/opencode/opencode.json +25 -0
|
@@ -2,100 +2,119 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:tsd-index-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
-
|
|
5
|
+
deliverable_type: architecture
|
|
6
|
+
status: ready
|
|
6
7
|
recipe: not-needed
|
|
7
8
|
sample: specdojo:tsd-index-sample
|
|
8
9
|
template: not-needed
|
|
9
10
|
---
|
|
10
11
|
|
|
11
|
-
#
|
|
12
|
+
# 技術スタック一覧(TSD Index)作成ルール
|
|
12
13
|
|
|
13
|
-
Technology Stack
|
|
14
|
+
Technology Stack Index (TSD Index) Documentation Rules
|
|
14
15
|
|
|
15
|
-
`tsd-index.md`
|
|
16
|
+
`tsd-index.md` は、対象システムや開発基盤で採用する技術と担当責務を一覧にし、詳細な構成・設定の正本へ導く入口文書である。技術の用途と適用範囲を俯瞰し、構築、実装、運用、変更時に参照すべき定義を判断できる内容を記載する。
|
|
16
17
|
|
|
17
18
|
## 1. 全体方針
|
|
18
19
|
|
|
19
|
-
-
|
|
20
|
-
-
|
|
21
|
-
-
|
|
22
|
-
-
|
|
23
|
-
-
|
|
20
|
+
- 一つのシステムまたは合意した対象範囲につき、技術一覧の正本を一つにする。複数システムを扱う場合は、一覧の対象範囲を明示する。
|
|
21
|
+
- 採用技術の名称、区分、担当責務を一覧で対応させる。実行基盤だけでなく、対象範囲に含まれる開発、検証、文書化、配布、運用の技術も扱う。
|
|
22
|
+
- すべての依存パッケージを列挙するのではなく、構成や作業の前提として関係者が把握すべき技術を選ぶ。
|
|
23
|
+
- 採用済みの必須構成と任意利用の構成を区別する。未決の候補は採用技術に混ぜず、判断の記録へ導く。
|
|
24
|
+
- 詳細な設定、構築手順、接続方法、資源制約は `tsd-<term>` または設定ファイルなどの正本へ委ねる。
|
|
25
|
+
- 版の粒度と参照元を明確にし、lockfile や詳細 TSD と異なる固定値を二重管理しない。
|
|
24
26
|
|
|
25
27
|
## 2. 位置づけ
|
|
26
28
|
|
|
27
|
-
|
|
29
|
+
| 文書・情報 | 役割 | 一覧からの導線 |
|
|
30
|
+
| ------------------------ | ------------------------------------ | ------------------------------------------ |
|
|
31
|
+
| `tsd-index` | 採用技術と担当責務の全体一覧 | 対象範囲の技術を俯瞰する入口とする |
|
|
32
|
+
| `tsd-<term>` | 技術領域や実行基盤の詳細定義 | 構成、前提、設定、導入、動作確認を参照する |
|
|
33
|
+
| 接続設定・日常利用の TSD | 基盤を利用するクライアント設定や操作 | 初期構築と利用時の手順を区別して導く |
|
|
34
|
+
| 設定ファイル・依存定義 | 実際に適用する版や設定の正本 | 正確な版や有効設定が必要な場合に参照する |
|
|
35
|
+
| 採用判断の記録 | 技術を選んだ理由と未決事項 | 一覧で説明しきれない判断の根拠へ導く |
|
|
28
36
|
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
| `tsd-<term>` | 特定技術領域の詳細設定・構成 | 複数セクションで詳述 |
|
|
33
|
-
|
|
34
|
-
`tsd-index` は全区分を俯瞰でき、必要に応じて `tsd-<term>` へリンクする。詳細設定・手順・コードブロックは `tsd-<term>` に委ねる。
|
|
37
|
+
- 詳細 TSD が未作成でも、採用が確認できた技術と担当責務は一覧に記載してよい。未整備の詳細文書を存在するように参照しない。
|
|
38
|
+
- 一つの技術に基盤設定と接続設定など複数の詳細文書がある場合は、参照先ごとの役割を示す。
|
|
39
|
+
- 同じ技術を複数の用途で使う場合は、責務を一行にまとめるか、適用範囲を明示して行を分ける。説明のない重複は作らない。
|
|
35
40
|
|
|
36
41
|
## 3. ファイル命名・ID規則
|
|
37
42
|
|
|
38
|
-
-
|
|
39
|
-
- `id
|
|
40
|
-
-
|
|
43
|
+
- ファイル名は `tsd-index.md` とする。
|
|
44
|
+
- `id` は `tsd-index` を基準に、名前空間と対象範囲内の一意性を共通のメタデータ規約に従って定める。
|
|
45
|
+
- 配置先はプロジェクトのアーキテクチャまたは技術基盤の文書群とし、詳細な `tsd-<term>.md` も同じ文書群にまとめる。
|
|
46
|
+
- 環境や領域ごとの補足を分冊する場合も、全体一覧の正本を複製せず、本書から参照する。
|
|
41
47
|
|
|
42
48
|
## 4. 推奨 Frontmatter 項目
|
|
43
49
|
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
|
47
|
-
|
|
|
48
|
-
| `
|
|
49
|
-
| `
|
|
50
|
-
| `
|
|
50
|
+
項目は `specdojo` 配下に置く。共通の型と参照形式は [document-metadata-standard.md](../standards/document-metadata-standard.md) と成果物の Frontmatter スキーマに従う。
|
|
51
|
+
|
|
52
|
+
| 項目 | 必須 | 値・記述内容 |
|
|
53
|
+
| ------------ | -------- | -------------------------------------------------- |
|
|
54
|
+
| `id` | ○ | 対象範囲で一意な `tsd-index` 系の ID |
|
|
55
|
+
| `type` | ○ | `architecture` |
|
|
56
|
+
| `status` | ○ | `draft` / `ready` / `deprecated` |
|
|
57
|
+
| `rulebook` | 推奨 | `specdojo:tsd-index-rulebook` |
|
|
58
|
+
| `part_of` | 任意 | 所属するアーキテクチャ文書などの ID 配列 |
|
|
59
|
+
| `based_on` | 条件付き | 技術構成の直接の根拠となる設計や採用判断の ID 配列 |
|
|
60
|
+
| `supersedes` | 条件付き | 既存の技術一覧を置き換える場合の旧文書 ID 配列 |
|
|
51
61
|
|
|
52
|
-
## 5.
|
|
62
|
+
## 5. 本文要件
|
|
53
63
|
|
|
54
|
-
|
|
|
55
|
-
|
|
|
56
|
-
|
|
|
57
|
-
|
|
|
64
|
+
| 内容 | 必須 | 目的・記述要件 |
|
|
65
|
+
| ------------------ | -------- | --------------------------------------------------------------- |
|
|
66
|
+
| 冒頭の概要 | ○ | 対象システム、環境、一覧の利用目的と対象範囲を 1〜3 文で示す |
|
|
67
|
+
| 技術スタック一覧 | ○ | 区分、採用技術、担当責務を一つの主一覧表で対応させる |
|
|
68
|
+
| 補足・詳細への導線 | 条件付き | 詳細 TSD や設定の正本がある場合、各参照先の役割と適用条件を示す |
|
|
58
69
|
|
|
59
|
-
-
|
|
60
|
-
-
|
|
70
|
+
- 実行時に使う技術と、開発・検証・運用に使う技術の範囲が分かるようにする。対象外の領域まで空欄や仮の技術で埋めない。
|
|
71
|
+
- 版、利用環境、必須・任意が判断に必要な場合は、一覧の列または補足に記載する。
|
|
72
|
+
- 補足では全体の共通条件と参照先を示し、設定値や手順の詳細を転載しない。
|
|
61
73
|
|
|
62
74
|
## 6. 記述ガイド
|
|
63
75
|
|
|
64
|
-
### 6.1.
|
|
76
|
+
### 6.1. 技術スタック一覧の列
|
|
77
|
+
|
|
78
|
+
| 列 | 必須 | 記述内容 |
|
|
79
|
+
| ---------- | -------- | -------------------------------------------------------------------- |
|
|
80
|
+
| 区分 | ○ | 言語、ランタイム、DB、文書化など、利用目的を俯瞰できる分類 |
|
|
81
|
+
| 採用技術 | ○ | 製品・サービス・技術の識別できる名称。版を含める場合は粒度をそろえる |
|
|
82
|
+
| 担当責務 | ○ | 対象システムや作業のどこで、何を担うか |
|
|
83
|
+
| 版・正本 | 条件付き | 版の制約、または正確な版を管理する設定ファイル・詳細文書 |
|
|
84
|
+
| 適用範囲 | 条件付き | 対象環境、実行場所、必須・任意など、利用条件の違い |
|
|
85
|
+
| 詳細・備考 | 任意 | 詳細 TSD への参照、短い制約や選定理由 |
|
|
65
86
|
|
|
66
|
-
|
|
87
|
+
- 担当責務は「開発用」「利用する」だけで終えず、対象と役割を一文で示す。
|
|
88
|
+
- 複数の製品を一つの実行基盤としてまとめる場合は、構成の内訳と各役割を詳細 TSD へ導く。
|
|
89
|
+
- 版を採用技術名に含める場合は、別の版列で同じ情報を繰り返さない。
|
|
67
90
|
|
|
68
|
-
|
|
69
|
-
| -------- | ------------------------------------------------------------------ |
|
|
70
|
-
| 区分 | カテゴリ(例: 言語 / ランタイム / DB / ホスティング) |
|
|
71
|
-
| 採用技術 | 技術名とメジャーバージョン(例: `TypeScript 5.x`、`Node.js 24.x`) |
|
|
72
|
-
| 担当責務 | その技術を何に使うか(判定可能な粒度で1行) |
|
|
91
|
+
### 6.2. 区分と網羅範囲
|
|
73
92
|
|
|
74
|
-
|
|
93
|
+
- 言語・ランタイム・フレームワーク、データ保存・連携、ホスティング・ネットワークなど、対象の実行に必要な技術を確認する。
|
|
94
|
+
- build・テスト・静的検査・文書化・図解・ソース管理・CI/CD・パッケージ配布・運用監視など、対象の開発と保守を支える技術も確認する。
|
|
95
|
+
- AI 実行環境やローカルモデル基盤など固有の領域は、実際に採用した範囲で追加する。区分名や製品名の例を、すべてのプロジェクトの必須構成にしない。
|
|
75
96
|
|
|
76
|
-
|
|
97
|
+
### 6.3. 版と採用状態
|
|
77
98
|
|
|
78
|
-
-
|
|
79
|
-
-
|
|
80
|
-
-
|
|
81
|
-
-
|
|
82
|
-
- ドキュメントサイト / 図解生成
|
|
83
|
-
- Git フック / コミット規約
|
|
84
|
-
- ソースコード管理 / CI/CD / パッケージ配信
|
|
85
|
-
- AI エージェント実行 / ローカル LLM
|
|
99
|
+
- 一覧ではメジャーバージョンや互換性の制約など、構成を理解するために必要な粒度を使う。特定の版が採用判断に不可欠な場合は、その理由と正本を示す。
|
|
100
|
+
- 正確なパッチ版や依存解決結果を lockfile などで管理する場合は、その参照先を示す。確認していない版を推測で記入しない。
|
|
101
|
+
- 任意利用の技術は、採用済みの選択肢であることと適用条件を明示する。未採択の比較候補や将来案は、採用一覧の外で扱う。
|
|
102
|
+
- 「最新版」と記載する場合は、取得元と更新方針を示す。実際に使用した版の確認方法が分からない表現にしない。
|
|
86
103
|
|
|
87
|
-
### 6.
|
|
104
|
+
### 6.4. 詳細文書と更新
|
|
88
105
|
|
|
89
|
-
-
|
|
90
|
-
-
|
|
106
|
+
- 技術の初期構築、クライアント接続、日常利用を分冊している場合は、それぞれの目的が分かる参照名にする。
|
|
107
|
+
- 採用・廃止・責務・適用範囲が変わったときに一覧を更新し、詳細 TSD や設定の正本との不一致を確認する。
|
|
108
|
+
- 未作成の詳細や未決の条件は共通ラベルで示し、仮の参照先や設定値を確定情報として残さない。
|
|
91
109
|
|
|
92
110
|
## 7. 禁止事項
|
|
93
111
|
|
|
94
|
-
| 禁止事項
|
|
95
|
-
|
|
|
96
|
-
|
|
|
97
|
-
|
|
|
98
|
-
|
|
|
99
|
-
|
|
|
100
|
-
|
|
|
101
|
-
|
|
|
112
|
+
| 禁止事項 | 理由 |
|
|
113
|
+
| ------------------------------------------------------------ | ---------------------------------------------- |
|
|
114
|
+
| 担当責務を空欄や技術名の言い換えだけにする | 採用技術が担う役割を判断できないため |
|
|
115
|
+
| 採用済みの構成と未決の候補を区別せず並べる | 構築や実装の前提を誤らせるため |
|
|
116
|
+
| 同じ技術や一覧を、適用範囲を示さず重複させる | 責務と更新先が分からなくなるため |
|
|
117
|
+
| 全依存パッケージやすべての版固定値を転載する | 一覧の目的を超え、依存定義と二重管理になるため |
|
|
118
|
+
| 詳細設定、接続先、構築コマンド、コードを一覧の本文へ展開する | 詳細 TSD や設定の正本との責務が重なるため |
|
|
119
|
+
| API キー、トークン、秘密鍵、機密の接続情報を記載する | 一覧の配布や履歴を通じて漏れるため |
|
|
120
|
+
| 任意利用の製品や実例の構成を一律の必須技術にする | 対象範囲や環境による違いを失うため |
|
|
@@ -2,102 +2,150 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:tsd-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
-
|
|
5
|
+
deliverable_type: architecture
|
|
6
|
+
status: ready
|
|
7
|
+
recipe: specdojo:tsd-recipe
|
|
6
8
|
sample: specdojo:tsd-sample
|
|
7
9
|
template: not-needed
|
|
8
10
|
---
|
|
9
11
|
|
|
10
|
-
#
|
|
12
|
+
# 技術領域別 技術スタック詳細定義(TSD)作成ルール
|
|
11
13
|
|
|
12
|
-
|
|
14
|
+
Technology Stack Detail Definition (TSD) Documentation Rules
|
|
13
15
|
|
|
14
|
-
`tsd-<term>.md`
|
|
16
|
+
`tsd-<term>.md` は、採用した技術や実行基盤について、構成、設定、導入、接続、動作確認、継続利用に必要な情報を定義する。`tsd-index.md` の技術一覧を具体化し、別の担当者が対象環境で同じ構成を再現し、正常性を判断できる内容を残す。
|
|
15
17
|
|
|
16
18
|
## 1. 全体方針
|
|
17
19
|
|
|
18
|
-
-
|
|
19
|
-
-
|
|
20
|
-
-
|
|
21
|
-
-
|
|
22
|
-
-
|
|
20
|
+
- 一つの文書は、技術領域、接続関係、または一連の利用場面を単位とする。目的を共有する複数の技術を、一つの実行基盤として扱ってよい。
|
|
21
|
+
- 目的、対象環境、前提条件、実行場所を明示し、採用設定と動作確認を対応させる。
|
|
22
|
+
- 採用した値、推奨する値、任意の選択肢、未決事項を区別する。根拠のない製品名、版、容量、並列数を補わない。
|
|
23
|
+
- 一覧、技術基盤の初期構築、クライアントからの接続、日常利用を必要に応じて分冊し、同じ設定の正本を一つにする。
|
|
24
|
+
- 再現に必要な設定ファイル、コマンド、補助スクリプトの記述を認める。アプリケーションの内部設計、詳細 API 仕様、SQL 全文は扱わない。
|
|
25
|
+
- 秘密値は記載せず、取得・保存・参照の方法を記載する。公開可能な接続方式、ポート、汎用ホスト名と、個人・組織固有の機密情報を区別する。
|
|
23
26
|
|
|
24
27
|
## 2. 位置づけ
|
|
25
28
|
|
|
26
|
-
|
|
29
|
+
| 文書・情報 | 役割 | TSD との関係 |
|
|
30
|
+
| -------------------- | ------------------------------------------ | --------------------------------------------------------------- |
|
|
31
|
+
| `tsd-index` | 採用技術、区分、担当責務の一覧 | 全体の入口とし、技術領域ごとの詳細へ導く |
|
|
32
|
+
| `tsd-<term>` | 技術領域や実行基盤の構成と採用設定 | 対象領域の設定と再現手順の正本にする |
|
|
33
|
+
| 接続設定の分冊 | 既存の技術基盤を利用するクライアントの設定 | 基盤側の導入を前提として参照し、重複記載しない |
|
|
34
|
+
| 日常利用の分冊 | 接続、再接続、起動、停止などの利用手順 | 初期構築の完了を前提とし、設定の正本を参照する |
|
|
35
|
+
| 上位設計・非機能要件 | 責務分界、品質要求、採用判断の根拠 | TSD の設定が満たすべき条件を示す |
|
|
36
|
+
| 運用設計・運用手順 | 体制、SLO、障害対応、バックアップなど | 組織的な運用方針は参照し、技術固有の操作だけを TSD で具体化する |
|
|
27
37
|
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
| `tsd-<term>` | 特定技術領域の詳細定義 | `tsd-ollama.md` |
|
|
38
|
+
- 分冊した文書には、前提となる文書と、本書で定義する差分を明示する。
|
|
39
|
+
- ホスト、コンテナ、接続元端末などで役割が異なる場合は、構成図または対応表で境界を示す。
|
|
40
|
+
- 共通設定や技術一覧を転載せず、正本への参照でつなぐ。参照だけでは実行順が分からない場合は、前提の完了条件を併記する。
|
|
32
41
|
|
|
33
42
|
## 3. ファイル命名・ID規則
|
|
34
43
|
|
|
35
|
-
-
|
|
36
|
-
- `
|
|
37
|
-
-
|
|
38
|
-
-
|
|
44
|
+
- ファイル名は `tsd-<term>.md` とする。`<term>` は対象技術、実行基盤、接続関係が分かる英小文字・数字・ハイフンで表す。
|
|
45
|
+
- 接続設定は `tsd-<technology>-<client>.md`、日常利用は `tsd-<environment>-usage.md` のように用途を区別してよい。名称だけで内容を判断できない分割は避ける。
|
|
46
|
+
- `id` はファイル名の stem と対応させ、名前空間や一意性は共通のメタデータ規約に従う。
|
|
47
|
+
- 配置先は `tsd-index.md` と同じ技術基盤の文書群とする。プロジェクトのディレクトリ構成を優先する。
|
|
39
48
|
|
|
40
49
|
## 4. 推奨 Frontmatter 項目
|
|
41
50
|
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
|
45
|
-
|
|
|
46
|
-
| `
|
|
47
|
-
| `
|
|
48
|
-
| `
|
|
49
|
-
| `
|
|
51
|
+
項目は `specdojo` 配下に置く。共通の型と参照形式は [document-metadata-standard.md](../standards/document-metadata-standard.md) と成果物の Frontmatter スキーマに従う。
|
|
52
|
+
|
|
53
|
+
| 項目 | 必須 | 値・記述内容 |
|
|
54
|
+
| ------------ | -------- | ------------------------------------------------------------ |
|
|
55
|
+
| `id` | ○ | 対象文書を一意に識別する `tsd-<term>` 系の ID |
|
|
56
|
+
| `type` | ○ | `architecture` |
|
|
57
|
+
| `status` | ○ | `draft` / `ready` / `deprecated` |
|
|
58
|
+
| `rulebook` | 推奨 | `specdojo:tsd-rulebook` |
|
|
59
|
+
| `part_of` | 推奨 | 所属する `tsd-index` などの ID 配列 |
|
|
60
|
+
| `based_on` | 条件付き | 構成や設定の直接の根拠となる上位設計、基盤定義などの ID 配列 |
|
|
61
|
+
| `supersedes` | 条件付き | 既存の構成定義を置き換える場合の旧文書 ID 配列 |
|
|
62
|
+
|
|
63
|
+
接続設定や利用手順を分冊する場合は、前提となる技術基盤の文書を `based_on` に示す。参考として読んだだけの文書を、採用判断の根拠として列挙しない。
|
|
64
|
+
|
|
65
|
+
## 5. 本文要件
|
|
66
|
+
|
|
67
|
+
以下は内容要件であり、固定した見出し順を要求しない。対象に合わせて章をまとめたり分けたりしてよい。条件付きの内容を別冊へ委ねる場合は、その正本と前提の完了条件を示す。
|
|
68
|
+
|
|
69
|
+
| 内容 | 必須 | 目的・記述要件 |
|
|
70
|
+
| ---------------------- | -------- | -------------------------------------------------------------------------------------------------- |
|
|
71
|
+
| 概要・位置づけ | ○ | 目的、対象範囲、対象外、他文書との責務分担を明示する |
|
|
72
|
+
| 対象環境・前提条件 | ○ | OS、実行環境、必要な権限、導入済みの依存、必要な資源を示す。特別な前提がない項目はその旨を書く |
|
|
73
|
+
| 全体構成・接続経路 | 条件付き | 複数のホスト、プロセス、クライアントを使う場合、配置、役割、通信方向、公開範囲を示す |
|
|
74
|
+
| 採用技術・設定 | ○ | 用途、採用する版・モデル・設定値、適用範囲、理由、制約を対応させる |
|
|
75
|
+
| 導入・初期設定 | 条件付き | 初期構築を扱う場合、実行場所、順序、変更先、既存設定との統合方法を示す |
|
|
76
|
+
| 接続設定 | 条件付き | 外部サービスや別の実行環境へ接続する場合、接続方式、認証方法、識別子の対応を示す |
|
|
77
|
+
| 動作確認 | ○ | 前提の確認と最終的な利用確認を分け、確認方法、期待結果、失敗時の切り分け先を示す |
|
|
78
|
+
| 継続利用・運用 | 条件付き | 常駐、長時間実行、再接続などを扱う場合、起動・停止・再開、設定の永続化、再構築で失われる状態を示す |
|
|
79
|
+
| 制約・トラブルシュート | ○ | 既知の制約、症状別の確認箇所、回避方法を示す。未確認の条件は未確認と分かる形で残す |
|
|
80
|
+
| 更新・復旧・撤去 | 条件付き | 既存環境を変更する場合、切り戻し、旧方式との共存可否、設定・データの保持や削除の範囲を示す |
|
|
81
|
+
| 参照情報 | 任意 | 判断や手順の根拠となる公式情報、確認した版や日付、関連文書への導線を示す |
|
|
82
|
+
|
|
83
|
+
- 初期構築、接続設定、日常利用のいずれを扱う文書かを冒頭で明示する。
|
|
84
|
+
- 版や環境で手順が変わる場合は、適用条件を分ける。任意の設定を全利用者の必須条件として書かない。
|
|
85
|
+
- 手順を省略して別文書へ導く場合も、本書の開始条件と完了を判断する確認方法は残す。
|
|
50
86
|
|
|
51
|
-
##
|
|
87
|
+
## 6. 記述ガイド
|
|
52
88
|
|
|
53
|
-
|
|
89
|
+
### 6.1. 対象環境と責務分界
|
|
54
90
|
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
| 選定・バージョン | 採用モデル・バージョン・用途の対応表 | 推奨 |
|
|
59
|
-
| 設定・セットアップ手順 | 環境構築・設定手順(コマンド・設定ファイル) | 推奨 |
|
|
60
|
-
| 動作確認 | 正常稼働を確認するコマンドや手順 | 任意 |
|
|
61
|
-
| 運用上の注意 | 制約・注意事項・トラブルシュート観点 | 任意 |
|
|
91
|
+
- 接続元端末、ホスト、コンテナなどに一貫した呼び名を付け、各コマンドをどこで実行するか示す。
|
|
92
|
+
- インストール先、設定保存先、作業ディレクトリ、実行ユーザーを、手順を再現できる粒度で記載する。
|
|
93
|
+
- OS、ハードウェア、メモリ、ディスク、並列数などの制約は採用理由と結び付ける。検証した構成と一般的な推奨を区別する。
|
|
62
94
|
|
|
63
|
-
|
|
95
|
+
### 6.2. 採用設定の表
|
|
96
|
+
|
|
97
|
+
| 列 | 記述内容 |
|
|
98
|
+
| -------------- | ---------------------------------------------- |
|
|
99
|
+
| 対象・用途 | どの構成要素や利用場面に適用するか |
|
|
100
|
+
| 設定項目 | 製品や設定ファイル上の項目名 |
|
|
101
|
+
| 採用値・版 | 値、単位、版、モデル ID など |
|
|
102
|
+
| 適用範囲 | ユーザー、プロジェクト、プロセスなどの有効範囲 |
|
|
103
|
+
| 理由・制約 | 採用根拠、互換性、資源上の制約 |
|
|
104
|
+
| 反映・確認方法 | 再起動の要否、有効値の確認方法 |
|
|
64
105
|
|
|
65
|
-
|
|
106
|
+
設定ファイルと環境変数の両方がある場合は、優先順位と反映先を記載する。GUI で保存する設定も、画面の項目名、保存先、反映条件を示す。
|
|
66
107
|
|
|
67
|
-
|
|
68
|
-
- 「何のために」「どこで使うか」を明示する
|
|
108
|
+
### 6.3. 導入・変更手順
|
|
69
109
|
|
|
70
|
-
|
|
110
|
+
- 順序付きリストと、言語識別子付きのコードブロックを使う。シェル、実行場所、事前条件が分かるようにする。
|
|
111
|
+
- 設定の追加、部分的な変更、ファイル全体の置換を区別する。既存の provider や利用者設定を残す必要がある場合は統合方法を示す。
|
|
112
|
+
- 再起動、権限変更、データ削除などの影響と、実行前に確認すべき条件を併記する。導入、起動、再起動、停止を同じ操作として扱わない。
|
|
113
|
+
- 既存環境からの移行では、旧方式の停止、競合の回避、切り戻し方法を示す。撤去時は設定・認証状態・データの保持と削除を分ける。
|
|
71
114
|
|
|
72
|
-
|
|
115
|
+
### 6.4. 動作確認と切り分け
|
|
73
116
|
|
|
74
|
-
|
|
117
|
+
| 列 | 記述内容 |
|
|
118
|
+
| -------------- | ------------------------------------------ |
|
|
119
|
+
| 確認対象 | 接続、設定反映、利用機能など |
|
|
120
|
+
| 実行場所・方法 | コマンド、GUI 操作、ログ確認など |
|
|
121
|
+
| 期待結果 | 出力項目、状態、応答内容などの判定条件 |
|
|
122
|
+
| 失敗時の確認先 | 前提の依存、保存先、ログ、次の切り分け手順 |
|
|
75
123
|
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
| 採用技術 / モデル | バージョンまたはエディションを含む名称 |
|
|
80
|
-
| 補足 | 選定理由・制約など |
|
|
124
|
+
- プロセスの起動、ネットワーク疎通、認証、モデルや provider の識別子、実際の利用機能を必要に応じて段階的に確認する。
|
|
125
|
+
- 期待結果は版や環境で変わる表示を丸写しせず、正常と判断する項目を明示する。
|
|
126
|
+
- 未実施の確認を成功した事実として書かない。確認環境、未確認条件、残る確認方法を記載する。
|
|
81
127
|
|
|
82
|
-
### 6.
|
|
128
|
+
### 6.5. 継続利用と状態の保存
|
|
83
129
|
|
|
84
|
-
-
|
|
85
|
-
-
|
|
86
|
-
-
|
|
87
|
-
- ステップが複数ある場合は順序付きリスト(`1.` `2.`)で構成する
|
|
130
|
+
- 切断後の再接続、処理の再開、プロセスの再起動を区別し、自動で復旧する範囲を明記する。
|
|
131
|
+
- 再起動や再構築で保持される設定、認証状態、作業データと、失われるセッションを示す。
|
|
132
|
+
- 資源制約や長時間実行が関係する場合は、監視項目、正常範囲、処理を減らす判断条件を示す。
|
|
88
133
|
|
|
89
|
-
### 6.
|
|
134
|
+
### 6.6. 接続情報と秘密情報
|
|
90
135
|
|
|
91
|
-
-
|
|
92
|
-
-
|
|
136
|
+
- 接続方式、公開可能なポート、汎用ホスト名、API の基点など、再現に必要な情報は記載してよい。
|
|
137
|
+
- 個人・組織固有のホスト名、アカウント、URL などは公開可否を判断し、機密の場合はプレースホルダーで示す。
|
|
138
|
+
- API キー、トークン、パスワード、秘密鍵の実値を載せず、credential store などの保存・参照方法を示す。設定例や出力例にも秘密値を含めない。
|
|
93
139
|
|
|
94
140
|
## 7. 禁止事項
|
|
95
141
|
|
|
96
|
-
| 禁止事項
|
|
97
|
-
|
|
|
98
|
-
|
|
|
99
|
-
|
|
|
100
|
-
|
|
|
101
|
-
|
|
|
102
|
-
|
|
|
103
|
-
|
|
|
142
|
+
| 禁止事項 | 理由 |
|
|
143
|
+
| ------------------------------------------------------------------------- | --------------------------------------- |
|
|
144
|
+
| 秘密値や機密の接続先を本文・設定例・ログ例に載せる | 文書の配布や Git 履歴を通じて漏れるため |
|
|
145
|
+
| 実行場所や適用条件が異なる手順を区別せず並べる | 誤った環境や権限で設定を変更するため |
|
|
146
|
+
| 未確認の構成や未採択の設定を、動作確認済み・採用済みとして書く | 実行と判断の前提を誤らせるため |
|
|
147
|
+
| 根拠なく「最新」「十分」「問題ない」だけで版や正常性を定義する | 再現や合否判定ができないため |
|
|
148
|
+
| アプリケーションの内部クラス、関数設計、詳細 API 仕様、SQL 全文を展開する | 技術基盤の構成定義を超えるため |
|
|
149
|
+
| 技術一覧や他の TSD の設定を複数箇所で正本として管理する | 更新時に構成が食い違うため |
|
|
150
|
+
| 無関係な技術領域や独立した利用目的を一つの文書に詰め込む | 適用範囲と保守単位が分からなくなるため |
|
|
151
|
+
| 停止、削除、再構築を、状態やデータへの影響を示さず指示する | 復旧や継続利用に必要な状態を失うため |
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:uis-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: ui
|
|
5
6
|
status: draft
|
|
6
7
|
recipe: undecided
|
|
7
8
|
sample: specdojo:uis-sample
|
|
@@ -42,14 +43,14 @@ specdojo:
|
|
|
42
43
|
| 項目 | 説明 | 必須 |
|
|
43
44
|
| -------- | ------------------------------------------- | ---- |
|
|
44
45
|
| id | 画面ID(小文字ハイフン) | ○ |
|
|
45
|
-
| type | `
|
|
46
|
+
| type | `ui` 固定 | ○ |
|
|
46
47
|
| title | 画面名 | ○ |
|
|
47
48
|
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
48
49
|
| based_on | 根拠となる仕様ID(API/ドメイン/他画面など) | 任意 |
|
|
49
50
|
|
|
50
51
|
### NG/OK例(抜粋)
|
|
51
52
|
|
|
52
|
-
- NG例: `id: UI_ProductList`(大文字/アンダースコアNG), `type: data`(`
|
|
53
|
+
- NG例: `id: UI_ProductList`(大文字/アンダースコアNG), `type: data`(`ui`以外NG), `extra: foo`(未定義プロパティNG)
|
|
53
54
|
- OK例: `id: uis-product-list`, `type: ui`, `status: ready`
|
|
54
55
|
|
|
55
56
|
## 5. 本文構成(標準テンプレ)
|