specdojo 0.4.7 → 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 +46 -0
- 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/core.js +2 -0
- package/dist/exec/pipeline-state.js +5 -2
- package/dist/exec/plans-core.js +3 -2
- package/dist/exec/plans-generation.js +9 -5
- 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/register.js +16 -1
- 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/register-core.js +11 -0
- package/dist/exec/run/register-mode.js +19 -1
- package/dist/exec/run/register-resume.js +22 -0
- package/dist/exec/run/register-worktree.js +23 -0
- package/dist/exec/strategy.js +2 -0
- package/dist/exec/task-repos.js +18 -4
- package/dist/exec/worktree-ops-commit.js +7 -1
- package/dist/grade/apply.js +6 -2
- package/dist/grade/markdown.js +7 -2
- package/dist/grade/plan.js +6 -4
- package/dist/register/approach.js +19 -0
- package/dist/register/catalog-status.js +49 -0
- package/dist/register/core.js +3 -0
- package/dist/register/create-commands.js +34 -4
- 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 +4 -0
- package/dist/register/external-project.js +4 -0
- package/dist/register/item.js +10 -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/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-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/specdojo-config.js +10 -3
- package/dist/shared/specdojo-gitignore.js +4 -0
- 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/guides/docs-editing-guide.md +14 -1
- package/docs/ja/specdojo/guides/docs-structure-guide.md +10 -8
- package/docs/ja/specdojo/guides/exec-operation-guide.md +16 -15
- package/docs/ja/specdojo/guides/orchestrator-operation-guide.md +19 -1
- package/docs/ja/specdojo/guides/practice-system-composition-guide.md +2 -0
- package/docs/ja/specdojo/guides/quick-start-guide.md +37 -14
- package/docs/ja/specdojo/guides/register-operation-guide.md +44 -15
- 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 +42 -4
- package/docs/ja/specdojo/references/specdojo-config-reference.md +20 -8
- 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 +50 -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/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 +18 -0
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +40 -3
- package/docs/specdojo/schemas/v1/rulebook-frontmatter.schema.yaml +5 -0
- package/docs/specdojo/schemas/v1/specdojo-config.schema.yaml +5 -0
- 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/opencode/agents/specdojo-orchestrator.md +14 -9
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:sac-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: requirement
|
|
5
6
|
status: draft
|
|
6
7
|
recipe: undecided
|
|
7
8
|
sample: specdojo:sac-sample
|
|
@@ -57,7 +58,7 @@ Frontmatter は `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml`
|
|
|
57
58
|
| 項目 | 説明 | 必須 |
|
|
58
59
|
| ---------- | --------------------------------------------- | ---- |
|
|
59
60
|
| id | 受入条件ID(`sac-...`) | ○ |
|
|
60
|
-
| type | `
|
|
61
|
+
| type | `requirement` 固定 | ○ |
|
|
61
62
|
| title | 受入条件名(例: システム受入条件: 性能) | ○ |
|
|
62
63
|
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
63
64
|
| part_of | 上位SAC ID(分割している場合) | 任意 |
|
|
@@ -153,7 +154,7 @@ SAC は **Markdown** で「受入対象」と「シナリオ」を記述しま
|
|
|
153
154
|
```yaml
|
|
154
155
|
---
|
|
155
156
|
id: sac-performance
|
|
156
|
-
type:
|
|
157
|
+
type: requirement
|
|
157
158
|
title: システム受入条件: 性能
|
|
158
159
|
status: draft
|
|
159
160
|
part_of: []
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:sf-index-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: requirement
|
|
5
6
|
status: draft
|
|
6
7
|
recipe: undecided
|
|
7
8
|
sample: specdojo:sf-index-sample
|
|
@@ -33,12 +34,12 @@ System Functions Index Documentation Rules
|
|
|
33
34
|
|
|
34
35
|
## 4. 推奨 Frontmatter 項目
|
|
35
36
|
|
|
36
|
-
| 項目 | 値
|
|
37
|
-
| -------- |
|
|
38
|
-
| id | 一意なID
|
|
39
|
-
| type |
|
|
40
|
-
| status | draft / ready / deprecated
|
|
41
|
-
| rulebook | `sf-index-rulebook`
|
|
37
|
+
| 項目 | 値 | 必須 |
|
|
38
|
+
| -------- | -------------------------- | ---- |
|
|
39
|
+
| id | 一意なID | ○ |
|
|
40
|
+
| type | `requirement` 固定 | ○ |
|
|
41
|
+
| status | draft / ready / deprecated | ○ |
|
|
42
|
+
| rulebook | `sf-index-rulebook` | 任意 |
|
|
42
43
|
|
|
43
44
|
## 5. 本文構成(標準テンプレ)
|
|
44
45
|
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:sf-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: requirement
|
|
5
6
|
status: draft
|
|
6
7
|
recipe: undecided
|
|
7
8
|
sample: specdojo:sf-sample
|
|
@@ -17,7 +18,7 @@ specdojo:
|
|
|
17
18
|
| 項目 | 説明 | 必須 |
|
|
18
19
|
| ---------- | ----------------------------- | ---- |
|
|
19
20
|
| id | 機能一覧ID (sf-xxx-xxxx) | ○ |
|
|
20
|
-
| type | `
|
|
21
|
+
| type | `requirement` 固定 | ○ |
|
|
21
22
|
| title | 機能一覧名 | ○ |
|
|
22
23
|
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
23
24
|
| supersedes | 置き換え関係(古仕様→新仕様) | 任意 |
|
|
@@ -26,7 +27,7 @@ specdojo:
|
|
|
26
27
|
|
|
27
28
|
- 機能一覧IDは正規表現 `^sf-[a-z0-9-]+$` に合致する一意IDを使用する。
|
|
28
29
|
|
|
29
|
-
- `type:
|
|
30
|
+
- `type: requirement` は機能・業務イベントの要件であることを示します。
|
|
30
31
|
|
|
31
32
|
ドキュメントID・機能IDともに `sf-` プレフィックスの `lower-kebab` 形式(正規表現: `^sf-[a-z0-9-]+$`)を使用します。
|
|
32
33
|
一覧ハブには `sf-index`、個別機能には `sf-<機能名>` を付与してください(例: `sf-product-register`)。
|
|
@@ -58,7 +59,7 @@ specdojo:
|
|
|
58
59
|
```yaml
|
|
59
60
|
---
|
|
60
61
|
id: sf-index
|
|
61
|
-
type:
|
|
62
|
+
type: requirement
|
|
62
63
|
title: システム化機能一覧(main)
|
|
63
64
|
status: draft
|
|
64
65
|
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:sld-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: data
|
|
5
6
|
status: draft
|
|
6
7
|
recipe: undecided
|
|
7
8
|
sample: specdojo:sld-sample
|
|
@@ -17,7 +18,7 @@ specdojo:
|
|
|
17
18
|
| 項目 | 説明 | 必須 |
|
|
18
19
|
| ---- | ----------------------------- | ---- |
|
|
19
20
|
| id | 保管場所一覧ID (sll-xxx-xxxx) | ○ |
|
|
20
|
-
| type | `
|
|
21
|
+
| type | `data` 固定 | ○ |
|
|
21
22
|
|
|
22
23
|
| title | 保管場所一覧名 | ○ |
|
|
23
24
|
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:sysd-critical-flows-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: architecture
|
|
5
6
|
status: draft
|
|
6
7
|
sample: specdojo:sysd-critical-flows-sample
|
|
7
8
|
---
|
|
@@ -66,7 +67,7 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
66
67
|
|
|
67
68
|
| ---------- | ----------------------------------------------- | ---- |
|
|
68
69
|
| id | SYSD-CF ID(推奨: `sysd-critical-flows`) | ○ |
|
|
69
|
-
| type | `architecture`
|
|
70
|
+
| type | `architecture` 固定 | ○ |
|
|
70
71
|
| title | システム設計: 重要フロー | ○ |
|
|
71
72
|
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
72
73
|
| based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:sysd-cross-cutting-policy-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: architecture
|
|
5
6
|
status: draft
|
|
6
7
|
sample: specdojo:sysd-cross-cutting-policy-sample
|
|
7
8
|
---
|
|
@@ -64,14 +65,14 @@ SYSD-CCP は、以下を目的とする。
|
|
|
64
65
|
|
|
65
66
|
Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml](../../../specdojo/schemas/v1/deliverable-frontmatter.schema.yaml) / [document-metadata-standard.md](../standards/document-metadata-standard.md))。
|
|
66
67
|
|
|
67
|
-
| 項目 | 説明
|
|
68
|
-
| ---------- |
|
|
69
|
-
| id | SYSD-CCP ID(推奨: `sysd-cross-cutting-policy`)
|
|
70
|
-
| type | `architecture`
|
|
71
|
-
| title | システム設計: 横断ルール
|
|
72
|
-
| status | `draft` / `ready` / `deprecated`
|
|
73
|
-
| based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可)
|
|
74
|
-
| supersedes | 置き換え関係(ID配列。未指定は `[]` 可)
|
|
68
|
+
| 項目 | 説明 | 必須 |
|
|
69
|
+
| ---------- | ------------------------------------------------ | ---- |
|
|
70
|
+
| id | SYSD-CCP ID(推奨: `sysd-cross-cutting-policy`) | ○ |
|
|
71
|
+
| type | `architecture` 固定 | ○ |
|
|
72
|
+
| title | システム設計: 横断ルール | ○ |
|
|
73
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
74
|
+
| based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
|
|
75
|
+
| supersedes | 置き換え関係(ID配列。未指定は `[]` 可) | 任意 |
|
|
75
76
|
|
|
76
77
|
### 4.2. 推奨ルール
|
|
77
78
|
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:sysd-index-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: architecture
|
|
5
6
|
status: draft
|
|
6
7
|
recipe: not-needed
|
|
7
8
|
sample: specdojo:sysd-index-sample
|
|
@@ -63,7 +64,7 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
63
64
|
| 項目 | 説明 | 必須 |
|
|
64
65
|
| ---------- | ------------------------------------------------------ | ---- |
|
|
65
66
|
| id | SYSD ID(推奨: `sysd-index`) | ○ |
|
|
66
|
-
| type | `architecture`
|
|
67
|
+
| type | `architecture` 固定 | ○ |
|
|
67
68
|
| title | システム設計: 全体構成(リンク集)など対象が分かる名称 | ○ |
|
|
68
69
|
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
69
70
|
| based_on | 根拠となる仕様ID(ID配列。未指定は `[]` 可) | 任意 |
|
|
@@ -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
|
+
| 任意利用の製品や実例の構成を一律の必須技術にする | 対象範囲や環境による違いを失うため |
|