specdojo 0.4.1 → 0.4.3
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/CHANGELOG.md +39 -0
- package/dist/catalog/build.js +7 -7
- package/dist/catalog/generate.js +27 -12
- package/dist/commands/init.js +26 -7
- package/dist/commands/orchestrator.js +9 -2
- package/dist/dashboard/timeline-build.js +4 -151
- package/dist/devcontainer/command.js +1 -1
- package/dist/devcontainer/scaffold.js +24 -9
- package/dist/exec/core.js +4 -0
- package/dist/exec/events.js +17 -6
- package/dist/exec/plans-core.js +26 -6
- package/dist/exec/plans-generation.js +13 -0
- package/dist/exec/plans-storage.js +15 -3
- package/dist/exec/register.js +64 -6
- package/dist/exec/results.js +5 -1
- package/dist/exec/strategy.js +4 -0
- package/dist/kata/authoring.js +100 -0
- package/dist/kata/command.js +52 -2
- package/dist/kata/kata.js +55 -12
- package/dist/register/approach.js +29 -1
- package/dist/register/core.js +3 -2
- package/dist/register/create-commands.js +9 -0
- package/dist/register/cross-project.js +141 -0
- package/dist/register/derivation.js +28 -7
- package/dist/register/external-project.js +136 -0
- package/dist/register/item.js +26 -5
- package/dist/register/register.js +45 -28
- package/dist/schedule/strategy-generate-scope.js +2 -1
- package/dist/schedule/strategy-profiles.js +3 -0
- package/dist/shared/agent-types.js +4 -0
- package/dist/shared/catalog-files.js +31 -0
- package/dist/shared/lefthook-scaffold.js +177 -0
- package/dist/shared/provider-scaffold.js +3 -3
- package/dist/shared/specdojo-config.js +130 -6
- package/dist/shared/timeline-index.js +125 -0
- package/docs/ja/specdojo/exec-templates/xep-recipe-authoring-template.md +45 -0
- package/docs/ja/specdojo/exec-templates/xep-rulebook-authoring-template.md +45 -0
- package/docs/ja/specdojo/exec-templates/xep-sample-authoring-template.md +45 -0
- package/docs/ja/specdojo/exec-templates/xep-template-authoring-template.md +45 -0
- package/docs/ja/specdojo/guides/docs-editing-guide.md +32 -0
- package/docs/ja/specdojo/guides/docs-structure-guide.md +1 -1
- package/docs/ja/specdojo/guides/exec-config-guide.md +13 -6
- package/docs/ja/specdojo/guides/kata-guide.md +4 -0
- package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +4 -2
- package/docs/ja/specdojo/guides/quick-start-guide.md +374 -68
- package/docs/ja/specdojo/guides/register-operation-guide.md +30 -0
- package/docs/ja/specdojo/guides/remote-host-development-guide.md +10 -2
- package/docs/ja/specdojo/guides/ryu-guide.md +18 -4
- package/docs/ja/specdojo/guides/use-case-guide.md +2 -2
- package/docs/ja/specdojo/references/command-reference.md +77 -29
- package/docs/ja/specdojo/references/specdojo-config-reference.md +41 -12
- package/docs/ja/specdojo/standards/recipe-authoring-standard.md +10 -10
- package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +13 -13
- package/docs/ja/specdojo/standards/sample-authoring-standard.md +4 -4
- package/docs/ja/specdojo/standards/template-authoring-standard.md +4 -4
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +6 -0
- package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +6 -6
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +21 -4
- package/docs/specdojo/schemas/v1/specdojo-config.schema.yaml +34 -0
- package/package.json +2 -2
- package/templates/antigravity/README.md +1 -1
- package/templates/antigravity/settings.global.json +5 -0
- package/templates/claude/README.md +11 -8
- package/templates/claude/settings.edit.json +10 -1
- package/templates/claude/settings.orchestrator.json +90 -0
- package/templates/claude/settings.report.json +14 -1
- package/templates/claude/settings.review.json +13 -1
- package/templates/codex/README.md +7 -5
- package/templates/codex/rules/specdojo.rules +48 -0
- package/templates/devcontainer/devcontainer.json +1 -4
- package/templates/init-agent-members.yaml +3 -3
- package/templates/lefthook/tools/install-lefthook.mjs +46 -0
- package/templates/lefthook/tools/specdojo-pre-commit.mjs +207 -0
- package/templates/opencode/README.md +8 -2
- package/templates/opencode/agents/opencode-executor.md +2 -0
- package/templates/opencode/agents/opencode-review-executor.md +2 -0
- package/templates/opencode/agents/specdojo-orchestrator.md +60 -6
- /package/dist/{shared → kata}/yaml-schema-modeline.js +0 -0
|
@@ -58,9 +58,17 @@ npx specdojo devcontainer scaffold --provider claude,codex --preset recommended
|
|
|
58
58
|
npx specdojo devcontainer scaffold --provider claude,codex --preset recommended
|
|
59
59
|
```
|
|
60
60
|
|
|
61
|
-
|
|
61
|
+
用途に合わせて、provider とは別に次の preset を選びます。
|
|
62
62
|
|
|
63
|
-
|
|
63
|
+
| preset | 内容 |
|
|
64
|
+
| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
65
|
+
| `minimal` | 選んだ provider の CLI と SpecDojo の動作に必要な最小構成。preset を省略した場合と同じ。 |
|
|
66
|
+
| `recommended` | `minimal` に GitHub CLI(`gh`)、端末版 Emacs と Vim、tmux、SpecDojo の文書作業向け VS Code 拡張・設定を追加する。 |
|
|
67
|
+
| `full` | `recommended` に ripgrep、fd、fzf、yq、shellcheck、shfmt、Ollama 接続、cron を追加する。fd は `fd-find` package から `fd` コマンドとして利用できる。 |
|
|
68
|
+
|
|
69
|
+
`recommended` / `full` のエディタ設定は既存設定を上書きしません。VS Code 拡張は Git Graph、markdownlint、YAML、Prettier、remark、Markdown All in One、Code Spell Checker、EditorConfig、Error Lens、Even Better TOML で、選択した provider の拡張もその provider の分だけ追加します。Markdown と YAML は保存時に Prettier で整形し、主要な SpecDojo YAML を `docs/specdojo/schemas/v1/` の schema へ関連付けます。同じ拡張は `.vscode/extensions.json` の recommendation にも追加されます。
|
|
70
|
+
|
|
71
|
+
既存の `.devcontainer/` は通常実行では上書きしません。置き換える場合だけ `--force` を指定します。生成設定は provider の設定ディレクトリを名前付きボリュームへ保存し、ホストの認証情報・秘密鍵・`.env` は既定でマウントしません。GitHub へのログインは自動では行わないため、利用者が必要なときだけコンテナ内で `gh auth login` を実行します。認証は同じリポジトリのコンテナを作り直しても名前付き volume に残りますが、同じ利用者で動く agent からも見えます。このため配布する agent 権限では `git push` と `gh` の書き込みを拒否します。pipeline executor・review executor・reporter は読み取りを含む全 `gh` を拒否し、対話型オーケストレーターは役割別設定を持てる Claude Code と OpenCode でだけ `gh pr view`・`gh run view` などの読み取りを許可します。Codex と Antigravity は権限が役割共通のため全 `gh` を拒否します。preset に個別の `--ollama`・`--cron`・`--tmux`・`--editor` を加えることもできます。本書の構成図のようにホスト側の tmux でコンテナ自体を包む場合、tmux を含めない `minimal` も選べます。
|
|
64
72
|
|
|
65
73
|
生成する `devcontainer.json` は、利用リポジトリ単体ではなく、その親ディレクトリをホスト側と同じ名前の `/workspaces/<親名>` へマウントします。例えば `app1-workspace/app1-specdojo` の作業ディレクトリは `/workspaces/app1-workspace/app1-specdojo` です。別リポジトリ構成では `repos` の参照先(例: `../app1`)と `worktree_base`(例: `../app1-specdojo-worktrees`)が利用リポジトリの外にあるためです。これらの Git リポジトリと worktree は `safe.directory` の対象になります。一方、同じ親ディレクトリに置いたその他のファイルもコンテナから見えるため、秘密情報などコンテナへ公開しないファイルは別の場所へ置いてください。
|
|
66
74
|
|
|
@@ -42,7 +42,7 @@ SpecDojo は道場のメタファーとして、進め方(`approach`)を「R
|
|
|
42
42
|
|
|
43
43
|
### 1.1. approach の選び方
|
|
44
44
|
|
|
45
|
-
進め方は、まずタスクの目的で分かれ、通常の成果物作成・更新では実践の型の整備状況でさらに分かれます。`fully-guided` / `recipe-guided` / `freeform` は実践の型をどこまで基準にするかを表します。`retrofit` は実装先行時の現在動作調査、`bootstrap` / `cross-deliverable-dedup`・各 `*-maintenance`・`finalize` 系は、それぞれの目的に応じて選ぶ進め方です。
|
|
45
|
+
進め方は、まずタスクの目的で分かれ、通常の成果物作成・更新では実践の型の整備状況でさらに分かれます。`fully-guided` / `recipe-guided` / `freeform` は実践の型をどこまで基準にするかを表します。`retrofit` は実装先行時の現在動作調査、`bootstrap` / `cross-deliverable-dedup`・各 `*-authoring`・各 `*-maintenance`・`finalize` 系は、それぞれの目的に応じて選ぶ進め方です。
|
|
46
46
|
|
|
47
47
|
```mermaid
|
|
48
48
|
flowchart TD
|
|
@@ -56,6 +56,7 @@ flowchart TD
|
|
|
56
56
|
FF --> W
|
|
57
57
|
P -->|"実装先行の成果物を反映・新設"| RF["retrofit<br/>実装 → 成果物"]
|
|
58
58
|
P -->|"成果物と実践の型を新規に一括整備"| BS["bootstrap"]
|
|
59
|
+
P -->|"既存成果物から実践の型だけを新規作成"| AU["各 authoring<br/>成果物 → 新しい実践の型"]
|
|
59
60
|
P -->|"成果物群の重複を整理"| DD["cross-deliverable-dedup"]
|
|
60
61
|
P -->|"実践の型を見直す"| MT["各 maintenance<br/>成果物 → 実践の型"]
|
|
61
62
|
P -->|"human が確定する"| FIN["finalize / bootstrap-finalize<br/>status を ready へ昇格"]
|
|
@@ -65,7 +66,7 @@ flowchart TD
|
|
|
65
66
|
|
|
66
67
|
### 1.2. approach 一覧
|
|
67
68
|
|
|
68
|
-
`approach`
|
|
69
|
+
`approach` は、目的に応じて「成果物の作成・更新」「初期整備・実装反映・横断整理」「実践の型の新規作成」「実践の型のメンテナンス」「human による確定」の5種に分けられます。以下の表にある edit / review は plan テンプレート、result は実行記録のテンプレートです。テンプレートには各 `approach` で行う具体的な手順が定義されています。mode や execution に対応する専用テンプレートがない場合のフォールバック規則は [plan/resultライフサイクルガイド](plan-result-lifecycle-guide.md) を参照してください。
|
|
69
70
|
|
|
70
71
|
#### 1.2.1. 成果物の作成・更新
|
|
71
72
|
|
|
@@ -123,7 +124,20 @@ flowchart LR
|
|
|
123
124
|
|
|
124
125
|
`retrofit` では、実装を現在動作(AS-IS)の根拠、既存成果物・決定記録・プロジェクトコンテキストを意図された仕様の根拠、`done_criteria` を成果物が満たすべき目的として扱います。三者が一致すれば成果物へ反映し、実装が意図された仕様と異なる場合は実装へ無条件に合わせず、乖離と修正対象候補を result に記録します。実装から確認できない目的・業務判断・将来方針は推測しません。
|
|
125
126
|
|
|
126
|
-
#### 1.2.3.
|
|
127
|
+
#### 1.2.3. 実践の型の新規作成
|
|
128
|
+
|
|
129
|
+
既存成果物を読み取り専用の手本として、指定した種類の kata だけを新規作成します。`--target` の先頭は新しい kata ID、後続は任意の手本成果物です。
|
|
130
|
+
|
|
131
|
+
| `approach` | 作る対象 | 対応テンプレート |
|
|
132
|
+
| -------------------- | -------- | ------------------------------------------------------------ |
|
|
133
|
+
| `rulebook-authoring` | rulebook | [edit](../exec-templates/xep-rulebook-authoring-template.md) |
|
|
134
|
+
| `recipe-authoring` | recipe | [edit](../exec-templates/xep-recipe-authoring-template.md) |
|
|
135
|
+
| `sample-authoring` | sample | [edit](../exec-templates/xep-sample-authoring-template.md) |
|
|
136
|
+
| `template-authoring` | template | [edit](../exec-templates/xep-template-authoring-template.md) |
|
|
137
|
+
|
|
138
|
+
authoring は register 専用です。Schedule の成果物単位の target では新しい kata ID と複数の手本を区別できないため、strategy profile は用意しません。
|
|
139
|
+
|
|
140
|
+
#### 1.2.4. 実践の型のメンテナンス
|
|
127
141
|
|
|
128
142
|
通常の成果物作業とは参照の向きを逆にし、成果物や review result を根拠として対象の実践の型を見直します。
|
|
129
143
|
|
|
@@ -150,7 +164,7 @@ flowchart LR
|
|
|
150
164
|
|
|
151
165
|
rulebook frontmatter で `not-needed` と宣言された型はメンテナンス対象ではなく、strategy へ対応する `*-maintenance` フェーズを生成しません。作成が必要になった場合は、先に要否判断の根拠と rulebook frontmatter の宣言を更新します。
|
|
152
166
|
|
|
153
|
-
#### 1.2.
|
|
167
|
+
#### 1.2.5. human による確定
|
|
154
168
|
|
|
155
169
|
`execution: human` と組み合わせ、確認対象の `status` を `ready` へ昇格する確定プロファイルです。`ready` への昇格は human のみが行えます。
|
|
156
170
|
|
|
@@ -76,7 +76,7 @@ flowchart TD
|
|
|
76
76
|
|
|
77
77
|
- ゴール: 目的・スコープ・対象成果物が未確定な状態を、記録しながら決めていく。
|
|
78
78
|
- 進め方: `issue` / `question` を登録し、調査のうえ `decision` で方針を確定し、`todo` で成果物カタログ作成につなげる。決定後は schedule 側で計画済み作業を管理する。
|
|
79
|
-
- 主に使う文書: [
|
|
79
|
+
- 主に使う文書: [Quick Startガイド](quick-start-guide.md) の `registerをユースケース別に使う`、[登録簿運用ガイド](register-operation-guide.md)。
|
|
80
80
|
|
|
81
81
|
### 2.3. 既存プロダクト(文書なし)から着手する
|
|
82
82
|
|
|
@@ -96,7 +96,7 @@ flowchart TD
|
|
|
96
96
|
|
|
97
97
|
- ゴール: agent の変更を task 単位で隔離し、成功時だけ統合する。
|
|
98
98
|
- 進め方: 統合先ブランチにいることを確認し、`exec run --worktree`(または `--auto`)で実行する。段階ごとに確認する場合は分割コマンドを使う。
|
|
99
|
-
- 主に使う文書: [Quick Startガイド](quick-start-guide.md) の
|
|
99
|
+
- 主に使う文書: [Quick Startガイド](quick-start-guide.md) の `発展: worktreeで1タスクを隔離実行する`、[exec worktree運用ガイド](exec-worktree-guide.md)、[ブランチワークフローガイド](branch-workflow-guide.md)。
|
|
100
100
|
|
|
101
101
|
### 3.3. 対話(チャット)で運用する
|
|
102
102
|
|
|
@@ -38,16 +38,16 @@ project の解決順序と設定は [遂行の技活用ガイド](../guides/waza
|
|
|
38
38
|
|
|
39
39
|
## 2. init / config / project
|
|
40
40
|
|
|
41
|
-
| コマンド | 用途
|
|
42
|
-
| ------------------------ |
|
|
43
|
-
| `init` | project から agent 実行までを質問式で初期設定する
|
|
44
|
-
| `config init` | `specdojo.config.json` と `.gitignore` を個別に用意する
|
|
45
|
-
| `config migrate-members` | agent 定義を保護設定へ移す
|
|
46
|
-
| `config scaffold` | provider
|
|
47
|
-
| `project list` | 登録済み project を表示する
|
|
41
|
+
| コマンド | 用途 | 例 |
|
|
42
|
+
| ------------------------ | ----------------------------------------------------------- | ------------------------------------------- |
|
|
43
|
+
| `init` | project から agent 実行までを質問式で初期設定する | `specdojo init` |
|
|
44
|
+
| `config init` | `specdojo.config.json` と `.gitignore` を個別に用意する | `specdojo config init` |
|
|
45
|
+
| `config migrate-members` | agent 定義を保護設定へ移す | `specdojo config migrate-members --dry-run` |
|
|
46
|
+
| `config scaffold` | provider、VS Code ワークスペース、Git hook を個別に配置する | `specdojo config scaffold --lefthook` |
|
|
47
|
+
| `project list` | 登録済み project を表示する | `specdojo project list` |
|
|
48
48
|
|
|
49
49
|
`init` は対話できる端末で、project ID と名前、register、人の nickname と表示名、複数指定可能な
|
|
50
|
-
provider、exec、Dev Container の順に質問します。Dev Container
|
|
50
|
+
provider、exec、Dev Container、Git hook の順に質問します。Dev Container を選んだ場合だけ、続けて `minimal` / `recommended` / `full` の preset を質問します(既定は `recommended`)。Git hook は既定では作りません。成果物カタログは対話では質問せず、`--catalog <size>` を
|
|
51
51
|
明示した場合にだけ作成します。既存ファイルは上書きせず、スキップしたパスを表示します。`--dry-run` は
|
|
52
52
|
予定だけを表示し、ファイルや `package.json` を変更しません。各回答は質問の直後に検証され、誤りの理由を
|
|
53
53
|
表示して同じ質問だけをやり直します。それまでの回答は保持されます。`--exec` を選んだのに provider が
|
|
@@ -68,10 +68,13 @@ provider、exec、Dev Container の順に質問します。Dev Container を選
|
|
|
68
68
|
| `--exec` | executor / reporter の名簿と起動設定を作る | 作らない |
|
|
69
69
|
| `--catalog <size>` | `small` / `medium` / `large` の成果物カタログを作る(対話では質問しない) | 作らない |
|
|
70
70
|
| `--devcontainer` | 選んだ provider の Dev Container を作る | 作らない |
|
|
71
|
-
| `--
|
|
71
|
+
| `--lefthook` | commit 前の文書・SpecDojo 検査を行う Git hook を作る | 作らない |
|
|
72
|
+
| `--devcontainer-preset <name>` | Dev Container の preset(`minimal` / `recommended` / `full`)を選ぶ | `recommended` |
|
|
72
73
|
| `--workspace-name <name>` | Dev Container 内で使う親ディレクトリ名 | ホスト側の親名 |
|
|
73
74
|
| `--dry-run` | 作成・変更予定だけを表示する | 書き込む |
|
|
74
75
|
|
|
76
|
+
`--devcontainer-preset none` は後方互換のため受け付け、`minimal` と同じ構成として扱います。
|
|
77
|
+
|
|
75
78
|
`init` が作る `.specdojo/agent-members.yaml` と `.specdojo/exec-defaults.yaml` は、選択した
|
|
76
79
|
provider だけを含みます。親 runner の検証は、対応する `package.json` の npm script が存在する
|
|
77
80
|
ID だけを `pipeline.parent_validations` へ設定し、該当する script がなければこの設定を省略します。
|
|
@@ -103,6 +106,32 @@ specdojo config scaffold --provider antigravity --global
|
|
|
103
106
|
|
|
104
107
|
`--force` はリポジトリ内の scaffold ファイルだけを上書きし、グローバル設定の既存項目は上書きしません。従来の `exec scaffold --provider antigravity` でも同じ `--global` / `--dry-run` の挙動を利用できます。
|
|
105
108
|
|
|
109
|
+
`config scaffold --lefthook` は、利用リポジトリに `lefthook.yml`、`.markdownlint.jsonc`、
|
|
110
|
+
`.markdownlintignore`、依存なしで起動できる `tools/install-lefthook.mjs` と
|
|
111
|
+
`tools/specdojo-pre-commit.mjs` を生成します。pre-commit では staged の Markdown と YAML だけを
|
|
112
|
+
Prettier で整形し、staged の Markdown だけを markdownlint で検査します。
|
|
113
|
+
また、`.specdojo/specdojo.config.json` の `project_register_path` 配下に staged の変更がある project では
|
|
114
|
+
`specdojo register build`、`catalog_path` 配下に変更がある project では `specdojo catalog validate` を
|
|
115
|
+
実行します。`catalog_path` がない構成には catalog の command を生成せず、テストは hook に含めません。
|
|
116
|
+
|
|
117
|
+
```bash
|
|
118
|
+
specdojo config scaffold --lefthook --dry-run
|
|
119
|
+
specdojo config scaffold --lefthook
|
|
120
|
+
npm install
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
生成する markdownlint 設定は SpecDojo の文書向けに行長などの規則を調整し、ignore は Claude Code、
|
|
124
|
+
GitHub Copilot、OpenCode の agent 定義を検査対象から外します。既存の markdownlint 設定と ignore は
|
|
125
|
+
`--force` を付けても上書きしません。既存の `lefthook.yml` と `tools/` のファイルは `--force` なしでは
|
|
126
|
+
上書きしません。必要な
|
|
127
|
+
`lefthook`・`prettier`・`markdownlint-cli` の devDependencies と `prepare`・`pre-commit` npm script は、
|
|
128
|
+
不足している項目を `package.json` の変更前に表示してから追加します。同名の script、dependencies、
|
|
129
|
+
devDependencies は `--force` を指定しても保持します。`package.json` がない場合は必要な JSON を表示する
|
|
130
|
+
だけで、ファイルを新規作成しません。installer は linked worktree と `node_modules/lefthook` がない環境を
|
|
131
|
+
成功扱いで skip します。primary worktree で `npm install`、または既存の `prepare` を保持した場合は
|
|
132
|
+
`node tools/install-lefthook.mjs` を実行してください。hook 内から Git を呼ぶ入口は `GIT_DIR` などの
|
|
133
|
+
repository-local 環境変数を除いてから staged files を調べます。
|
|
134
|
+
|
|
106
135
|
`config scaffold --workspace` は、`.specdojo/specdojo.config.json` の `repos` 宣言から VS Code のマルチルートワークスペース(`<project-id>.code-workspace`)をリポジトリルートに生成します。`folders` にはプロジェクトリポジトリ(`.`)と各プロダクトリポジトリ(`repos[].path`)を宣言順に並べ、別リポジトリ構成でも 1 つの VS Code ウィンドウでプロジェクトとプロダクトを同時に開けます。`--project <id>` で対象 project を指定でき、省略時は `current_project` を使います。既存のファイルは `--force` を指定しない限り上書きしません。`repos` が宣言されていない project ではエラーになります。`--dry-run` は書き込まず予定の内容だけを表示します。
|
|
107
136
|
|
|
108
137
|
```bash
|
|
@@ -117,7 +146,7 @@ specdojo config scaffold --workspace --force
|
|
|
117
146
|
|
|
118
147
|
### 2.1. kata
|
|
119
148
|
|
|
120
|
-
`kata`
|
|
149
|
+
`kata` は、利用リポジトリで作成・上書きした型(Kata)と npm package から参照中の型を確認・取得します。対象種別は rulebook / standard / recipe / sample / template です。同じ正準パスにファイルがある場合は利用リポジトリ側を優先します。`kata_authority` の kata は `docs/ja/kata/` からだけ解決し、`kata list` と `kata show` にも表示します。
|
|
121
150
|
|
|
122
151
|
| コマンド | 用途 | 例 |
|
|
123
152
|
| ---------------- | ------------------------------------------------------- | ------------------------------------------------ |
|
|
@@ -349,7 +378,7 @@ specdojo schedule strategy generate \
|
|
|
349
378
|
| `register history` | 追記型 event と旧 Git 履歴から変更を再構成する | `specdojo register history --project prj-0001 --since 2026-08-01` |
|
|
350
379
|
| `register migrate` | 旧形式の登録簿データを現行形式へ移行する | `specdojo register migrate --project prj-0001 --dry-run` |
|
|
351
380
|
|
|
352
|
-
`register add` は ID
|
|
381
|
+
`register add` は ID を省略すると自動採番し、現在の project では現在の作業ツリーに type 別の個票を作成します。別 project を `--project` で指定して `--commit` を付けると、対象 project の統合ブランチを開いている worktree、または CLI が作る一時 worktree で起票・再生成・commit を完了します。ID は乱数部分を持ち、曖昧文字(`I` / `L` / `O` / `U`)を除いた英大文字+数字の 32 文字セットによる 4 桁(例: `PJR-4B7K`)です。個票 Frontmatter が分類、処理状態、優先度、担当、日付、結論の正本であり、`register build` は個票から一覧と派生ビューを生成します。`register` 系コマンドはすべて、成功時の通常出力を標準出力へ、エラーメッセージを標準エラー出力へ書きます。
|
|
353
382
|
|
|
354
383
|
主要オプション:
|
|
355
384
|
|
|
@@ -379,7 +408,7 @@ specdojo schedule strategy generate \
|
|
|
379
408
|
|
|
380
409
|
`register` の `--by` は、project の `pm-members.yaml` にある人の nickname、`.specdojo/agent-members.yaml` にある agent の nickname または alias、予約 actor の `SpecDojo`・`specdojo-orchestrator`・`night-orchestrator` だけを受け付けます。agent alias は実体名で event に記録し、未知の値は書き込み前に拒否します。省略時は `SpecDojo` です。決定・承認では `PO` などの Role code や予約 actor ではなく、本人の nickname を指定します。
|
|
381
410
|
|
|
382
|
-
`--approach`
|
|
411
|
+
`--approach` を指定する場合、通常は `--target` が 1 件だけ必須です。成果物を作成・修正する approach の対象は成果物カタログの doc id で解決するため、まだ文書がない成果物も指定できます。kata maintenance の対象は文書索引で解決し、approach に対応する kata 種別との一致も書き込み前に検証します。kata authoring だけは、1 件目を新しい kata ID、2 件目以降を任意の手本成果物 ID とします。
|
|
383
412
|
|
|
384
413
|
`item_type: note` は `open` のまま更新する記録です。`register close` / `register reject` / `register defer` は終了コード 1 で拒否し、対応・回答・判断が必要な場合は `todo` / `question` / `decision` など目的に合う別の `item_type` で起票するよう案内します。本文の追記や修正には `register update` を使用できます。
|
|
385
414
|
|
|
@@ -387,12 +416,20 @@ specdojo schedule strategy generate \
|
|
|
387
416
|
|
|
388
417
|
`register update --topic <slug>` は個票のファイル名と Frontmatter の文書 ID を同時に変更し、`docs/ja` 配下の旧文書 ID 参照を更新してから生成ビューを再生成します。変更は `action: update` の event に文書 ID の変更として記録されます。形式は英小文字・数字・単一ハイフン区切りに限り、変更先ファイルが存在する場合は書き込み前に停止します。
|
|
389
418
|
|
|
390
|
-
`register add --from <ID>` は、起票の元になった登録項目を個票 Frontmatter の `derived_from` へ記録します。`--from` は複数回指定でき、同じ project の項目は `PJR-XXXX`、別 project の項目は `<project-id>:PJR-XXXX`
|
|
419
|
+
`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 を起票するときも、この関係を追跡先として使います。
|
|
391
420
|
|
|
392
|
-
`register add --
|
|
421
|
+
`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 が残ります。
|
|
422
|
+
|
|
423
|
+
`register add --approach <approach> --target <doc-id>` は、個票 Frontmatter に進め方と対象を書きます。成果物を作成・修正する進め方は成果物カタログにある文書を、`rulebook-maintenance` などの保守の進め方は名前に対応する kata 種別を対象にし、対象は 1 件だけです。`rulebook-authoring` / `recipe-authoring` / `sample-authoring` / `template-authoring` は、1 件目を新しい kata ID、2 件目以降を手本にするカタログ成果物 ID とします。新しい ID の authority、種類別の末尾、既存 ID との重複、手本の存在を起票時と実行時に検証します。既存 ID には対応する `*-maintenance` を使います。手本の該当参照が `undecided` または未記入なら同じ実行で新 ID へ更新し、別 ID または `not-needed` なら上書きせず result へ申し送ります。`approach` を指定しない `--target` は複数回指定でき、従来どおり変更網羅検証の対象宣言として使えます。`register update` でも同じ検証を行います。
|
|
424
|
+
|
|
425
|
+
kata authoring は register 専用です。Schedule の task は対象成果物を起点にするため、「新しい kata ID + 0 件以上の手本」という target 契約を損なわずに表現できません。strategy の phase に指定した場合は plan 生成時に停止します。
|
|
393
426
|
|
|
394
427
|
記帳系コマンドの `--commit` は、register の worktree 実行と同じ project の `register lifecycle` 枠を取得してから、記帳、`register build` 相当の検証・派生ビュー再生成、pathspec を限定した commit を行います。commit 対象はコマンドが新たに変更した個票・event・参照文書だけで、開始前からあるほかの変更を含めません。対象個票・event・参照文書に開始前の未 commit 変更がある場合は、既存差分との混在を避けるため記帳前に停止します。既定件名は `docs(register PJR-XXXX): <command> <title>` で、`-m` / `--message` により上書きできます。`--dry-run --commit` は変更予定だけを表示し、枠の取得と commit は行いません。
|
|
395
428
|
|
|
429
|
+
別 project への `register add` は `--commit` が必須です。対象 project の登録簿に未 commit 変更がある場合、または統合ブランチがローカルに存在しない場合は、何も書き込まず終了コード 1 で停止します。元の worktree とブランチは変更しません。`close`、`reject` など別 project の状態遷移は受け付けず、対象 project の worktree での実行を案内します。
|
|
430
|
+
|
|
431
|
+
別リポジトリへの起票も `--commit` が必須です。相手のリポジトリ、`node_modules/.bin/specdojo`、0.4.2 以上の版のいずれかを確認できない場合は、相手を変更せず停止します。相手の起票が失敗した場合は相手の標準出力・標準エラー出力と終了コードをそのまま引き継ぎ、push は行いません。外部 project の `close` などの状態遷移は委譲しないため、案内された相手のリポジトリで実行してください。
|
|
432
|
+
|
|
396
433
|
一覧・派生ビューの「登録日」「完了日」は、保存した日時を config の `run.register_date_timezone`(IANA タイムゾーン名、既定 `UTC`)へ変換して導出する表示値です。
|
|
397
434
|
|
|
398
435
|
`register migrate` は旧形式の登録簿データを現行形式へ移す一度限りの移行コマンドです。追跡対象だった `pjr-index.md` の表を個票 Frontmatter へ移し、旧日時を UTC へ変換し、個票内の `register_events` を `events/pjr-XXXX.yaml` へ分離します。イベントがまだない項目は、利用可能な Git 履歴を項目別イベントファイルへ変換します。event ID は commit・項目 ID・変更内容から決定的に生成するため、再実行で重複しません。
|
|
@@ -948,17 +985,25 @@ specdojo orchestrator night --project prj-0001 \
|
|
|
948
985
|
|
|
949
986
|
主要オプション:
|
|
950
987
|
|
|
951
|
-
| オプション | 用途
|
|
952
|
-
| ------------------------- |
|
|
953
|
-
| `--preset recommended`
|
|
954
|
-
| `--provider <names>` | `claude,codex` のようにカンマ区切りで provider を指定する。
|
|
955
|
-
| `--editor <names>` | `emacs,vim` のようにエディタと初期設定を追加する。
|
|
956
|
-
| `--ollama` | Ollama への接続設定(環境変数)を追加する。
|
|
957
|
-
| `--cron` | cron をインストールし、起動時にサービスを開始する。
|
|
958
|
-
| `--tmux` | tmux をインストールする。
|
|
959
|
-
| `--workspace-name <name>` | Dev Container 内で使う親ディレクトリ名を上書きする。
|
|
960
|
-
| `--force` | `.devcontainer/` が既に存在する場合に上書きする。
|
|
961
|
-
| `--dry-run` | 実際にファイルを作成せず、作成予定のファイルを表示する。
|
|
988
|
+
| オプション | 用途 |
|
|
989
|
+
| ------------------------- | ------------------------------------------------------------- |
|
|
990
|
+
| `--preset <name>` | `minimal` / `recommended` / `full` の構成をまとめて適用する。 |
|
|
991
|
+
| `--provider <names>` | `claude,codex` のようにカンマ区切りで provider を指定する。 |
|
|
992
|
+
| `--editor <names>` | `emacs,vim` のようにエディタと初期設定を追加する。 |
|
|
993
|
+
| `--ollama` | Ollama への接続設定(環境変数)を追加する。 |
|
|
994
|
+
| `--cron` | cron をインストールし、起動時にサービスを開始する。 |
|
|
995
|
+
| `--tmux` | tmux をインストールする。 |
|
|
996
|
+
| `--workspace-name <name>` | Dev Container 内で使う親ディレクトリ名を上書きする。 |
|
|
997
|
+
| `--force` | `.devcontainer/` が既に存在する場合に上書きする。 |
|
|
998
|
+
| `--dry-run` | 実際にファイルを作成せず、作成予定のファイルを表示する。 |
|
|
999
|
+
|
|
1000
|
+
preset の違いは次のとおりです。preset は provider とは別に選び、個別の `--ollama`・`--cron`・`--tmux`・`--editor` を追加指定できます。
|
|
1001
|
+
|
|
1002
|
+
| preset | 内容 |
|
|
1003
|
+
| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1004
|
+
| `minimal` | 選んだ provider の CLI と SpecDojo の動作に必要な最小構成。preset を省略した場合と同じ。 |
|
|
1005
|
+
| `recommended` | `minimal` に `gh`、Emacs、Vim、tmux、文書作業向けの VS Code 拡張・設定を追加する。 |
|
|
1006
|
+
| `full` | `recommended` に ripgrep、fd、fzf、yq、shellcheck、shfmt、Ollama 接続、cron を追加する。fd は `fd-find` package から `fd` コマンドとして利用できる。 |
|
|
962
1007
|
|
|
963
1008
|
```bash
|
|
964
1009
|
# claude と codex 用の CLI を含む Dev Container を生成する
|
|
@@ -967,6 +1012,9 @@ npx specdojo devcontainer scaffold --provider claude,codex
|
|
|
967
1012
|
# SpecDojo の文書作業向けの推奨設定をまとめて追加する
|
|
968
1013
|
npx specdojo devcontainer scaffold --provider claude,codex --preset recommended
|
|
969
1014
|
|
|
1015
|
+
# ローカル LLM や routine を含む開発用の構成を追加する
|
|
1016
|
+
npx specdojo devcontainer scaffold --provider claude,codex --preset full
|
|
1017
|
+
|
|
970
1018
|
# 追加オプションを指定する
|
|
971
1019
|
npx specdojo devcontainer scaffold --provider claude --ollama --tmux
|
|
972
1020
|
|
|
@@ -977,7 +1025,7 @@ npx specdojo devcontainer scaffold --provider claude --editor emacs
|
|
|
977
1025
|
npx specdojo devcontainer scaffold --workspace-name app1-workspace
|
|
978
1026
|
```
|
|
979
1027
|
|
|
980
|
-
`.devcontainer/` が既に存在する場合は何も書き込まず、置き換える場合だけ `--force` を指定します。上書き前や初回生成前は `--dry-run` で対象ファイルを確認してください。生成設定は provider の設定ディレクトリを名前付きボリュームへ保存してコンテナ再作成後も利用できるようにし、ホストの認証情報・秘密鍵・`.env`
|
|
1028
|
+
`.devcontainer/` が既に存在する場合は何も書き込まず、置き換える場合だけ `--force` を指定します。上書き前や初回生成前は `--dry-run` で対象ファイルを確認してください。生成設定は provider の設定ディレクトリを名前付きボリュームへ保存してコンテナ再作成後も利用できるようにし、ホストの認証情報・秘密鍵・`.env` を直接マウントしません。認証は生成したコンテナ内で利用者が必要なときに行い、自動ログインはしません。
|
|
981
1029
|
|
|
982
1030
|
生成する `devcontainer.json` は `${localWorkspaceFolder}/..` を、ホスト側の親ディレクトリ名に合わせた `/workspaces/<親名>` へマウントし、`workspaceFolder` をその中の `${localWorkspaceFolderBasename}` へ向けます。例えば `app1-workspace/app1-specdojo` で scaffold すると、作業ディレクトリは `/workspaces/app1-workspace/app1-specdojo` です。別リポジトリ構成の `repos` と `worktree_base` はプロジェクトリポジトリの外にあるため、親ディレクトリを共有することでプロダクトリポジトリと exec の worktree をコンテナから利用できます。`post-create.sh` はマウントした親ディレクトリ配下の Git リポジトリと worktree を `safe.directory` の対象にします。親ディレクトリ内のその他のファイルもコンテナから見えるため、コンテナへ公開しないファイルは同じ親ディレクトリに置かないでください。
|
|
983
1031
|
|
|
@@ -991,12 +1039,12 @@ Codex 自身の sandbox は引き続き使用し、`workspace-write` で許可
|
|
|
991
1039
|
|
|
992
1040
|
名前付きボリュームは `<repository>-specdojo-*` という名前で生成します。`<repository>` は scaffold の対象ディレクトリ名を Docker volume 名に使える小文字へ正規化した値です。本体リポジトリや別の利用リポジトリとは共有せず、同じリポジトリの Dev Container を作り直した場合だけ再利用します。固定名を共有すればログインを使い回せますが、プロジェクトごとのアカウントを分けられず、`safe.directory` などのコンテナ固有 Git 設定も混在するため、分離を既定とします。volume 名は scaffold を実行した時点のディレクトリ名から決まり、生成した `devcontainer.json` に固定されます。後でディレクトリ名を変えても volume は変わりません。一方、別の場所にある同じディレクトリ名のリポジトリ(例: 別組織の `app`)を scaffold すると同じ volume 名になり、認証情報を共有します。分離したい場合は、生成後に `devcontainer.json` の `mounts` の `source` を一意な名前へ書き換えてください。
|
|
993
1041
|
|
|
994
|
-
保存先は次のとおりです。表の「常時」は provider の指定にかかわらず mount します。GitHub CLI
|
|
1042
|
+
保存先は次のとおりです。表の「常時」は provider の指定にかかわらず mount します。GitHub CLI の設定と認証は `recommended` / `full` preset のときだけ保存します。
|
|
995
1043
|
|
|
996
1044
|
| 対象 | コンテナ内の保存先 | volume 名 | 条件 |
|
|
997
1045
|
| ----------------------------- | ---------------------------------- | ------------------------------------- | ---------------------- |
|
|
998
1046
|
| コンテナ固有の Git 設定 | `/home/node/.config/git` | `<repository>-specdojo-git` | 常時 |
|
|
999
|
-
| GitHub CLI の設定・認証 | `/home/node/.config/gh` | `<repository>-specdojo-gh` |
|
|
1047
|
+
| GitHub CLI の設定・認証 | `/home/node/.config/gh` | `<repository>-specdojo-gh` | `recommended` / `full` |
|
|
1000
1048
|
| Claude Code の設定・認証 | `/home/node/.claude` | `<repository>-specdojo-claude` | `claude` provider |
|
|
1001
1049
|
| Codex の設定・認証 | `/home/node/.codex` | `<repository>-specdojo-codex` | `codex` provider |
|
|
1002
1050
|
| OpenCode の設定 | `/home/node/.config/opencode` | `<repository>-specdojo-opencode` | `opencode` provider |
|
|
@@ -1011,7 +1059,7 @@ OpenCode の API key は `/home/node/.local/share/opencode/auth.json` に入り
|
|
|
1011
1059
|
|
|
1012
1060
|
post-create は `~/.emacs`、`~/.emacs.el`、`~/.emacs.d/init.el`、`~/.config/emacs/init.el` のいずれも無い場合だけ、生成したテンプレートを配置します。`~/.emacs.d` ディレクトリがあれば `~/.emacs.d/init.el` へ、なければ `~/.config/emacs/init.el` へコピーし、配置先を出力します。dotfiles が設定を先に配置した場合は上書きしません。初回のコンテナ作成前に既定値を変える場合は `.devcontainer/emacs/init.el` を編集してください。作成後は出力されたコピー先を編集します。コピー先を削除しない限り、再度 post-create を実行してもテンプレートの変更は反映されません。
|
|
1013
1061
|
|
|
1014
|
-
|
|
1062
|
+
`recommended` / `full` preset は、`gh` とその認証を保存する名前付き volume、`--editor emacs,vim --tmux` 相当のツールに加え、Git Graph、markdownlint、YAML、Prettier、remark、Markdown All in One、Code Spell Checker、EditorConfig、Error Lens、Even Better TOML の VS Code 拡張を追加します。選択した provider が Claude Code、Codex、GitHub Copilot の場合は、その provider の拡張だけも追加します。Markdown と YAML は保存時に Prettier で整形し、`docs/specdojo/schemas/v1/` の主要な schema を SpecDojo の YAML へ関連付けます。同じ拡張は `.vscode/extensions.json` の `recommendations` にも入り、既存の recommendation は保持されます。個別の `--editor`・`--tmux` と一緒に指定した場合は両方を重複なく適用します。`minimal` または preset を指定しない場合は `gh` と認証 volume を追加しません。
|
|
1015
1063
|
|
|
1016
1064
|
Vim の雛形は `.devcontainer/vim/vimrc` に生成され、`~/.vimrc` と `~/.vim/vimrc` のどちらも無い場合だけ `~/.vimrc` へコピーされます。既存の Vim 設定は上書きしません。Emacs の雛形も上記と同じ上書き防止を維持します。
|
|
1017
1065
|
|
|
@@ -13,7 +13,7 @@ SpecDojo Configuration Reference
|
|
|
13
13
|
|
|
14
14
|
**対象範囲**
|
|
15
15
|
|
|
16
|
-
- `.specdojo/specdojo.config.json` のトップレベル、project、`run`、`repos` の設定キー
|
|
16
|
+
- `.specdojo/specdojo.config.json` のトップレベル、project、`run`、`repos`、`external_projects` の設定キー
|
|
17
17
|
|
|
18
18
|
**ここで引けるもの**
|
|
19
19
|
|
|
@@ -52,15 +52,41 @@ SpecDojo Configuration Reference
|
|
|
52
52
|
|
|
53
53
|
## 2. トップレベルのキー
|
|
54
54
|
|
|
55
|
-
| キー | 必須 | 既定値 | 役割・利用箇所
|
|
56
|
-
| -------------------- | ---- | -------------------------------------- |
|
|
57
|
-
| `version` | 必須 | なし。現行値は `1` | 設定形式のバージョンです。すべての config 利用コマンドが検証します。
|
|
58
|
-
| `current_project` | 任意 | コマンドにより `projects` の先頭を使用 | `--project` と `SPECDOJO_PROJECT` を省略したときの対象 project です。
|
|
59
|
-
| `agent_members_path` | 任意 | `.specdojo/agent-members.yaml` | 全 project が共有する保護済み agent 定義です。`.specdojo/` 配下の YAML だけを指定できます。
|
|
60
|
-
| `
|
|
55
|
+
| キー | 必須 | 既定値 | 役割・利用箇所 |
|
|
56
|
+
| -------------------- | ---- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
|
57
|
+
| `version` | 必須 | なし。現行値は `1` | 設定形式のバージョンです。すべての config 利用コマンドが検証します。 |
|
|
58
|
+
| `current_project` | 任意 | コマンドにより `projects` の先頭を使用 | `--project` と `SPECDOJO_PROJECT` を省略したときの対象 project です。 |
|
|
59
|
+
| `agent_members_path` | 任意 | `.specdojo/agent-members.yaml` | 全 project が共有する保護済み agent 定義です。`.specdojo/` 配下の YAML だけを指定できます。 |
|
|
60
|
+
| `kata_authority` | 任意 | リポジトリのディレクトリ名 | 利用者が新しく作る kata のリポジトリ単位の authority です。英小文字・数字・ハイフンで指定します。 |
|
|
61
|
+
| `projects` | 必須 | なし | project ID をキー、project 設定を値とするオブジェクトです。複数 project を1ファイルで扱えます。 |
|
|
62
|
+
| `external_projects` | 任意 | なし | 別リポジトリの project をローカルの別名で宣言します。`register add` と `orchestrator launch` が使用します。 |
|
|
61
63
|
|
|
62
64
|
対象 project の一般的な解決順序は、`--project <id>`、`SPECDOJO_PROJECT`、`current_project`、`projects` の先頭です。一部のコマンドは `current_project` を参照せず `projects` の先頭へフォールバックするため、複数 project では `--project` を明示してください。
|
|
63
65
|
|
|
66
|
+
`kata_authority` は project ごとではなくリポジトリ全体で共有します。省略時は元リポジトリのディレクトリ名を小文字・ハイフン形式へ正規化した値です。worktree でも元リポジトリの名前を使います。利用者の kata は `docs/ja/kata/` 配下に置かれ、この authority の ID だけを利用者リポジトリから解決します。値は英小文字から始め、英小文字・数字・ハイフンだけを使います。project ID と区別するため `prj-` で始めず、SpecDojo 本体専用の `specdojo` も使いません。
|
|
67
|
+
|
|
68
|
+
### 2.1. `external_projects`のキー
|
|
69
|
+
|
|
70
|
+
別リポジトリの登録簿へ起票する場合は、トップレベルの `external_projects` に、呼び出し元だけで使う別名をキーとして、相手のリポジトリと project ID を宣言します。
|
|
71
|
+
|
|
72
|
+
```json
|
|
73
|
+
{
|
|
74
|
+
"external_projects": {
|
|
75
|
+
"customer": {
|
|
76
|
+
"path": "../customer-specdojo",
|
|
77
|
+
"project_id": "prj-0002"
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
| キー | 必須 | 役割 |
|
|
84
|
+
| ------------ | ---- | -------------------------------------------------------------------------- |
|
|
85
|
+
| `path` | 必須 | このリポジトリのルートから相手のリポジトリへの相対パスです。 |
|
|
86
|
+
| `project_id` | 必須 | 相手の `specdojo.config.json` の `projects` にある実際の project ID です。 |
|
|
87
|
+
|
|
88
|
+
別名は `[a-z0-9-]+` とし、ローカルの `projects` の ID と重ねられません。`path` は存在するディレクトリでなければならず、絶対パスは使えません。起票時は相手の `node_modules/.bin/specdojo` を使うため、相手に SpecDojo 0.4.2 以上が必要です。`orchestrator launch` は `repos` に加えて、宣言したすべての外部リポジトリにも provider 別の編集許可を付けます。
|
|
89
|
+
|
|
64
90
|
## 3. projectのパスキー
|
|
65
91
|
|
|
66
92
|
`projects.<project-id>` に指定するキーです。`base_path` 以外の表中のパスは、`base_path` があればそこからの相対パス、無ければリポジトリルートからの相対パスとして解決します。
|
|
@@ -83,11 +109,14 @@ SpecDojo Configuration Reference
|
|
|
83
109
|
|
|
84
110
|
## 4. projectの非パスキー
|
|
85
111
|
|
|
86
|
-
| キー
|
|
87
|
-
|
|
|
88
|
-
| `
|
|
89
|
-
| `
|
|
90
|
-
| `
|
|
112
|
+
| キー | 既定値 | 役割・利用箇所 |
|
|
113
|
+
| -------------------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
114
|
+
| `integration_branch` | `project/<project-id>/develop` | 別 project の作業ツリーから `register add --project <project-id> --commit` で直接記帳する統合ブランチです。 |
|
|
115
|
+
| `project_context` | `["prj-overview"]` | edit / review plan へ常に渡す project 共通文書のローカル ID です。空配列 `[]` で無効化できます。`depends_on` や成果物の `based_on` は変更しません。 |
|
|
116
|
+
| `run` | `{}` | agent 実行、worktree、登録日の表示に関する project 単位の設定です。 |
|
|
117
|
+
| `repos` | なし | project のタスクが変更するプロダクトリポジトリの宣言です。詳細は「`repos`のキー」を参照してください。 |
|
|
118
|
+
|
|
119
|
+
project の `integration_branch` は、`repos[].integration_branch` とは別の設定です。前者は project リポジトリ内の登録簿へ直接記帳するブランチ、後者は exec が各プロダクトリポジトリへ変更を統合するブランチを表します。指定した project の統合ブランチはローカルに存在していなければなりません。
|
|
91
120
|
|
|
92
121
|
## 5. `run`のキー
|
|
93
122
|
|
|
@@ -9,13 +9,13 @@ specdojo:
|
|
|
9
9
|
|
|
10
10
|
Recipe Authoring Standard
|
|
11
11
|
|
|
12
|
-
`docs/ja/specdojo/recipes/` 配下の各 `*-recipe.md` が従うべき章立て・記述ルール・禁止事項・運用ルールを定義します。成果物の構造・必須項目・禁止事項は対応する rulebook を正本とし、本書は「良い内容を書くための作り方」の記述方法を定義します。
|
|
12
|
+
`docs/ja/specdojo/recipes/` と `docs/ja/kata/recipes/` 配下の各 `*-recipe.md` が従うべき章立て・記述ルール・禁止事項・運用ルールを定義します。成果物の構造・必須項目・禁止事項は対応する rulebook を正本とし、本書は「良い内容を書くための作り方」の記述方法を定義します。
|
|
13
13
|
|
|
14
14
|
## 1. 適用範囲
|
|
15
15
|
|
|
16
|
-
- 対象: `docs/ja/specdojo/recipes/` 配下のすべての `*-recipe.md`
|
|
16
|
+
- 対象: `docs/ja/specdojo/recipes/` と `docs/ja/kata/recipes/` 配下のすべての `*-recipe.md`
|
|
17
17
|
- 目的: recipe の章構成・記述品質を統一し、書き手が良い内容を再現可能に作成できるようにする
|
|
18
|
-
- 成果物構造の正本: 対応する `docs/ja/specdojo/rulebooks
|
|
18
|
+
- 成果物構造の正本: 対応する `docs/ja/specdojo/rulebooks/` または `docs/ja/kata/rulebooks/` 配下の rulebook
|
|
19
19
|
- Frontmatter 共通原則: [document-metadata-standard.md](document-metadata-standard.md)
|
|
20
20
|
- 成果物 Frontmatter の構築: template の `frontmatter_template` から構築する([document-metadata-standard.md](document-metadata-standard.md) の `生成物 Frontmatter 雛形`)。この手順を recipe 本文に複製しない。
|
|
21
21
|
- 参照スキーマ: [recipe-frontmatter.schema.yaml](../../../specdojo/schemas/v1/recipe-frontmatter.schema.yaml)
|
|
@@ -36,13 +36,13 @@ Recipe Authoring Standard
|
|
|
36
36
|
- `type` は `recipe` 固定とする。
|
|
37
37
|
- 対応する成果物の根拠を示すため、`rulebook` と `sample`(存在する場合)を記載する。
|
|
38
38
|
|
|
39
|
-
| 項目 | 必須 | 説明
|
|
40
|
-
| -------- | ---- |
|
|
41
|
-
| id | ○ | `specdojo:<prefix>-recipe` 形式の一意 ID |
|
|
42
|
-
| type | ○ | `recipe` 固定
|
|
43
|
-
| status | ○ | `draft` / `ready` / `deprecated`
|
|
44
|
-
| rulebook | ○ | 構造の正本となる rulebook の完全 ID
|
|
45
|
-
| sample | 任意 | 粒度・文体の参照となる sample の完全 ID
|
|
39
|
+
| 項目 | 必須 | 説明 |
|
|
40
|
+
| -------- | ---- | ------------------------------------------------------------------------------------------------ |
|
|
41
|
+
| id | ○ | 同梱は `specdojo:<prefix>-recipe`、利用者作成は `<kata_authority>:<prefix>-recipe` 形式の一意 ID |
|
|
42
|
+
| type | ○ | `recipe` 固定 |
|
|
43
|
+
| status | ○ | `draft` / `ready` / `deprecated` |
|
|
44
|
+
| rulebook | ○ | 構造の正本となる rulebook の完全 ID |
|
|
45
|
+
| sample | 任意 | 粒度・文体の参照となる sample の完全 ID |
|
|
46
46
|
|
|
47
47
|
## 4. 標準章構成(`*-recipe.md`)
|
|
48
48
|
|
|
@@ -9,11 +9,11 @@ specdojo:
|
|
|
9
9
|
|
|
10
10
|
Rulebook Authoring Standard
|
|
11
11
|
|
|
12
|
-
`docs/ja/specdojo/rulebooks/` 配下の各 `*-rulebook.md` が従うべき章立て・記述ルール・Frontmatter 規約・禁止事項・運用ルールを定義します。Frontmatter の共通原則は [document-metadata-standard.md](document-metadata-standard.md) に従い、機械検証は参照スキーマに従います。
|
|
12
|
+
`docs/ja/specdojo/rulebooks/` と `docs/ja/kata/rulebooks/` 配下の各 `*-rulebook.md` が従うべき章立て・記述ルール・Frontmatter 規約・禁止事項・運用ルールを定義します。Frontmatter の共通原則は [document-metadata-standard.md](document-metadata-standard.md) に従い、機械検証は参照スキーマに従います。
|
|
13
13
|
|
|
14
14
|
## 1. 適用範囲
|
|
15
15
|
|
|
16
|
-
- 対象: `docs/ja/specdojo/rulebooks/` 配下のすべての `*-rulebook.md`
|
|
16
|
+
- 対象: `docs/ja/specdojo/rulebooks/` と `docs/ja/kata/rulebooks/` 配下のすべての `*-rulebook.md`
|
|
17
17
|
- 目的: 章構成・見出しレベル・記述品質・Frontmatter を統一し、参照・保守を容易にする
|
|
18
18
|
- Frontmatter 共通原則: [document-metadata-standard.md](document-metadata-standard.md)
|
|
19
19
|
- 参照スキーマ: [rulebook-frontmatter.schema.yaml](../../../specdojo/schemas/v1/rulebook-frontmatter.schema.yaml)
|
|
@@ -35,17 +35,17 @@ Rulebook Authoring Standard
|
|
|
35
35
|
- `id` はauthority、英小文字・数字・ハイフンで構成し、一意にする(正確な制約は参照スキーマに従う)。
|
|
36
36
|
- `status` は `draft` / `ready` / `deprecated` のいずれかとする。
|
|
37
37
|
|
|
38
|
-
| 項目 | 必須 | 説明
|
|
39
|
-
| ------------- | ---- |
|
|
40
|
-
| id | ○ | `specdojo:<prefix>-rulebook` 形式の一意 ID
|
|
41
|
-
| type | ○ | `rulebook` 固定
|
|
42
|
-
| status | ○ | `draft` / `ready` / `deprecated`
|
|
43
|
-
| target_format | 任意 | 対象ドキュメントのフォーマット(`yaml` / `json` / `markdown`)
|
|
44
|
-
| recipe | 任意 | 対応する recipe の完全 ID、`undecided`、`not-needed`
|
|
45
|
-
| sample | 任意 | 対応する sample の完全 ID または ID 配列、上記2状態
|
|
46
|
-
| template | 任意 | 対応する template の完全 ID、`undecided`、`not-needed`
|
|
47
|
-
| based_on | 任意 | 上位規約や根拠ドキュメント
|
|
48
|
-
| supersedes | 任意 | 置き換え関係
|
|
38
|
+
| 項目 | 必須 | 説明 |
|
|
39
|
+
| ------------- | ---- | ---------------------------------------------------------------------------------------------------- |
|
|
40
|
+
| id | ○ | 同梱は `specdojo:<prefix>-rulebook`、利用者作成は `<kata_authority>:<prefix>-rulebook` 形式の一意 ID |
|
|
41
|
+
| type | ○ | `rulebook` 固定 |
|
|
42
|
+
| status | ○ | `draft` / `ready` / `deprecated` |
|
|
43
|
+
| target_format | 任意 | 対象ドキュメントのフォーマット(`yaml` / `json` / `markdown`) |
|
|
44
|
+
| recipe | 任意 | 対応する recipe の完全 ID、`undecided`、`not-needed` |
|
|
45
|
+
| sample | 任意 | 対応する sample の完全 ID または ID 配列、上記2状態 |
|
|
46
|
+
| template | 任意 | 対応する template の完全 ID、`undecided`、`not-needed` |
|
|
47
|
+
| based_on | 任意 | 上位規約や根拠ドキュメント |
|
|
48
|
+
| supersedes | 任意 | 置き換え関係 |
|
|
49
49
|
|
|
50
50
|
- `target_format` が未記載の場合は markdown を対象とみなす。
|
|
51
51
|
- `recipe` / `sample` / `template` は要否と所在の正本であり、`undecided` は要否未判断、項目省略は必要だが未整備、完全 ID は必要かつ整備済み、`not-needed` は不要を表す。
|
|
@@ -9,13 +9,13 @@ specdojo:
|
|
|
9
9
|
|
|
10
10
|
Sample Authoring Standard
|
|
11
11
|
|
|
12
|
-
`docs/ja/specdojo/samples/` 配下の各 `*-sample.(md|yaml|json)` が従うべき構成・記述ルール・禁止事項・運用ルールを定義します。Frontmatter(メタ情報)の規約は [document-metadata-standard.md](document-metadata-standard.md) を正本とし、本書では扱いません。
|
|
12
|
+
`docs/ja/specdojo/samples/` と `docs/ja/kata/samples/` 配下の各 `*-sample.(md|yaml|json)` が従うべき構成・記述ルール・禁止事項・運用ルールを定義します。Frontmatter(メタ情報)の規約は [document-metadata-standard.md](document-metadata-standard.md) を正本とし、本書では扱いません。
|
|
13
13
|
|
|
14
14
|
## 1. 適用範囲
|
|
15
15
|
|
|
16
|
-
- 対象: `docs/ja/specdojo/samples/` 配下のすべての `*-sample.(md|yaml|json)`
|
|
16
|
+
- 対象: `docs/ja/specdojo/samples/` と `docs/ja/kata/samples/` 配下のすべての `*-sample.(md|yaml|json)`
|
|
17
17
|
- 目的: sample の構成・記述品質を統一し、粒度・文体・表の書き方を確認できる完成最小例を提供する
|
|
18
|
-
- 一次根拠: 対応する `docs/ja/specdojo/rulebooks
|
|
18
|
+
- 一次根拠: 対応する `docs/ja/specdojo/rulebooks/` または `docs/ja/kata/rulebooks/` 配下の rulebook
|
|
19
19
|
- Frontmatter 規約の正本: [document-metadata-standard.md](document-metadata-standard.md)
|
|
20
20
|
- ファイル名・ID 規則: [docs-structure-guide.md](../guides/docs-structure-guide.md)
|
|
21
21
|
|
|
@@ -93,7 +93,7 @@ sample は実在プロジェクトの記録ではありません。記載値は
|
|
|
93
93
|
| 金森鉄子 | 60 | 女 | 店舗運営アドバイザー | 店舗運用、引継ぎ、障害時対応、継続運用の観点から助言する | `operations-advisor` | 金森金物店の店主。しっかり者で面倒見がよく、算野家を支援する |
|
|
94
94
|
| 春野さくら | 24 | 女 | 家族利用者代表 | 家族による店番や、子どもにも分かりやすい利用方法の観点を提供する | `family-user-representative` | 創太のいとこ。保育士で明るく優しい性格を持ち、子どもたちから親しまれている |
|
|
95
95
|
|
|
96
|
-
人物名はこの共通人物台帳と物語文書だけで管理し、`docs/ja/specdojo/samples/` 配下の sample には記載しません。各 sample では対象成果物に関係する人物だけを、次の識別方法で記述します。
|
|
96
|
+
人物名はこの共通人物台帳と物語文書だけで管理し、`docs/ja/specdojo/samples/` または `docs/ja/kata/samples/` 配下の sample には記載しません。各 sample では対象成果物に関係する人物だけを、次の識別方法で記述します。
|
|
97
97
|
|
|
98
98
|
- 本文、表の表示名、ステークホルダー名には「店主代表」「開発担当」「利用者代表」などの役割名を使用する。
|
|
99
99
|
- Member や実行主体の安定識別子が必要な項目には、表に定義した役割ベースの `nickname` を使用する。
|
|
@@ -9,14 +9,14 @@ specdojo:
|
|
|
9
9
|
|
|
10
10
|
Template Authoring Standard
|
|
11
11
|
|
|
12
|
-
`docs/ja/specdojo/templates/` 配下の成果物テンプレートが従うべき構成・プレースホルダ規約・禁止事項・運用ルールを定義します。プレースホルダを埋めた結果が満たすべき Frontmatter 規約は [document-metadata-standard.md](document-metadata-standard.md) を正本とし、本書では雛形側の記述方法を定義します。
|
|
12
|
+
`docs/ja/specdojo/templates/` と `docs/ja/kata/templates/` 配下の成果物テンプレートが従うべき構成・プレースホルダ規約・禁止事項・運用ルールを定義します。プレースホルダを埋めた結果が満たすべき Frontmatter 規約は [document-metadata-standard.md](document-metadata-standard.md) を正本とし、本書では雛形側の記述方法を定義します。
|
|
13
13
|
|
|
14
14
|
## 1. 適用範囲
|
|
15
15
|
|
|
16
|
-
- 対象: `docs/ja/specdojo/templates/` 配下のすべての成果物テンプレート `*-template.(md|yaml)`
|
|
16
|
+
- 対象: `docs/ja/specdojo/templates/` と `docs/ja/kata/templates/` 配下のすべての成果物テンプレート `*-template.(md|yaml)`
|
|
17
17
|
- 対象外: `docs/ja/specdojo/exec-templates/` 配下の plan / result 生成用内部テンプレート。rulebook から宣言される実践の型ではなく、生成処理が消費する実行基盤の部品として [plan/result ライフサイクルガイド](../guides/plan-result-lifecycle-guide.md) に従う
|
|
18
18
|
- 目的: テンプレートの構成・プレースホルダ記法を統一し、同じ rulebook 系統の成果物へ再利用できる雛形を提供する
|
|
19
|
-
- 成果物の意味要件の正本: 対応する `docs/ja/specdojo/rulebooks
|
|
19
|
+
- 成果物の意味要件の正本: 対応する `docs/ja/specdojo/rulebooks/` または `docs/ja/kata/rulebooks/` 配下の rulebook
|
|
20
20
|
- 見出し・キー・記入欄の骨組みの正本: rulebook frontmatter が文書 ID で宣言する template
|
|
21
21
|
- 完成後の Frontmatter 規約の正本: [document-metadata-standard.md](document-metadata-standard.md)
|
|
22
22
|
- ファイル名・ID 規則: [docs-structure-guide.md](../guides/docs-structure-guide.md)
|
|
@@ -26,7 +26,7 @@ Template Authoring Standard
|
|
|
26
26
|
- ファイル名は `<prefix>-template.md` / `<prefix>-template.yaml` とし、対応 rulebook の `target_format` に合わせる。
|
|
27
27
|
- Markdown テンプレートは、対応 rulebook の本文要件を満たす見出し構成を持つ。見出しの順序と記入欄は template を正本とし、rulebook 本文へ同じ骨組みを転載しない。
|
|
28
28
|
- YAML テンプレートは、対象成果物のルートキー・必須キー・型を雛形として示す。
|
|
29
|
-
- テンプレートファイル自身の Frontmatter も `specdojo:`
|
|
29
|
+
- テンプレートファイル自身の Frontmatter も `specdojo:` 名前空間配下に実値で記述する。`specdojo.id` は同梱なら `specdojo:<prefix>-template`、利用者作成なら `<kata_authority>:<prefix>-template` とし、`specdojo.type: template`、`specdojo.status: draft` を記述する。生成物の Frontmatter は自身 Frontmatter とは別に表現する。Markdown 成果物テンプレートは、[document-metadata-standard.md](document-metadata-standard.md) の `テンプレート自身のメタ情報と生成物 Frontmatter の分離` に従い、`specdojo:` 配下の `frontmatter_template` フィールドに `specdojo:` ラッパー込みの生成物 Frontmatter を記述する。
|
|
30
30
|
- YAML テンプレートも自身のメタ情報(`id` / `type` / `status` / `title` / `rulebook`)をトップレベルに実値で記述する。YAML catalog(`dct-*`)を除き、生成物のメタ情報はトップレベルの `metadata_template` フィールドに記述する([document-metadata-standard.md](document-metadata-standard.md) の `生成物メタ情報雛形(metadata_template)`)。
|
|
31
31
|
|
|
32
32
|
## 3. プレースホルダ規約
|
|
@@ -52,6 +52,10 @@ $defs:
|
|
|
52
52
|
"recipe-guided",
|
|
53
53
|
"freeform",
|
|
54
54
|
"bootstrap",
|
|
55
|
+
"rulebook-authoring",
|
|
56
|
+
"recipe-authoring",
|
|
57
|
+
"sample-authoring",
|
|
58
|
+
"template-authoring",
|
|
55
59
|
"retrofit",
|
|
56
60
|
"cross-deliverable-dedup",
|
|
57
61
|
"rulebook-maintenance",
|
|
@@ -67,6 +71,8 @@ $defs:
|
|
|
67
71
|
a deliverable. bootstrap authors the deliverable and its full reference set
|
|
68
72
|
(rulebook/recipe/sample/template) together in one task as a mutually consistent whole;
|
|
69
73
|
it is used to initially establish a deliverable and its reference materials.
|
|
74
|
+
The *-authoring values create one new kata from optional read-only exemplar deliverables;
|
|
75
|
+
they are register-only because their ordered target contract is not available to schedule.
|
|
70
76
|
retrofit reads implementation evidence declared by the catalog and reflects the verified
|
|
71
77
|
current behavior into an existing or newly created deliverable without treating the
|
|
72
78
|
implementation as the unconditional source of intended behavior.
|