specdojo 0.4.3 → 0.4.5
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 +2 -0
- package/CHANGELOG.md +18 -0
- package/dist/catalog/build.js +8 -6
- package/dist/docs/doc-index.js +11 -0
- package/dist/exec/plans-core.js +11 -0
- package/dist/exec/plans-generation.js +1 -1
- package/dist/exec/register.js +47 -14
- package/dist/exec/run/in-place.js +7 -4
- package/dist/exec/run/register-core.js +10 -2
- package/dist/exec/run/register-worktree.js +4 -1
- package/dist/exec/task-repos.js +11 -0
- package/dist/kata/authoring.js +60 -14
- package/dist/kata/command.js +40 -28
- package/dist/kata/kata.js +26 -12
- package/dist/register/approach.js +13 -12
- package/dist/register/authoring-sources.js +132 -0
- package/dist/register/core.js +4 -3
- package/dist/register/create-commands.js +77 -10
- package/dist/register/events.js +2 -0
- package/dist/register/external-project.js +11 -1
- package/dist/register/item.js +37 -5
- package/dist/register/renumber.js +3 -3
- package/dist/shared/text.js +3 -1
- package/docs/ja/specdojo/exec-templates/xep-recipe-authoring-template.md +7 -7
- package/docs/ja/specdojo/exec-templates/xep-rulebook-authoring-template.md +7 -7
- package/docs/ja/specdojo/exec-templates/xep-sample-authoring-template.md +7 -7
- package/docs/ja/specdojo/exec-templates/xep-template-authoring-template.md +7 -7
- package/docs/ja/specdojo/guides/docs-structure-guide.md +1 -1
- package/docs/ja/specdojo/guides/kata-guide.md +6 -2
- package/docs/ja/specdojo/guides/practice-system-composition-guide.md +4 -0
- package/docs/ja/specdojo/guides/quick-start-guide.md +5 -3
- package/docs/ja/specdojo/references/command-reference.md +30 -25
- package/docs/ja/specdojo/references/specdojo-config-reference.md +1 -1
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +2 -1
- package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +4 -0
- package/docs/ja/specdojo/standards/recipe-authoring-standard.md +3 -3
- package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +2 -2
- package/docs/ja/specdojo/standards/sample-authoring-standard.md +4 -4
- package/docs/ja/specdojo/standards/template-authoring-standard.md +3 -3
- package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +4 -3
- package/docs/specdojo/schemas/v1/exec-result-frontmatter.schema.yaml +3 -3
- package/docs/specdojo/schemas/v1/register-events.schema.yaml +1 -0
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +31 -3
- package/package.json +12 -11
- package/templates/antigravity/orchestrator.md +2 -0
- package/templates/claude/agents/specdojo-orchestrator.md +2 -0
- package/templates/codex/agents/specdojo-orchestrator.toml +2 -0
- package/templates/codex/orchestrator.md +2 -0
- package/templates/opencode/agents/specdojo-orchestrator.md +2 -0
|
@@ -14,21 +14,21 @@ _PHASE_DESCRIPTION_
|
|
|
14
14
|
- 記述標準: [[_AUTHORING_STANDARD_ID_|執筆標準]](`_AUTHORING_STANDARD_PATH_`)
|
|
15
15
|
- result: `_RESULT_REF_`
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
手本にするファイル:
|
|
18
18
|
|
|
19
19
|
_AUTHORING_EXEMPLARS_
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
手本ファイルは読み取り専用であり、プロジェクトリポジトリとプロダクトリポジトリのどちらにあっても変更しない。手本がない場合は、記述標準と対象領域の慣行だけを根拠に実践の型を作る。
|
|
22
22
|
|
|
23
23
|
## 3. 進め方
|
|
24
24
|
|
|
25
|
-
1.
|
|
25
|
+
1. 記述標準と手本ファイルを実際に読み、複数の成果物に再利用できる規則・問い・完成例・雛形を抽出する。
|
|
26
26
|
2. `_AUTHORING_KATA_PATH_` に `_AUTHORING_KATA_ID_` を持つ `_AUTHORING_KATA_KIND_` を新規作成する。frontmatter の `status` は `draft` とし、`ready` へ変更しない。
|
|
27
27
|
3. 手本の内容を丸写しせず、プロジェクト固有の値を一般化する。手本同士が矛盾する場合は、共通部分と差異を分け、判断できない点を result の申し送りへ記録する。
|
|
28
|
-
4.
|
|
29
|
-
5.
|
|
28
|
+
4. 手本のうち成果物カタログに載っているものだけ、作った種類の参照が `undecided` または未記入なら `_AUTHORING_KATA_ID_` へ更新する。カタログ外の文書とプロダクトリポジトリのファイルは読み取り専用の手本にとどめ、参照を付け替えない。rulebook は成果物カタログの `rulebook`、recipe / sample / template は成果物が参照する rulebook frontmatter の同名フィールドを正本とする。
|
|
29
|
+
5. カタログ成果物の参照がすでに別の kata を指す場合は上書きせず、その成果物 ID・既存参照・新しい kata ID を result の申し送りへ記録する。`not-needed` も意図的な判断として上書きしない。
|
|
30
30
|
recipe / sample / template の作成時に、手本の rulebook 自体が `undecided`・未記入・`not-needed` で参照先を記録できない場合は、別種の kata を同時作成せず、付け替え不能として result へ記録する。
|
|
31
|
-
6. 新しい kata
|
|
31
|
+
6. 新しい kata と参照の更新だけを変更対象とし、手本ファイルは変更しない。
|
|
32
32
|
|
|
33
33
|
## 4. 完了手順
|
|
34
34
|
|
|
@@ -39,7 +39,7 @@ _AUTHORING_EXEMPLARS_
|
|
|
39
39
|
## 5. 異常終了の条件
|
|
40
40
|
|
|
41
41
|
- 新しい id が既に存在する、対象種別と id の末尾が一致しない、手本を解決できない、または検査が未解消の場合は異常終了する。
|
|
42
|
-
-
|
|
42
|
+
- 手本ファイル(プロダクトリポジトリを含む)へ変更が生じた場合は元に戻し、commit の対象に含めない。解消できなければ異常終了する。
|
|
43
43
|
- agent 自身は登録簿の状態を変更しない。
|
|
44
44
|
|
|
45
45
|
_COMMON_CONVENTIONS_
|
|
@@ -14,21 +14,21 @@ _PHASE_DESCRIPTION_
|
|
|
14
14
|
- 記述標準: [[_AUTHORING_STANDARD_ID_|執筆標準]](`_AUTHORING_STANDARD_PATH_`)
|
|
15
15
|
- result: `_RESULT_REF_`
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
手本にするファイル:
|
|
18
18
|
|
|
19
19
|
_AUTHORING_EXEMPLARS_
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
手本ファイルは読み取り専用であり、プロジェクトリポジトリとプロダクトリポジトリのどちらにあっても変更しない。手本がない場合は、記述標準と対象領域の慣行だけを根拠に実践の型を作る。
|
|
22
22
|
|
|
23
23
|
## 3. 進め方
|
|
24
24
|
|
|
25
|
-
1.
|
|
25
|
+
1. 記述標準と手本ファイルを実際に読み、複数の成果物に再利用できる規則・問い・完成例・雛形を抽出する。
|
|
26
26
|
2. `_AUTHORING_KATA_PATH_` に `_AUTHORING_KATA_ID_` を持つ `_AUTHORING_KATA_KIND_` を新規作成する。frontmatter の `status` は `draft` とし、`ready` へ変更しない。
|
|
27
27
|
3. 手本の内容を丸写しせず、プロジェクト固有の値を一般化する。手本同士が矛盾する場合は、共通部分と差異を分け、判断できない点を result の申し送りへ記録する。
|
|
28
|
-
4.
|
|
29
|
-
5.
|
|
28
|
+
4. 手本のうち成果物カタログに載っているものだけ、作った種類の参照が `undecided` または未記入なら `_AUTHORING_KATA_ID_` へ更新する。カタログ外の文書とプロダクトリポジトリのファイルは読み取り専用の手本にとどめ、参照を付け替えない。rulebook は成果物カタログの `rulebook`、recipe / sample / template は成果物が参照する rulebook frontmatter の同名フィールドを正本とする。
|
|
29
|
+
5. カタログ成果物の参照がすでに別の kata を指す場合は上書きせず、その成果物 ID・既存参照・新しい kata ID を result の申し送りへ記録する。`not-needed` も意図的な判断として上書きしない。
|
|
30
30
|
recipe / sample / template の作成時に、手本の rulebook 自体が `undecided`・未記入・`not-needed` で参照先を記録できない場合は、別種の kata を同時作成せず、付け替え不能として result へ記録する。
|
|
31
|
-
6. 新しい kata
|
|
31
|
+
6. 新しい kata と参照の更新だけを変更対象とし、手本ファイルは変更しない。
|
|
32
32
|
|
|
33
33
|
## 4. 完了手順
|
|
34
34
|
|
|
@@ -39,7 +39,7 @@ _AUTHORING_EXEMPLARS_
|
|
|
39
39
|
## 5. 異常終了の条件
|
|
40
40
|
|
|
41
41
|
- 新しい id が既に存在する、対象種別と id の末尾が一致しない、手本を解決できない、または検査が未解消の場合は異常終了する。
|
|
42
|
-
-
|
|
42
|
+
- 手本ファイル(プロダクトリポジトリを含む)へ変更が生じた場合は元に戻し、commit の対象に含めない。解消できなければ異常終了する。
|
|
43
43
|
- agent 自身は登録簿の状態を変更しない。
|
|
44
44
|
|
|
45
45
|
_COMMON_CONVENTIONS_
|
|
@@ -14,21 +14,21 @@ _PHASE_DESCRIPTION_
|
|
|
14
14
|
- 記述標準: [[_AUTHORING_STANDARD_ID_|執筆標準]](`_AUTHORING_STANDARD_PATH_`)
|
|
15
15
|
- result: `_RESULT_REF_`
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
手本にするファイル:
|
|
18
18
|
|
|
19
19
|
_AUTHORING_EXEMPLARS_
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
手本ファイルは読み取り専用であり、プロジェクトリポジトリとプロダクトリポジトリのどちらにあっても変更しない。手本がない場合は、記述標準と対象領域の慣行だけを根拠に実践の型を作る。
|
|
22
22
|
|
|
23
23
|
## 3. 進め方
|
|
24
24
|
|
|
25
|
-
1.
|
|
25
|
+
1. 記述標準と手本ファイルを実際に読み、複数の成果物に再利用できる規則・問い・完成例・雛形を抽出する。
|
|
26
26
|
2. `_AUTHORING_KATA_PATH_` に `_AUTHORING_KATA_ID_` を持つ `_AUTHORING_KATA_KIND_` を新規作成する。frontmatter の `status` は `draft` とし、`ready` へ変更しない。
|
|
27
27
|
3. 手本の内容を丸写しせず、プロジェクト固有の値を一般化する。手本同士が矛盾する場合は、共通部分と差異を分け、判断できない点を result の申し送りへ記録する。
|
|
28
|
-
4.
|
|
29
|
-
5.
|
|
28
|
+
4. 手本のうち成果物カタログに載っているものだけ、作った種類の参照が `undecided` または未記入なら `_AUTHORING_KATA_ID_` へ更新する。カタログ外の文書とプロダクトリポジトリのファイルは読み取り専用の手本にとどめ、参照を付け替えない。rulebook は成果物カタログの `rulebook`、recipe / sample / template は成果物が参照する rulebook frontmatter の同名フィールドを正本とする。
|
|
29
|
+
5. カタログ成果物の参照がすでに別の kata を指す場合は上書きせず、その成果物 ID・既存参照・新しい kata ID を result の申し送りへ記録する。`not-needed` も意図的な判断として上書きしない。
|
|
30
30
|
recipe / sample / template の作成時に、手本の rulebook 自体が `undecided`・未記入・`not-needed` で参照先を記録できない場合は、別種の kata を同時作成せず、付け替え不能として result へ記録する。
|
|
31
|
-
6. 新しい kata
|
|
31
|
+
6. 新しい kata と参照の更新だけを変更対象とし、手本ファイルは変更しない。
|
|
32
32
|
|
|
33
33
|
## 4. 完了手順
|
|
34
34
|
|
|
@@ -39,7 +39,7 @@ _AUTHORING_EXEMPLARS_
|
|
|
39
39
|
## 5. 異常終了の条件
|
|
40
40
|
|
|
41
41
|
- 新しい id が既に存在する、対象種別と id の末尾が一致しない、手本を解決できない、または検査が未解消の場合は異常終了する。
|
|
42
|
-
-
|
|
42
|
+
- 手本ファイル(プロダクトリポジトリを含む)へ変更が生じた場合は元に戻し、commit の対象に含めない。解消できなければ異常終了する。
|
|
43
43
|
- agent 自身は登録簿の状態を変更しない。
|
|
44
44
|
|
|
45
45
|
_COMMON_CONVENTIONS_
|
|
@@ -381,7 +381,7 @@ VS Code でプロジェクトリポジトリとプロダクトリポジトリを
|
|
|
381
381
|
|
|
382
382
|
プロダクト文書は実装と同期して改訂するため、`app1/docs/ja/product/` に置きます。README、ソースコードから生成する API リファレンス、パッケージ利用者向けの手順など、コードと同じ revision で読む付属文書も `app1/` に置きます。
|
|
383
383
|
|
|
384
|
-
`app1-specdojo/` には `docs/ja/projects
|
|
384
|
+
`app1-specdojo/` には `docs/ja/projects/` と `docs/ja/specdojo/` を置きます。前者はプロジェクト固有の目的・判断・計画・実行記録、後者は SpecDojo が配布する型と、種類ディレクトリ配下の authority サブディレクトリに置く利用者作成の rulebook / recipe / sample / template です。この境界により、プロダクトの内容と同じ revision が必要な文書は `app1/`、SpecDojo の記帳と再利用可能な型は `app1-specdojo/` の履歴に残ります。
|
|
385
385
|
|
|
386
386
|
プロダクト文書の catalog `base_path` を別リポジトリへ解決する機能と、[[prj-0001:pjr-xkks-grade-sidecar|PJR-XKKS grade result のサイドカー化]] で定める成果物へ書き込まない grade 運用は、プロダクト文書を成果物として管理する場合の前提です。exec はプロダクト文書をファイルとして変更・統合できますが、catalog・grade・doc index の対象にはしません。
|
|
387
387
|
|
|
@@ -65,9 +65,13 @@ template は、記述する部分を _TODO_ などのプレースホルダとし
|
|
|
65
65
|
|
|
66
66
|
要否は初回の `bootstrap` で判断します。`undecided` の型は、必要なら項目を省略したうえで必要な型を成果物と一緒に整備し、不要なら `not-needed` へ更新します。既存の型を廃止する、または `not-needed` を必要へ変更する場合は、成果物の実績・繰り返し発生したレビュー指摘・schema の表現範囲を根拠として rulebook frontmatter の宣言も同時に更新します。
|
|
67
67
|
|
|
68
|
-
成果物と型を一組で初めて作るときは `bootstrap` を使います。成果物がすでにあり、そこから再利用可能な型だけを新しく起こすとき、または手本なしで型だけを作るときは `rulebook-authoring` / `recipe-authoring` / `sample-authoring` / `template-authoring` を使います。authoring
|
|
68
|
+
成果物と型を一組で初めて作るときは `bootstrap` を使います。成果物がすでにあり、そこから再利用可能な型だけを新しく起こすとき、または手本なしで型だけを作るときは `rulebook-authoring` / `recipe-authoring` / `sample-authoring` / `template-authoring` を使います。authoring では `--target` に新しい kata ID、繰り返し可能な `--source` に読み取り専用の手本を指定します。手本は文書索引で解決できる doc id、プロジェクトリポジトリの相対パス、または project の `repos` に宣言した `<repo>:<path>` です。パスにはファイル、ディレクトリ、glob を指定できます。展開後の手本は重複を除いて 100 ファイルまでです。広すぎるパターンによる読み取り範囲と plan の肥大化を抑えるため、超過時は起票・実行を停止します。
|
|
69
69
|
|
|
70
|
-
|
|
70
|
+
`<repo>` が `repos[].name` と一致する値はプロダクトリポジトリのパスとして扱います。それ以外で `/` または拡張子を含む値はプロジェクトリポジトリのパス、残りは doc id として文書索引で解決します。いずれの形も手本が見つからなければ停止します。成果物カタログは必須ではありません。手本がカタログ成果物で、その kata 参照が `undecided` または未記入の場合だけ新しい kata ID へ更新します。カタログ外とプロダクトリポジトリの手本は変更せず、参照も付け替えません。互換性のため、新しい kata ID に続く 2 個目以降の `--target` も `--source` と同じ手本として受け付けます。
|
|
71
|
+
|
|
72
|
+
利用者が作る kata はリポジトリ単位の `kata_authority` を使い、`docs/ja/specdojo/{rulebooks,recipes,samples,templates}/<kata_authority>/` に置きます。たとえば `customer:payment-rulebook` の配置は `docs/ja/specdojo/rulebooks/customer/payment-rulebook.md` です。`specdojo:` は SpecDojo 本体専用であり、利用者リポジトリでは新規作成できません。これにより、同じリポジトリの複数 project で型を共有しながら、将来追加される同名の同梱 kata と衝突しません。
|
|
73
|
+
|
|
74
|
+
0.4.4 のあいだは旧 `docs/ja/kata/` 配置も読みますが、解決時に新配置への移動案内を出します。同じ ID が新旧の両方にある場合は authority サブディレクトリ側を使い、旧ファイルの削除を案内します。
|
|
71
75
|
|
|
72
76
|
`kind: generated` の成果物には実践の型を適用しません。成果物ごとの型宣言は置かず、`kind` から非適用を導出します。rulebook を持たない成果物は成果物カタログの `rulebook: not-needed` で表します。
|
|
73
77
|
|
|
@@ -35,12 +35,16 @@ SpecDojo は、成果物(プロダクトとプロジェクトの内容その
|
|
|
35
35
|
|
|
36
36
|
npm package が所有する型の文書は、package ごとの authority を ID に付けます。SpecDojo core は `specdojo:`、業界固有の variant package は `construction-dojo:` などを使用します。authority は論理IDにだけ含め、ファイル名には含めません。利用プロジェクトへコピーした標準文書を override する場合は同じ完全IDを維持し、独自文書を追加する場合は別IDを付けます。
|
|
37
37
|
|
|
38
|
+
配置は SpecDojo core が `docs/ja/specdojo/<種類>s/<local-id>.<拡張子>`、それ以外が `docs/ja/specdojo/<種類>s/<authority>/<local-id>.<拡張子>` です。利用者リポジトリと variant package は同じ authority サブディレクトリ形式を使うため、育てた kata を ID とパスを変えずに package へ移せます。
|
|
39
|
+
|
|
38
40
|
### 1.1. npm package からの参照と eject
|
|
39
41
|
|
|
40
42
|
SpecDojo core の rulebook / standard / recipe / sample / template は、npm package に同梱されたものを既定で参照します。プロジェクト固有の変更が必要な文書だけを利用リポジトリの同じ相対パスへ eject し、同じ完全 ID を維持して上書きします。
|
|
41
43
|
|
|
42
44
|
文書 ID のインデックスは、利用リポジトリの `docs/` と、resolver が返す package ルート配下の上記 5 種別のディレクトリを別スコープとして走査します。同一スコープ内で同じ ID が複数のファイルにあればエラーです。利用リポジトリと package の間で同じ ID がある場合は正常な override として利用リポジトリ側を採用します。どちらにも存在しない ID は未解決のままです。
|
|
43
45
|
|
|
46
|
+
0.4.4 では移行互換として旧 `docs/ja/kata/<種類>s/` も読みます。旧配置を見つけた場合は authority サブディレクトリへの移動を案内し、新旧に同じ ID がある場合は新配置を優先して警告します。
|
|
47
|
+
|
|
44
48
|
package の探索では `node_modules` 全体を再帰走査せず、resolver が返した SpecDojo package の対象ディレクトリだけを読みます。この解決結果は CLI の wikilink とカタログ検証に使います。VitePress で package 側文書を配信するためのステージングは、docs サイトのビルド責務として別に扱います。
|
|
45
49
|
|
|
46
50
|
## 2. 種別と役割
|
|
@@ -336,7 +336,7 @@ npx specdojo config init
|
|
|
336
336
|
|
|
337
337
|
`specdojo config init` は `.specdojo/specdojo.config.json` が存在しない場合に雛形を作成し、既存ファイルは上書きしません。雛形は register だけを使える最小構成であり、project パスはリポジトリルートを基準とし、`run.worktree_base` はディレクトリ名から作る `../<リポジトリ名>-worktrees` を指します。例えば `app1-specdojo/` では `../app1-specdojo-worktrees` です。作成された設定を開き、対象プロジェクトの ID と各パスを実際の名前に合わせてください。catalog、schedule、exec へ進むときに追加するキーと既定値は [[specdojo:specdojo-config-reference|SpecDojo設定リファレンス]] で確認できます。
|
|
338
338
|
|
|
339
|
-
プロダクト文書は `app1/docs/ja/product/`、プロジェクト文書は `app1-specdojo/docs/ja/projects/` に置きます。同梱の SpecDojo の型(Kata)は `app1-specdojo/docs/ja/specdojo/`、このリポジトリで新しく作る kata
|
|
339
|
+
プロダクト文書は `app1/docs/ja/product/`、プロジェクト文書は `app1-specdojo/docs/ja/projects/` に置きます。同梱の SpecDojo の型(Kata)は `app1-specdojo/docs/ja/specdojo/<種類>s/`、このリポジトリで新しく作る kata はその下の `<kata_authority>/` から解決します。現行実装では1つの項目で両リポジトリを自動統合できないため、プロダクト文書や実装も変更する項目は分けるか、人が統合を管理します。詳細は [ドキュメント構成ガイド](docs-structure-guide.md) の `別リポジトリ構成` を参照してください。
|
|
340
340
|
|
|
341
341
|
成果物と実装を常に同じ変更・履歴として扱う場合に限り、**同一リポジトリ構成**としてプロダクトリポジトリのルートで同じ初期化手順を実行できます。CLI は構成を強制しません。
|
|
342
342
|
|
|
@@ -645,14 +645,16 @@ npx specdojo register add \
|
|
|
645
645
|
--difficulty hard \
|
|
646
646
|
--approach rulebook-authoring \
|
|
647
647
|
--target <kata-authority>:<name>-rulebook \
|
|
648
|
-
--
|
|
648
|
+
--source <deliverable-doc-id>
|
|
649
649
|
npx specdojo exec run \
|
|
650
650
|
--project <project-id> \
|
|
651
651
|
--register <PJR-ID> \
|
|
652
652
|
--worktree
|
|
653
653
|
```
|
|
654
654
|
|
|
655
|
-
|
|
655
|
+
`--target` は新しい kata ID、`--source` は任意の読み取り専用の手本です。`--source` は繰り返し指定でき、文書索引の doc id、プロジェクトリポジトリの相対パス、`repos` に宣言した `<repo>:<path>` を受け付けます。パスにはファイル、ディレクトリ、`*.md` などの glob を書けます。たとえば `--source docs/ja/lessons/01-chase/README.md` や `--source 'coderdojo-lessons:lessons/**/*.md'` の形です。カタログがない project でも使えますが、手本が見つからない場合と展開後に 100 ファイルを超える場合は停止します。互換性のため、2 個目以降の `--target` も手本として引き続き受け付けます。
|
|
656
|
+
|
|
657
|
+
成果物も型もまだない初期立ち上げには `bootstrap` を使います。手本なしで kata だけを作る場合は `--source` を省略します。recipe / sample / template では `approach` と ID の末尾を同じ種類へ置き換えます。手本がカタログ成果物で該当参照が `undecided` または未記入の場合だけ参照を新しい kata ID へ更新し、カタログ外とプロダクトリポジトリの手本は変更しません。
|
|
656
658
|
|
|
657
659
|
### 3.10. 統合後にreviewのagentへ確かめさせる
|
|
658
660
|
|
|
@@ -146,7 +146,7 @@ specdojo config scaffold --workspace --force
|
|
|
146
146
|
|
|
147
147
|
### 2.1. kata
|
|
148
148
|
|
|
149
|
-
`kata` は、利用リポジトリで作成・上書きした型(Kata)と npm package から参照中の型を確認・取得します。対象種別は rulebook / standard / recipe / sample / template です。同じ正準パスにファイルがある場合は利用リポジトリ側を優先します。`kata_authority` の kata は `docs/ja/
|
|
149
|
+
`kata` は、利用リポジトリで作成・上書きした型(Kata)と npm package から参照中の型を確認・取得します。対象種別は rulebook / standard / recipe / sample / template です。同じ正準パスにファイルがある場合は利用リポジトリ側を優先します。`kata_authority` の kata は `docs/ja/specdojo/<種類>s/<kata_authority>/` から解決し、`kata list` と `kata show` にも表示します。0.4.4 のあいだは旧 `docs/ja/kata/<種類>s/` も読み、新配置への移動案内を標準エラーへ出します。新旧に同じ ID があれば新配置を優先します。
|
|
150
150
|
|
|
151
151
|
| コマンド | 用途 | 例 |
|
|
152
152
|
| ---------------- | ------------------------------------------------------- | ------------------------------------------------ |
|
|
@@ -382,33 +382,34 @@ specdojo schedule strategy generate \
|
|
|
382
382
|
|
|
383
383
|
主要オプション:
|
|
384
384
|
|
|
385
|
-
| オプション | 用途
|
|
386
|
-
| ------------------------- |
|
|
387
|
-
| `--to <PJR-ID>` | 移動先の PJR-ID を指定する
|
|
388
|
-
| `--registered <datetime>` | 起票日時(タイムゾーン付き RFC 3339)。省略時は実行時刻
|
|
389
|
-
| `--completed <datetime>` | 完了・却下日時(タイムゾーン付き RFC 3339)。省略時は実行時刻
|
|
390
|
-
| `--by <actor>` | 名簿または予約一覧の actor を追記型 event に記録する
|
|
391
|
-
| `--reason <text>` | event の理由を記録(`wait` では `block_reason` も更新)
|
|
392
|
-
| `--conclusion <text>` | 終端時の結論を記録・更新(`update` では `-` で削除)
|
|
393
|
-
| `--block-reason <text>` | `waiting` の理由を更新(`-` で削除)
|
|
394
|
-
| `--approach <approach>` | 個票の進め方を指定(`update` では `-` で削除)
|
|
395
|
-
| `--target <doc-id>` | 対象文書 ID を指定(繰り返し可、`update` では `-` で削除)
|
|
396
|
-
| `--
|
|
397
|
-
| `--
|
|
398
|
-
|
|
|
399
|
-
| `--
|
|
400
|
-
| `--
|
|
401
|
-
| `--
|
|
402
|
-
| `--
|
|
403
|
-
| `--
|
|
404
|
-
| `--
|
|
405
|
-
| `--
|
|
385
|
+
| オプション | 用途 | 対象 |
|
|
386
|
+
| ------------------------- | ------------------------------------------------------------------- | ------------------------------------------------ |
|
|
387
|
+
| `--to <PJR-ID>` | 移動先の PJR-ID を指定する | `renumber` |
|
|
388
|
+
| `--registered <datetime>` | 起票日時(タイムゾーン付き RFC 3339)。省略時は実行時刻 | `add` |
|
|
389
|
+
| `--completed <datetime>` | 完了・却下日時(タイムゾーン付き RFC 3339)。省略時は実行時刻 | `close` / `reject` |
|
|
390
|
+
| `--by <actor>` | 名簿または予約一覧の actor を追記型 event に記録する | `add` / 更新 / 遷移コマンド |
|
|
391
|
+
| `--reason <text>` | event の理由を記録(`wait` では `block_reason` も更新) | `add` / 更新 / 遷移コマンド |
|
|
392
|
+
| `--conclusion <text>` | 終端時の結論を記録・更新(`update` では `-` で削除) | `add` / `update` / 終端コマンド |
|
|
393
|
+
| `--block-reason <text>` | `waiting` の理由を更新(`-` で削除) | `update` |
|
|
394
|
+
| `--approach <approach>` | 個票の進め方を指定(`update` では `-` で削除) | `add` / `update` |
|
|
395
|
+
| `--target <doc-id>` | 対象文書 ID を指定(繰り返し可、`update` では `-` で削除) | `add` / `update` |
|
|
396
|
+
| `--source <ref>` | kata authoring の手本を指定(繰り返し可、`update` では `-` で削除) | `add` / `update` |
|
|
397
|
+
| `--topic <slug>` | 個票ファイル名と文書 ID の論点部分を指定・更新する | `add` / `update` |
|
|
398
|
+
| `--commit` | `register lifecycle` 枠内で記帳・再生成・commitを行う | `add` / `update` / `renumber` / 遷移 |
|
|
399
|
+
| `-m, --message <message>` | `--commit` のcommitメッセージを上書きする | `add` / `update` / `renumber` / 遷移 |
|
|
400
|
+
| `--dry-run` | 書き込みを行わず変更対象を表示する | `add` / `update` / `renumber` / 遷移 / `migrate` |
|
|
401
|
+
| `--since <date>` | 対象コミットの開始日(`YYYY-MM-DD`、当日を含む) | `history` |
|
|
402
|
+
| `--until <date>` | 対象コミットの終了日(`YYYY-MM-DD`、当日を含む) | `history` |
|
|
403
|
+
| `--id <PJR-ID...>` | 出力する項目を限定する(空白・カンマ区切りで複数可) | `history` |
|
|
404
|
+
| `--status-only` | 追加・削除・状態遷移だけを出力する | `history` |
|
|
405
|
+
| `--limit <count>` | 走査するコミット数の上限 | `history` |
|
|
406
|
+
| `--json` | イベントを JSON で出力する | `history` |
|
|
406
407
|
|
|
407
408
|
`register add` は個票 Frontmatter の `registered_at`(起票日時)を、`register close` / `register reject` は `completed_at`(完了・却下日時)を自動記入します。値は UTC の RFC 3339・秒精度(例: `2026-08-09T14:08:51Z`)で、OS / コンテナの `TZ` 環境変数には依存しません。`register reopen` は `completed_at` を削除します。
|
|
408
409
|
|
|
409
410
|
`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 を指定します。
|
|
410
411
|
|
|
411
|
-
`--approach` を指定する場合、通常は `--target` が 1 件だけ必須です。成果物を作成・修正する approach の対象は成果物カタログの doc id で解決するため、まだ文書がない成果物も指定できます。kata maintenance の対象は文書索引で解決し、approach に対応する kata 種別との一致も書き込み前に検証します。kata authoring
|
|
412
|
+
`--approach` を指定する場合、通常は `--target` が 1 件だけ必須です。成果物を作成・修正する approach の対象は成果物カタログの doc id で解決するため、まだ文書がない成果物も指定できます。kata maintenance の対象は文書索引で解決し、approach に対応する kata 種別との一致も書き込み前に検証します。kata authoring は `--target` を新しい kata ID、`--source` を 0 件以上の読み取り専用の手本とします。互換性のため、2 個目以降の `--target` も `--source` と同じ手本として扱います。
|
|
412
413
|
|
|
413
414
|
`item_type: note` は `open` のまま更新する記録です。`register close` / `register reject` / `register defer` は終了コード 1 で拒否し、対応・回答・判断が必要な場合は `todo` / `question` / `decision` など目的に合う別の `item_type` で起票するよう案内します。本文の追記や修正には `register update` を使用できます。
|
|
414
415
|
|
|
@@ -418,9 +419,13 @@ specdojo schedule strategy generate \
|
|
|
418
419
|
|
|
419
420
|
`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 を起票するときも、この関係を追跡先として使います。
|
|
420
421
|
|
|
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
|
+
`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 以上である必要があります。
|
|
422
423
|
|
|
423
|
-
`register add --approach <approach> --target <doc-id>` は、個票 Frontmatter に進め方と対象を書きます。成果物を作成・修正する進め方は成果物カタログにある文書を、`rulebook-maintenance` などの保守の進め方は名前に対応する kata 種別を対象にし、対象は 1 件だけです。`rulebook-authoring` / `recipe-authoring` / `sample-authoring` / `template-authoring`
|
|
424
|
+
`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` へ保存します。
|
|
425
|
+
|
|
426
|
+
`--source` は次の順で解釈します。コロンの前が対象 project の `repos[].name` と一致すれば `<repo>:<path>`、一致せず値に `/` または拡張子があればプロジェクトリポジトリのパス、残りは文書索引で解決する doc id です。パスはファイル、ディレクトリ、glob を受け付けます。ディレクトリと glob はファイルへ展開し、重複を除いた合計が 100 件を超えると停止します。この上限は広すぎるパターンによる読み取り範囲と plan の肥大化を防ぐためです。プロダクトリポジトリの手本は plan に `$SPECDOJO_REPO_<NAME>/<path>` として載ります。カタログは必須ではなく、いずれの形も見つからなければ起票時と実行時に理由を示して停止します。
|
|
427
|
+
|
|
428
|
+
新しい ID の authority、種類別の末尾、既存 ID との重複も起票時と実行時に検証します。既存 ID には対応する `*-maintenance` を使います。手本がカタログ成果物で、該当参照が `undecided` または未記入なら同じ実行で新 ID へ更新します。別 ID または `not-needed` なら上書きせず result へ申し送り、カタログ外とプロダクトリポジトリの手本は変更も参照更新もしません。互換性のため、新しい kata ID に続く 2 個目以降の `--target` も `--source` と同じ手本として受け付けます。`approach` を指定しない `--target` は複数回指定でき、従来どおり変更網羅検証の対象宣言として使えます。`register update` でも同じ検証を行います。
|
|
424
429
|
|
|
425
430
|
kata authoring は register 専用です。Schedule の task は対象成果物を起点にするため、「新しい kata ID + 0 件以上の手本」という target 契約を損なわずに表現できません。strategy の phase に指定した場合は plan 生成時に停止します。
|
|
426
431
|
|
|
@@ -63,7 +63,7 @@ SpecDojo Configuration Reference
|
|
|
63
63
|
|
|
64
64
|
対象 project の一般的な解決順序は、`--project <id>`、`SPECDOJO_PROJECT`、`current_project`、`projects` の先頭です。一部のコマンドは `current_project` を参照せず `projects` の先頭へフォールバックするため、複数 project では `--project` を明示してください。
|
|
65
65
|
|
|
66
|
-
`kata_authority` は project ごとではなくリポジトリ全体で共有します。省略時は元リポジトリのディレクトリ名を小文字・ハイフン形式へ正規化した値です。worktree でも元リポジトリの名前を使います。利用者の kata は `docs/ja/
|
|
66
|
+
`kata_authority` は project ごとではなくリポジトリ全体で共有します。省略時は元リポジトリのディレクトリ名を小文字・ハイフン形式へ正規化した値です。worktree でも元リポジトリの名前を使います。利用者の kata は `docs/ja/specdojo/<種類>s/<kata_authority>/` 配下に置かれ、この authority の ID だけを利用者リポジトリから解決します。値は英小文字から始め、英小文字・数字・ハイフンだけを使います。project ID と区別するため `prj-` で始めず、SpecDojo 本体専用の `specdojo` も使いません。0.4.4 のあいだは旧 `docs/ja/kata/` も移行元として読みます。
|
|
67
67
|
|
|
68
68
|
### 2.1. `external_projects`のキー
|
|
69
69
|
|
|
@@ -103,7 +103,7 @@ YAML 成果物のため、Markdown Frontmatter ではなくファイル先頭の
|
|
|
103
103
|
|
|
104
104
|
| `domain` | ○ | ドメイン識別子 |
|
|
105
105
|
| `base_path` | 任意 | ドメインの既定ディレクトリ |
|
|
106
|
-
| `groups` | ○ |
|
|
106
|
+
| `groups` | ○ | グループ(章)の配列。`project` では成果物がまだない領域を空配列 `[]` で表せる |
|
|
107
107
|
|
|
108
108
|
### 5.2. `groups[]`(グループ)
|
|
109
109
|
|
|
@@ -154,6 +154,7 @@ YAML 成果物のため、Markdown Frontmatter ではなくファイル先頭の
|
|
|
154
154
|
|
|
155
155
|
### 6.1. グループ構成
|
|
156
156
|
|
|
157
|
+
- `type: project` では、対象領域に成果物がまだない場合に限り、必須キーの `groups` を空配列 `[]` とする。`groups` 自体の省略や配列以外の値は認めない。テンプレートには少なくとも 1 つのグループを定義する。
|
|
157
158
|
- サブドメインに分かれない場合は、単一の葉グループに `deliverables` を並べる(平坦型)。
|
|
158
159
|
- サブドメインが2つ以上に分かれる場合は、親グループの `groups` 配下に子グループを並べ、各子グループに `name`・`base_path`・`deliverables` を記載する(章分割型)。
|
|
159
160
|
- 親グループは `deliverables` を直接持たず、子 `groups` で表現する。
|
|
@@ -48,6 +48,8 @@ repo/apps/product-b/docs/
|
|
|
48
48
|
|
|
49
49
|
npm package が所有する型(Kata)の文書は、利用プロジェクトの成果物と同じ Unit に展開しても所有元を識別できるよう、package ごとに定めた authority を ID の namespace として持つ。SpecDojo core の authority は `specdojo` とする。
|
|
50
50
|
|
|
51
|
+
Kata の配置は authority と対応させる。SpecDojo core は `docs/ja/specdojo/<種類>s/<local-id>.<拡張子>`、それ以外の authority は `docs/ja/specdojo/<種類>s/<authority>/<local-id>.<拡張子>` とする。authority はファイル名には含めず、利用者リポジトリと variant package でも同じ配置を使う。
|
|
52
|
+
|
|
51
53
|
複数の SpecDojo Unit を横断して扱う場合は、必要に応じて Unit ID とドキュメントIDの組み合わせで識別する。
|
|
52
54
|
|
|
53
55
|
```text
|
|
@@ -144,6 +146,8 @@ specdojo:track-design-guide
|
|
|
144
146
|
|
|
145
147
|
authority は論理的な所有元であり、ファイル名には含めない。SpecDojo core をローカルへコピーして明示的に override する場合も、同じ論理文書として同じ完全 ID を維持する。
|
|
146
148
|
|
|
149
|
+
`specdojo:` の文書は種類ディレクトリの直下へ置き、ほかの authority の文書は同じ種類ディレクトリの authority サブディレクトリへ置く。たとえば `customer:payment-rulebook` は `docs/ja/specdojo/rulebooks/customer/payment-rulebook.md` に置く。
|
|
150
|
+
|
|
147
151
|
#### 3.1.4. local-id の形式
|
|
148
152
|
|
|
149
153
|
`<local-id>` は次の形式を基本とする。
|
|
@@ -9,13 +9,13 @@ specdojo:
|
|
|
9
9
|
|
|
10
10
|
Recipe Authoring Standard
|
|
11
11
|
|
|
12
|
-
`docs/ja/specdojo/recipes/`
|
|
12
|
+
`docs/ja/specdojo/recipes/` 直下と `docs/ja/specdojo/recipes/<authority>/` 配下の各 `*-recipe.md` が従うべき章立て・記述ルール・禁止事項・運用ルールを定義します。成果物の構造・必須項目・禁止事項は対応する rulebook を正本とし、本書は「良い内容を書くための作り方」の記述方法を定義します。
|
|
13
13
|
|
|
14
14
|
## 1. 適用範囲
|
|
15
15
|
|
|
16
|
-
- 対象: `docs/ja/specdojo/recipes/`
|
|
16
|
+
- 対象: `docs/ja/specdojo/recipes/` 直下と `docs/ja/specdojo/recipes/<authority>/` 配下のすべての `*-recipe.md`
|
|
17
17
|
- 目的: recipe の章構成・記述品質を統一し、書き手が良い内容を再現可能に作成できるようにする
|
|
18
|
-
- 成果物構造の正本: 対応する `docs/ja/specdojo/rulebooks/`
|
|
18
|
+
- 成果物構造の正本: 対応する `docs/ja/specdojo/rulebooks/` 直下または `docs/ja/specdojo/rulebooks/<authority>/` 配下の 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)
|
|
@@ -9,11 +9,11 @@ specdojo:
|
|
|
9
9
|
|
|
10
10
|
Rulebook Authoring Standard
|
|
11
11
|
|
|
12
|
-
`docs/ja/specdojo/rulebooks/`
|
|
12
|
+
`docs/ja/specdojo/rulebooks/` 直下と `docs/ja/specdojo/rulebooks/<authority>/` 配下の各 `*-rulebook.md` が従うべき章立て・記述ルール・Frontmatter 規約・禁止事項・運用ルールを定義します。Frontmatter の共通原則は [document-metadata-standard.md](document-metadata-standard.md) に従い、機械検証は参照スキーマに従います。
|
|
13
13
|
|
|
14
14
|
## 1. 適用範囲
|
|
15
15
|
|
|
16
|
-
- 対象: `docs/ja/specdojo/rulebooks/`
|
|
16
|
+
- 対象: `docs/ja/specdojo/rulebooks/` 直下と `docs/ja/specdojo/rulebooks/<authority>/` 配下のすべての `*-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)
|
|
@@ -9,13 +9,13 @@ specdojo:
|
|
|
9
9
|
|
|
10
10
|
Sample Authoring Standard
|
|
11
11
|
|
|
12
|
-
`docs/ja/specdojo/samples/`
|
|
12
|
+
`docs/ja/specdojo/samples/` 直下と `docs/ja/specdojo/samples/<authority>/` 配下の各 `*-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/`
|
|
16
|
+
- 対象: `docs/ja/specdojo/samples/` 直下と `docs/ja/specdojo/samples/<authority>/` 配下のすべての `*-sample.(md|yaml|json)`
|
|
17
17
|
- 目的: sample の構成・記述品質を統一し、粒度・文体・表の書き方を確認できる完成最小例を提供する
|
|
18
|
-
- 一次根拠: 対応する `docs/ja/specdojo/rulebooks/`
|
|
18
|
+
- 一次根拠: 対応する `docs/ja/specdojo/rulebooks/` 直下または `docs/ja/specdojo/rulebooks/<authority>/` 配下の 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/`
|
|
96
|
+
人物名はこの共通人物台帳と物語文書だけで管理し、`docs/ja/specdojo/samples/` 直下または `docs/ja/specdojo/samples/<authority>/` 配下の 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/`
|
|
12
|
+
`docs/ja/specdojo/templates/` 直下と `docs/ja/specdojo/templates/<authority>/` 配下の成果物テンプレートが従うべき構成・プレースホルダ規約・禁止事項・運用ルールを定義します。プレースホルダを埋めた結果が満たすべき Frontmatter 規約は [document-metadata-standard.md](document-metadata-standard.md) を正本とし、本書では雛形側の記述方法を定義します。
|
|
13
13
|
|
|
14
14
|
## 1. 適用範囲
|
|
15
15
|
|
|
16
|
-
- 対象: `docs/ja/specdojo/templates/`
|
|
16
|
+
- 対象: `docs/ja/specdojo/templates/` 直下と `docs/ja/specdojo/templates/<authority>/` 配下のすべての成果物テンプレート `*-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/specdojo/rulebooks/<authority>/` 配下の 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)
|
|
@@ -113,9 +113,10 @@ properties:
|
|
|
113
113
|
Doc ids of the documents this task targets. Existing documents are resolvable via the
|
|
114
114
|
doc index. For deliverable work, the first entry is the target deliverable and subsequent
|
|
115
115
|
entries are reference materials the approach may modify or confirm. For *-authoring
|
|
116
|
-
register tasks, the
|
|
117
|
-
|
|
118
|
-
|
|
116
|
+
register tasks, the entry is an intentionally not-yet-existing kata id; read-only
|
|
117
|
+
exemplars are carried in the register item's sources and rendered as paths in the plan
|
|
118
|
+
body. Plans created before sources was introduced may retain exemplar doc ids after the
|
|
119
|
+
first target. Unresolvable reference materials are omitted.
|
|
119
120
|
|
|
120
121
|
paths:
|
|
121
122
|
type: array
|
|
@@ -139,6 +139,6 @@ properties:
|
|
|
139
139
|
minLength: 1
|
|
140
140
|
minItems: 1
|
|
141
141
|
description: >
|
|
142
|
-
Doc ids of the documents this task targets, carried with the same rules as the
|
|
143
|
-
|
|
144
|
-
|
|
142
|
+
Doc ids of the documents this task targets, carried with the same rules as the plan
|
|
143
|
+
frontmatter targets. Authoring results carry the new kata id; read-only exemplar sources
|
|
144
|
+
are described in the plan body instead of becoming change-coverage targets.
|
|
@@ -70,6 +70,21 @@ properties:
|
|
|
70
70
|
targets:
|
|
71
71
|
type: array
|
|
72
72
|
maxItems: 1
|
|
73
|
+
- if:
|
|
74
|
+
required:
|
|
75
|
+
- sources
|
|
76
|
+
properties:
|
|
77
|
+
sources: true
|
|
78
|
+
then:
|
|
79
|
+
required:
|
|
80
|
+
- approach
|
|
81
|
+
properties:
|
|
82
|
+
approach:
|
|
83
|
+
enum:
|
|
84
|
+
- rulebook-authoring
|
|
85
|
+
- recipe-authoring
|
|
86
|
+
- sample-authoring
|
|
87
|
+
- template-authoring
|
|
73
88
|
- type: object
|
|
74
89
|
required:
|
|
75
90
|
- rulebook
|
|
@@ -199,9 +214,9 @@ properties:
|
|
|
199
214
|
approach:
|
|
200
215
|
$ref: "#/$defs/Approach"
|
|
201
216
|
description: >
|
|
202
|
-
Execution approach. Authoring approaches use the
|
|
203
|
-
|
|
204
|
-
compatible document id.
|
|
217
|
+
Execution approach. Authoring approaches use the target as the new kata id and
|
|
218
|
+
sources as read-only exemplars. For compatibility, additional targets are also
|
|
219
|
+
accepted as exemplar sources. Other approaches require one compatible document id.
|
|
205
220
|
|
|
206
221
|
targets:
|
|
207
222
|
type: array
|
|
@@ -218,6 +233,19 @@ properties:
|
|
|
218
233
|
coverage validation works for register-originated plans. Omit the
|
|
219
234
|
key when the target documents are unknown or not applicable.
|
|
220
235
|
|
|
236
|
+
sources:
|
|
237
|
+
type: array
|
|
238
|
+
items:
|
|
239
|
+
type: string
|
|
240
|
+
minLength: 1
|
|
241
|
+
minItems: 1
|
|
242
|
+
uniqueItems: true
|
|
243
|
+
description: >
|
|
244
|
+
Read-only exemplars for a kata authoring approach. Each value is a document id, a
|
|
245
|
+
project-repository-relative path, or <repo>:<path> for a repository declared in
|
|
246
|
+
projects.<id>.repos. Paths may name files, directories, or glob patterns. Omit the
|
|
247
|
+
key when the authoring task has no exemplar.
|
|
248
|
+
|
|
221
249
|
$defs:
|
|
222
250
|
ItemType:
|
|
223
251
|
type: string
|