specdojo 0.6.0 → 0.7.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/CHANGELOG.md +40 -0
- package/README.md +2 -2
- package/dist/commands/agent.js +33 -0
- package/dist/commands/init.js +1 -0
- package/dist/commands/orchestrator.js +10 -1
- package/dist/devcontainer/command.js +18 -0
- package/dist/devcontainer/host-script.js +21 -0
- package/dist/devcontainer/scaffold.js +4 -3
- package/dist/exec/antigravity-session.js +154 -0
- package/dist/exec/parent-validation.js +7 -0
- package/dist/exec/plan-markdownlint.js +89 -0
- package/dist/exec/plans-generation.js +6 -2
- package/dist/exec/register-resume.js +28 -0
- package/dist/exec/run/lifecycle-commands.js +85 -16
- package/dist/exec/run/register-command.js +6 -0
- package/dist/exec/run/schedule-mode.js +22 -2
- package/dist/exec/run/schedule-prepare.js +42 -1
- package/dist/exec/run/schedule-task.js +3 -0
- package/dist/exec/worktree-ops-commit.js +1 -13
- package/dist/exec/worktree-ops-lifecycle.js +40 -36
- package/dist/register/register.js +31 -23
- package/dist/shared/git.js +7 -0
- package/dist/shared/provider-scaffold.js +2 -0
- package/dist/shared/specdojo-gitignore.js +1 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +2 -0
- package/docs/ja/specdojo/guides/docs-editing-guide.md +36 -0
- package/docs/ja/specdojo/guides/exec-config-guide.md +14 -12
- package/docs/ja/specdojo/guides/exec-operation-guide.md +20 -8
- package/docs/ja/specdojo/guides/orchestrator-operation-guide.md +4 -2
- package/docs/ja/specdojo/guides/quick-start-guide.md +597 -871
- package/docs/ja/specdojo/guides/register-operation-guide.md +2 -0
- package/docs/ja/specdojo/guides/remote-host-development-guide.md +31 -4
- package/docs/ja/specdojo/guides/schedule-operation-guide.md +14 -0
- package/docs/ja/specdojo/guides/use-case-guide.md +537 -77
- package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +88 -86
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +96 -122
- package/docs/ja/specdojo/references/command-reference.md +69 -37
- package/docs/ja/specdojo/rulebooks/cdfd-d2-rulebook.md +367 -0
- package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +6 -5
- package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +96 -100
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +38 -47
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +108 -103
- package/docs/ja/specdojo/samples/cdfd-overview-sample.md +248 -140
- package/docs/ja/specdojo/samples/cdfd-uc-sample.md +128 -97
- package/docs/ja/specdojo/templates/cdfd-overview-template.md +161 -83
- package/docs/ja/specdojo/templates/cdfd-uc-template.md +127 -90
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +1 -0
- package/docs/specdojo/schemas/v1/specdojo-config.schema.yaml +1 -0
- package/package.json +5 -2
- package/templates/antigravity/README.md +19 -46
- package/templates/antigravity/exec-defaults-snippet.yaml +5 -6
- package/templates/antigravity/settings.edit.json +73 -0
- package/templates/antigravity/settings.orchestrator.json +15 -0
- package/templates/antigravity/settings.report.json +7 -0
- package/templates/antigravity/settings.review.json +7 -0
- package/templates/devcontainer/remote-host/devcontainer-tmux.sh +217 -0
- package/templates/devcontainer/remote-host/specdojo-tmux.sh.sample +8 -96
- package/templates/devcontainer/remote-host/ssh-config.sample +3 -1
- package/templates/init-agent-members.yaml +1 -0
- package/templates/init-exec-defaults.yaml +1 -1
|
@@ -11,49 +11,43 @@ specdojo:
|
|
|
11
11
|
|
|
12
12
|
Conceptual Data Flow Diagram Use Case Writing Recipe
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
全体概要で選定した一つのユースケースまたは系統について、開始から終了までの流れと、受け渡す情報・物を具体化するための作成手順です。参加単位と詳細化の境界は rulebook の「描き方の選択」に従います。
|
|
15
15
|
|
|
16
16
|
## 1. このレシピの使い方
|
|
17
17
|
|
|
18
|
-
-
|
|
19
|
-
-
|
|
20
|
-
-
|
|
21
|
-
- その後、隣接するグループ間ごとに渡す情報、受け側を開始できる条件、受け取れない場合の戻す条件を具体化し、条件不成立時の戻り先と再開条件を表へ整理します。
|
|
22
|
-
- 最後に、全体概要との名称整合、全引き渡しの追跡、グループ内部と状態遷移の非重複をレビューします。
|
|
18
|
+
- 全体概要からケース ID、業務目的、参加単位、開始・終了を抜き出します。
|
|
19
|
+
- 目的、適用範囲、役割表、データストアの部分集合を作り、上から下へ進む図で受け渡しを示します。
|
|
20
|
+
- 最後に表と図の名称・順序、全体概要との境界、有効な参照先を確認します。業務上重要な戻りだけ、任意の図を追加します。
|
|
23
21
|
|
|
24
|
-
|
|
22
|
+
ケース ID、参加単位の名称・領域 ID、データストア名を軸に、範囲・表・図を対応させます。引き渡し ID を追加せず、情報・物の名前を線のラベルにします。
|
|
25
23
|
|
|
26
24
|
## 2. 作成前に集める情報
|
|
27
25
|
|
|
28
|
-
| 項目
|
|
29
|
-
|
|
|
30
|
-
| 対象ケース
|
|
31
|
-
|
|
|
32
|
-
|
|
|
33
|
-
|
|
|
34
|
-
|
|
|
35
|
-
|
|
|
36
|
-
|
|
|
37
|
-
|
|
|
38
|
-
|
|
|
39
|
-
|
|
|
40
|
-
| 状態の参照先 | 状態一覧と状態遷移図を統合した STSD。内容は転記せず参照先だけ控える |
|
|
41
|
-
| 未決事項 | 横断境界、条件、戻り先、判断者が未確定な論点と、影響、決定者、決定時期 |
|
|
26
|
+
| 項目 | 集める情報 |
|
|
27
|
+
| ------------ | ---------------------------------------------------------------------------- |
|
|
28
|
+
| 対象ケース | 全体概要にあるケース ID、業務名、業務目的 |
|
|
29
|
+
| 描く単位 | rulebook の「描き方の選択」で決める参加単位と詳細化の境界 |
|
|
30
|
+
| 開始と終了 | 開始する出来事と、最後に利用可能になる成果 |
|
|
31
|
+
| 役割と順序 | 全体概要と同じグループ・区分、領域 ID、正常系の通過順、各参加単位の責務 |
|
|
32
|
+
| 受け渡し | 隣接する参加単位やデータストアの間で渡す情報・物 |
|
|
33
|
+
| データストア | 全体概要にある名称、マスタ・構成/トランザクションの区分、参照・更新する内容 |
|
|
34
|
+
| 共通の約束 | 全体概要の責任分担、凡例、Orchestrator の指示の図 |
|
|
35
|
+
| 参照先 | 有効な全体概要、必要な詳細文書と STSD。status が `deprecated` の文書は除く |
|
|
36
|
+
| 重要な戻り | 補完・再判断を担う参加単位、返す不足情報や差異。業務上重要な場合だけ集める |
|
|
37
|
+
| 未決事項 | 境界、名称、責務、判断者が未確定な論点、影響、決定者、決定時期 |
|
|
42
38
|
|
|
43
39
|
## 3. 全体の作成手順
|
|
44
40
|
|
|
45
|
-
1.
|
|
46
|
-
2.
|
|
47
|
-
3.
|
|
48
|
-
4.
|
|
49
|
-
5.
|
|
50
|
-
6.
|
|
51
|
-
7.
|
|
52
|
-
8.
|
|
53
|
-
9.
|
|
54
|
-
10.
|
|
55
|
-
11. 内部プロセス名、内部例外、状態名・遷移、実装項目を探し、対応する `cdfd-<group>` と STSD の参照へ置き換えます。
|
|
56
|
-
12. ケース ID と引き渡し ID を使って、範囲、プロセス領域、データストア、図、引き渡し表、戻り先表の重複・欠落を解消します。
|
|
41
|
+
1. 全体概要の「詳細 CDFD 一覧」からケースを選び、rulebook の「描き方の選択」で参加単位を決めます。
|
|
42
|
+
2. その業務が何のためにあるかを、開始からどの成果までを成立させるかという 1〜2 文で書きます。読み手の承認・設計・確認作業は含めません。
|
|
43
|
+
3. 対象と対象外を 1 行ずつ書き、共通原則は全体概要を参照します。`based_on` と本文の参照先が有効な文書であることを確認します。
|
|
44
|
+
4. 全体概要と同じグループ・区分ごとに節を設け、正常系の順序と責務を役割表だけで示します。PDCA が必要なら独立した任意の列を追加します。
|
|
45
|
+
5. 全体概要から、このケースで参照・更新するデータストアを同じ名称・区分で切り出し、関連する参加単位と利用内容を書きます。
|
|
46
|
+
6. 開始イベント、参加単位、終了の出来事を上から下へ並べ、渡す情報・物の名前を線のラベルにします。D2 は `direction: down` とし、引き渡し条件のイベントや Orchestrator は置きません。
|
|
47
|
+
7. データストアを同名ノードで加え、表の各行と図を対応させます。イベントは一ノード一出来事の短い文とし、長ければ原文を保って改行します。
|
|
48
|
+
8. 図に業務の言葉で題を付け、読み取れることを 1 文で説明します。凡例は全体概要への短い参照にします。
|
|
49
|
+
9. 業務上重要な戻りがある場合だけ、「概念データフロー」に「例外時の戻り」の図を追加し、返す情報を線にします。戻りの線は上側のノードを左辺にした `a <- b` で書きます。
|
|
50
|
+
10. ケース ID、名称、領域 ID で範囲・表・図を突き合わせ、内部処理や状態定義・遷移の重複を除きます。
|
|
57
51
|
|
|
58
52
|
## 4. 各章の書き方
|
|
59
53
|
|
|
@@ -61,138 +55,118 @@ Conceptual Data Flow Diagram Use Case Writing Recipe
|
|
|
61
55
|
|
|
62
56
|
問い:
|
|
63
57
|
|
|
64
|
-
-
|
|
65
|
-
-
|
|
66
|
-
- 誰がグループ間の重複・欠落と戻り経路を確認しますか。
|
|
58
|
+
- そのユースケースまたは系統は何のためにありますか。
|
|
59
|
+
- どの出来事から、どの成果または判断までを成立させますか。
|
|
67
60
|
|
|
68
|
-
|
|
61
|
+
「欠品した商品を補充し、売場で販売できるようにする」のように業務の目的を 1〜2 文で書きます。BA・QE・承認者などの読み手の役割は書きません。
|
|
69
62
|
|
|
70
63
|
### 4.2. 適用範囲
|
|
71
64
|
|
|
72
65
|
問い:
|
|
73
66
|
|
|
74
|
-
- ケース ID
|
|
75
|
-
-
|
|
76
|
-
-
|
|
77
|
-
-
|
|
78
|
-
- 承認と最終判断を担う人間のロールを参照できますか。
|
|
67
|
+
- ケース ID、参加単位、開始・終了は全体概要と一致していますか。
|
|
68
|
+
- 対象と対象外がそれぞれ 1 行で分かりますか。
|
|
69
|
+
- 共通原則と調整役の指示を全体概要に委ねていますか。
|
|
70
|
+
- 本文と `based_on` に `deprecated` の文書が残っていませんか。
|
|
79
71
|
|
|
80
|
-
|
|
72
|
+
全体概要の選定を変える必要があれば先に全体概要を見直します。未作成の参照先は ID をインラインコードで仮置きします。
|
|
81
73
|
|
|
82
74
|
### 4.3. プロセス領域
|
|
83
75
|
|
|
84
76
|
問い:
|
|
85
77
|
|
|
86
|
-
-
|
|
87
|
-
-
|
|
88
|
-
-
|
|
89
|
-
-
|
|
90
|
-
- 各グループの内部を確認できる `cdfd-<group>` を一意に示せますか。
|
|
78
|
+
- rulebook の「描き方の選択」に従い、全体概要と同じまとまりの節にしていますか。
|
|
79
|
+
- 各節は役割表だけですか。主要入力・主要出力・データストアの箇条書きが残っていませんか。
|
|
80
|
+
- 順序、プロセスグループ・区分、含む領域、横断上の役割、参照先を示していますか。
|
|
81
|
+
- PDCA を示す場合は独立した任意の列にし、全体概要の区分と混同していませんか。
|
|
91
82
|
|
|
92
|
-
|
|
83
|
+
表の一行を図の一つのプロセスノードに対応させます。全体概要を名称と領域の正本とし、入力・出力の正本は図にします。
|
|
93
84
|
|
|
94
85
|
### 4.4. データストア
|
|
95
86
|
|
|
96
87
|
問い:
|
|
97
88
|
|
|
98
|
-
-
|
|
99
|
-
-
|
|
100
|
-
-
|
|
101
|
-
-
|
|
89
|
+
- 対象ケースで参照・更新する正本だけですか。
|
|
90
|
+
- 名称と区分は全体概要と一致していますか。
|
|
91
|
+
- 関連する参加単位を名称・領域 ID で示し、利用内容を説明していますか。
|
|
92
|
+
- 表の各行と図の同名ノードが対応していますか。
|
|
102
93
|
|
|
103
|
-
|
|
94
|
+
マスタ・構成データとトランザクションデータに分け、該当する行がない区分は節ごと省略します。
|
|
104
95
|
|
|
105
96
|
### 4.5. 概念データフロー
|
|
106
97
|
|
|
107
98
|
問い:
|
|
108
99
|
|
|
109
|
-
-
|
|
110
|
-
-
|
|
111
|
-
-
|
|
112
|
-
-
|
|
113
|
-
-
|
|
100
|
+
- 正常系の参加単位を開始から終了まで上から下へ追えますか。
|
|
101
|
+
- 一つのイベントに一つの出来事だけを書き、短い文または改行で読めますか。入口の文言は選んだ方式の規定に合っていますか。
|
|
102
|
+
- 渡す情報・物を線の名詞ラベルから読み取れますか。条件のイベントや引き渡し ID が残っていませんか。
|
|
103
|
+
- Orchestrator と調整要求・応答を図から外していますか。
|
|
104
|
+
- 図の題は業務の言葉ですか。説明は読み取れることの 1 文ですか。
|
|
114
105
|
|
|
115
|
-
|
|
106
|
+
D2 は `direction: down` とします。必要な承認は「承認済みの補充依頼」など成果の性質として線に表し、条件の判定ノードは置きません。凡例は全体概要を参照します。
|
|
116
107
|
|
|
117
|
-
### 4.6.
|
|
108
|
+
### 4.6. 例外時の戻りの図(任意)
|
|
118
109
|
|
|
119
110
|
問い:
|
|
120
111
|
|
|
121
|
-
-
|
|
122
|
-
-
|
|
123
|
-
-
|
|
124
|
-
- 条件を満たさないとき、何をどのグループへ戻すか分かりますか。
|
|
112
|
+
- 先行する参加単位へ情報や判断を戻すことが、業務として重要ですか。
|
|
113
|
+
- 戻す不足情報・差異と、補完・再判断を担う参加単位が線から分かりますか。
|
|
114
|
+
- 再提示も「修正・承認済みの補充依頼」などの情報として描いていますか。
|
|
125
115
|
|
|
126
|
-
|
|
116
|
+
必要な場合だけ「概念データフロー」の節に追加し、通常の図と名称・領域 ID をそろえます。「引き渡し」「例外時の戻り先」の章や、戻す条件・再開条件の表は作りません。
|
|
127
117
|
|
|
128
|
-
### 4.7.
|
|
129
|
-
|
|
130
|
-
問い:
|
|
131
|
-
|
|
132
|
-
- 各引き渡しの戻す条件を、戻り先表の条件不成立へ対応させましたか。
|
|
133
|
-
- 不足を補完または再判断できるグループが戻り先になっていますか。
|
|
134
|
-
- 戻す情報から、不足・不一致・判断待ちの内容が分かりますか。
|
|
135
|
-
- 再開条件は同じ引き渡しを再評価できる形になっていますか。
|
|
136
|
-
|
|
137
|
-
戻り先は内部プロセスではなくグループまでに留めます。受け側内部の再試行やログは扱わず、先行グループへ情報・判断を戻すことで横断順序が変わる場合だけを記載します。
|
|
138
|
-
|
|
139
|
-
### 4.8. 未決事項(任意)
|
|
118
|
+
### 4.7. 未決事項(任意)
|
|
140
119
|
|
|
141
120
|
- 調査で確定できる不足情報は _TODO_:、意思決定待ちは _UNDECIDED_:、仮置きする前提は _ASSUMPTION_: とします。
|
|
142
|
-
-
|
|
143
|
-
-
|
|
121
|
+
- 未決論点には影響するケース・参加単位、決定者、決定時期を添えます。
|
|
122
|
+
- ない場合は章を省略し、空表や「なし」だけの章を残しません。
|
|
144
123
|
|
|
145
124
|
## 5. 深掘り手順
|
|
146
125
|
|
|
147
|
-
1.
|
|
148
|
-
2.
|
|
149
|
-
3.
|
|
150
|
-
4.
|
|
151
|
-
5.
|
|
152
|
-
6.
|
|
153
|
-
7.
|
|
154
|
-
8. データストアを一つずつ外しても引き渡し条件を説明できるか試し、不要なものを図から削除します。
|
|
126
|
+
1. 最後の成果から逆にたどり、各参加単位と受け渡しが業務目的に必要か確認します。
|
|
127
|
+
2. 開始イベントから順にたどり、前段の成果が次段へ情報・物として渡っているか確認します。
|
|
128
|
+
3. 全体概要の区分と領域 ID を突き合わせ、PDCA の値で区分を置き換えた行を直します。
|
|
129
|
+
4. データストアを一つずつ確かめ、このケースの情報・物の受け渡しに不要なものを除きます。
|
|
130
|
+
5. 状態定義・遷移や内部プロセスが残っていれば、責任を持つ有効な文書の参照へ移します。
|
|
131
|
+
6. 戻りの図がある場合だけ、不足情報や差異が補完責任のある参加単位へ届くか確認します。
|
|
132
|
+
7. D2 を `d2 --layout elk` で SVG に出力し、上下の順序、ノードとラベルの大きさを確認します。読みづらい場合はイベントの改行や図の分割を見直します。
|
|
155
133
|
|
|
156
134
|
## 6. 良い例 / 悪い例
|
|
157
135
|
|
|
158
|
-
| 観点
|
|
159
|
-
|
|
|
160
|
-
|
|
|
161
|
-
|
|
|
162
|
-
|
|
|
163
|
-
|
|
|
164
|
-
|
|
|
165
|
-
|
|
|
166
|
-
|
|
|
167
|
-
| 状態責務
|
|
168
|
-
| グループ内例外 | 発注不可の結果を在庫へ戻す条件だけを扱う | 仕入先選定、再発注、返品処理の手順を横断図へ展開する |
|
|
136
|
+
| 観点 | 良い例 | 悪い例 |
|
|
137
|
+
| ----------- | ------------------------------------------------ | -------------------------------------------------- |
|
|
138
|
+
| 目的 | 欠品した商品を補充し、売場で販売できるようにする | BA が承認し、QE が検証へ使う |
|
|
139
|
+
| 区分と PDCA | 区分は実行サイクル、PDCA は別列で Do | 区分を Do に置き換える |
|
|
140
|
+
| 渡す情報 | 在庫から仕入へ「承認済みの補充依頼」を直接つなぐ | 途中に「H-01 受理できる」というイベントを置く |
|
|
141
|
+
| イベント | 「在庫が補充基準を下回った」を必要なら改行 | 複数の出来事を一つの長い六角形に詰める |
|
|
142
|
+
| 戻り | 仕入から在庫へ「不足項目・商品候補」を返す線 | すべての受け渡しについて戻り先表を必須にする |
|
|
143
|
+
| 参照先 | 有効な全体概要を参照する | `deprecated` のグループ別 CDFD を参照する |
|
|
144
|
+
| 調整役 | Orchestrator の指示は全体概要の図に任せる | 詳細の図に Orchestrator と各段階への要求を再掲する |
|
|
145
|
+
| 状態責務 | 商品状態は STSD を参照する | 未発注から販売可能への状態遷移を本書で定義する |
|
|
169
146
|
|
|
170
147
|
## 7. レビュー観点
|
|
171
148
|
|
|
172
|
-
| 観点
|
|
173
|
-
|
|
|
174
|
-
| 業務価値
|
|
175
|
-
|
|
|
176
|
-
|
|
|
177
|
-
|
|
|
178
|
-
|
|
|
179
|
-
|
|
|
180
|
-
| 状態責務 | 状態定義・遷移を複製せず、必要な STSD へ接続している | 技術メンター |
|
|
181
|
-
| 例外時の再開 | 条件不成立から戻り先、戻す情報、再開条件、再評価する引き渡しまでたどれる | 品質確認担当、店主代表 |
|
|
149
|
+
| 観点 | 確認内容 | 主な確認者 |
|
|
150
|
+
| ---------- | ---------------------------------------------------------- | -------------------------- |
|
|
151
|
+
| 業務価値 | 目的が業務の存在理由・成果を示し、終了時の成果と一致する | 業務分析担当、業務責任者 |
|
|
152
|
+
| 範囲と粒度 | rulebook の「描き方の選択」と全体概要に合う | 業務分析担当 |
|
|
153
|
+
| 表と図 | 順序・名称・領域 ID が対応し、受け渡しを線から読み取れる | 品質確認担当 |
|
|
154
|
+
| データ整合 | データストアの名称・区分と凡例が全体概要に合う | 技術メンター、品質確認担当 |
|
|
155
|
+
| 戻り | 図が必要な場合だけあり、戻す情報と責任が分かる | 業務責任者、品質確認担当 |
|
|
156
|
+
| 正本の境界 | 調整・状態遷移・内部処理を重複させず、有効な文書を参照する | アーキテクト |
|
|
182
157
|
|
|
183
|
-
|
|
158
|
+
確認者の呼称は、対象プロジェクトのロール定義または責任分担文書で正式な担当へ対応付けます。
|
|
184
159
|
|
|
185
160
|
## 8. 仕上げチェック
|
|
186
161
|
|
|
187
|
-
-
|
|
188
|
-
-
|
|
189
|
-
-
|
|
190
|
-
-
|
|
191
|
-
-
|
|
192
|
-
-
|
|
193
|
-
-
|
|
194
|
-
-
|
|
195
|
-
-
|
|
196
|
-
-
|
|
197
|
-
-
|
|
198
|
-
- 個人情報、秘密情報、非公開の組織情報など、公開範囲に不適切な内容を含めていない。
|
|
162
|
+
- 全体概要のケース ID、業務名、目的、名称・領域 ID を引き継いだ。
|
|
163
|
+
- 目的は業務のための 1〜2 文、適用範囲は対象と対象外が 1 行ずつになっている。
|
|
164
|
+
- 各節が役割表だけで、区分と任意の PDCA 列を分けた。
|
|
165
|
+
- 表と図の参加単位、データストアが対応し、開始から終了まで縦に追える。
|
|
166
|
+
- イベントは一ノード一出来事で短く、入口の原文を保っている。
|
|
167
|
+
- 受け渡しは線のラベルにあり、引き渡し ID・条件イベント・旧来の引き渡し/戻り先の章がない。
|
|
168
|
+
- Orchestrator を詳細の図に置かず、全体概要の指示の図へ委ねた。
|
|
169
|
+
- 図の題は業務の言葉、説明は読み取れることの 1 文で、凡例は全体概要を参照している。
|
|
170
|
+
- 戻りの図は業務上重要な場合だけ追加し、条件表や内部の再試行手順を置いていない。
|
|
171
|
+
- `based_on` と本文に `deprecated` の参照先がなく、状態定義・遷移を複製していない。
|
|
172
|
+
- 未決事項がない場合は章を省略し、公開範囲に不適切な情報を含めていない。
|
|
@@ -115,7 +115,9 @@ exec の result の commit 前検査は markdownlint-cli が読む利用リポ
|
|
|
115
115
|
`.markdownlintrc` を含む)を優先し、設定がなければ上記の6規則だけをコマンド引数で無効にします。
|
|
116
116
|
フォールバック用ファイルは利用リポジトリに作りません。CLI2 専用設定はこの検査では読みません。
|
|
117
117
|
|
|
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` を付けても上書きしません。
|
|
118
|
+
`package.json` がある場合、provider ごとのオーケストレーター起動スクリプトも追加します。Claude Code は `orch:opus`・`orch:sonnet`、Codex は `orch:sol`(`gpt-6.1-sol`)・`orch:luna`(`gpt-6-luna`)、Antigravity は `orch:argon`(`gemini-4-argon-medium`)・`orch:flash`(`gemini-3.8-flash-high`)、OpenCode は `orch:opencode` です。既存のスクリプトは `--force` を付けても上書きしません。
|
|
119
|
+
|
|
120
|
+
agy 1.4.12 以降向けの通常導入は edit / review / report / orchestrator のセッション別プロファイルを配置し、ユーザー設定を書き換えません。非対話用 command template は `specdojo agent launch --provider antigravity --role {mode} -- --sandbox --model {model} -p "$(cat)"`、対話型は `specdojo orchestrator launch --provider antigravity -- <agy 引数>` を使います。各入口が宣言済みルートの保護ルールを一つの `--settings` JSON として渡します。`agent launch` は runner の `SPECDOJO_REPO_*` に示された task worktree と cwd だけを追加し、任意の `--add-dir` や別 `--settings`、bypass、既存会話の再開を拒否します。review / report は全書き込み・command・MCP を拒否します。詳しい移行と実機確認は [[sysd-antigravity-agent-settings|Antigravity CLI エージェント設定]] を参照してください。
|
|
119
121
|
|
|
120
122
|
`antigravity` に限り `--global` を指定すると、`~/.gemini/antigravity-cli/settings.json` へ SpecDojo 用の permission rule を追記します。既存キー・既存 rule は保持し、実書き込み前に timestamp 付きバックアップを作ります。`--global` を省略した通常実行はユーザーディレクトリへ触れません。適用前は次の dry-run で追加 rule を確認してください。
|
|
121
123
|
|
|
@@ -645,6 +647,8 @@ kata authoring は register 専用です。Schedule の task は対象成果物
|
|
|
645
647
|
| `exec plan` | plan だけを生成する | `specdojo exec plan --project prj-0001 --task <task-id>` |
|
|
646
648
|
| `exec archive` | 完了済み plan を `done/` へ移動する | `specdojo exec archive --project prj-0001 --task <task-id>` |
|
|
647
649
|
|
|
650
|
+
schedule の `exec resume --task <task-id> --resume-from executor` は、executor が `succeeded` で reporter が未完了の pipeline を、既存 worktree・変更・同じ run を引き継いで executor → reporter → 統合の順に再実行します。対象状態は reporter 段の `blocked` または中断した `doing` で、executor の試行回数を増やし、`blocked` からの状態遷移は `unblock` イベントへ記録します。統合段、executor 未成功、pipeline 以外、`executor` 以外の値は拒否します。`--task` は必須で、`--due` とは併用できません。worktree の `<execution_path>/exec/plans/<task-id>-plan.md` を編集してから再開すると、その plan を使います。変更理由と再開の経緯を報告の `handoff` へ記載するよう plan に指示し、再開後の result の申し送りを確認してください。手順は [[specdojo:exec-operation-guide|exec運用ガイド]] の「blockedタスクの復帰」を参照してください。
|
|
651
|
+
|
|
648
652
|
`exec scaffold --project <project-id>` は、対象 project の `viewpoints_path` へ `extends: specdojo:pm-review-viewpoints` を持つ空の差分ファイルを生成します。共通正本は [[specdojo:pm-review-viewpoints|共通レビュー観点一覧]] であり、scaffold 時点の全量コピーは作りません。そのため、共通側の更新は次回の review plan 生成時に継承 project へ反映されます。既存ファイルは既定で保持し、`--force` の指定時だけ差分雛形で置き換えます。
|
|
649
653
|
|
|
650
654
|
プロジェクト差分の upsert、無効化、独自ロールの宣言規則は [[specdojo:review-guide|レビューガイド]] を参照してください。provider 設定の推奨入口は `config scaffold --provider <name>` です。従来の `exec scaffold --provider <name>` も互換入口として同じ設定一式を生成します。
|
|
@@ -658,35 +662,36 @@ kata authoring は register 専用です。Schedule の task は対象成果物
|
|
|
658
662
|
|
|
659
663
|
主要オプション:
|
|
660
664
|
|
|
661
|
-
| オプション | 用途 | 対象
|
|
662
|
-
| -------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
663
|
-
| `--task <task-id>` | 対象タスクを指定する | 状態遷移系 / `run` / `plan`
|
|
664
|
-
| `--by <actor>` | 実行 actor / agent の nickname を指定する(手動ターゲットの agent 選択も兼ねる) | 状態遷移系 / `run` / `resume` / `worktree agent`
|
|
665
|
-
| `--edit-by <nickname>` | `--auto` バッチで edit タスクに使う agent nickname | `run --auto` / `resume`
|
|
666
|
-
| `--review-by <nickname>` | `--auto` の review タスク、または register の統合後 review に使う agent nickname | `run --auto` / `run --register --post-review` / `resume`
|
|
667
|
-
| `--strategy <name>` | 選択戦略を切り替える(`critical-first` 既定 / `fifo`) | `scheduler` / `run --auto`
|
|
668
|
-
| `--auto` / `--loop` | Ready タスクを自動選択する / Ready がなくなるまで繰り返す | `run`
|
|
669
|
-
| `--
|
|
670
|
-
| `--
|
|
671
|
-
| `--
|
|
672
|
-
| `--
|
|
673
|
-
| `--
|
|
674
|
-
| `--register-
|
|
675
|
-
| `--register-
|
|
676
|
-
| `--
|
|
677
|
-
| `--
|
|
678
|
-
| `--
|
|
679
|
-
| `--
|
|
680
|
-
| `--
|
|
681
|
-
| `--resume
|
|
682
|
-
| `--
|
|
683
|
-
| `--
|
|
684
|
-
| `--
|
|
685
|
-
| `--
|
|
686
|
-
| `--
|
|
687
|
-
| `--
|
|
688
|
-
| `--fallback-
|
|
689
|
-
| `--
|
|
665
|
+
| オプション | 用途 | 対象 |
|
|
666
|
+
| -------------------------------------- | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
|
667
|
+
| `--task <task-id>` | 対象タスクを指定する | 状態遷移系 / `run` / `plan` |
|
|
668
|
+
| `--by <actor>` | 実行 actor / agent の nickname を指定する(手動ターゲットの agent 選択も兼ねる) | 状態遷移系 / `run` / `resume` / `worktree agent` |
|
|
669
|
+
| `--edit-by <nickname>` | `--auto` バッチで edit タスクに使う agent nickname | `run --auto` / `resume` |
|
|
670
|
+
| `--review-by <nickname>` | `--auto` の review タスク、または register の統合後 review に使う agent nickname | `run --auto` / `run --register --post-review` / `resume` |
|
|
671
|
+
| `--strategy <name>` | 選択戦略を切り替える(`critical-first` 既定 / `fifo`) | `scheduler` / `run --auto` |
|
|
672
|
+
| `--auto` / `--loop` | Ready タスクを自動選択する / Ready がなくなるまで繰り返す | `run` |
|
|
673
|
+
| `--track <track>` | `--auto` の選択を 1 つの track に限定する。存在しない track は claim 前にエラー。省略時は全 track が対象 | `run --auto`(`--parallel` / `--loop` / `--dry-run` と併用可能) |
|
|
674
|
+
| `--parallel <n>` | 同時に走らせる agent 数の上限を指定する | `run --auto` / register の worktree モード |
|
|
675
|
+
| `--worktree` | worktree に隔離して実行する | `run --task` / `run --register` |
|
|
676
|
+
| `--in-place` | register 項目を現在の作業ツリーで実行する(`run.register_execution` を上書き) | `run --register` |
|
|
677
|
+
| `--track-state` | claim / complete の状態イベントを記録する | `run --task` |
|
|
678
|
+
| `--register <PJR-ID>` | 登録簿の項目を実行する(空白・カンマ区切りで複数可。場所の既定は `run.register_execution`) | `run` / `plan` |
|
|
679
|
+
| `--register-filter` | 登録簿項目を type / priority / status / limit の条件で決定論的に選ぶ | `run` |
|
|
680
|
+
| `--register-commit` | 成功したIDごとに、その実行で生じた変更を1コミットにまとめる(worktree モードでは常に commit のため無視) | `run --register` |
|
|
681
|
+
| `--post-review` | worktree 統合後に完了 review を行い、todo / issue を verdict に応じて close または waiting にする | `run --register --worktree` |
|
|
682
|
+
| `--on-failure <stop\|continue>` | 途中失敗時に残りのIDを停止するか継続するか(既定は `stop`) | `run --register` |
|
|
683
|
+
| `--branch <repo>=<name>` | run ごとのプロダクト作業ブランチ名(繰り返し可)を指定する | register の worktree モード |
|
|
684
|
+
| `--integration-branch <repo>=<branch>` | run ごとのプロダクトリポジトリの統合先(繰り返し可)を指定する | register の worktree モード |
|
|
685
|
+
| `--resume` | run が止まった段(executor / reporter / 統合)を既存 worktree と checkpoint で再開する | register の worktree モード |
|
|
686
|
+
| `--resume-from executor` | reporter 段から再開可能な run を、既存成果を保持したまま executor 段から再開する | register の worktree モード(`--resume` と併用)、schedule の `resume --task`(`--due` と併用不可) |
|
|
687
|
+
| `--force-restart` | 再開可能な run の成果があっても、worktree を破棄して項目全体を再実行する | register の worktree モード |
|
|
688
|
+
| `--join` | 実行中の register worktree 実行の終了を待たずに合流して並行実行する(上限は `run.max_concurrent_runs`) | register の worktree モード |
|
|
689
|
+
| `--executor-by <nickname>` | executor 段の agent。register では `PJR-ID=nickname,...` による項目別指定も可能 | `run --auto` / `resume` / `run --register` / `run --plan` / `run --deliverable` |
|
|
690
|
+
| `--reporter-by <nickname>` | executor/reporter パイプラインの reporter 段に使う agent nickname | `run --auto` / `resume` / `run --register` / `run --plan` / `run --deliverable` |
|
|
691
|
+
| `--on-rate-limit <action>` | 指名した agent の上限時の扱い。`stop` / `wait` / `fallback` | `run` / `resume` |
|
|
692
|
+
| `--fallback-executor-by <name>` | rate limit の `fallback` または接続不能時に executor 段を1回だけ引き継ぐ agent | `run` / `resume` |
|
|
693
|
+
| `--fallback-reporter-by <name>` | rate limit の `fallback` または接続不能時に reporter 段を1回だけ引き継ぐ agent | `run` / `resume` |
|
|
694
|
+
| `--due` | 再開時刻を迎えた利用制限延期 task を対象にする | `resume` |
|
|
690
695
|
|
|
691
696
|
`--plan` と `--deliverable` も Schedule のパイプライン宣言を持たないため、`--executor-by` / `--reporter-by` の少なくとも一方を指定したときだけ executor/reporter 2段階で実行します。指定しなかった段は `stage_role` による自動選択で決まります。`--plan` では reporter が scaffold 済みの result を記入するため、frontmatter に `task_id` を持つ plan が必要です。`--by` との併用はエラーです。`--by` に `stage_role` を持つ pipeline 用 agent を指定すると、result 未記入の blocked にはせず、`--executor-by` / `--reporter-by` を使うよう案内するエラーで実行前に拒否します。
|
|
692
697
|
|
|
@@ -718,6 +723,9 @@ specdojo exec run --project prj-0001 --auto --parallel 5
|
|
|
718
723
|
# Ready がなくなるまで連続実行する
|
|
719
724
|
specdojo exec run --project prj-0001 --auto --loop --parallel 5
|
|
720
725
|
|
|
726
|
+
# 指定した track だけを連続実行する
|
|
727
|
+
specdojo exec run --project prj-0001 --auto --track data-flow-uc-rewrite --loop --parallel 3
|
|
728
|
+
|
|
721
729
|
# 登録簿の項目を実行する(開始で in-progress、成功で review、失敗で waiting へ遷移)
|
|
722
730
|
specdojo exec run --project prj-0001 --register PJR-0012
|
|
723
731
|
|
|
@@ -818,7 +826,7 @@ specdojo exec trial adopt --project prj-0001 --comparison <comparison-id> --tria
|
|
|
818
826
|
|
|
819
827
|
`--agent`と任意の`--reporter-by`を使うと、reporterなしまたは全trial共通reporterの従来方式になります。`--pair <executor>=<reporter>...`は2組以上を指定し、executorとreporterを一組として比較します。`--pair`は`--agent` / `--reporter-by`と併用できません。比較記録の`reporter_mode`には`none` / `shared` / `paired`のいずれかを保存します。各reporterについて構造化出力の成否、形式試行回数、形式再試行回数、`evidence_blocked` / `invalid_output` / `invocation_failure` / `rate_limit`の失敗分類も保存します。`evidence_blocked` は reporter の申告ではなく、executor evidence から runner が機械判定した blocked を表します。
|
|
820
828
|
|
|
821
|
-
`pipeline.parent_validations`に指定できるIDは`validate-schema`、`typecheck`、`test-unit`、`test-integration`、`lint-ts`、`lint-fm`、`lint-md`、`lint-mermaid`、`build`、`format-check`です(各IDは組み込み許可リストの固定argvへ解決されます)。`pipeline.parent_validations`はtrialにも適用され、executor成功後・reporter起動前に各worktreeで実行されます。親検証結果は`source: runner`付きでevidenceへ保存し、失敗時はtrialを`failed`にします。比較記録と`trial status`はexecutor・親検証・全体の時間を分け、executorの検証報告総数と`passed` / `failed` / `not_run` / `requires_human`、親検証の状態と件数を別々に表示します。採用前に親検証の成功、executorの未実施・未報告、sandbox 外で人が行う確認を確認してください。
|
|
829
|
+
`pipeline.parent_validations`に指定できるIDは`validate-schema`、`typecheck`、`test-unit`、`test-integration`、`lint-ts`、`lint-fm`、`lint-md`、`lint-mermaid`、`lint-d2`、`build`、`format-check`です(各IDは組み込み許可リストの固定argvへ解決されます)。`pipeline.parent_validations`はtrialにも適用され、executor成功後・reporter起動前に各worktreeで実行されます。親検証結果は`source: runner`付きでevidenceへ保存し、失敗時はtrialを`failed`にします。比較記録と`trial status`はexecutor・親検証・全体の時間を分け、executorの検証報告総数と`passed` / `failed` / `not_run` / `requires_human`、親検証の状態と件数を別々に表示します。採用前に親検証の成功、executorの未実施・未報告、sandbox 外で人が行う確認を確認してください。
|
|
822
830
|
|
|
823
831
|
記録先は`execution_path/exec/trials/<comparison-id>/`です。agent選定への反映は自動化せず、人が複数比較を確認して `.specdojo/agent-members.yaml` を更新します。
|
|
824
832
|
|
|
@@ -1123,9 +1131,10 @@ schedule / register / job / routine の使い分けの基準は [exec運用ガ
|
|
|
1123
1131
|
|
|
1124
1132
|
`agent` は、保存済みの plan を指定した1つの agent へ渡し、その標準出力を取得します。agent の選択は `.specdojo/agent-members.yaml` の nickname で一意に決まるため、実行のたびに担当が変わりません。決定論的な手順を shell script や CLI 側に置き、agent には判断だけを委ねるための最小の部品です。
|
|
1125
1133
|
|
|
1126
|
-
| コマンド
|
|
1127
|
-
|
|
|
1128
|
-
| `agent run`
|
|
1134
|
+
| コマンド | 用途 |
|
|
1135
|
+
| -------------- | ----------------------------------------------------------------------- |
|
|
1136
|
+
| `agent run` | plan を stdin で agent へ渡し、標準出力をファイルへ保存する |
|
|
1137
|
+
| `agent launch` | agy を役割別セッション設定と runner の宣言済み task worktree で起動する |
|
|
1129
1138
|
|
|
1130
1139
|
```bash
|
|
1131
1140
|
specdojo agent run --plan <plan.md> --by <nickname> --out <response.txt>
|
|
@@ -1169,9 +1178,10 @@ specdojo orchestrator night --project prj-0001 \
|
|
|
1169
1178
|
|
|
1170
1179
|
`devcontainer` は、利用リポジトリの `.devcontainer/` 環境を構築するためのサブコマンドです。VS Code Dev Container などで、オーケストレーターを起動するための分離されたコンテナ環境を生成します。
|
|
1171
1180
|
|
|
1172
|
-
| コマンド
|
|
1173
|
-
|
|
|
1174
|
-
| `devcontainer scaffold`
|
|
1181
|
+
| コマンド | 用途 |
|
|
1182
|
+
| -------------------------- | ----------------------------------------------------------------------- |
|
|
1183
|
+
| `devcontainer scaffold` | `.devcontainer/` の設定ファイル群を生成する |
|
|
1184
|
+
| `devcontainer host-script` | ホストから tmux へ接続するスクリプト本体を `.specdojo/host/` に書き出す |
|
|
1175
1185
|
|
|
1176
1186
|
`devcontainer scaffold` は、指定された provider の CLI と、要求された追加機能を組み込んだ `devcontainer.json` と `post-create.sh` を生成します。あわせて、常時稼働ホストへの接続と tmux セッション維持のためのサンプルスクリプト(`.devcontainer/remote-host/specdojo-tmux.sh.sample`)と接続元 SSH 設定サンプル(`.devcontainer/remote-host/ssh-config.sample`)も生成します。provider は `antigravity`、`claude`、`codex`、`opencode` を指定できます。`--editor emacs` / `--editor vim` を指定した場合は、それぞれ Emacs 用の `emacs/init.el` / Vim 用の `vim/vimrc` も生成します。Dev Container は任意の実行環境であり、既存の Node.js 環境を置き換える必須手順ではありません。
|
|
1177
1187
|
|
|
@@ -1255,6 +1265,28 @@ post-create は `~/.emacs`、`~/.emacs.el`、`~/.emacs.d/init.el`、`~/.config/e
|
|
|
1255
1265
|
|
|
1256
1266
|
Vim の雛形は `.devcontainer/vim/vimrc` に生成され、`~/.vimrc` と `~/.vim/vimrc` のどちらも無い場合だけ `~/.vimrc` へコピーされます。既存の Vim 設定は上書きしません。Emacs の雛形も上記と同じ上書き防止を維持します。
|
|
1257
1267
|
|
|
1268
|
+
### 16.1. devcontainer host-script
|
|
1269
|
+
|
|
1270
|
+
`devcontainer host-script` は、常時稼働ホストから devcontainer 内の tmux セッションへ入るためのスクリプト本体(`.specdojo/host/devcontainer-tmux.sh`)をワークスペースへ書き出します。
|
|
1271
|
+
|
|
1272
|
+
```bash
|
|
1273
|
+
npx specdojo devcontainer host-script
|
|
1274
|
+
```
|
|
1275
|
+
|
|
1276
|
+
主要オプション:
|
|
1277
|
+
|
|
1278
|
+
| オプション | 用途 |
|
|
1279
|
+
| ----------- | -------------------------------------------------------- |
|
|
1280
|
+
| `--dry-run` | 実際にファイルを作成せず、作成予定のファイルを表示する。 |
|
|
1281
|
+
|
|
1282
|
+
本体スクリプトの対応 OS は macOS、Linux、Windows の WSL2 です。ホスト側のスクリプト(`~/bin/specdojo-tmux.sh` など)はワークスペースのパスを渡してこの本体スクリプトを呼び出す数行のみとなり、ホスト側スクリプトの保守負担を抑えられます。
|
|
1283
|
+
|
|
1284
|
+
- ラベル `devcontainer.local_folder` が一致する稼働中のコンテナがあれば、そのまま tmux へ入ります。
|
|
1285
|
+
- 停止中のコンテナがあれば `docker start` で起動してから入ります。この場合ホスト側に Node.js は不要です。
|
|
1286
|
+
- コンテナが存在しないときだけ `devcontainer up` を動かします。環境変数 `SPECDOJO_NODE_BIN` があればそこを `PATH` に足し、なければ利用者のログインシェル(`"$SHELL" -lic`)経由で起動します。mise を利用している場合は shims のディレクトリ(例: `~/.local/share/mise/shims`)を指定してください。
|
|
1287
|
+
- コンテナ内の作業ディレクトリはマウント情報から、実行ユーザーは `devcontainer.json` の `remoteUser` から求めます。求められないときは原因を stderr に出力して終了します。
|
|
1288
|
+
- スクリプトは実行権限(`0o755`)付きで書き出され、同じ版で複数回実行しても内容は変わりません。
|
|
1289
|
+
|
|
1258
1290
|
## 17. 関連ガイド
|
|
1259
1291
|
|
|
1260
1292
|
| 詳細 | 参照先 |
|