specdojo 0.5.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/.github/agents/specdojo-orchestrator.md +2 -0
- package/CHANGELOG.md +100 -0
- package/README.md +2 -2
- package/dist/catalog/generate.js +144 -13
- package/dist/commands/agent.js +33 -0
- package/dist/commands/init.js +2 -0
- package/dist/commands/orchestrator.js +10 -1
- package/dist/deliverable/deliverable.js +77 -4
- 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/core.js +1 -0
- package/dist/exec/parent-validation.js +14 -0
- package/dist/exec/plan-markdownlint.js +89 -0
- package/dist/exec/plans-core.js +46 -1
- package/dist/exec/plans-generation.js +45 -5
- package/dist/exec/plans-planning.js +1 -1
- package/dist/exec/plans-storage.js +1 -0
- package/dist/exec/product-branch-records.js +105 -0
- package/dist/exec/product-branches.js +52 -0
- package/dist/exec/register-product-message.js +50 -0
- package/dist/exec/register-resume.js +28 -0
- package/dist/exec/register.js +6 -0
- package/dist/exec/repo-integration-sync.js +4 -2
- package/dist/exec/repo-integration.js +41 -4
- package/dist/exec/repo-trace.js +2 -0
- package/dist/exec/results.js +9 -5
- package/dist/exec/run/lifecycle-commands.js +85 -16
- package/dist/exec/run/register-command.js +22 -0
- package/dist/exec/run/register-resume.js +11 -1
- package/dist/exec/run/register-worktree.js +29 -8
- package/dist/exec/run/schedule-mode.js +22 -2
- package/dist/exec/run/schedule-prepare.js +49 -4
- package/dist/exec/run/schedule-task.js +3 -0
- package/dist/exec/strategy.js +2 -1
- package/dist/exec/task-repos.js +78 -16
- package/dist/exec/worktree-command.js +2 -2
- package/dist/exec/worktree-ops-commit.js +1 -13
- package/dist/exec/worktree-ops-lifecycle.js +40 -36
- package/dist/exec/worktree.js +3 -3
- package/dist/register/core.js +5 -0
- package/dist/register/create-commands.js +54 -2
- package/dist/register/deliverable-target.js +24 -17
- package/dist/register/event-merge.js +4 -0
- package/dist/register/events.js +6 -0
- package/dist/register/external-project.js +2 -0
- package/dist/register/input.js +168 -0
- package/dist/register/item.js +61 -0
- package/dist/register/register.js +33 -25
- package/dist/register/renumber.js +4 -0
- package/dist/register/update.js +6 -0
- package/dist/schedule/approach.js +9 -0
- package/dist/schedule/strategy-profiles.js +22 -2
- package/dist/shared/agent-types.js +4 -1
- package/dist/shared/branch-template.js +26 -0
- package/dist/shared/commit-message-template.js +38 -0
- package/dist/shared/commit-types.js +15 -0
- package/dist/shared/git.js +7 -0
- package/dist/shared/provider-scaffold.js +2 -0
- package/dist/shared/specdojo-config.js +35 -4
- package/dist/shared/specdojo-gitignore.js +1 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +2 -0
- package/docs/ja/specdojo/exec-templates/xep-draft-template.md +93 -0
- package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +9 -2
- package/docs/ja/specdojo/exec-templates/xep-register-investigate-template.md +2 -0
- package/docs/ja/specdojo/exec-templates/xep-register-template.md +2 -0
- package/docs/ja/specdojo/exec-templates/xer-human-bootstrap-finalize-template.md +2 -0
- package/docs/ja/specdojo/exec-templates/xer-human-draft-template.md +23 -0
- package/docs/ja/specdojo/exec-templates/xer-human-finalize-template.md +2 -0
- package/docs/ja/specdojo/exec-templates/xrp-fully-guided-template.md +7 -4
- package/docs/ja/specdojo/guides/docs-editing-guide.md +36 -0
- package/docs/ja/specdojo/guides/exec-config-guide.md +16 -12
- package/docs/ja/specdojo/guides/exec-operation-guide.md +116 -10
- 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 +16 -1
- package/docs/ja/specdojo/guides/remote-host-development-guide.md +31 -4
- package/docs/ja/specdojo/guides/ryu-guide.md +114 -23
- package/docs/ja/specdojo/guides/schedule-design-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/recipes/exec-human-finalize-recipe.md +1 -0
- package/docs/ja/specdojo/recipes/tsd-recipe.md +20 -12
- package/docs/ja/specdojo/references/command-reference.md +111 -46
- package/docs/ja/specdojo/references/specdojo-config-reference.md +69 -8
- 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/rulebooks/dct-rulebook.md +8 -0
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +4 -0
- package/docs/ja/specdojo/rulebooks/sch-rulebook.md +3 -1
- 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/samples/dct-sample.yaml +5 -1
- package/docs/ja/specdojo/standards/document-metadata-standard.md +16 -0
- package/docs/ja/specdojo/standards/exec-human-finalize-standard.md +1 -0
- package/docs/ja/specdojo/standards/guide-authoring-standard.md +2 -1
- package/docs/ja/specdojo/standards/philosophy-authoring-standard.md +1 -0
- package/docs/ja/specdojo/standards/recipe-authoring-standard.md +2 -1
- package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +2 -1
- package/docs/ja/specdojo/standards/standard-authoring-standard.md +2 -1
- package/docs/ja/specdojo/templates/cdfd-overview-template.md +161 -83
- package/docs/ja/specdojo/templates/cdfd-uc-template.md +127 -90
- package/docs/ja/specdojo/templates/pjr-change-request-template.md +10 -4
- package/docs/ja/specdojo/templates/pjr-issue-template.md +10 -4
- package/docs/ja/specdojo/templates/pjr-question-template.md +11 -5
- package/docs/ja/specdojo/templates/pjr-risk-template.md +10 -4
- package/docs/ja/specdojo/templates/pjr-todo-template.md +10 -4
- package/docs/specdojo/schemas/v1/dct.schema.yaml +9 -0
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +2 -1
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +2 -0
- package/docs/specdojo/schemas/v1/register-events.schema.yaml +3 -0
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +35 -0
- package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +1 -0
- package/docs/specdojo/schemas/v1/specdojo-config.schema.yaml +41 -2
- package/package.json +6 -2
- package/templates/antigravity/README.md +19 -46
- package/templates/antigravity/exec-defaults-snippet.yaml +5 -6
- package/templates/antigravity/orchestrator.md +2 -0
- 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/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/devcontainer/remote-host/devcontainer-tmux.sh +217 -0
- package/templates/devcontainer/remote-host/specdojo-tmux.sh.sample +8 -90
- 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
- package/templates/opencode/agents/specdojo-orchestrator.md +2 -0
|
@@ -10,6 +10,7 @@ specdojo:
|
|
|
10
10
|
template: specdojo:cdfd-uc-template
|
|
11
11
|
includes:
|
|
12
12
|
- specdojo:cdfd-mermaid-rulebook
|
|
13
|
+
- specdojo:cdfd-d2-rulebook
|
|
13
14
|
based_on:
|
|
14
15
|
- specdojo:rulebook-authoring-standard
|
|
15
16
|
---
|
|
@@ -18,155 +19,159 @@ specdojo:
|
|
|
18
19
|
|
|
19
20
|
Conceptual Data Flow Diagram Use Case Documentation Rulebook
|
|
20
21
|
|
|
21
|
-
|
|
22
|
+
全体概要で選定した一つのユースケースまたは系統について、開始から終了までの流れと、受け渡す情報・物を表と概念データフロー図(Mermaid または D2)で示すためのルールです。状態の定義と遷移は STSD を正本とします。
|
|
22
23
|
|
|
23
24
|
## 1. 全体方針
|
|
24
25
|
|
|
25
|
-
- 一文書は、全体概要の「詳細 CDFD 一覧」にある一つのケース ID
|
|
26
|
-
-
|
|
27
|
-
-
|
|
28
|
-
-
|
|
29
|
-
-
|
|
30
|
-
-
|
|
26
|
+
- 一文書は、全体概要の「詳細 CDFD 一覧」にある一つのケース ID と、そのユースケースまたは系統を詳細化します。描く単位と詳細化の境界は「描き方の選択」に従います。
|
|
27
|
+
- 「プロセス領域」は順序と責務の正本、「データストア」は全体概要の一覧の部分集合、図は開始から終了までの順序と受け渡しの正本とします。主要入力・主要出力の箇条書きや、引き渡しを列挙する章は設けません。
|
|
28
|
+
- 渡す情報・物は図の線のラベルで表します。引き渡し条件のイベントや引き渡し ID は使いません。業務上重要な戻りの流れだけ、任意の図で示します。
|
|
29
|
+
- 詳細の図に Orchestrator(調整役)を置きません。調整は全体概要の「Orchestrator による PDCA の調整」などの指示の図へ委ねます。
|
|
30
|
+
- 目的はその業務が何のためにあるかを 1〜2 文、適用範囲は対象と対象外を 1 行ずつとします。人間と AI Agent の責任分担などの共通原則と凡例は、全体概要を参照し、本書で再定義しません。
|
|
31
|
+
- 状態名・成立条件・遷移元・遷移先・イベント・遷移条件は STSD を正本とします。本書は状態の定義や遷移表を持ちません。
|
|
31
32
|
|
|
32
33
|
## 2. 位置づけと用語定義
|
|
33
34
|
|
|
34
|
-
| 用語
|
|
35
|
-
|
|
|
36
|
-
| 全体概要
|
|
37
|
-
|
|
|
38
|
-
|
|
|
39
|
-
|
|
|
40
|
-
|
|
|
41
|
-
| 戻す条件 | 引き渡し条件の不成立または受け側で判明した不足により、情報や判断を送り元または先行グループへ返す条件 |
|
|
42
|
-
| 例外時の戻り先 | 条件不成立時に補完・再判断を担い、再開条件を成立させるプロセスグループ |
|
|
43
|
-
| 関連データストア | 引き渡し条件の判定または引き渡す情報の正本として必要な、全体概要と同じ名称・区分を持つデータストア |
|
|
44
|
-
| グループ内部 | `cdfd-<group>` が正本とする、領域、個別プロセス、プロセス入出力、主要例外、データストアの具体的な読み書き |
|
|
35
|
+
| 用語 | 定義 |
|
|
36
|
+
| ---------------- | -------------------------------------------------------------------------- |
|
|
37
|
+
| 全体概要 | 領域のまとまり、データストア、詳細 CDFD の割り当てを定める `cdfd-overview` |
|
|
38
|
+
| ケース ID | 全体概要でユースケースまたは系統に割り当てられた `C-<nn>` 形式の識別子 |
|
|
39
|
+
| 起点イベント | 業務を始める、発生を判定できる出来事 |
|
|
40
|
+
| 関連データストア | 対象ケースで参照・更新する、全体概要と同じ名称・区分を持つ正本 |
|
|
41
|
+
| 例外時の戻り | 不足や不一致を、補完・再判断を担う参加単位へ返す業務上の流れ |
|
|
45
42
|
|
|
46
|
-
|
|
43
|
+
全体概要がケースの業務目的と対象範囲を選定し、本書がその流れを具体化します。領域の分割、名称、担当、起点イベントは全体概要を正本とします。
|
|
47
44
|
|
|
48
45
|
## 3. ファイル命名・ID規則
|
|
49
46
|
|
|
50
47
|
- 対象プロダクトの業務仕様配下にあるデータフローディレクトリへ配置します。
|
|
51
|
-
- ファイル名と成果物 ID は `cdfd-uc-<topic>` とし、ファイル名だけ `.md` を付けます。`<topic>`
|
|
48
|
+
- ファイル名と成果物 ID は `cdfd-uc-<topic>` とし、ファイル名だけ `.md` を付けます。`<topic>` は全体概要のユースケースまたは系統を表す英小文字・数字・ハイフンのスラッグです。
|
|
52
49
|
- product 成果物の ID にプロジェクト ID や authority を付けません。例: ファイル名 `cdfd-uc-replenishment.md`、ID `cdfd-uc-replenishment`。
|
|
53
|
-
- ケース ID は全体概要の `C-<nn>`
|
|
54
|
-
-
|
|
55
|
-
- プロセスグループ名、領域 ID、データストア名は全体概要と一致させます。プロセスグループ別 CDFD の参照先は `cdfd-<group>` 形式とします。
|
|
50
|
+
- ケース ID は全体概要の `C-<nn>` を引き継ぎ、新しい ID の採番や別ケースの ID の流用はしません。
|
|
51
|
+
- 領域 ID、プロセスグループ名・区分名、データストア名は全体概要と一致させます。図を分けても同じ対象に同じ ID・名称を使い、接続のための独自 ID は付けません。
|
|
56
52
|
|
|
57
53
|
## 4. 推奨 Frontmatter 項目
|
|
58
54
|
|
|
59
|
-
| 項目 | 説明
|
|
60
|
-
| ---------- |
|
|
61
|
-
| id | プロジェクト修飾なしの `cdfd-uc-<topic>`
|
|
62
|
-
| type | `flow`
|
|
63
|
-
| status | `draft` / `ready` / `deprecated`
|
|
64
|
-
| rulebook | `specdojo:cdfd-uc-rulebook`
|
|
65
|
-
| based_on
|
|
66
|
-
| supersedes | 置き換える旧ユースケース別 CDFD の ID
|
|
55
|
+
| 項目 | 説明 | 必須 |
|
|
56
|
+
| ---------- | ---------------------------------------- | ---- |
|
|
57
|
+
| id | プロジェクト修飾なしの `cdfd-uc-<topic>` | ○ |
|
|
58
|
+
| type | `flow` | ○ |
|
|
59
|
+
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
60
|
+
| rulebook | `specdojo:cdfd-uc-rulebook` | ○ |
|
|
61
|
+
| `based_on` | 全体概要など、有効な直接の内容根拠の ID | 任意 |
|
|
62
|
+
| supersedes | 置き換える旧ユースケース別 CDFD の ID | 任意 |
|
|
67
63
|
|
|
68
64
|
- `based_on` に全体概要を記載する場合も product 成果物 ID を使用し、成果物カタログの `depends_on` の推移閉包に含まれる根拠だけを列挙します。
|
|
69
|
-
-
|
|
65
|
+
- status が `deprecated` の文書を `based_on` と本文の参照先にしません。有効な全体概要や後継文書へ参照を更新します。
|
|
66
|
+
- ケース ID、ユースケース名、開始・終了は本文で定義し、未定義の Frontmatter 項目を追加しません。
|
|
70
67
|
- 作成途中の `status` は `draft` とし、完成判定と所定の承認を満たした後の昇格は定められた承認者が行います。
|
|
71
68
|
|
|
72
69
|
## 5. 本文要件
|
|
73
70
|
|
|
74
71
|
見出し順・表・記入欄の骨組みは template を正本とします。本章は各章の目的と必須・任意を定めます。
|
|
75
72
|
|
|
76
|
-
| 番号 | 見出し | 必須 | 内容
|
|
77
|
-
| ---- | ---------------- | -------- |
|
|
78
|
-
| 冒頭 | 導入文 | ○ | ケース ID
|
|
79
|
-
| 1 | 目的 | ○ |
|
|
80
|
-
| 2 | 適用範囲 | ○ |
|
|
81
|
-
| 3 | プロセス領域 | ○ |
|
|
82
|
-
| 4 | データストア | ○ |
|
|
83
|
-
| 5 | 概念データフロー | ○ |
|
|
84
|
-
| 6 |
|
|
85
|
-
| 7 | 例外時の戻り先 | ○ | 対象引き渡し、条件不成立、戻り先グループ、戻す情報、再開条件 |
|
|
86
|
-
| 8 | 未決事項 | 条件付き | 横断境界、引き渡し条件、戻り先、判断者が未確定な論点。未決事項がある場合だけ設ける |
|
|
73
|
+
| 番号 | 見出し | 必須 | 内容 |
|
|
74
|
+
| ---- | ---------------- | -------- | ----------------------------------------------------------------------------------------------------- |
|
|
75
|
+
| 冒頭 | 導入文 | ○ | ケース ID とユースケースまたは系統を一文で定義 |
|
|
76
|
+
| 1 | 目的 | ○ | その業務が何のためにあるか、開始からどの成果までを成立させるか(1〜2 文) |
|
|
77
|
+
| 2 | 適用範囲 | ○ | 対象と対象外を 1 行ずつ。責任分担などの共通原則は全体概要を参照 |
|
|
78
|
+
| 3 | プロセス領域 | ○ | 全体概要と同じまとまりごとの節。各節は順序と役割の表のみ |
|
|
79
|
+
| 4 | データストア | ○ | 対象ケースで参照・更新する全体概要のデータストアの部分集合 |
|
|
80
|
+
| 5 | 概念データフロー | ○ | 開始・終了のイベント、参加単位、関連データストア、情報・物の流れ。各図に業務の言葉による題と説明 1 文 |
|
|
81
|
+
| 6 | 未決事項 | 条件付き | 境界、名称、責務、判断者が未確定な論点。ある場合だけ最終章に設ける |
|
|
87
82
|
|
|
88
|
-
|
|
83
|
+
「引き渡し」「例外時の戻り先」の章は設けません。図を分ける場合は「概念データフロー」に `5.1.`、`5.2.` の節を設けます。「例外時の戻り」は業務上重要な場合だけ同章内に追加できる任意の図であり、必須の章や表にしません。
|
|
89
84
|
|
|
90
85
|
## 6. 記述ガイド
|
|
91
86
|
|
|
92
|
-
### 6.1.
|
|
87
|
+
### 6.1. 描き方の選択
|
|
93
88
|
|
|
94
|
-
|
|
95
|
-
- 目的は、誰が横断順序を承認し、誰がグループ間の入出力を設計へ使い、誰が重複・欠落を確認するかを利用結果と結び付けます。
|
|
96
|
-
- 上位の業務目的を長く書き写さず、グループ境界の合意によって防ぐ欠落や手戻りを示します。
|
|
89
|
+
全体概要で採用された方式から、次のどちらかを選びます。以下では、表の一行と図の一つのプロセスノードが表す対象を「参加単位」と呼びます。
|
|
97
90
|
|
|
98
|
-
|
|
91
|
+
| 観点 | 通常の横断ユースケース | 系統の関係を描く方式の詳細 |
|
|
92
|
+
| ------------ | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
|
93
|
+
| 対象 | 二つ以上のプロセスグループを横断する一つの業務。単一グループに閉じる業務には作成しない | 全体概要で選定した一つの系統と、通過する共用領域 |
|
|
94
|
+
| 参加単位 | 一つのプロセスグループを一つの代表ノードにし、名称と含む領域 ID を併記 | 一つのプロセス領域を一つのノードにし、`P-xx 領域名` を表示 |
|
|
95
|
+
| 表のまとまり | 全体概要のプロセスグループごと | 全体概要の区分ごと。PDCA の段階で区分を置き換えない |
|
|
96
|
+
| 詳細化の境界 | グループ内部の領域・プロセス・主要例外は有効な `cdfd-<group>` へ委ねる | 対象系統と共用領域の流れを領域単位で示し、非推奨のグループ別 CDFD へ依存しない |
|
|
97
|
+
| 入口 | ケースの開始イベントを描く | 系統の入口の起点イベントを描き、文言を全体概要の「プロセス領域」の表と一致させる |
|
|
99
98
|
|
|
100
|
-
|
|
101
|
-
- 開始イベントは最初のグループが動き始める出来事、終了条件は最後のグループが受け取った成果を利用可能と判断できる状態として記述します。
|
|
102
|
-
- 対象外には、グループ内部の領域・プロセス・主要例外、補助操作、実装詳細、状態の定義・遷移を明記し、対応する `cdfd-<group>` と STSD へ委ねます。
|
|
103
|
-
- 人間と AI Agent の責任分担は本文で再定義せず、対応する方針文書を参照します。参照先がない場合は、人間が承認と最終判断を担う原則だけを記載します。
|
|
99
|
+
### 6.2. 導入文と目的
|
|
104
100
|
|
|
105
|
-
|
|
101
|
+
- 導入文は「ケース `C-02` の欠品から補充まで」のように、ケース ID と業務名を明示します。
|
|
102
|
+
- 目的は、そのユースケースまたは系統が何のためにあるかを 1〜2 文で記述します。例: 「欠品した商品を補充し、売場で販売できるようにするために、在庫の補充判断から仕入・販売への流れを示す。」
|
|
103
|
+
- BA・QE・承認者など、読み手ごとの承認・設計・確認作業を目的に書きません。
|
|
106
104
|
|
|
107
|
-
|
|
108
|
-
- 正常系で通過するプロセスグループごとに節(`3.1.`、`3.2.`、…)を設け、見出しは「グループ名(含む領域 ID の範囲)」とします。同じグループが正常系で再登場する場合は別の節とし、その理由を説明します。
|
|
109
|
-
- 各節は、そのグループが前段から何を受け取り次段へ何を渡すかを示す 1〜3 文の説明、`**主要入力**`・`**主要出力**`・`**データストア**` の箇条書き、横断上の役割を示す表の順で構成します。
|
|
110
|
-
- 表は「順序」「プロセスグループ」「含む領域」「横断上の役割」「参照先」の 5 列とし、一節に一行を記載します。グループ名と領域 ID は全体概要から引き継ぎ、参照先は `cdfd-<group>` 形式とします。
|
|
111
|
-
- 内部プロセス、内部例外、担当は書き写しません。未作成の参照先も安定した ID をバッククォートで示し、作成状況は登録簿で追跡します。
|
|
105
|
+
### 6.3. 適用範囲
|
|
112
106
|
|
|
113
|
-
|
|
107
|
+
- 対象はケース ID、参加単位、開始イベント、終了時の成果、必要な組織・システム境界を 1 行(1 文)で示します。
|
|
108
|
+
- 対象外は操作手順、補助操作、実装詳細などを 1 行(1 文)で示し、詳細化の境界は「描き方の選択」に従います。状態の定義と遷移は STSD を正本とします。
|
|
109
|
+
- 人間と AI Agent の責任分担などの共通原則は、全体概要を参照します。
|
|
114
110
|
|
|
115
|
-
|
|
116
|
-
- 表の列は「データストア」「関連引き渡し」「横断上の利用」とします。関連引き渡しには `H-<nn>` を記載し、どの情報または条件の正本かを利用内容で説明します。
|
|
117
|
-
- 名称と区分は全体概要から変更しません。新しいデータストアまたは区分変更が必要なら先に全体概要を変更し、本章だけへ追加しません。
|
|
118
|
-
- 各行は概念データフローの同名ノードに対応させます。図に置かないデータストアや、本章に行のないデータストアノードを残しません。
|
|
111
|
+
### 6.4. プロセス領域
|
|
119
112
|
|
|
120
|
-
|
|
113
|
+
- 章冒頭にケース ID、正常系の通過順、全体概要との正本関係を簡潔に示します。
|
|
114
|
+
- 全体概要と同じまとまりごとに節(`3.1.`、`3.2.`、…)を設け、見出しは「グループ名または区分名(含む領域 ID)」とします。各節には役割の表だけを置き、入力・出力やデータストアの箇条書きは置きません。
|
|
115
|
+
- 表の列は次のとおりです。同じ参加単位が再登場する場合は別の行にして役割を区別します。
|
|
121
116
|
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
117
|
+
| 列 | 記載内容 |
|
|
118
|
+
| ---------------------- | ---------------------------------------------------------------------------------------------------- |
|
|
119
|
+
| 順序 | 正常系で通過する順番 |
|
|
120
|
+
| プロセスグループ・区分 | 全体概要で領域をまとめている名称 |
|
|
121
|
+
| 含む領域 | 全体概要と同じ領域 ID。領域単位の行では領域名も併記し、「プロセス領域」という列名にしてよい |
|
|
122
|
+
| PDCA(任意) | 全体概要にある Plan、Do、Check、Action、全体などの位置付け。「プロセスグループ・区分」とは別の分類軸 |
|
|
123
|
+
| 横断上の役割 | このケースで担う業務上の責務 |
|
|
124
|
+
| 参照先 | 全体概要または有効な詳細文書。未作成の文書は ID をインラインコードで仮置き |
|
|
128
125
|
|
|
129
|
-
### 6.
|
|
126
|
+
### 6.5. データストア
|
|
130
127
|
|
|
131
|
-
-
|
|
132
|
-
-
|
|
133
|
-
-
|
|
134
|
-
- 戻す条件は、どの不足または不一致で受け側が開始できないかを示します。戻しが発生しない引き渡しは、その根拠を記載し、空欄にしません。
|
|
128
|
+
- 全体概要と同じ「マスタ・構成データ」「トランザクションデータ」の節に分け、対象ケースで参照・更新する行だけを同じ名称・区分で示します。該当行がない区分は節ごと省略します。
|
|
129
|
+
- 表は「データストア」「関連する参加単位」「横断上の利用」の列とします。関連は参加単位の名称または領域 ID で示します。
|
|
130
|
+
- 各行を図の同名ノードへ対応させます。物理保管は全体概要の区分に従い、保管先の詳細や物理項目へ展開しません。
|
|
135
131
|
|
|
136
|
-
### 6.
|
|
132
|
+
### 6.6. 概念データフロー
|
|
137
133
|
|
|
138
|
-
-
|
|
139
|
-
-
|
|
140
|
-
-
|
|
141
|
-
-
|
|
134
|
+
- ノード、線種、色、絵文字は全体概要の「凡例(本プロダクト共通)」で選択された記法ルール([[specdojo:cdfd-mermaid-rulebook|Mermaid 記法ルール]] または [[specdojo:cdfd-d2-rulebook|D2 記法ルール]])に従います。記法の宣言がなければ Mermaid とし、sample と template は D2 の例とします。参加単位・方向・イベントの要件が記法部品と異なる場合は本書を優先し、Mermaid も `flowchart TB` で縦に描きます。
|
|
135
|
+
- 正常系を上から下へ並べます。D2 は `direction: down` とし、戻りの線は上にあるノードを左辺にした `a <- b` で書きます。
|
|
136
|
+
- プロセスノードを役割表の行へ対応させ、通常の流れ全体を通して開始イベントと終了の出来事を描きます。分割図や戻りの図へ開始・終了を再掲する必要はありません。イベントは一つのノードに一つの出来事とし、発生を判定できる短い文にします。長い場合は改行し、原文を言い換えません。全体概要の起点イベントが複数の出来事を列挙している場合は、各出来事の文言を保ってノードを分けます。
|
|
137
|
+
- 参加単位どうし、または参加単位とデータストアを直接結び、渡す情報・物を名詞のラベルにします。必要な承認は「承認済みの補充依頼」のように成果の性質として表し、引き渡し条件を判定するイベントは置きません。
|
|
138
|
+
- Orchestrator とその調整要求・応答は描かず、全体概要の指示の図を参照します。対象範囲内の担当ロールを外部主体として追加しません。
|
|
139
|
+
- 図の題は「欠品から売場補充まで」「起票から完了記録まで」のように業務の言葉で付けます。説明は、その図から読み取れる流れや関係を 1 文で書きます。凡例への参照は別の短い注記にし、凡例を再定義しません。
|
|
140
|
+
- 一図で追いにくい場合は連続する業務の範囲で分け、接続する参加単位・データストアを同じ ID・名称で再掲します。図ごとに省略事項と共有ノードを短く注記します。
|
|
141
|
+
|
|
142
|
+
### 6.7. 例外時の戻りの図(任意)
|
|
143
|
+
|
|
144
|
+
- 不足や不一致を先行する参加単位へ返すことが業務上重要な場合だけ、「概念データフロー」に「例外時の戻り」の図を追加できます。すべての受け渡しを網羅する表は作りません。
|
|
145
|
+
- 補完・再判断を担う参加単位へ戻る線に「不足項目」「記録と受入品の差異」などの戻す情報を付けます。通常の図と同じ名称・領域 ID を使います。
|
|
146
|
+
- 再提示を示す場合も「修正・承認済みの補充依頼」のような情報の線で表し、戻す条件・再開条件の列や条件イベントは設けません。内部の再試行、ログ、操作手順は描きません。
|
|
142
147
|
|
|
143
148
|
### 6.8. 未決事項
|
|
144
149
|
|
|
145
|
-
-
|
|
146
|
-
-
|
|
147
|
-
- 調査で埋める不足は `_TODO_`、意思決定待ちは `_UNDECIDED_`、仮置きする前提は `_ASSUMPTION_` として区別します。
|
|
150
|
+
- 境界、名称、責務、判断者のいずれかが未確定な場合だけ設け、ない場合は章ごと省略します。
|
|
151
|
+
- 表は「論点」「影響するケース・参加単位」「決定者」「決定時期」の 4 列とし、本文中の `_UNDECIDED_` と対応させます。
|
|
148
152
|
|
|
149
153
|
### 6.9. 完成判定
|
|
150
154
|
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
-
|
|
154
|
-
-
|
|
155
|
-
-
|
|
156
|
-
-
|
|
157
|
-
-
|
|
158
|
-
-
|
|
159
|
-
-
|
|
155
|
+
本節だけを `ready` 昇格のチェックリストの正本とします。次の全項目を満たす必要があります。
|
|
156
|
+
|
|
157
|
+
- ケース ID、業務名、目的、対象範囲、領域 ID・名称が全体概要と一致し、「描き方の選択」で決めた参加単位と詳細化の境界を守っています。
|
|
158
|
+
- 「目的」が業務の存在理由・成果を 1〜2 文で示し、読み手の役割を含みません。「適用範囲」は対象と対象外が 1 行ずつで、共通原則は全体概要を参照しています。
|
|
159
|
+
- 「プロセス領域」の各節は役割表だけで構成され、全体概要のグループ・区分と一致しています。PDCA の値を示す場合は独立した任意の列にしています。
|
|
160
|
+
- 正常系の全参加単位が表と図で同じ順序・名称・領域 ID に対応し、開始から終了まで上から下へ追えます。開始・終了のイベントは一ノード一出来事の短い文で、入口の文言は選んだ方式の規定に従っています。
|
|
161
|
+
- 渡す情報・物を線のラベルから読み取れ、引き渡し ID や条件のイベント、「引き渡し」「例外時の戻り先」の章がありません。
|
|
162
|
+
- Orchestrator は図に含まれず、その調整は全体概要の指示の図へ委ねられています。
|
|
163
|
+
- 図には業務の言葉による題と、読み取れることを示す説明 1 文があり、凡例は全体概要を参照しています。図を分けた場合も共有ノードと接続が追えます。
|
|
164
|
+
- 関連データストアは全体概要と同じ名称・区分で、表の各行と図のノードが対応しています。
|
|
165
|
+
- 例外時の戻りの図を設けた場合、戻す情報と補完・再判断の責任を持つ参加単位を読み取れます。戻りの図が不要な場合は省略されています。
|
|
166
|
+
- `based_on` と本文に `deprecated` の文書への参照がありません。状態定義・遷移を複製せず、有効な STSD や詳細文書を参照しています。
|
|
160
167
|
|
|
161
168
|
## 7. 禁止事項
|
|
162
169
|
|
|
163
|
-
-
|
|
164
|
-
-
|
|
165
|
-
-
|
|
166
|
-
-
|
|
167
|
-
-
|
|
168
|
-
-
|
|
169
|
-
-
|
|
170
|
-
-
|
|
171
|
-
- 受け側グループ、戻り先グループ、引き渡す情報のいずれかがない矢印や表行を残しません。
|
|
172
|
-
- 作成状況やレビュー状態を成果物本文へ記載せず、登録簿で追跡します。
|
|
170
|
+
- プロセス領域に主要入力・主要出力・データストアの箇条書きを置く、または図をなぞる長文の注記を書く。
|
|
171
|
+
- 詳細 CDFD に独自の凡例を再掲・重複定義する。
|
|
172
|
+
- 全体概要にないケースや領域分割を作る、または「描き方の選択」の粒度・詳細化の境界を越えて内部処理を再掲する。
|
|
173
|
+
- 全体概要と異なるグループ名・区分名・領域 ID・データストア名を使う、または PDCA の値をグループ・区分の列に入れる。
|
|
174
|
+
- 引き渡し ID を採番する、引き渡し条件のイベントを図に置く、引き渡し・戻す条件・再開条件の表を設ける。
|
|
175
|
+
- Orchestrator の調整を詳細の図に複製する、または対象範囲内の担当者を外部主体にする。
|
|
176
|
+
- `deprecated` の文書を `based_on` または本文から参照する。
|
|
177
|
+
- 状態定義・遷移表・状態遷移図を複製する、または物理テーブル、カラム、SQL、実装クラス、詳細 API、画面操作を記載する。
|
|
@@ -129,6 +129,7 @@ YAML 成果物のため、Markdown Frontmatter ではなくファイル先頭の
|
|
|
129
129
|
|
|
130
130
|
| `depends_on` | 任意 | 依存する成果物の `local_id` 配列。なければ空配列 `[]` |
|
|
131
131
|
| `overview` | ○ | 成果物の目的を1文で記述 |
|
|
132
|
+
| `brief` | 任意 | 成果物の外から継続して渡す前提(技術スタックや制約など) |
|
|
132
133
|
| `path` | ○(`work`) | 成果物のファイルパス |
|
|
133
134
|
| `rulebook` | 任意 | rulebook の文書 ID、未判断なら `undecided`、不要なら `not-needed` |
|
|
134
135
|
| `evidence_refs` | 任意 | `retrofit` で読む非成果物エビデンス |
|
|
@@ -269,6 +270,13 @@ YAML 成果物のため、Markdown Frontmatter ではなくファイル先頭の
|
|
|
269
270
|
- 既存カタログとの差分は `--dry-run` で確認する。既存ファイルは既定で保護し、内容が異なる場合の上書きには `--force` を必要とする。同一入力の再実行で内容が同じ場合は書き込まない。
|
|
270
271
|
- 生成されたカタログの `status` は template に従い `draft` のままとする。生成成功を理由に Timeline の `catalog_status` を `primary` へ変更せず、人間の内容確認後に別途更新する。
|
|
271
272
|
|
|
273
|
+
### 6.14. `brief`・`overview`・`done_criteria` の使い分けと YAML アンカー
|
|
274
|
+
|
|
275
|
+
- `overview`: 成果物の目的・責務を 1 文で記述する。カタログの表・一覧(Markdown 表示ページ)に配置され、ドメイン全体の俯瞰や成果物の責務把握に用いる。
|
|
276
|
+
- `brief`: 成果物の外から継続して渡す前提(採用する技術スタック、アーキテクチャ上の制約、設計・選定方針など)を記述する。schedule の task の plan や register 経由の plan に「前提」として展開される。未指定の場合は plan に載せない。
|
|
277
|
+
- `done_criteria`: 成果物が満たすべき完了条件・受入基準を記述する。ロールコード(`roles`)とレビュー観点(`viewpoint`)を紐づけ、客観的に検証可能な形で記載する。前提や指示そのものはここに書かず、成果物が達成した検証可能な振る舞い・状態を記載する。
|
|
278
|
+
- 複数の成果物で前提を共有する場合は、YAML のアンカー(`&anchor`)とエイリアス(`*anchor`)を利用して記述の重複を防ぐ。同一カタログファイル内で共通の前提をアンカー定義し、各成果物の `brief` から参照する。
|
|
279
|
+
|
|
272
280
|
## 7. 禁止事項
|
|
273
281
|
|
|
274
282
|
| 禁止事項 | 理由 |
|
|
@@ -117,6 +117,7 @@ Project Register Documentation Rules
|
|
|
117
117
|
| 末尾 | 関連ドキュメント | ○ | 根拠、影響先、追跡先を文書 ID で示す |
|
|
118
118
|
|
|
119
119
|
- H1 は `PJR-XXXX <タイトル>` 形式とする。
|
|
120
|
+
- 実行対象の `todo`・`issue`・`change-request`・`question`・`risk` の個票は、対話で得た前提・制約・委任範囲を箇条書きで残す `入力` 節を持つ。入力がない場合は `-` とする。完了条件・回答の確定条件とは分ける。既存個票に節がなくても読み込め、初回の入力更新時に節を追加する。
|
|
120
121
|
- `epic` は概要、範囲(track と domain)、完了の判断の基準、子項目、対応結果、関連ドキュメントを持つ。範囲には domain と境界、完了の基準には子項目と schedule を確認する判断条件、対応結果には人が完了を判断した根拠を記録する。
|
|
121
122
|
- 子 todo は `--from <epic-id>` で起票する。`derived_from` を逆引きした epic 別ビューは直接の子を type と状態付きで表示し、子がない epic も表示する。別 project の子は project 修飾 ID で識別する。孫を再帰的に含めず、状態の自動集約や自動 close は行わない。
|
|
122
123
|
- type 固有の構成は `todo` の概要・完了条件・作業内容・対応結果など、各 type 用テンプレートに従う。
|
|
@@ -158,6 +159,9 @@ Project Register Documentation Rules
|
|
|
158
159
|
- カタログなしの `bootstrap` は `target_path`、新しい `target_rulebook`、設定の `kata_authority` を必須とする。既存 rulebook を再利用しない。rulebook の名前部分から recipe・sample・template の ID を導出し、`docs/ja/specdojo/<kind>s/<kata_authority>/` に配置する候補を plan へ示す。成果物には新しい `specdojo.rulebook` を記録する。
|
|
159
160
|
- `finalize`・`bootstrap-finalize` は既存成果物だけを対象にし、カタログなしでは個票の完了条件を確認チェック表にする。後者は成果物と frontmatter から辿る kata 一式を確定対象とする。
|
|
160
161
|
|
|
162
|
+
- 対話で得た前提は `register add --input <text>` で個票本文の `入力` へ記録する。繰り返し指定した順に箇条書きとし、`register update --input` は指定した一覧で置換する。追記する場合は既存分を含めて渡し、`--input -` 単独で全削除する。未指定時は保持する。空文字、削除指定と他の入力の混在、add での削除指定は拒否する。
|
|
163
|
+
- 入力の変更は event の `input` フィールドへ変更前後の JSON 配列として記録し、値がない場合は `-` とする。register 経由の plan は approach の有無を問わず、入力がある場合だけ「個票の入力(前提)」に展開する。入力を完了条件へ転記しない。
|
|
164
|
+
|
|
161
165
|
### 5.2. 構造化フィールドと生成
|
|
162
166
|
|
|
163
167
|
- 新しい項目は `register add` で作成し、個票の Frontmatter に初期値を書き込む。全 type で個票を省略しない。
|
|
@@ -117,8 +117,10 @@ schema で機械検証できない記述規範だけを定める。設計の考
|
|
|
117
117
|
### 5.5. intent と grade からの strategy 生成
|
|
118
118
|
|
|
119
119
|
- `schedule strategy generate --track <track>` は、既存 strategy の `scope.catalogs` と catalog ごとの `local_ids` を優先し、新規 track では Timeline の `domains` から物理分割を含む DCT を解決する。scope は `include_kinds: [work]` 固定とし、既存の `local_ids` がある場合は選択部分集合だけを生成対象にする。
|
|
120
|
-
- `approach_rules` は scope の全 work 成果物を重複なく網羅し、
|
|
120
|
+
- `approach_rules` は scope の全 work 成果物を重複なく網羅し、8 種の intent を成果物別に宣言する。`improve-kata` は `kata_target`、`bootstrap-kata-set` と `confirm-with-kata-set` は `bootstrap_scope` も宣言する。
|
|
121
121
|
- `author-deliverable` の approach は Kata 宣言と保存済み grade から `fully-guided` / `recipe-guided` / `freeform` へ導出する。他の intent は目的別 approach へ一意に写像し、必要な evidence や追加パラメータがなければ生成を停止する。
|
|
122
|
+
- 人が雛形に文脈を記入してから下書きする場合は `draft-with-context` を宣言する。必要な Kata がすべて利用可能な場合だけ `draft` profile を生成し、雛形作成・文脈記入(human)、下書き(`draft`)、磨き込み(`fully-guided`)、review、finalize(human)の順とする。human の着手と完了は claim / complete で記録する。
|
|
123
|
+
- `guided-pass` の草案作成は `draft` とし、文脈がない場合も template を骨組みにして根拠のある内容を下書きする。未委任の調査・選定を行わず、`fully-guided` は後続の既存草案の磨き込みに使う。
|
|
122
124
|
- 導出した approach は標準 profile へ写像し、`phase_sets`、`default_phase_sets`、`owner_rules`、phase gate、finalize 系フェーズをコードで組み立てる。profile は duration、`execution`、`mode`、`approach`、agent pipeline を一元管理する。
|
|
123
125
|
- 主担当は `--owner <local_id>=<ROLE>`、既存 strategy の `owner_rules`、`--default-owner <ROLE>` の順に解決する。`done_criteria.roles` はレビュー観点であり主担当の根拠にしない。未解決または `pm-roles.yaml` に存在しない owner があれば生成を停止する。
|
|
124
126
|
- `bootstrap` と他の approach が同一 track に混在する場合は成果物別に profile を分け、既定では同一カタログの非 bootstrap 成果物を代表 bootstrap 成果物の後に配置する。不要な場合だけ `--no-bootstrap-ordering` を明示する。
|