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
|
@@ -16,7 +16,7 @@ Markdown の Frontmatter と YAML・JSON の構造化メタデータに関する
|
|
|
16
16
|
- 共通原則: Frontmatter を持つすべての Markdown ドキュメント
|
|
17
17
|
- 独立 YAML データファイル向け規約: SpecDojo スキーマ(`docs/specdojo/schemas/v1/`)を持つ YAML 成果物(`dct-*.yaml` / `pm-*.yaml` / `sch-*.yaml` / `bdd-*.yaml` など)
|
|
18
18
|
- JSON データファイル向け規約: SpecDojo が管理する JSON 文書、実行イベント、設定、インデックス、生成物
|
|
19
|
-
- 成果物向け詳細規約: `project` / `flow` / `rule` / `data` / `ui` / `api` / `architecture` / `test` / `operations` / `template`
|
|
19
|
+
- 成果物向け詳細規約: `project` / `requirement` / `glossary` / `flow` / `rule` / `data` / `ui` / `api` / `architecture` / `test` / `operations` / `template`
|
|
20
20
|
- 成果物スキーマ: [deliverable-frontmatter.schema.yaml](../../../specdojo/schemas/v1/deliverable-frontmatter.schema.yaml)
|
|
21
21
|
|
|
22
22
|
`rulebook` / `recipe` / `guide` / `reference` / `standard` / `philosophy` は専用スキーマを持つため、成果物向け詳細規約の対象外とします。それぞれの追加規約は次を正本とします。
|
|
@@ -36,6 +36,31 @@ Markdown の Frontmatter と YAML・JSON の構造化メタデータに関する
|
|
|
36
36
|
- `id` は共通スキーマの `idRef` に従い、`^[a-z0-9][a-z0-9-:]*$` に一致させる。
|
|
37
37
|
- npm package が所有する型(Kata)の文書の `id` は `<authority>:<local-id>` とし、SpecDojo core は `specdojo:` を使用する。これは Frontmatter の親キー `specdojo:` とは別に、ID値の所有元を表す namespace である。
|
|
38
38
|
- `type` は各ドキュメント種別のスキーマに定義された値を使用する。
|
|
39
|
+
- 成果物の `type` は次の意味で選び、準拠する rulebook の `specdojo.deliverable_type` を正本とする。index も扱う内容と同じ分類にする。
|
|
40
|
+
|
|
41
|
+
| 値 | 意味 |
|
|
42
|
+
| -------------- | ---------------------------------------------------------------------------- |
|
|
43
|
+
| `project` | プロジェクトの計画・体制・登録簿・進捗・管理ビュー(prj・pm・dct・tml など) |
|
|
44
|
+
| `requirement` | システム機能、業務イベントの要求、非機能要件、業務・システムの受入基準 |
|
|
45
|
+
| `glossary` | 用語と定義を管理する用語集 |
|
|
46
|
+
| `flow` | 業務フロー・プロセス・概念データフロー |
|
|
47
|
+
| `rule` | 業務の判断条件・規則 |
|
|
48
|
+
| `data` | データ構造・概念モデル・状態・保管・データ移行設計 |
|
|
49
|
+
| `ui` | 画面・帳票の仕様 |
|
|
50
|
+
| `api` | API・コマンド・ファイル・メッセージなど外部 I/F の契約 |
|
|
51
|
+
| `architecture` | システム構成・設計・技術選定 |
|
|
52
|
+
| `test` | テスト戦略・設計・ケース・実施計画 |
|
|
53
|
+
| `operations` | 運用設計・手順・本番切替・運用移管 |
|
|
54
|
+
|
|
55
|
+
- `project` をプロダクト仕様の受け皿にしない。sample は見本にする成果物の `type` を使い、`id` とファイル名の `-sample` で識別する。`template` はテンプレート自身の種別であり、生成物の種別ではない。
|
|
56
|
+
- `lint:fm` の frontmatter 検査では、Markdown 成果物・sample の `specdojo.type` と、テンプレートの `specdojo.frontmatter_template.specdojo.type` をそれぞれの `rulebook` の宣言と照合する。宣言と異なる値(従来の `project` や `sample` を含む)は即時エラーとし、宣言された置き換え先を表示する。`rulebook: none` は照合対象外とする。
|
|
57
|
+
- 照合は主 rulebook の宣言を使い、`includes` はたどらない。rulebook は完全 ID で解決し、同じ ID のローカル文書を同梱文書より優先する。解決不能・曖昧・宣言欠落は検査エラーとする。未修飾 ID は一意に解決できる場合のみ許容する。
|
|
58
|
+
- `validate:schema:yaml`(`yaml-schema --modeline`)と `validate:schema:file` は、YAML 成果物・sample のトップレベルまたは `x-spec-meta` の `type` と、テンプレートの `metadata_template.type` を主 rulebook の宣言と照合する。`specdojo-schema: none` / `validate=false` は構造の検証だけを省略し、メタ情報の照合は省略しない。平坦な YAML catalog テンプレートは生成物のメタ情報雛形を持たないため、その `type: template` は照合しない。
|
|
59
|
+
- YAML メタ情報の旧値 `domain` / `command` / `message` は `rulebook: none` の場合もエラーとし、それぞれ `data` / `api` / `api` への置き換えを表示する。本文中のデータ型や CloudEvents のイベント種別は対象外とする。
|
|
60
|
+
- YAML の表示用ページ(`generated/` 配下)は元 YAML のトップレベルまたは `x-spec-meta` の `type` を引き継ぐ。配置パスから分類を補わず、欠落も補完しない。生成ページも `lint:fm` の宣言照合対象とする。ただし、ジョブ定義・評価記録など `type` を持たない YAML の表示用ページは成果物 Frontmatter を付けずに生成する。これらの表示ページは Markdown の Frontmatter 必須原則の対象外とし、正本 YAML の構造・メタ情報は対応する schema と YAML 検証を正本とする。
|
|
61
|
+
- 成果物として成り立つ文書の `type` は、中身の種類(`project` / `flow` / `data` など)を表す。成果物として成り立たない実践の型(rulebook / recipe / template など)の `type` は、その役割を表す。
|
|
62
|
+
- sample は完成した成果物の最小例であり、Markdown・YAML・JSON とも、`type` には見本にする成果物の type を書く。sample であることは `id` とファイル名の `-sample`、`samples/` への配置、対応 rulebook の `sample` 宣言で表す。
|
|
63
|
+
- sample のメタ情報と本文は成果物と同じ形式にし、文書索引で実物の成果物と衝突しないよう `id` を区別する。既存の `type: sample` は schema 上の互換値として保持するが、新規作成・更新では使用しない。rulebook を持つ Markdown・YAML sample は宣言との照合でエラーになるため、宣言された成果物の type へ移行する。
|
|
39
64
|
- `status` は `draft` / `ready` / `deprecated` のいずれかとする。
|
|
40
65
|
- ドキュメント名は Frontmatter ではなく本文先頭の H1 に記述する。
|
|
41
66
|
- `specdojo:` 名前空間の対象は Markdown Frontmatter のみとする。独立 YAML データファイル(`dct-*.yaml` / `pm-*.yaml` / `sch-*.yaml` など)は Markdown ではなく他ツールとの同居も無いため、名前空間化せずトップレベルに項目を置く。
|
|
@@ -126,7 +151,7 @@ specdojo:
|
|
|
126
151
|
- `rulebook` を必須とし、準拠する rulebook の ID を指定する。該当する rulebook がない場合のみ `none` を許可する(成果物の必須項目と同じ制約)。
|
|
127
152
|
- YAML catalog テンプレート(`dct-*-template.yaml`)では、`title` / `rulebook` は生成物側フィールドとして生成物の値を平坦に記述する(テンプレート自身のメタ情報と生成物 Frontmatter の分離を参照)。それ以外のテンプレート(`*-template.yaml`)では、`title` はテンプレート自身の名前を実値で記述し、生成物のメタ情報は `metadata_template` に記述する(本標準 `生成物メタ情報雛形(metadata_template)`)。
|
|
128
153
|
- 上記以外の項目(`based_on` / `supersedes` / `version` / `project_id` など)の許可項目と型は各スキーマを正本とする。
|
|
129
|
-
- OpenAPI / AsyncAPI など外部標準形式の YAML(`ifx-*`
|
|
154
|
+
- OpenAPI / AsyncAPI など外部標準形式の YAML(`ifx-*` 等)は配置について各形式の慣行に従い、表題は `info.title`、`id` / `type` / `status` / `rulebook` は `x-spec-meta` に置く。`type` は主 rulebook の宣言と照合する。
|
|
130
155
|
|
|
131
156
|
```yaml
|
|
132
157
|
id: prj-0001:pm-roles
|
|
@@ -251,7 +276,7 @@ specdojo:
|
|
|
251
276
|
|
|
252
277
|
### 6.2. 継続品質評価(`grade`)
|
|
253
278
|
|
|
254
|
-
Markdown 文書の最新の継続品質評価は、プロジェクトの `<execution_path>/grade/results
|
|
279
|
+
Markdown 文書の最新の継続品質評価は、プロジェクトの `<execution_path>/grade/results/` 配下にサイドカーとして記録します。本リポジトリの文書は `<doc-id>.yaml`、`project.repos` に宣言したリポジトリの文書は `<repo 名>/<doc-id>.yaml` に保存し、`<repo 名>` には `repos[].name`、ファイル名には文書 ID の `:` を `.` に置き換えた値を使います。成果物の Frontmatter と本文には grade や finding を書き込みません。サイドカーは最新状態のスナップショットであり、`specdojo grade apply` は同じリポジトリ・文書 ID のファイルを冪等に上書きします。履歴は Job Run と evidence、合意形成は review result が担います。成果物の現在品質を参照するときは、サイドカーの `content_hash` が現在のファイル全体と一致することを確認します。
|
|
255
280
|
|
|
256
281
|
| 項目 | 意味 |
|
|
257
282
|
| ------------------- | ------------------------------------------------------------------------------------ |
|
|
@@ -442,6 +442,8 @@ IDには、次の情報を含めない。
|
|
|
442
442
|
- `<subject>`: 文書の主題を表す名詞句
|
|
443
443
|
- `<type-suffix>`: `guide`、`standard`、`reference`、`philosophy`、`rulebook`、`recipe`、`sample`、`template`
|
|
444
444
|
|
|
445
|
+
sample の種類の判定は `id` の local-id の末尾 `-sample` で行います。`type` は見本にする成果物の type とします(正本: [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]])。この規則は利用者の authority の sample にも適用します。
|
|
446
|
+
|
|
445
447
|
- package の所有元は `specdojo:` のような authority で表し、local-id に `specdojo-` のような所属接頭辞を重ねない。
|
|
446
448
|
- ただし SpecDojo 自体を主題とする文書は、主題語として `specdojo` を用いる。
|
|
447
449
|
|
|
@@ -32,22 +32,26 @@ Rulebook Authoring Standard
|
|
|
32
32
|
- ファイル名は `<prefix>-rulebook.md` とする。
|
|
33
33
|
- `id` / `type` / `status` を必須とし、共通原則は [document-metadata-standard.md](document-metadata-standard.md) に従う。
|
|
34
34
|
- `type` は `rulebook` 固定とする。
|
|
35
|
+
- `deliverable_type` は必須とし、扱う成果物の `type` を一つ宣言する。値の意味は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。`template` / `sample` は成果物の分類ではないため宣言しない。
|
|
35
36
|
- `id` はauthority、英小文字・数字・ハイフンで構成し、一意にする(正確な制約は参照スキーマに従う)。
|
|
36
37
|
- `status` は `draft` / `ready` / `deprecated` のいずれかとする。
|
|
37
38
|
|
|
38
|
-
| 項目
|
|
39
|
-
|
|
|
40
|
-
| id
|
|
41
|
-
| type
|
|
42
|
-
|
|
|
43
|
-
|
|
|
44
|
-
|
|
|
45
|
-
|
|
|
46
|
-
|
|
|
47
|
-
|
|
|
48
|
-
|
|
|
39
|
+
| 項目 | 必須 | 説明 |
|
|
40
|
+
| ------------------ | ---- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
|
41
|
+
| id | ○ | 同梱は `specdojo:<prefix>-rulebook`、利用者作成は `<kata_authority>:<prefix>-rulebook` 形式の一意 ID |
|
|
42
|
+
| type | ○ | `rulebook` 固定 |
|
|
43
|
+
| `deliverable_type` | ○ | 成果物の種別。`project` / `requirement` / `glossary` / `flow` / `rule` / `data` / `ui` / `api` / `architecture` / `test` / `operations` |
|
|
44
|
+
| status | ○ | `draft` / `ready` / `deprecated` |
|
|
45
|
+
| target_format | 任意 | 対象ドキュメントのフォーマット(`yaml` / `json` / `markdown`) |
|
|
46
|
+
| recipe | 任意 | 対応する recipe の完全 ID、`undecided`、`not-needed` |
|
|
47
|
+
| sample | 任意 | 対応する sample の完全 ID または ID 配列、上記2状態 |
|
|
48
|
+
| template | 任意 | 対応する template の完全 ID、`undecided`、`not-needed` |
|
|
49
|
+
| based_on | 任意 | 上位規約や根拠ドキュメント |
|
|
50
|
+
| supersedes | 任意 | 置き換え関係 |
|
|
49
51
|
|
|
50
52
|
- `target_format` が未記載の場合は markdown を対象とみなす。
|
|
53
|
+
- `deliverable_type` は format・成熟度によらず全 rulebook に必要とする。index は扱う内容で分類し、`project` はプロジェクトの管理文書に限る。Mermaid など `includes` で適用される記法部品も、扱う成果物の種別を宣言する。
|
|
54
|
+
- `lint:fm` は Markdown 成果物・sample・テンプレートの生成物 Frontmatter(`frontmatter_template`)を、主 rulebook の宣言と照合する。テンプレート自身の `type: template` は照合しない。宣言との不一致、宣言欠落、参照の解決不能・曖昧さはエラーとし、不一致には宣言値を示す。YAML 成果物・sample とテンプレートの `metadata_template` は YAML schema 検証時に同じ宣言と照合し、外部形式の `x-spec-meta` も対象とする。構造検証を省略する指示でも照合は省略しない。YAML の表示用ページは正本の `type` を引き継ぎ、`lint:fm` の照合対象とする。
|
|
51
55
|
- `recipe` / `sample` / `template` は要否と所在の正本であり、`undecided` は要否未判断、項目省略は必要だが未整備、完全 ID は必要かつ整備済み、`not-needed` は不要を表す。
|
|
52
56
|
- 完全 ID は `fully-guided` / `recipe-guided` の plan 生成で参照先パスの解決に使う(rulebook を参照ハブとする)。命名規約に従う場合も明示的に宣言し、宣言された参照先ファイルが存在しないと `exec validate` が警告する。`sample` の拡張子は `target_format` に従う。
|
|
53
57
|
- 同じ rulebook 系統に複数の完成例がある場合、`sample` を ID 配列で宣言する。配列の先頭を既定例として使う。
|
|
@@ -60,6 +64,7 @@ Rulebook Authoring Standard
|
|
|
60
64
|
specdojo:
|
|
61
65
|
id: specdojo:imp-business-rulebook
|
|
62
66
|
type: rulebook
|
|
67
|
+
deliverable_type: project
|
|
63
68
|
status: draft
|
|
64
69
|
---
|
|
65
70
|
```
|
|
@@ -105,6 +105,7 @@ sample は実在プロジェクトの記録ではありません。記載値は
|
|
|
105
105
|
|
|
106
106
|
- ファイル名は `<prefix>-sample.md` / `<prefix>-sample.yaml` / `<prefix>-sample.json` とし、対応 rulebook の `target_format` に合わせる。
|
|
107
107
|
- `target_format` が未記載の場合は markdown を対象とみなす。
|
|
108
|
+
- [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、`type` は見本にする成果物の type とする。sample であることは `id` とファイル名の `-sample` で表す。
|
|
108
109
|
- Markdown の場合、H1 はファイル内で 1 つだけとし、`id` / `type` / `status` / `rulebook` を含む Frontmatter を先頭に置く。
|
|
109
110
|
- YAML / JSON の場合、対応 rulebook が定める先頭メタ項目・ルートキー・必須キーを満たす。
|
|
110
111
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:pjr-dependent-items-template
|
|
4
|
+
type: template
|
|
5
|
+
status: draft
|
|
6
|
+
frontmatter_template:
|
|
7
|
+
specdojo:
|
|
8
|
+
id: _PROJECT_ID_:pjr-dependent-items
|
|
9
|
+
type: project
|
|
10
|
+
status: ready
|
|
11
|
+
rulebook: specdojo:pjr-rulebook
|
|
12
|
+
part_of:
|
|
13
|
+
- _PROJECT_ID_:pjr-index
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
# 登録項目の実行依存
|
|
17
|
+
|
|
18
|
+
> このファイルは個票の `depends_on` から生成された派生ビューです。正本は個票の Frontmatter であり、このファイルは再生成可能です。
|
|
19
|
+
|
|
20
|
+
## 1. 先行項目から後続項目を辿る
|
|
21
|
+
|
|
22
|
+
<!-- specdojo:view-slot=derived-items -->
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:pjr-epic-items-template
|
|
4
|
+
type: template
|
|
5
|
+
status: draft
|
|
6
|
+
frontmatter_template:
|
|
7
|
+
specdojo:
|
|
8
|
+
id: _PROJECT_ID_:pjr-epic-items
|
|
9
|
+
type: project
|
|
10
|
+
status: draft
|
|
11
|
+
rulebook: specdojo:pjr-rulebook
|
|
12
|
+
part_of:
|
|
13
|
+
- _PROJECT_ID_:pjr-index
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
# epic ごとの子項目
|
|
17
|
+
|
|
18
|
+
> 個票の `derived_from` から生成した直接の子項目と現在の状態です。正本は個票の Frontmatter です。子の完了だけでは epic を自動 close しません。
|
|
19
|
+
|
|
20
|
+
## 1. epic 別の一覧
|
|
21
|
+
|
|
22
|
+
<!-- specdojo:view-slot=epic-items -->
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:pjr-epic-template
|
|
4
|
+
type: template
|
|
5
|
+
status: draft
|
|
6
|
+
frontmatter_template:
|
|
7
|
+
specdojo:
|
|
8
|
+
id: _PJR_DOCUMENT_ID_
|
|
9
|
+
type: project
|
|
10
|
+
status: draft
|
|
11
|
+
rulebook: specdojo:pjr-rulebook
|
|
12
|
+
part_of:
|
|
13
|
+
- _PROJECT_ID_:pjr-index
|
|
14
|
+
item_type: epic
|
|
15
|
+
track: track-id
|
|
16
|
+
item_status: open
|
|
17
|
+
priority: medium
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
# _PJR-XXXX_ _EPIC_TITLE_
|
|
21
|
+
|
|
22
|
+
## 1. 概要
|
|
23
|
+
|
|
24
|
+
_TODO_: track で達成する目的と着手の理由を記載する。
|
|
25
|
+
|
|
26
|
+
## 2. 範囲(track と domain)
|
|
27
|
+
|
|
28
|
+
_TODO_: Frontmatter の `track` が担う範囲と対象 domain、対象外の境界を記載する。
|
|
29
|
+
|
|
30
|
+
## 3. 完了の判断の基準
|
|
31
|
+
|
|
32
|
+
- _TODO_: 子項目と schedule を確認して、人が完了を判断できる基準を記載する。
|
|
33
|
+
|
|
34
|
+
## 4. 子項目
|
|
35
|
+
|
|
36
|
+
子 todo は `register add --type todo --from <epic-id>` で起票する。現在の一覧と状態は `register build` が生成する epic 別ビューで確認する。
|
|
37
|
+
|
|
38
|
+
## 5. 対応結果
|
|
39
|
+
|
|
40
|
+
_TODO_: 完了を判断した根拠と残課題を記載する。未完了の場合は `-` とする。
|
|
41
|
+
|
|
42
|
+
## 6. 関連ドキュメント
|
|
43
|
+
|
|
44
|
+
- _TODO_: 根拠・影響先・追跡先を文書 ID で記載する。
|
|
@@ -27,8 +27,8 @@ Project Register
|
|
|
27
27
|
## 1. 登録項目一覧
|
|
28
28
|
|
|
29
29
|
<!-- prettier-ignore -->
|
|
30
|
-
| ID | ステータス | タイトル | 説明 | 分類 | 優先度 | 担当 | 登録日 | 期限 | 完了日 | 結論 | 個票 |
|
|
31
|
-
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
|
30
|
+
| ID | ステータス | タイトル | 説明 | 分類 | 優先度 | 担当 | 登録日 | 期限 | 完了日 | 結論 | 個票 | `depends_on` |
|
|
31
|
+
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
|
32
32
|
|
|
33
33
|
## 2. 派生ビュー
|
|
34
34
|
|
|
@@ -41,6 +41,8 @@ Project Register
|
|
|
41
41
|
- [[pjr-views-by-priority|台帳ビュー(優先度別)]]
|
|
42
42
|
- [[pjr-views-by-owner|台帳ビュー(担当者別)]]
|
|
43
43
|
- [[pjr-derived-items|登録項目の派生関係]]
|
|
44
|
+
- [[_PROJECT_ID_:pjr-dependent-items|登録項目の実行依存]]
|
|
45
|
+
- [[_PROJECT_ID_:pjr-epic-items|epic ごとの子項目]]
|
|
44
46
|
|
|
45
47
|
### 2.2. controls 全体の派生管理ビュー
|
|
46
48
|
|
|
@@ -1,5 +1,20 @@
|
|
|
1
1
|
$schema: "https://json-schema.org/draft/2020-12/schema"
|
|
2
2
|
title: Deliverables Front Matter
|
|
3
|
+
$defs:
|
|
4
|
+
deliverableType:
|
|
5
|
+
type: string
|
|
6
|
+
enum:
|
|
7
|
+
- project # プロジェクトの管理文書
|
|
8
|
+
- requirement # システム機能・非機能要件・受入基準
|
|
9
|
+
- glossary # 用語集
|
|
10
|
+
- flow # 業務フロー・プロセス仕様
|
|
11
|
+
- rule # 業務ルール仕様
|
|
12
|
+
- data # データ仕様
|
|
13
|
+
- ui # 画面・帳票仕様
|
|
14
|
+
- api # API・外部 I/F 仕様
|
|
15
|
+
- architecture # アーキテクチャ設計
|
|
16
|
+
- test # テスト仕様・設計
|
|
17
|
+
- operations # 運用設計・手順
|
|
3
18
|
# SpecDojo が所有する frontmatter は `specdojo:` 名前空間配下に置く。
|
|
4
19
|
# トップレベルは第三者ツール(VitePress 等)のキーを許容するため制限しない。
|
|
5
20
|
type: object
|
|
@@ -16,22 +31,12 @@ properties:
|
|
|
16
31
|
- rulebook
|
|
17
32
|
properties:
|
|
18
33
|
type:
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
- project # プロジェクト文書全般
|
|
26
|
-
# プロダクト仕様文書
|
|
27
|
-
- flow # 業務フロー・プロセス仕様
|
|
28
|
-
- rule # 業務ルール仕様
|
|
29
|
-
- data # データ仕様
|
|
30
|
-
- ui # 画面・帳票仕様
|
|
31
|
-
- api # API・外部I/F仕様
|
|
32
|
-
- architecture # アーキテクチャ設計
|
|
33
|
-
- test # テスト仕様・設計
|
|
34
|
-
- operations # 運用設計・手順
|
|
34
|
+
anyOf:
|
|
35
|
+
- $ref: "#/$defs/deliverableType"
|
|
36
|
+
- type: string
|
|
37
|
+
enum:
|
|
38
|
+
- template # テンプレート自身のメタ情報
|
|
39
|
+
- sample # 非推奨。rulebook を持つ sample は宣言された成果物 type に移行する。
|
|
35
40
|
description: "仕様の種別(rulebook/guide/standard は各専用スキーマを使用)"
|
|
36
41
|
rulebook:
|
|
37
42
|
$ref: "./common-frontmatter.schema.yaml#/$defs/rulebookRef"
|
|
@@ -60,6 +65,9 @@ properties:
|
|
|
60
65
|
item_type:
|
|
61
66
|
$ref: "./register-item-frontmatter.schema.yaml#/$defs/ItemType"
|
|
62
67
|
description: "プロジェクト登録項目の種別。pjr-*-template で使用する。"
|
|
68
|
+
track:
|
|
69
|
+
$ref: "./register-item-frontmatter.schema.yaml#/$defs/Track"
|
|
70
|
+
description: "epic が担う track。定義の検証は register コマンドが行う。"
|
|
63
71
|
item_status:
|
|
64
72
|
$ref: "./register-item-frontmatter.schema.yaml#/$defs/ItemStatus"
|
|
65
73
|
description: "登録項目の処理状態。文書成熟度の status とは別の状態軸。"
|
|
@@ -52,6 +52,8 @@ $defs:
|
|
|
52
52
|
"recipe-guided",
|
|
53
53
|
"freeform",
|
|
54
54
|
"bootstrap",
|
|
55
|
+
"catalog-planning",
|
|
56
|
+
"strategy-planning",
|
|
55
57
|
"rulebook-authoring",
|
|
56
58
|
"recipe-authoring",
|
|
57
59
|
"sample-authoring",
|
|
@@ -66,7 +68,8 @@ $defs:
|
|
|
66
68
|
"bootstrap-finalize",
|
|
67
69
|
]
|
|
68
70
|
description: >
|
|
69
|
-
How the task is carried out.
|
|
71
|
+
How the task is carried out. catalog-planning and strategy-planning create a catalog
|
|
72
|
+
or schedule strategy from register-only domain:<id> / track:<id> targets. fully-guided/recipe-guided/freeform describe how strictly
|
|
70
73
|
the agent follows reference materials (rulebook/recipe/sample/template) when working on
|
|
71
74
|
a deliverable. bootstrap authors the deliverable and its full reference set
|
|
72
75
|
(rulebook/recipe/sample/template) together in one task as a mutually consistent whole;
|
|
@@ -110,7 +110,7 @@ properties:
|
|
|
110
110
|
minLength: 1
|
|
111
111
|
minItems: 1
|
|
112
112
|
description: >
|
|
113
|
-
|
|
113
|
+
Document IDs, or domain:<id> / track:<id> for register planning approaches. Existing documents are resolvable via the
|
|
114
114
|
doc index. For deliverable work, the first entry is the target deliverable and subsequent
|
|
115
115
|
entries are reference materials the approach may modify or confirm. For *-authoring
|
|
116
116
|
register tasks, the entry is an intentionally not-yet-existing kata id; read-only
|
|
@@ -4,10 +4,18 @@ type: object
|
|
|
4
4
|
additionalProperties: false
|
|
5
5
|
required:
|
|
6
6
|
- id
|
|
7
|
+
- type
|
|
8
|
+
- rulebook
|
|
7
9
|
- title
|
|
8
10
|
- locale
|
|
9
11
|
- terms
|
|
10
12
|
properties:
|
|
13
|
+
type:
|
|
14
|
+
type: string
|
|
15
|
+
const: glossary
|
|
16
|
+
rulebook:
|
|
17
|
+
type: string
|
|
18
|
+
pattern: "^((?:[a-z][a-z0-9-]*:)?[a-z0-9][a-z0-9-]*-rulebook|none)$"
|
|
11
19
|
id:
|
|
12
20
|
type: string
|
|
13
21
|
pattern: "^([a-z0-9-]+:)?gl-[a-z0-9-]+$"
|
|
@@ -26,7 +26,7 @@ properties:
|
|
|
26
26
|
minLength: 1
|
|
27
27
|
type:
|
|
28
28
|
type: string
|
|
29
|
-
enum: ["
|
|
29
|
+
enum: ["api", "template"]
|
|
30
30
|
status:
|
|
31
31
|
type: string
|
|
32
32
|
enum: ["draft", "ready", "deprecated"]
|
|
@@ -46,6 +46,10 @@ properties:
|
|
|
46
46
|
metadata_template:
|
|
47
47
|
type: object
|
|
48
48
|
additionalProperties: true
|
|
49
|
+
properties:
|
|
50
|
+
type:
|
|
51
|
+
type: string
|
|
52
|
+
const: api
|
|
49
53
|
|
|
50
54
|
command:
|
|
51
55
|
type: object
|
|
@@ -81,8 +81,9 @@ $defs:
|
|
|
81
81
|
required: [status, commit, merged_at]
|
|
82
82
|
properties:
|
|
83
83
|
status:
|
|
84
|
+
# branch-only is successful handling without a merge; commit and merged_at stay null.
|
|
84
85
|
type: string
|
|
85
|
-
enum: [pending, merged, unchanged, failed]
|
|
86
|
+
enum: [pending, merged, unchanged, branch-only, failed]
|
|
86
87
|
# Merge commit on the integration target. Null for the project repository (the merge commit
|
|
87
88
|
# contains this state) and for repositories that are not merged.
|
|
88
89
|
commit:
|
|
@@ -33,6 +33,22 @@ $defs:
|
|
|
33
33
|
- migrate
|
|
34
34
|
|
|
35
35
|
RegisterEventChange:
|
|
36
|
+
allOf:
|
|
37
|
+
- if:
|
|
38
|
+
required: [field]
|
|
39
|
+
properties:
|
|
40
|
+
field:
|
|
41
|
+
const: type
|
|
42
|
+
then:
|
|
43
|
+
properties:
|
|
44
|
+
from:
|
|
45
|
+
anyOf:
|
|
46
|
+
- $ref: "./register-item-frontmatter.schema.yaml#/$defs/ItemType"
|
|
47
|
+
- enum: ["", "-", "_TODO_"]
|
|
48
|
+
to:
|
|
49
|
+
anyOf:
|
|
50
|
+
- $ref: "./register-item-frontmatter.schema.yaml#/$defs/ItemType"
|
|
51
|
+
- enum: ["", "-", "_TODO_"]
|
|
36
52
|
type: object
|
|
37
53
|
additionalProperties: false
|
|
38
54
|
required:
|
|
@@ -48,6 +64,7 @@ $defs:
|
|
|
48
64
|
- title
|
|
49
65
|
- description
|
|
50
66
|
- type
|
|
67
|
+
- track
|
|
51
68
|
- priority
|
|
52
69
|
- difficulty
|
|
53
70
|
- owner
|
|
@@ -62,6 +79,7 @@ $defs:
|
|
|
62
79
|
- target_path
|
|
63
80
|
- target_rulebook
|
|
64
81
|
- derived_from
|
|
82
|
+
- depends_on
|
|
65
83
|
- autopilot
|
|
66
84
|
from:
|
|
67
85
|
type: string
|
|
@@ -107,6 +107,18 @@ properties:
|
|
|
107
107
|
finalize,
|
|
108
108
|
bootstrap-finalize,
|
|
109
109
|
]
|
|
110
|
+
- if:
|
|
111
|
+
required: [item_type]
|
|
112
|
+
properties:
|
|
113
|
+
item_type:
|
|
114
|
+
const: epic
|
|
115
|
+
then:
|
|
116
|
+
required: [track]
|
|
117
|
+
properties:
|
|
118
|
+
track: true
|
|
119
|
+
else:
|
|
120
|
+
properties:
|
|
121
|
+
track: false
|
|
110
122
|
- type: object
|
|
111
123
|
required:
|
|
112
124
|
- rulebook
|
|
@@ -150,6 +162,10 @@ properties:
|
|
|
150
162
|
$ref: "#/$defs/ItemType"
|
|
151
163
|
description: "Classification of the register item (list column: 分類)."
|
|
152
164
|
|
|
165
|
+
track:
|
|
166
|
+
$ref: "#/$defs/Track"
|
|
167
|
+
description: "Track governed by this epic; checked against tml-index.yaml when present."
|
|
168
|
+
|
|
153
169
|
item_status:
|
|
154
170
|
$ref: "#/$defs/ItemStatus"
|
|
155
171
|
description: "Processing status of the item (list column: ステータス)."
|
|
@@ -226,6 +242,19 @@ properties:
|
|
|
226
242
|
same project and <project-id>:PJR-XXXX for an item in another project. Omit the key
|
|
227
243
|
when the item was not derived from another register item.
|
|
228
244
|
|
|
245
|
+
depends_on:
|
|
246
|
+
type: array
|
|
247
|
+
items:
|
|
248
|
+
oneOf:
|
|
249
|
+
- $ref: "#/$defs/LocalRegisterItemRef"
|
|
250
|
+
- $ref: "#/$defs/QualifiedRegisterItemRef"
|
|
251
|
+
minItems: 1
|
|
252
|
+
uniqueItems: true
|
|
253
|
+
description: >
|
|
254
|
+
Predecessor register item IDs. Execution requires every predecessor to be done or
|
|
255
|
+
decided; rejected and deferred do not satisfy a dependency. References use the
|
|
256
|
+
same local or project-qualified syntax as derived_from. Cycles are forbidden.
|
|
257
|
+
|
|
229
258
|
autopilot:
|
|
230
259
|
type: string
|
|
231
260
|
const: approved
|
|
@@ -238,7 +267,8 @@ properties:
|
|
|
238
267
|
description: >
|
|
239
268
|
Execution approach. Authoring approaches use the target as the new kata id and
|
|
240
269
|
sources as read-only exemplars. For compatibility, additional targets are also
|
|
241
|
-
accepted as exemplar sources.
|
|
270
|
+
accepted as exemplar sources. Planning approaches require one domain:<id> or track:<id>
|
|
271
|
+
target. Other approaches require one compatible document id.
|
|
242
272
|
|
|
243
273
|
targets:
|
|
244
274
|
type: array
|
|
@@ -247,7 +277,7 @@ properties:
|
|
|
247
277
|
minLength: 1
|
|
248
278
|
minItems: 1
|
|
249
279
|
description: >
|
|
250
|
-
|
|
280
|
+
Document IDs or planning units (domain:<id> for catalog-planning, track:<id> for strategy-planning). Deliverable targets
|
|
251
281
|
used with an approach prefer the project catalog; target_path and target_rulebook or existing frontmatter allow catalog-less resolution so that
|
|
252
282
|
not-yet-created deliverables can be selected; kata and standalone
|
|
253
283
|
targets are resolved via the doc index. When present, exec plan
|
|
@@ -279,10 +309,15 @@ properties:
|
|
|
279
309
|
key when the authoring task has no exemplar.
|
|
280
310
|
|
|
281
311
|
$defs:
|
|
312
|
+
Track:
|
|
313
|
+
type: string
|
|
314
|
+
pattern: "^[a-z0-9][a-z0-9-]*$"
|
|
315
|
+
|
|
282
316
|
ItemType:
|
|
283
317
|
type: string
|
|
284
318
|
enum:
|
|
285
319
|
- todo
|
|
320
|
+
- epic
|
|
286
321
|
- question
|
|
287
322
|
- risk
|
|
288
323
|
- issue
|
|
@@ -337,6 +372,8 @@ $defs:
|
|
|
337
372
|
- recipe-guided
|
|
338
373
|
- freeform
|
|
339
374
|
- bootstrap
|
|
375
|
+
- catalog-planning
|
|
376
|
+
- strategy-planning
|
|
340
377
|
- rulebook-authoring
|
|
341
378
|
- recipe-authoring
|
|
342
379
|
- sample-authoring
|
|
@@ -349,7 +386,7 @@ $defs:
|
|
|
349
386
|
- template-maintenance
|
|
350
387
|
- finalize
|
|
351
388
|
- bootstrap-finalize
|
|
352
|
-
description: "Execution approach shared with src/shared/agent-types.ts."
|
|
389
|
+
description: "Execution approach shared with src/shared/agent-types.ts. catalog-planning and strategy-planning are register-only."
|
|
353
390
|
|
|
354
391
|
Date:
|
|
355
392
|
type: string
|
|
@@ -11,11 +11,16 @@ properties:
|
|
|
11
11
|
allOf:
|
|
12
12
|
- $ref: "./common-frontmatter.schema.yaml"
|
|
13
13
|
- type: object
|
|
14
|
+
required:
|
|
15
|
+
- deliverable_type
|
|
14
16
|
properties:
|
|
15
17
|
type:
|
|
16
18
|
type: string
|
|
17
19
|
const: rulebook
|
|
18
20
|
description: "ドキュメント種別(rulebook 固定)"
|
|
21
|
+
deliverable_type:
|
|
22
|
+
$ref: "./deliverable-frontmatter.schema.yaml#/$defs/deliverableType"
|
|
23
|
+
description: "扱う成果物の type。Markdown 成果物・sample・生成物 Frontmatter 雛形との照合の正本。"
|
|
19
24
|
target_format:
|
|
20
25
|
type: string
|
|
21
26
|
enum:
|
|
@@ -148,6 +148,11 @@ $defs:
|
|
|
148
148
|
integration_branch:
|
|
149
149
|
description: Branch exec integrates into. Omit to use the repository's current branch.
|
|
150
150
|
$ref: "#/$defs/NonEmptyString"
|
|
151
|
+
integration_strategy:
|
|
152
|
+
description: Local merge commit (default), or retain the exec branch for product-side PR review.
|
|
153
|
+
type: string
|
|
154
|
+
enum: [merge, branch-only]
|
|
155
|
+
default: merge
|
|
151
156
|
setup:
|
|
152
157
|
description: Whether exec installs dependencies and builds in the repository worktree.
|
|
153
158
|
type: object
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "specdojo",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.0",
|
|
4
4
|
"description": "A dojo for Spec-Dō, the way of specification: decide with a register, write specs and designs with kata, and keep sharpening them with AI.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "naoji3x",
|
|
@@ -90,7 +90,7 @@
|
|
|
90
90
|
"docs:generate": "node --import tsx src/specdojo.ts build",
|
|
91
91
|
"docs:dev": "npm run docs:generate && npm --prefix packages/docs-site run docs:dev",
|
|
92
92
|
"docs:build:mermaid": "npm --prefix packages/docs-site run docs:build:mermaid",
|
|
93
|
-
"docs:rebuild:mermaid": "rm -f
|
|
93
|
+
"docs:rebuild:mermaid": "rm -f .vitepress/mermaid/*.svg && npm run docs:build:mermaid",
|
|
94
94
|
"docs:build": "npm run docs:generate && npm --prefix packages/docs-site run docs:build",
|
|
95
95
|
"lint:fm": "node packages/docs-lint/bin/specdojo-docs-lint.js remark \"docs/**/*.{md,mdx}\" --quiet --frail",
|
|
96
96
|
"validate:schema:job-run": "node packages/docs-lint/bin/specdojo-docs-lint.js yaml-schema --schema docs/specdojo/schemas/v1/job-run.schema.yaml --data \"docs/ja/**/execution/jobs/runs/*.json\" --allow-empty",
|
|
@@ -85,15 +85,16 @@ catalog へ進む段階になったら、`.specdojo/specdojo.config.json` へ `c
|
|
|
85
85
|
|
|
86
86
|
type は次のように使い分ける。
|
|
87
87
|
|
|
88
|
-
| type | 用途
|
|
89
|
-
| ---------------- |
|
|
90
|
-
| `issue` | 解決すべき問題。原因調査を伴う
|
|
91
|
-
| `decision` | 選択肢から方針を決める
|
|
92
|
-
| `todo` | 実施する作業
|
|
93
|
-
| `question` | 判断を保留し、後で決める
|
|
94
|
-
| `risk` | 将来の不確実性
|
|
95
|
-
| `change-request` | 合意済み範囲の変更要求
|
|
96
|
-
| `note` | 記録として残す観測・分析
|
|
88
|
+
| type | 用途 | 終端状態 |
|
|
89
|
+
| ---------------- | ---------------------------------- | --------- |
|
|
90
|
+
| `issue` | 解決すべき問題。原因調査を伴う | `done` |
|
|
91
|
+
| `decision` | 選択肢から方針を決める | `decided` |
|
|
92
|
+
| `todo` | 実施する作業 | `done` |
|
|
93
|
+
| `question` | 判断を保留し、後で決める | `decided` |
|
|
94
|
+
| `risk` | 将来の不確実性 | `done` |
|
|
95
|
+
| `change-request` | 合意済み範囲の変更要求 | `done` |
|
|
96
|
+
| `note` | 記録として残す観測・分析 | なし |
|
|
97
|
+
| `epic` | track ごとの仕事の着手と完了の管理 | `done` |
|
|
97
98
|
|
|
98
99
|
起票では `--title` と `--description` を具体的に書く。`--description` は一覧へ出るため、後から見て内容が分かる文にする。`--topic` を省くとタイトルの英数字の部分から導出される。タイトルが日本語の場合は、内容を表す英語の `--topic`(小文字・ハイフン区切り。例: `payment-scope`)を渡す。
|
|
99
100
|
|
|
@@ -123,6 +124,10 @@ npx specdojo register close --project <project-id> --id <PJR-XXXX> \
|
|
|
123
124
|
|
|
124
125
|
`decision` と `question` は `--status decided` を付ける。close の前に個票の `決定内容` / `承認` を埋める。
|
|
125
126
|
|
|
127
|
+
`epic` は `--track <track>` で担う track を指定して起票し、具体的な作業は `--from <epic-id>` を付けた子 todo に分解する。epic 自体は `exec run --register` で実行せず、夜間の実行でも飛ばされる。子項目の状態は `register build` が生成する epic ごとのビューで確かめ、子項目と schedule を材料に人が close を判断する。
|
|
128
|
+
|
|
129
|
+
順番のある項目は `--depends-on <PJR-XXXX>`(繰り返し指定できる)で先に終わっているべき項目を記録する。起票の由来を表す `--from`(`derived_from`)とは別の意味で、どちらかで他方を兼ねない。先行の項目がすべて `done` / `decided` になるまで、`exec run --register` は止まり、夜間の実行では飛ばされる。状態は自動では `waiting` にならない。外すときは `--depends-on -` を指定する。後続の項目は一覧の `depends_on` 列と `generated/pjr-dependent-items.md` で確かめる。
|
|
130
|
+
|
|
126
131
|
`note` は終端させず、`open` のまま新しい事実・知見を追記する。close / reject / defer の対象にしない。対応や判断が必要になった場合は、目的に合う別の type で起票し、note は参照元として残す(`pjr-rulebook` の type 別の扱い)。
|
|
127
132
|
|
|
128
133
|
## 実践の型(kata)の扱い
|