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
|
@@ -0,0 +1,198 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:tsd-recipe
|
|
4
|
+
type: recipe
|
|
5
|
+
status: draft
|
|
6
|
+
rulebook: specdojo:tsd-rulebook
|
|
7
|
+
sample: specdojo:tsd-sample
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# 技術領域別 技術スタック詳細定義(TSD)作成レシピ
|
|
11
|
+
|
|
12
|
+
Technology Stack Detail Definition (TSD) Writing Recipe
|
|
13
|
+
|
|
14
|
+
採用した技術や実行基盤について、別の担当者が構成を再現し、利用できる状態か判断できる文書へ仕上げる手順を示します。初期構築、クライアント接続、日常利用の違いを整理し、設定の根拠から確認・復旧までをつなぎます。
|
|
15
|
+
|
|
16
|
+
## 1. このレシピの使い方
|
|
17
|
+
|
|
18
|
+
- 上位設計や非機能要件から、対象の技術で実現する利用場面と守る条件を短く抜き出す。技術一覧の採用理由や組織全体の運用方針は、その正本への参照で引き継ぐ。
|
|
19
|
+
- 「作成前に集める情報」をメモし、「全体の作成手順」で一冊の担当範囲を決める。初期構築・接続・日常利用をまとめるか分けるかは、読み手の開始条件と設定の更新単位から判断する。
|
|
20
|
+
- 「各章の書き方」を使い、構成、採用値、反映操作、正常性の判定を具体化する。必要な設定例やコマンドは対象環境で再現できる粒度にし、内部クラス、詳細 API 仕様、SQL 全文の設計はその担当文書へ委ねる。
|
|
21
|
+
- 最後に、利用目的に対する採用設定、設定を反映する操作、確認結果の対応をたどる。文書 ID、設定項目名、確認項目名で根拠を追跡し、未実施の確認は残る作業として示す。
|
|
22
|
+
|
|
23
|
+
## 2. 作成前に集める情報
|
|
24
|
+
|
|
25
|
+
秘密値を収集せず、次の問いに答える短いメモを作る。確認不足は _TODO_、意思決定待ちは _UNDECIDED_、仮の前提は _ASSUMPTION_ を付け、担当と確認・判断の時期を添える。
|
|
26
|
+
|
|
27
|
+
| 入力 | 答える問い・集める情報 |
|
|
28
|
+
| ------------------ | -------------------------------------------------------------------------------------------------------- |
|
|
29
|
+
| 利用目的と根拠 | 誰が何をできるようにするか。上位設計のどの責務・品質条件に応えるか |
|
|
30
|
+
| 文書の境界 | 技術一覧、既存の基盤定義、接続設定、利用手順のどこに正本があるか |
|
|
31
|
+
| 環境と権限 | OS、実行環境、ユーザー、権限、依存の版、必要な CPU・メモリ・ディスクは何か。特別な条件がない項目はどれか |
|
|
32
|
+
| 配置と経路 | 接続元、ホスト、コンテナ、サービスはどこで動き、どの方向へ通信するか。公開範囲はどこまでか |
|
|
33
|
+
| 設定の事実 | 導入済みの版、有効な設定、保存先、優先順位、再起動の要否を何で確認できるか |
|
|
34
|
+
| 採用の判断 | 決定済みの値と推奨候補は何か。互換性、ライセンス、資源の制約と採否の根拠は何か |
|
|
35
|
+
| 認証と公開範囲 | 認証方式、秘密情報の取得・保存・参照の仕組みは何か。固有の接続先や識別子を公開できるか |
|
|
36
|
+
| 確認と証跡 | 最小の利用成功は何か。確認場所、期待結果、確認環境・版・日付、記録先は何か |
|
|
37
|
+
| 継続利用と変更影響 | 切断、再起動、再構築で何が残るか。旧方式との競合、切り戻し、撤去で失う状態は何か |
|
|
38
|
+
|
|
39
|
+
## 3. 全体の作成手順
|
|
40
|
+
|
|
41
|
+
1. 利用目的を一文にし、文書を読み始める人の状態と、読み終えて確認する到達状態を書き出す。独立した利用目的が混ざっていたら別文書へ分ける。
|
|
42
|
+
2. 初期構築・接続設定・日常利用の担当を決める。同じ読み手が同じ前提で一続きに作業し、設定を一か所で保守できるなら一冊にまとめる。構築済み基盤を複数のクライアントが利用する、または接続・再開だけを繰り返すなら分冊を選ぶ。分冊ごとに前提の文書と開始できる確認結果をメモする。
|
|
43
|
+
3. 対象が分かる `tsd-<term>.md` の名前と配置を決め、既存文書との重複を確かめる。各設定の正本を一つ決め、別冊側ではその完了条件と本書で変える差分を示す。
|
|
44
|
+
4. 章の下書きを「概要・位置づけ」「対象環境・前提条件」「全体構成・接続経路」「採用技術・設定」「導入・初期設定」「接続設定」「動作確認」「継続利用・運用」「制約・トラブルシュート」「更新・復旧・撤去」「参照情報」の流れで置く。対象に応じて章を統合・並べ替え、扱わない手順は対象外とする理由や委譲先を概要へ残す。
|
|
45
|
+
5. 接続元・ホスト・コンテナなどに呼び名を付け、配置と通信方向を図か表にする。各操作の実行場所、設定保存先、権限をこの呼び名へそろえる。
|
|
46
|
+
6. 採用設定を表にし、推奨候補や任意の選択肢と分ける。実測・決定・公式情報のどれを根拠にしたか確かめ、裏付けがない版や容量は決めた値として埋めない。
|
|
47
|
+
7. 導入、設定変更、接続の順序を組み立てる。設定を追加・部分変更・全体置換する範囲と、既存設定を残す方法、反映に必要な操作を各段階へ添える。
|
|
48
|
+
8. 基盤の起動から最終利用まで確認を段階化し、各確認に期待結果と失敗時の戻り先を書く。設定の有効値の確認は、単なる疎通確認と分ける。
|
|
49
|
+
9. 切断・再接続・再起動・再構築の違いを調べ、必要な再開操作と失われる状態を書く。移行や撤去を扱う場合は、旧方式との共存可否、切り戻し、保持するデータを先に決める。
|
|
50
|
+
10. 本文、設定例、出力例を公開可否の観点で読み直す。秘密値は参照方法へ、機密の固有情報はプレースホルダーへ置き換える。
|
|
51
|
+
11. 「レビュー観点」と「仕上げチェック」で、別の担当者が開始条件から正常性の判定まで進めるか確認する。未確認の条件には残る確認方法を付け、成功した事実と区別して仕上げる。
|
|
52
|
+
|
|
53
|
+
## 4. 各章の書き方
|
|
54
|
+
|
|
55
|
+
以下は下書きを具体化するための順序である。各章を独立させるか、関連する章へまとめるかは、読み手が行う作業に合わせて選ぶ。
|
|
56
|
+
|
|
57
|
+
### 4.1. 概要・位置づけ
|
|
58
|
+
|
|
59
|
+
- 問い: どの利用目的に応え、初期構築・接続・日常利用のどこを扱うか。読み手が既に完了している作業は何か。
|
|
60
|
+
- 書き方: 目的、対象、対象外を短く置き、別冊へ進む境界にその開始条件を添える。既存文書は project 修飾 doc id の `[[id|title]]` 形式で参照し、未作成なら `tsd-<term>.md` のような仮のファイル名で示す。
|
|
61
|
+
- 良い例: 「構築済み基盤へ接続するクライアントの設定を扱う。基盤側の起動と利用対象の登録確認を開始条件とし、本体の導入は基盤定義へ委ねる」。避けたい例: 「関連技術の設定をまとめる」だけで責務を決めない。
|
|
62
|
+
|
|
63
|
+
### 4.2. 対象環境・前提条件
|
|
64
|
+
|
|
65
|
+
- 問い: コマンドをどこで、誰が、どの shell・作業ディレクトリで実行するか。OS や版によって変わる条件はあるか。
|
|
66
|
+
- 書き方: 実行場所ごとに OS、ランタイム、権限、導入済みの依存、必要資源をそろえる。特別な権限や追加資源が不要なら、その旨を明記する。実測した環境と一般的な推奨環境を分ける。
|
|
67
|
+
- 良い例: 「ホストで常駐プロセスを管理し、接続元コンテナで利用確認する。管理者権限を使う操作は導入時だけ」。避けたい例: 「ローカルで実行する」とだけ書き、端末とホストを混同させる。
|
|
68
|
+
|
|
69
|
+
### 4.3. 全体構成・接続経路
|
|
70
|
+
|
|
71
|
+
- 問い: どのプロセスがどこで動き、どこからどこへ接続するか。待受アドレス、接続先アドレス、公開範囲は対応するか。
|
|
72
|
+
- 書き方: 配置と通信方向を図か対応表にし、端末・ホスト・コンテナの境界を先に描く。名前解決、ポート転送、トンネルを使う場合は、経路ごとに入口と出口を結ぶ。
|
|
73
|
+
- 良い例: 「接続元 → トンネル → ホストの公開ポート → コンテナの待受ポート」と経路を示す。避けたい例: すべてを同じ `localhost` とし、どの環境のアドレスか説明しない。
|
|
74
|
+
|
|
75
|
+
### 4.4. 採用技術・設定
|
|
76
|
+
|
|
77
|
+
- 問い: その値は何を満たすために採用したか。候補・任意設定・未決事項との違いは何か。設定ファイルと環境変数のどちらが実行プロセスへ反映されるか。
|
|
78
|
+
- 書き方: 次の表へ、設定の適用範囲と確認方法まで一行でつなぐ。GUI 設定も画面項目・保存先・反映条件を調べる。推奨値を適用する場合は、採用を決めた記録を別に残す。
|
|
79
|
+
- 良い例: 「推奨候補の並列数は評価後に採否を決める。現行の採用値は有効値の確認結果に基づく」。避けたい例: 推奨値を無条件に採用済みの表へ混ぜる。
|
|
80
|
+
|
|
81
|
+
| 対象・用途 | 設定項目 | 採用値・版 | 適用範囲 | 理由・制約 | 反映・確認方法 |
|
|
82
|
+
| ------------------ | -------------- | -------------------- | ------------------------ | -------------- | ------------------------------ |
|
|
83
|
+
| 利用場面と構成要素 | 製品上の項目名 | 決定した値・単位・版 | 環境・ユーザー・プロセス | 根拠と適用条件 | 保存先・反映操作・有効値の確認 |
|
|
84
|
+
|
|
85
|
+
下書きでは次のように状態を整理し、未決の値を採用値の代わりに埋めない。
|
|
86
|
+
|
|
87
|
+
| 状態 | 書き進める方法 |
|
|
88
|
+
| ------------ | ---------------------------------------------------------------------- |
|
|
89
|
+
| 採用値 | 決定の根拠と対象環境を示し、反映操作と確認へつなぐ |
|
|
90
|
+
| 推奨値 | 推奨する条件と採否の判断方法を添え、現行の採用値と分ける |
|
|
91
|
+
| 任意の選択肢 | 利用する場合の前提と追加確認を示し、共通手順から分岐させる |
|
|
92
|
+
| 確認不足 | _TODO_: 確認対象・方法・担当・確認時期を記す |
|
|
93
|
+
| 意思決定待ち | _UNDECIDED_: 選択肢・判断基準・担当・判断期限・未決による影響を記す |
|
|
94
|
+
| 仮の前提 | _ASSUMPTION_: 仮置きの根拠・成立条件・検証方法・担当・見直し時期を記す |
|
|
95
|
+
|
|
96
|
+
### 4.5. 導入・初期設定
|
|
97
|
+
|
|
98
|
+
- 問い: 何を先に導入し、どの保存先を変更するか。既存の利用者設定を残せるか。再起動や権限変更で何が影響を受けるか。
|
|
99
|
+
- 書き方: 順序付き手順に実行場所、shell、作業ディレクトリ、事前条件、変更先を付ける。コマンドや再現に必要な補助スクリプトは言語識別子付きコードブロックへ置き、追加・部分変更・全体置換を区別する。導入と起動、起動と再起動は別の段階にする。
|
|
100
|
+
- 良い例: 「既存設定の対象セクションへ追加し、他の接続先を保持する。反映前にバックアップを取り、再起動が既存セッションへ与える影響を確認する」。避けたい例: ファイル全体の例を示して、そのまま上書きさせる。
|
|
101
|
+
|
|
102
|
+
### 4.6. 接続設定と秘密情報の扱い
|
|
103
|
+
|
|
104
|
+
- 問い: 接続方式と認証方式は何か。接続先の登録名、クライアントの選択名、リクエスト中の識別子は対応するか。例に含める値を公開できるか。
|
|
105
|
+
- 書き方: 接続先の基点、認証情報の参照方法、識別子の対応を先に整理する。秘密値を読まずに、設定の仕組みと公開可否を判断し、次の順序で例を作る。
|
|
106
|
+
- 良い例: 汎用の接続先 `service.example.invalid` と `<TOKEN>` を説明用に置き、実行時は credential store から渡す方法を示す。避けたい例: 実トークン付き URL や認証設定の全文を貼る。
|
|
107
|
+
|
|
108
|
+
1. ポートや接続方式、汎用ホスト名など、再現に必要で公開できる情報を選ぶ。接続情報という理由だけで一律に隠さない。
|
|
109
|
+
2. 個人・組織固有のホスト名、アカウント、URL は公開可否を確かめ、機密なら `<SERVICE_HOST>` などのプレースホルダーへ置き換える。公開可否が不明なら _TODO_ として確認先を示す。
|
|
110
|
+
3. API キー、トークン、パスワード、秘密鍵は実値を載せず、取得・保存・注入・参照方法を書く。認証不要の方式なら、その適用範囲と公開範囲を説明する。
|
|
111
|
+
4. 設定例、URL、出力例、ログ例、コマンド履歴にも秘密が残らない形を選ぶ。公開用の例と実行時に供給する値の対応を説明する。
|
|
112
|
+
|
|
113
|
+
### 4.7. 動作確認
|
|
114
|
+
|
|
115
|
+
- 問い: 起動、疎通、認証、識別子の解決、実際の利用のうち何を確認できたか。失敗したら一つ前のどの前提へ戻るか。
|
|
116
|
+
- 書き方: 下の段階を対象に合わせて選び、確認対象、実行場所・方法、期待結果、失敗時の確認先を表にする。認証不要などの段階は理由を添えて省く。有効値や版は専用の表示・照会で確かめ、疎通成功だけから設定反映を推定しない。
|
|
117
|
+
- 良い例: 「一覧応答は疎通と登録済み識別子の確認に使い、最小入力への応答で利用機能を確かめる」。避けたい例: 「起動したので設定と接続はすべて正常」とする。
|
|
118
|
+
|
|
119
|
+
| 段階 | 確認の組み立て方 | 期待結果と切り分けの例 |
|
|
120
|
+
| -------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
|
121
|
+
| 基盤・プロセス | 基盤側で依存と起動状態、必要な有効値を確認する | 対象プロセスが稼働し、有効値が採用値に一致する。起動設定・反映操作・ログへ戻る |
|
|
122
|
+
| 名前解決・疎通 | 実際の接続元から対象の入口へ到達できるか確認する | 接続でき、所定の応答項目が返る。名前解決・待受・転送・公開範囲を調べる |
|
|
123
|
+
| 認証・識別子 | 認証方式と利用対象の登録名・選択名を確認する | 対象の権限と識別子で利用できる。認証の参照先・権限・登録名の対応へ戻る |
|
|
124
|
+
| 最小利用 | 小さい入力で一機能を実行し、クライアント経由でも確認する | 意図した結果が得られる。直接利用が成功するならクライアント固有設定を調べる |
|
|
125
|
+
|
|
126
|
+
負荷や応答時間の目標を扱うなら、根拠となる要求とともに入力サイズ、並列数、初回・再実行の別、測定方法、合否を判断する時点をそろえる。未実施なら _TODO_ と確認環境・担当・残る方法を残し、想定する期待結果と実測した結果を分ける。
|
|
127
|
+
|
|
128
|
+
### 4.8. 継続利用・運用
|
|
129
|
+
|
|
130
|
+
- 問い: 切断後に戻る場所はどこか。再接続だけで再開するものと、明示的な再開が必要なものは何か。設定、認証状態、作業データ、実行中セッションはどこに保存されるか。
|
|
131
|
+
- 書き方: 通信切断、プロセス再起動、環境再構築を分け、保持する状態と復元操作を表にする。長時間実行は監視対象、根拠のある正常範囲、負荷を減らす判断条件を添える。組織的な監視体制やバックアップ方針は運用設計へ委ねる。
|
|
132
|
+
- 良い例: 「接続断では実行セッションへ戻り、プロセス終了時は明示的に再開する。再構築時は永続化した設定を復元し、失ったセッションを作り直す」。避けたい例: 「接続し直せばすべて再開する」。
|
|
133
|
+
|
|
134
|
+
### 4.9. 制約・トラブルシュート
|
|
135
|
+
|
|
136
|
+
- 問い: どの症状からどの段階の失敗を疑うか。確認済みの制約と未検証の条件はどれか。
|
|
137
|
+
- 書き方: 動作確認の失敗先を症状別に並べ、最初の確認、次の確認、回避・復旧を結ぶ。原因が確定していないものは仮説として扱い、設定の削除や再インストールより先に観測できる情報を選ぶ。
|
|
138
|
+
- 良い例: 「基盤からの応答はあるがクライアントで対象を選べない場合、登録識別子と選択名を照合する」。避けたい例: 「接続できなければ再インストール」。
|
|
139
|
+
|
|
140
|
+
### 4.10. 更新・復旧・撤去
|
|
141
|
+
|
|
142
|
+
- 問い: 旧方式と共存できるか。何を停止し、何を保存してから変更するか。どの確認で切り戻しを判断するか。
|
|
143
|
+
- 書き方: 競合する待受・自動起動・保存先を洗い出し、変更前の退避、旧方式の停止、新方式への変更、確認、切り戻しの順に書く。撤去はプロセス、設定、認証状態、データごとに保持・削除を分ける。
|
|
144
|
+
- 良い例: 「新方式の利用確認が失敗したら旧設定へ戻す。データ削除は撤去とは別の選択として影響と復元可否を示す」。避けたい例: 停止や再構築の手順にデータ削除を混ぜる。
|
|
145
|
+
|
|
146
|
+
### 4.11. 参照情報
|
|
147
|
+
|
|
148
|
+
- 問い: 採用判断や手順のどの主張を、どの資料・確認記録で確かめ直せるか。適用した版や確認日は分かるか。
|
|
149
|
+
- 書き方: 公式情報には対象の版や確認日、関連文書にはその責務を添える。設定表や確認項目から根拠へたどれる名前を使い、参考に読んだ資料をすべて採用根拠にしない。
|
|
150
|
+
- 良い例: 「環境変数の反映条件」の根拠を、適用した版の公式情報と確認記録へ結ぶ。避けたい例: 製品トップページだけを列挙し、何を裏付けるか示さない。
|
|
151
|
+
|
|
152
|
+
## 5. 深掘り手順
|
|
153
|
+
|
|
154
|
+
1. 主要な採用設定を一つ選び、利用目的や上位の品質条件へ戻れるか調べる。戻れなければ、値の追加より先に採用理由を明らかにする。
|
|
155
|
+
2. 設定ごとに保存先、適用範囲、優先順位、反映操作、有効値の確認をつなぐ。shell で見える値と常駐プロセスが受け取る値が同じか確かめる。
|
|
156
|
+
3. 接続元を起点に経路をたどり、基盤側で成功する確認とクライアント側で成功する確認を分ける。識別子は登録・選択・確認要求の三か所で照合する。
|
|
157
|
+
4. 再接続や再構築を仮に起こしたとして、保存された設定だけで復帰できるか点検する。セッションや一時データが足りなければ再開操作を具体化する。
|
|
158
|
+
5. 事実に見える未検証の主張を探し、確認不足・意思決定待ち・仮の前提へ分ける。それぞれに確認・判断方法と担当、時期を付ける。
|
|
159
|
+
6. 別冊と同じ設定値を持つ箇所を探し、正本を一つに寄せる。参照側には値の転載に代えて開始条件と本書で変える差分を残す。
|
|
160
|
+
|
|
161
|
+
## 6. 良い例 / 悪い例
|
|
162
|
+
|
|
163
|
+
| 観点 | 良い例 | 悪い例 |
|
|
164
|
+
| ---------------- | ------------------------------------------------------------ | --------------------------------------------------- |
|
|
165
|
+
| 文書の分け方 | 基盤導入と接続を分け、接続側に基盤の完了確認と差分だけを書く | 分冊した双方へ同じ導入・設定を転載する |
|
|
166
|
+
| 実行場所 | ホストで起動し、接続元コンテナから疎通を確認する | 「端末で実行する」だけで場所を特定しない |
|
|
167
|
+
| 値の根拠 | 現行の採用値と推奨候補を分け、未決には判断条件を付ける | 手本の版・容量・並列数をそのまま必須にする |
|
|
168
|
+
| 設定の反映 | 保存先と優先順位を示し、反映後に対象プロセスの有効値を調べる | shell の値や API の応答だけで全設定の反映を断定する |
|
|
169
|
+
| 既存設定との統合 | 既存の接続先を保持して対象項目を追加する | 設定例で既存ファイル全体を無条件に置換する |
|
|
170
|
+
| 確認の段階 | 疎通、認証、識別子、最小利用を分け、失敗時に戻る箇所を示す | クライアントを起動できれば利用可能とする |
|
|
171
|
+
| 継続利用 | 切断後の再接続と処理の再開を区別する | 履歴が保存されれば進行中の処理も自動再開するとする |
|
|
172
|
+
| 秘密情報 | 公開可能な経路を示し、秘密値は保存・参照方法で説明する | 認証設定やログの全文を実値のまま貼る |
|
|
173
|
+
| 撤去 | 自動起動・本体・設定・データの扱いと復元可否を分ける | アンインストールに全データ削除を含める |
|
|
174
|
+
|
|
175
|
+
## 7. レビュー観点
|
|
176
|
+
|
|
177
|
+
| 観点 | 確認内容 |
|
|
178
|
+
| ------------ | ---------------------------------------------------------------------------------------- |
|
|
179
|
+
| 目的との対応 | 主要な設定が利用目的・品質条件に結び付き、採用理由と制約を説明できるか |
|
|
180
|
+
| 文書の境界 | 一冊の開始・完了状態が分かり、分冊した設定の正本と差分をたどれるか |
|
|
181
|
+
| 環境と再現性 | OS・版・権限・依存・資源、実行場所・shell・変更先を特定できるか |
|
|
182
|
+
| 判断の確度 | 採用・推奨・任意・未決・仮説が混ざらず、未確定事項の担当と確認・判断時期が分かるか |
|
|
183
|
+
| 反映と検証 | 採用値から反映操作・有効値・最終利用までを確認でき、失敗時の戻り先が分かるか |
|
|
184
|
+
| 継続性と復旧 | 切断・再起動・再構築で保持・喪失する状態と、再開・切り戻し操作が対応するか |
|
|
185
|
+
| 公開適性 | 接続経路の説明を残しつつ、秘密値や機密の固有情報を本文・設定例・出力例から除けているか |
|
|
186
|
+
| 委譲と追跡 | 詳細 API・内部設計・組織的な運用方針を担当文書へ委ね、採用判断と確認の根拠を追跡できるか |
|
|
187
|
+
|
|
188
|
+
## 8. 仕上げチェック
|
|
189
|
+
|
|
190
|
+
- 初期構築・接続設定・日常利用の担当範囲と対象外が分かり、別冊の手順を始める条件が具体化されている。
|
|
191
|
+
- 構成の呼び名と各操作の実行場所が一致し、接続元から利用先までの経路と公開範囲をたどれる。
|
|
192
|
+
- 採用値に根拠と適用範囲があり、推奨値や任意設定、未決事項を採用済みと誤読しない。
|
|
193
|
+
- 設定の保存先、優先順位、反映条件がつながり、既存設定を保持する方法と変更影響が分かる。
|
|
194
|
+
- 確認に期待結果と失敗時の確認先があり、疎通と設定反映、最小利用を別々に判定できる。未実施の確認を成功としていない。
|
|
195
|
+
- 継続利用や変更を扱う箇所には、状態の保存、再開、切り戻し、削除の影響が対応している。
|
|
196
|
+
- 秘密値を含めず、機密情報のプレースホルダーと実行時の取得・参照方法が対応している。
|
|
197
|
+
- 参照先の存在、表内の wikilink の区切りのエスケープ、見出し名による章参照を確かめた。未作成の文書はコード表記で仮置きしている。
|
|
198
|
+
- 確認不足・未決・仮の前提には担当と確認・判断の時期があり、判断や再現を妨げる点を読み手が識別できる。
|
|
@@ -101,6 +101,20 @@ provider 設定、登録簿作成の順に次のコマンドを案内します
|
|
|
101
101
|
書き込まず、予定の内容だけを表示します。`config scaffold` の `--provider` には
|
|
102
102
|
`antigravity`、`claude`、`codex`、`copilot`、`opencode` を指定でき、`--dry-run` と `--force` も利用できます。
|
|
103
103
|
|
|
104
|
+
通常の `init` と `config init` は、markdownlint の設定がなければリポジトリ直下に
|
|
105
|
+
`.markdownlint.yaml` を作成します。SpecDojo の文書規約に合わせて MD013(行長)、MD024(見出しの重複)、
|
|
106
|
+
MD033(HTML)、MD036(強調だけの行)、MD041(先頭の H1)、MD060(表の列幅)を無効にします。
|
|
107
|
+
それ以外は markdownlint の既定の規則を使います。既存の `.markdownlint.*`・`.markdownlintrc`・
|
|
108
|
+
`.markdownlint-cli2.*` は保持し、競合する設定は追加しません。`--dry-run` は設定を書き込みません。
|
|
109
|
+
`init --lefthook` / `--slidev` では、後述の `.markdownlintrc` と CLI2 設定の配置を使います。
|
|
110
|
+
|
|
111
|
+
既存リポジトリでは `specdojo config init --dry-run` を確認してから `specdojo config init` を再実行すると、
|
|
112
|
+
SpecDojo の設定ファイルが既にあっても markdownlint の不足設定を追加できます。既存の規則を変更する場合は
|
|
113
|
+
利用側で編集してください。特に MD013 が有効な場合、長い行を許容するには `MD013: false` を設定します。
|
|
114
|
+
exec の result の commit 前検査は markdownlint-cli が読む利用リポジトリの設定(親ディレクトリの
|
|
115
|
+
`.markdownlintrc` を含む)を優先し、設定がなければ上記の6規則だけをコマンド引数で無効にします。
|
|
116
|
+
フォールバック用ファイルは利用リポジトリに作りません。CLI2 専用設定はこの検査では読みません。
|
|
117
|
+
|
|
104
118
|
`package.json` がある場合、provider ごとのオーケストレーター起動スクリプトも追加します。Claude Code は `orch:opus`・`orch:sonnet`、Codex は `orch:sol`(`gpt-6.1-sol`)・`orch:luna`(`gpt-6-luna`)、Antigravity は `orch:flash`(`gemini-3.8-flash-high`)、OpenCode は `orch:opencode` です。既存のスクリプトは `--force` を付けても上書きしません。
|
|
105
119
|
|
|
106
120
|
`antigravity` に限り `--global` を指定すると、`~/.gemini/antigravity-cli/settings.json` へ SpecDojo 用の permission rule を追記します。既存キー・既存 rule は保持し、実書き込み前に timestamp 付きバックアップを作ります。`--global` を省略した通常実行はユーザーディレクトリへ触れません。適用前は次の dry-run で追加 rule を確認してください。
|
|
@@ -444,7 +458,7 @@ specdojo schedule strategy generate \
|
|
|
444
458
|
| `catalog-scaffold.md` | `dct-<domain>.yaml` が未作成のドメインと `catalog scaffold` 実行コマンド |
|
|
445
459
|
| `timeline.json` | 後続コマンドが読む機械可読サマリー |
|
|
446
460
|
|
|
447
|
-
`depends_on` の未定義参照・循環、`depends_on` と `order` の矛盾、track id の重複を検出した場合は、生成物を書き込まずに終了コード 1 で停止します。`catalog_status`
|
|
461
|
+
`depends_on` の未定義参照・循環、`depends_on` と `order` の矛盾、track id の重複を検出した場合は、生成物を書き込まずに終了コード 1 で停止します。`catalog_status` と実カタログの有無が食い違う場合は警告のみを出します。`project_register_path` がある場合、`catalog-planning` の todo を domain ごとに読み、`done` が一件でもあればその domain を `primary`、着手中(`in-progress` / `waiting` / `review`)なら `draft`、`open` だけなら `not_started` と導きます。`rejected` / `deferred` は導出から除外します。対象 todo がない domain は従来の手書き値を使います。複数 domain の track は全 domain が `primary` なら着手可能とし、一部だけ進んでいれば `draft` とします。手書きの値との差は警告し、`tml-index.yaml` は変更しません。todo を reopen した場合も次回 build で再計算します。`timeline.json` の `track_catalog_status` は導出後の track 別状態です。strategy 生成も同じ導出を使います。カタログの突き合わせはファイル名ではなく各 `dct-*.yaml` の `domain` 値で行うため、1 ドメインが複数ファイルに分割されていても検出できます。
|
|
448
462
|
|
|
449
463
|
`timeline_path` は未設定の場合、プロジェクト直下の `timeline` を既定とします。記述ルールは [タイムライン作成ルール](../rulebooks/tml-rulebook.md)、生成フローと運用タイミングは [Timeline設計ガイド](../guides/timeline-design-guide.md)、トラックの標準構成と実行順序は [トラック設計ガイド](../guides/track-design-guide.md) を参照します。
|
|
450
464
|
|
|
@@ -475,6 +489,7 @@ specdojo schedule strategy generate \
|
|
|
475
489
|
|
|
476
490
|
| オプション | 用途 | 対象 |
|
|
477
491
|
| ---------------------------- | ------------------------------------------------------------------- | ------------------------------------------------ |
|
|
492
|
+
| `--track <track>` | epic が担う track(epic で必須、update で置換、削除不可) | `add` / `update` |
|
|
478
493
|
| `--to <PJR-ID>` | 移動先の PJR-ID を指定する | `renumber` |
|
|
479
494
|
| `--registered <datetime>` | 起票日時(タイムゾーン付き RFC 3339)。省略時は実行時刻 | `add` |
|
|
480
495
|
| `--completed <datetime>` | 完了・却下日時(タイムゾーン付き RFC 3339)。省略時は実行時刻 | `close` / `reject` |
|
|
@@ -483,7 +498,7 @@ specdojo schedule strategy generate \
|
|
|
483
498
|
| `--conclusion <text>` | 終端時の結論を記録・更新(`update` では `-` で削除) | `add` / `update` / 終端コマンド |
|
|
484
499
|
| `--block-reason <text>` | `waiting` の理由を更新(`-` で削除) | `update` |
|
|
485
500
|
| `--approach <approach>` | 個票の進め方を指定(`update` では `-` で削除) | `add` / `update` |
|
|
486
|
-
| `--target <
|
|
501
|
+
| `--target <target>` | 対象文書 ID を指定(繰り返し可、`update` では `-` で削除) | `add` / `update` |
|
|
487
502
|
| `--target-path <path>` | 成果物のリポジトリ相対パス(`update` は `-` で削除) | `add` / `update` |
|
|
488
503
|
| `--target-rulebook <doc-id>` | 成果物の rulebook ID(`update` は `-` で削除) | `add` / `update` |
|
|
489
504
|
| `--source <ref>` | kata authoring の手本を指定(繰り返し可、`update` では `-` で削除) | `add` / `update` |
|
|
@@ -504,6 +519,8 @@ specdojo schedule strategy generate \
|
|
|
504
519
|
|
|
505
520
|
`--approach` を指定する場合、通常は `--target` が 1 件だけ必須です。成果物を作成・修正する approach の対象は、成果物カタログを優先して doc id を解決します。カタログがなくても、既存文書は文書索引と frontmatter から、新規文書は明示したパスと rulebook から解決できます。kata maintenance の対象は文書索引で解決し、approach に対応する kata 種別との一致も書き込み前に検証します。kata authoring は `--target` を新しい kata ID、`--source` を 0 件以上の読み取り専用の手本とします。互換性のため、2 個目以降の `--target` も `--source` と同じ手本として扱います。
|
|
506
521
|
|
|
522
|
+
`sample-maintenance` は `type` を見ず、対象 `id` の末尾が `-sample` かどうかで判定します。利用者の authority の sample も同じ規則です。recipe・template・rulebook の maintenance は従来どおり `type` の一致を検証します。sample の `type` の規約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] を参照してください。
|
|
523
|
+
|
|
507
524
|
カタログなしで使える成果物の approach は `fully-guided`・`recipe-guided`・`freeform`・`retrofit`・`bootstrap`・`finalize`・`bootstrap-finalize` です。`cross-deliverable-dedup` はカタログが必要です。
|
|
508
525
|
|
|
509
526
|
- 新規文書には `--target-path <リポジトリ相対パス>` と `--target-rulebook <rulebook-id>` を指定します。個票の `target_path` と `target_rulebook` に保存されます。既存文書は `--target` の ID を索引で引き、パスと `specdojo.rulebook` を使います。明示指定と既存文書が矛盾した場合は停止します。
|
|
@@ -514,6 +531,8 @@ specdojo schedule strategy generate \
|
|
|
514
531
|
- カタログなしの plan は、カタログの `done_criteria` がないことを明示し、個票の完了条件と rulebook を使います。`retrofit` の実装調査入力は個票にパスを明記します。
|
|
515
532
|
- カタログ設定済みで対象が未登録の場合、パスと rulebook を両方明示した場合だけカタログなしと同じ解決を使います。未指定なら従来のエラーで停止します。カタログにある対象ではカタログの宣言を優先します。
|
|
516
533
|
|
|
534
|
+
`register add --type epic --track <track>` は track ごとの仕事を起票します。type は `epic` / `todo` / `question` / `risk` / `issue` / `change-request` / `decision` / `note` です。epic は todo と同じ状態を使い、通常終端は `done`、例外終端は `rejected` / `deferred` です。track は Frontmatter の `track` に保存し、`update --track` で置換します。英小文字・数字・ハイフン(先頭は英小文字か数字)の識別子が必須で、削除やほかの type への指定は拒否します。project の `timeline_path`(既定 `timeline`)に `tml-index.yaml` があるときは、add・update・build で track の定義を検証します。子 todo は `register add --type todo --from <epic-id>` で関連付けます。`register build` は `generated/pjr-epic-items.md` に epic ごとの直接の子項目と状態を表示し、別 project の子を project 修飾 ID で識別します。子のない epic も表示し、孫の再帰表示や epic の自動 close は行いません。完了は子項目と schedule を材料に人が判断します。
|
|
535
|
+
|
|
517
536
|
`item_type: note` は `open` のまま更新する記録です。`register close` / `register reject` / `register defer` は終了コード 1 で拒否し、対応・回答・判断が必要な場合は `todo` / `question` / `decision` など目的に合う別の `item_type` で起票するよう案内します。本文の追記や修正には `register update` を使用できます。
|
|
518
537
|
|
|
519
538
|
`--registered` / `--completed` にはタイムゾーン付きの RFC 3339 値(`2026-08-09T14:08:51Z` または `2026-08-09T23:08:51+09:00`)を指定し、保存時に UTC へ正規化します。タイムゾーンを含まない値は解釈が実行環境に依存するため受け付けません。期限(`--due`)は瞬間ではなく暦日のため `YYYY-MM-DD` のままです。
|
|
@@ -522,8 +541,25 @@ specdojo schedule strategy generate \
|
|
|
522
541
|
|
|
523
542
|
`register add --from <ID>` は、起票の元になった登録項目を個票 Frontmatter の `derived_from` へ記録します。`--from` は複数回指定でき、同じ project の項目は `PJR-XXXX`、別 project の項目は `<project-id>:PJR-XXXX` を使います。自己参照、未設定の project、存在しない項目は書き込み前に拒否します。別 project の項目は、その project の `integration_branch`(省略時は `project/<project-id>/develop`)の Git tree を読んで存在を確認します。`register update --from <ID>` は一覧を置換し、`--from -` で削除します。`register build` は `generated/pjr-derived-items.md` を生成し、元の項目から派生先を逆引きできるようにします。decision から todo を起票するときも、この関係を追跡先として使います。
|
|
524
543
|
|
|
544
|
+
`register add` / `update` の `--depends-on <ID>` は、起票の由来を示す `derived_from` と区別して、先行項目を `depends_on` に記録します。反復指定で一覧を設定・置換し、`--depends-on -` 単独で削除します。書式と別 project の存在確認は `--from` と同じです。存在しない ID、自己参照、project 間を含む循環を記帳前と `register build` で拒否し、変更を event に記録します。実行はすべての先行項目が `done` / `decided` の場合だけ許可し、`rejected` / `deferred` では進めません。直接の `exec run --register` は未完了の先行 ID と状態を表示して停止し、routine の sweep(`--register-filter`)と夜間 queue は対象を飛ばして理由を出力します。夜間の理由は朝報告にも残し、状態を自動で `waiting` に変えません。スキップは件数上限に数えません。先行完了後の再選択は次回の実行で行います。`generated/pjr-index.md` の `depends_on` 列と、逆引きビュー `generated/pjr-dependent-items.md` で関係を確認できます。
|
|
545
|
+
|
|
525
546
|
`external_projects` に宣言した別名を `register add --project <別名> --commit` へ渡すと、相手のリポジトリの `node_modules/.bin/specdojo` を起動し、宣言した実 project ID で起票します。相手の登録簿の形式、名簿、`integration_branch`、commit は相手の CLI に任せ、呼び出し元は相手のファイルを直接変更しません。`--from <別名>:PJR-XXXX` は相手へ `<実 project ID>:PJR-XXXX` として渡すため、相手の CLI が存在を検証し、`derived_from` にも実 project ID が残ります。別 project への起票で `--source` を使う場合、相手の SpecDojo は 0.4.5 以上である必要があります。
|
|
526
547
|
|
|
548
|
+
カタログ・strategy を作る register 専用の approach は、文書 ID の代わりに作業単位を指定します。実行時の project を対象範囲とするため、未作成の文書や物理分割された domain も一つの todo で扱えます。`--source`・`--target-path`・`--target-rulebook` は使用しません。
|
|
549
|
+
|
|
550
|
+
```bash
|
|
551
|
+
specdojo register add --project prj-0001 --type todo --from PJR-AB12 \
|
|
552
|
+
--title "カタログを作る" --topic catalog-planning \
|
|
553
|
+
--approach catalog-planning --target domain:data-model
|
|
554
|
+
specdojo register add --project prj-0001 --type todo --from PJR-AB12 \
|
|
555
|
+
--title "strategy を作る" --topic strategy-planning \
|
|
556
|
+
--approach strategy-planning --target track:data-model
|
|
557
|
+
```
|
|
558
|
+
|
|
559
|
+
- `catalog-planning`: `catalog_path` が必要です。plan は既存カタログと DCT の kata・domain ごとの template を参照し、`catalog plan prompt` に沿った agent の判定、`catalog plan scaffold --from`、`catalog plan validate`、`catalog scaffold --plan`、`catalog validate` を完了条件として展開します。上流資料が不足する場合は `--input` で明示し、未確定事項を推測で補いません。
|
|
560
|
+
- `strategy-planning`: `catalog_path` と `schedule_path` が必要です。timeline がある場合は定義済み track に限定します。timeline がない場合は strategy の明示 scope を使います。plan は既存カタログと Schedule の kata を参照し、`sch-strategy-<track>.yaml` の `scope.catalogs`・`approach_rules` の intent・担当の宣言、`schedule strategy generate`、`schedule build --track` の成功を完了条件として展開します。
|
|
561
|
+
- 対象はそれぞれ `domain:<id>` / `track:<id>` の 1 件です。ID は英小文字・数字・ハイフン、先頭は英小文字または数字、最大 63 文字です。個票の追加完了条件も plan に取り込みます。両 approach を schedule の成果物タスクへ指定することはできません。
|
|
562
|
+
|
|
527
563
|
`register add --approach <approach> --target <doc-id>` は、個票 Frontmatter に進め方と対象を書きます。成果物を作成・修正する進め方は成果物カタログにある文書を、`rulebook-maintenance` などの保守の進め方は名前に対応する kata 種別を対象にし、対象は 1 件だけです。`rulebook-authoring` / `recipe-authoring` / `sample-authoring` / `template-authoring` は `--target` に新しい kata ID、繰り返し可能な `--source` に手本を指定し、個票 Frontmatter の `sources` へ保存します。
|
|
528
564
|
|
|
529
565
|
`--source` は次の順で解釈します。コロンの前が対象 project の `repos[].name` と一致すれば `<repo>:<path>`、一致せず値に `/` または拡張子があればプロジェクトリポジトリのパス、残りは文書索引で解決する doc id です。パスはファイル、ディレクトリ、glob を受け付けます。ディレクトリと glob はファイルへ展開し、重複を除いた合計が 100 件を超えると停止します。この上限は広すぎるパターンによる読み取り範囲と plan の肥大化を防ぐためです。プロダクトリポジトリの手本は plan に `$SPECDOJO_REPO_<NAME>/<path>` として載ります。カタログは必須ではなく、いずれの形も見つからなければ起票時と実行時に理由を示して停止します。
|
|
@@ -542,7 +578,7 @@ kata authoring は register 専用です。Schedule の task は対象成果物
|
|
|
542
578
|
|
|
543
579
|
`register migrate` は旧形式の登録簿データを現行形式へ移す一度限りの移行コマンドです。追跡対象だった `pjr-index.md` の表を個票 Frontmatter へ移し、旧日時を UTC へ変換し、個票内の `register_events` を `events/pjr-XXXX.yaml` へ分離します。イベントがまだない項目は、利用可能な Git 履歴を項目別イベントファイルへ変換します。event ID は commit・項目 ID・変更内容から決定的に生成するため、再実行で重複しません。
|
|
544
580
|
|
|
545
|
-
`register history` は `events/pjr-XXXX.yaml` を読み、個票単位の追加(`added`)と変更(`updated`)を発生順に出力します。event 導入前または未移行の期間だけ Git 履歴を読み、削除(`removed`)を含む従来の履歴と統合します。event は発生日時・actor・action・reason・遷移前後状態・変更フィールドを保持するため、複数遷移を1コミットへまとめても粒度を失いません。比較対象は登録項目一覧の列と `block_reason`、`approach`、`targets`、`sources`、`target_path`、`target_rulebook`、`derived_from` です。
|
|
581
|
+
`register history` は `events/pjr-XXXX.yaml` を読み、個票単位の追加(`added`)と変更(`updated`)を発生順に出力します。event 導入前または未移行の期間だけ Git 履歴を読み、削除(`removed`)を含む従来の履歴と統合します。event は発生日時・actor・action・reason・遷移前後状態・変更フィールドを保持するため、複数遷移を1コミットへまとめても粒度を失いません。比較対象は登録項目一覧の列と `block_reason`、`approach`、`targets`、`sources`、`target_path`、`target_rulebook`、`derived_from`、`depends_on` です。
|
|
546
582
|
|
|
547
583
|
各書き込みコマンドは現在値を個票へ、event を項目別イベントファイルへ反映します。同じ現在値になる操作の再実行では event を追加しません。`register build` は個票とイベントファイルの対応、event の schema、ID 一意性、時刻順、直前イベント参照、状態連鎖、最新 event と現在値の一致を検証します。
|
|
548
584
|
|
|
@@ -696,7 +732,7 @@ specdojo exec run --project prj-0001 --register PJR-0012 --worktree --resume --r
|
|
|
696
732
|
specdojo exec run --project prj-0001 --job job-weekly-report --input period=2026-W32
|
|
697
733
|
```
|
|
698
734
|
|
|
699
|
-
`--register` は指定した個票の項目を実行します。`--register-filter` は `--register-types` / `--register-priorities` / `--register-statuses` のカンマ区切り条件と、正の整数の `--register-limit` で項目を選びます。条件省略時は open かつ実行可能な type が対象です。いずれも実行対象になる type は `todo` / `issue` / `change-request` / `question` / `risk` で、`decision` / `note` は対象外です。実行場所の既定は `.specdojo/exec-defaults.yaml` の `run.register_execution`(`worktree` / `in-place`)で選び、未設定時は互換性のため in-place です。`--worktree` / `--in-place` は設定を上書きし、同時指定はエラーになります。worktree モードは成果物の変更を隔離し、状態遷移(`start` / `review` / `waiting`)を直列化したうえで、成功時に merge back します。`--post-review` または `run.register_post_review: true` を指定すると、merge back の後に完了判定を行い、todo / issue を自動 close できます。`--parallel <n>` は worktree モードでのみ指定できます。
|
|
735
|
+
`--register` は指定した個票の項目を実行します。`--register-filter` は `--register-types` / `--register-priorities` / `--register-statuses` のカンマ区切り条件と、正の整数の `--register-limit` で項目を選びます。条件省略時は open かつ実行可能な type が対象です。いずれも実行対象になる type は `todo` / `issue` / `change-request` / `question` / `risk` で、`epic` / `decision` / `note` は対象外です。実行場所の既定は `.specdojo/exec-defaults.yaml` の `run.register_execution`(`worktree` / `in-place`)で選び、未設定時は互換性のため in-place です。`--worktree` / `--in-place` は設定を上書きし、同時指定はエラーになります。worktree モードは成果物の変更を隔離し、状態遷移(`start` / `review` / `waiting`)を直列化したうえで、成功時に merge back します。`--post-review` または `run.register_post_review: true` を指定すると、merge back の後に完了判定を行い、todo / issue を自動 close できます。`--parallel <n>` は worktree モードでのみ指定できます。
|
|
700
736
|
|
|
701
737
|
`--integration-branch <repo>=<branch>` は、register の worktree モードで、その run に限ってプロダクトリポジトリ `<repo>` の統合先を上書きします。複数リポジトリにはオプションを繰り返します。`<repo>` は `repos[].name` に宣言済みで、`<branch>` はそのリポジトリに存在する有効なローカルブランチでなければならず、リモートブランチの取得やローカルブランチの作成は行いません。同じ `<repo>` の重複、宣言にないリポジトリ、空の値は register の状態を変える前に拒否します。統合先の優先順位は「run の指定 → `repos[].integration_branch` → そのリポジトリの現在のブランチ」です。指定しない run の挙動は従来と変わりません。
|
|
702
738
|
|
|
@@ -757,6 +793,8 @@ specdojo exec trial adopt --project prj-0001 --comparison <comparison-id> --tria
|
|
|
757
793
|
|
|
758
794
|
`grade` は kata(rulebook / recipe / sample / template)または成果物を、review と同じ共通 viewpoint・category rubric で継続評価します。agent に直接ファイル探索やスコア計算をさせず、plan 生成と反映を分離します。
|
|
759
795
|
|
|
796
|
+
評価結果の正本は YAML サイドカーに保存します。本リポジトリの文書は `<execution_path>/grade/results/<文書 ID>.yaml`、`project.repos` に宣言したリポジトリの文書は `<execution_path>/grade/results/<repo 名>/<文書 ID>.yaml` です。ファイル名では ID の `:` を `.` に置き換え、`<repo 名>` には `repos[].name`(`--source <repo>:<path>` と同じ名前)を使います。同じ ID の文書が別のリポジトリにあっても、保存先と前回結果の読み込みを分離します。`grade plan`、`apply`、`run` の再開、結果表示・検証・翻訳、dashboard はこの配置を使います。本リポジトリの既存結果は従来の場所で読み取れます。旧配置の直下に保存されたプロダクトリポジトリの結果は自動では流用せず、再評価してリポジトリ別の結果を作成します。
|
|
797
|
+
|
|
760
798
|
`grade run` は npm package から利用でき、`list` と同じ対象選択、文書ごとの plan 生成、agent 実行、marker の機械変換と `apply` を単段で実行します。成果物を `--target deliverable` で評価するには、対象 project に `catalog_path` を設定する必要があります。`viewpoints_path` 未設定時は同梱の `specdojo:pm-review-viewpoints` を使います。
|
|
761
799
|
|
|
762
800
|
| コマンド | 用途 |
|
|
@@ -29,6 +29,12 @@ SpecDojo Configuration Reference
|
|
|
29
29
|
|
|
30
30
|
`npx specdojo config init` は、register を開始できる次の最小構成を生成します。catalog や schedule の未使用キーは生成しません。
|
|
31
31
|
|
|
32
|
+
あわせて、markdownlint の設定がなければリポジトリ直下に `.markdownlint.yaml` を生成します。
|
|
33
|
+
MD013・MD024・MD033・MD036・MD041・MD060 を無効にし、日本語の長い行や SpecDojo の文書構成を許容します。
|
|
34
|
+
既存設定は上書きしません。既存リポジトリでは `config init --dry-run` で確認してから再実行すると追加できます。
|
|
35
|
+
exec の result の commit 前検査にも、利用リポジトリに設定がないときは同じ基本規則が適用されます。
|
|
36
|
+
設定の優先順位と hook / CLI2 の配置は [[specdojo:command-reference|CLIコマンドリファレンス]] を参照してください。
|
|
37
|
+
|
|
32
38
|
```json
|
|
33
39
|
{
|
|
34
40
|
"version": 1,
|
|
@@ -182,15 +188,20 @@ project の `integration_branch` は、`repos[].integration_branch` とは別の
|
|
|
182
188
|
|
|
183
189
|
`projects.<project-id>.repos` は、プロジェクトリポジトリとは別のプロダクトリポジトリを配列で宣言します。プロジェクトリポジトリ自身は宣言しません。キーを省略した project(または空配列)は、従来どおりプロジェクトリポジトリ 1 つだけを扱います。
|
|
184
190
|
|
|
185
|
-
| キー
|
|
186
|
-
|
|
|
187
|
-
| `name`
|
|
188
|
-
| `path`
|
|
189
|
-
| `integration_branch`
|
|
190
|
-
| `
|
|
191
|
+
| キー | 必須 | 既定値 | 役割・利用箇所 |
|
|
192
|
+
| ---------------------- | ---- | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
|
|
193
|
+
| `name` | 必須 | なし | `targets`・`paths` の接頭辞に使うリポジトリ名です。`[a-z0-9-]` だけを使い、project 内で一意です。`project` は予約名で使えません。 |
|
|
194
|
+
| `path` | 必須 | なし | リポジトリのルートです。SpecDojo ルートからの相対パスで書き、実在するディレクトリを指します。 |
|
|
195
|
+
| `integration_branch` | 任意 | そのリポジトリの現在のブランチ | exec が変更を統合する先のブランチです。exec branch もこのブランチの先端から作ります。 |
|
|
196
|
+
| `integration_strategy` | 任意 | `merge` | `merge` はローカルの merge commit で統合します。`branch-only` は exec branch に commit して保持し、プロダクト側の PR レビューに渡します。 |
|
|
197
|
+
| `setup` | 任意 | 両方 `true` | worktree 作成時の準備の有無です。`install`(依存導入)と `build`(生成物の build)を真偽値で指定します。 |
|
|
191
198
|
|
|
192
199
|
register の worktree 実行では、`exec run --integration-branch <repo>=<branch>` により `integration_branch` を run ごとに上書きできます。統合先の優先順位は「run の指定 → `repos[].integration_branch` → そのリポジトリの現在のブランチ」です。指定方法、ローカルブランチの検査、並列実行と再開時の扱いは [[specdojo:command-reference]] を参照してください。
|
|
193
200
|
|
|
201
|
+
GitHub flow などで PR レビューを必須にするリポジトリには、`"integration_strategy": "branch-only"` を指定します。`integration_branch` は exec branch の作成元と、プロダクト側で PR を作る際の統合先の目安です。runner は統合先へ merge せず、push・PR 作成(`gh` を含む)も行いません。プロダクトの commit とプロジェクトの記帳が成功すると、プロジェクト側は通常どおり `review` へ進み、result に `branch-only`(未統合)、exec branch 名、trace key を残します。プロダクト側のレビューやリリースが完了したことは意味しません。
|
|
202
|
+
|
|
203
|
+
成功後は全 worktree を撤去し、`branch-only` の exec branch だけを残します。利用者はその branch を必要な承認のもと push し、プロダクト側の手順で PR を作成します。squash merge でも追跡できるよう、commit メッセージの `Refs: <project-id>:<item-id>` を保持してください。失敗時は worktree と branch を残して `--resume` で再開し、`branch-only` の worktree へ統合先を自動で取り込みません。同じ項目を新規実行する際に保持済み branch があると停止するため、既存 run を再開するか、プロダクト側の作業を終えて branch を退避・削除してから実行します。`exec worktree prune` は未統合の branch を削除しません。
|
|
204
|
+
|
|
194
205
|
```json
|
|
195
206
|
{
|
|
196
207
|
"base_path": "docs/ja/projects/prj-0001",
|
|
@@ -200,6 +211,7 @@ register の worktree 実行では、`exec run --integration-branch <repo>=<bran
|
|
|
200
211
|
"name": "app1",
|
|
201
212
|
"path": "../app1",
|
|
202
213
|
"integration_branch": "main",
|
|
214
|
+
"integration_strategy": "branch-only",
|
|
203
215
|
"setup": { "install": true, "build": false }
|
|
204
216
|
}
|
|
205
217
|
]
|
|
@@ -241,7 +253,7 @@ agent の起動コマンドには、provider ごとにプロダクト worktree
|
|
|
241
253
|
|
|
242
254
|
agent 実行の前後で行う保護設定(`package.json`、CI 設定など)と Git 状態(HEAD・ローカル設定)の検査は、プロダクト worktree にも同じ一覧で行います。evidence の変更ファイルは、プロダクト側を `<name>:<path>` で記録します。
|
|
243
255
|
|
|
244
|
-
プロダクトリポジトリの変更は、`exec run --worktree` の統合段で runner がリポジトリごとに commit
|
|
256
|
+
プロダクトリポジトリの変更は、`exec run --worktree` の統合段で runner がリポジトリごとに commit し、宣言順にプロダクトの設定方式を処理し、最後にプロジェクトを統合します。統合の順序、失敗時の部分状態、再開は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] の「複数リポジトリの worktree と統合順序」と「複数リポジトリの統合の失敗と再開」を参照してください。`exec worktree commit` はプロダクト側を統合しないため、プロダクト worktree に未 commit の変更か exec branch の commit が残るタスクは、プロジェクト側の commit の前に停止します。撤去は、全リポジトリの worktree が撤去できることを確かめてからまとめて行います。
|
|
245
257
|
|
|
246
258
|
exec worktree の中で設定を読む場合(agent が worktree で `specdojo` を実行する場合など)、`path` の代わりに同じタスクの `<worktree_base>/<task-id>/<name>/` へ解決します。
|
|
247
259
|
|
|
@@ -253,7 +265,7 @@ exec worktree の中で設定を読む場合(agent が worktree で `specdojo`
|
|
|
253
265
|
- `name` がいずれかの project ID と同じである。`<name>:<...>` が doc id とリポジトリのパスのどちらか区別できなくなるためです。
|
|
254
266
|
- `name` が予約名 `project` である。プロジェクトリポジトリの worktree のディレクトリ名と重なるためです。
|
|
255
267
|
- `path` が空、絶対パス、存在しない、またはディレクトリでない。
|
|
256
|
-
- 宣言に無いキーがある、`integration_branch` が空文字、`setup` の値が真偽値でない。
|
|
268
|
+
- 宣言に無いキーがある、`integration_branch` が空文字、`integration_strategy` が `merge` / `branch-only` 以外、`setup` の値が真偽値でない。
|
|
257
269
|
|
|
258
270
|
設定の形は `docs/specdojo/schemas/v1/specdojo-config.schema.yaml` でも検証できます。リポジトリ名と project ID の重複と `path` の実在は schema で表せないため、CLI の読み込み時の検証が正本です。
|
|
259
271
|
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:bac-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: requirement
|
|
5
6
|
status: draft
|
|
6
7
|
recipe: undecided
|
|
7
8
|
sample: specdojo:bac-sample
|
|
@@ -49,7 +50,7 @@ Frontmatter は `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml`
|
|
|
49
50
|
| ---- | ---- | ---- |
|
|
50
51
|
|
|
51
52
|
| id | 受入条件ID(`bac-...`) | ○ |
|
|
52
|
-
| type | `
|
|
53
|
+
| type | `requirement` 固定 | ○ |
|
|
53
54
|
| title | 受入条件名(例: 業務受入条件: 商品販売) | ○ |
|
|
54
55
|
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
55
56
|
| part_of | 上位BAC ID(分割している場合) | 任意 |
|
|
@@ -149,7 +150,7 @@ Markdown で「受入対象」と「シナリオ」を記述します。
|
|
|
149
150
|
```markdown
|
|
150
151
|
---
|
|
151
152
|
id: bac-sale-checkout
|
|
152
|
-
type:
|
|
153
|
+
type: requirement
|
|
153
154
|
title: 業務受入条件: 商品販売
|
|
154
155
|
status: draft
|
|
155
156
|
part_of: []
|
|
@@ -196,7 +197,7 @@ supersedes: []
|
|
|
196
197
|
```markdown
|
|
197
198
|
---
|
|
198
199
|
id: bac-procurement-order-to-payment
|
|
199
|
-
type:
|
|
200
|
+
type: requirement
|
|
200
201
|
title: 業務受入条件: 仕入(発注〜入荷〜支払)
|
|
201
202
|
status: draft
|
|
202
203
|
part_of: []
|
|
@@ -285,7 +286,7 @@ supersedes: []
|
|
|
285
286
|
```markdown
|
|
286
287
|
---
|
|
287
288
|
id: bac-sale-payment-method
|
|
288
|
-
type:
|
|
289
|
+
type: requirement
|
|
289
290
|
title: 業務受入条件: 会計確定(支払方法の記録)
|
|
290
291
|
status: draft
|
|
291
292
|
part_of: []
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:bdd-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: data
|
|
5
6
|
status: draft
|
|
6
7
|
target_format: yaml
|
|
7
8
|
recipe: not-needed
|
|
@@ -34,7 +35,7 @@ Business Data Dictionary (BDD) Documentation Rules
|
|
|
34
35
|
### 3.1. ID規約
|
|
35
36
|
|
|
36
37
|
- `id` は正規表現 `^bdd-[a-z0-9-]+$` に合致する一意IDを用いる。
|
|
37
|
-
- `type` は `
|
|
38
|
+
- `type` は `data` 固定とする。
|
|
38
39
|
- 置き換えがある場合は `supersedes` に旧IDを列挙する。
|
|
39
40
|
|
|
40
41
|
### 3.2. ファイル命名規約
|
|
@@ -50,7 +51,7 @@ Frontmatter と同等の以下の項目をYAMLドキュメントの先頭に必
|
|
|
50
51
|
| 項目 | 説明 | 必須 |
|
|
51
52
|
| ---------- | ---------------------------------------- | ---- |
|
|
52
53
|
| id | データ辞書ID(`bdd-...`) | ○ |
|
|
53
|
-
| type | `
|
|
54
|
+
| type | `data` 固定 | ○ |
|
|
54
55
|
| title | ドキュメント名。表示ページの見出しになる | ○ |
|
|
55
56
|
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
56
57
|
| rulebook | `specdojo:bdd-rulebook` 固定 | ○ |
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:bds-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: ui
|
|
5
6
|
status: draft
|
|
6
7
|
recipe: undecided
|
|
7
8
|
sample: specdojo:bds-sample
|
|
@@ -48,7 +49,7 @@ Frontmatter は `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml`
|
|
|
48
49
|
| ---- | ------------------- | ---- |
|
|
49
50
|
| id | 帳票ID(`bds-...`) | ○ |
|
|
50
51
|
|
|
51
|
-
| type | `
|
|
52
|
+
| type | `ui` 固定 | ○ |
|
|
52
53
|
| title | 帳票名 | ○ |
|
|
53
54
|
|
|
54
55
|
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
@@ -58,7 +59,7 @@ Frontmatter は `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml`
|
|
|
58
59
|
### 4.1 ID規約
|
|
59
60
|
|
|
60
61
|
- BDS の `id` は正規表現 `^bds-[a-z0-9-]+$` に合致する一意IDを使用します。
|
|
61
|
-
- `type:
|
|
62
|
+
- `type: ui` は帳票の利用者向け仕様であることを示します。
|
|
62
63
|
|
|
63
64
|
## 5. 本文構成(標準テンプレ)
|
|
64
65
|
|
|
@@ -153,7 +154,7 @@ Frontmatter は `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml`
|
|
|
153
154
|
```markdown
|
|
154
155
|
---
|
|
155
156
|
id: bds-daily-sales-summary
|
|
156
|
-
type:
|
|
157
|
+
type: ui
|
|
157
158
|
title: 日次売上サマリ
|
|
158
159
|
status: draft
|
|
159
160
|
part_of: []
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:bes-index-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: requirement
|
|
5
6
|
status: draft
|
|
6
7
|
target_format: markdown
|
|
7
8
|
recipe: undecided
|
|
@@ -43,13 +44,13 @@ Business Event Specification Index (BES Index) Documentation Rules
|
|
|
43
44
|
|
|
44
45
|
## 4. 推奨 Frontmatter 項目
|
|
45
46
|
|
|
46
|
-
| 項目 | 説明
|
|
47
|
-
| ------------ |
|
|
48
|
-
| `id` | ドキュメントID(例: `bes-index`)
|
|
49
|
-
| `type` | `
|
|
50
|
-
| `status` | `draft` / `ready` / `deprecated`
|
|
51
|
-
| `rulebook` | `specdojo:bes-index-rulebook`
|
|
52
|
-
| `supersedes` | 置き換え関係(古仕様→新仕様)
|
|
47
|
+
| 項目 | 説明 | 必須 |
|
|
48
|
+
| ------------ | --------------------------------- | ---- |
|
|
49
|
+
| `id` | ドキュメントID(例: `bes-index`) | ○ |
|
|
50
|
+
| `type` | `requirement` 固定 | ○ |
|
|
51
|
+
| `status` | `draft` / `ready` / `deprecated` | ○ |
|
|
52
|
+
| `rulebook` | `specdojo:bes-index-rulebook` | 任意 |
|
|
53
|
+
| `supersedes` | 置き換え関係(古仕様→新仕様) | 任意 |
|
|
53
54
|
|
|
54
55
|
## 5. 本文構成(標準テンプレ)
|
|
55
56
|
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
specdojo:
|
|
3
3
|
id: specdojo:bes-rulebook
|
|
4
4
|
type: rulebook
|
|
5
|
+
deliverable_type: requirement
|
|
5
6
|
status: draft
|
|
6
7
|
recipe: undecided
|
|
7
8
|
sample: specdojo:bes-sample
|
|
@@ -56,7 +57,7 @@ Frontmatter は `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml`
|
|
|
56
57
|
| ---- | --------------------------------- | ---- |
|
|
57
58
|
| id | BES ID(例: `bes-sale-checkout`) | ○ |
|
|
58
59
|
|
|
59
|
-
| type | `
|
|
60
|
+
| type | `requirement` 固定 | ○ |
|
|
60
61
|
| title | 業務イベント名(例: 業務イベント: 会計確定(販売)) | ○ |
|
|
61
62
|
| status | `draft`/`ready`/`deprecated` | ○ |
|
|
62
63
|
| based_on | 根拠となる仕様ID(BEL/UIS/BPS 等) | 任意 |
|
|
@@ -65,7 +66,7 @@ Frontmatter は `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml`
|
|
|
65
66
|
### 3.1 ID規約
|
|
66
67
|
|
|
67
68
|
- BES ID は `bes-...` の形式を推奨します(例: `bes-sale-checkout`)。
|
|
68
|
-
- `type:
|
|
69
|
+
- `type: requirement` は機能・業務イベントの要件であることを示します。
|
|
69
70
|
|
|
70
71
|
## 4. 本文テンプレ(最小)
|
|
71
72
|
|
|
@@ -97,7 +98,7 @@ BES の責務は次に **限定** し、各項目を見出しとしてこの順
|
|
|
97
98
|
---
|
|
98
99
|
|
|
99
100
|
id: bes-sale-checkout
|
|
100
|
-
type:
|
|
101
|
+
type: requirement
|
|
101
102
|
title: 業務イベント: 会計確定(販売)
|
|
102
103
|
status: draft
|
|
103
104
|
part_of: []
|