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.
Files changed (60) hide show
  1. package/CHANGELOG.md +40 -0
  2. package/README.md +2 -2
  3. package/dist/commands/agent.js +33 -0
  4. package/dist/commands/init.js +1 -0
  5. package/dist/commands/orchestrator.js +10 -1
  6. package/dist/devcontainer/command.js +18 -0
  7. package/dist/devcontainer/host-script.js +21 -0
  8. package/dist/devcontainer/scaffold.js +4 -3
  9. package/dist/exec/antigravity-session.js +154 -0
  10. package/dist/exec/parent-validation.js +7 -0
  11. package/dist/exec/plan-markdownlint.js +89 -0
  12. package/dist/exec/plans-generation.js +6 -2
  13. package/dist/exec/register-resume.js +28 -0
  14. package/dist/exec/run/lifecycle-commands.js +85 -16
  15. package/dist/exec/run/register-command.js +6 -0
  16. package/dist/exec/run/schedule-mode.js +22 -2
  17. package/dist/exec/run/schedule-prepare.js +42 -1
  18. package/dist/exec/run/schedule-task.js +3 -0
  19. package/dist/exec/worktree-ops-commit.js +1 -13
  20. package/dist/exec/worktree-ops-lifecycle.js +40 -36
  21. package/dist/register/register.js +31 -23
  22. package/dist/shared/git.js +7 -0
  23. package/dist/shared/provider-scaffold.js +2 -0
  24. package/dist/shared/specdojo-gitignore.js +1 -0
  25. package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +2 -0
  26. package/docs/ja/specdojo/guides/docs-editing-guide.md +36 -0
  27. package/docs/ja/specdojo/guides/exec-config-guide.md +14 -12
  28. package/docs/ja/specdojo/guides/exec-operation-guide.md +20 -8
  29. package/docs/ja/specdojo/guides/orchestrator-operation-guide.md +4 -2
  30. package/docs/ja/specdojo/guides/quick-start-guide.md +597 -871
  31. package/docs/ja/specdojo/guides/register-operation-guide.md +2 -0
  32. package/docs/ja/specdojo/guides/remote-host-development-guide.md +31 -4
  33. package/docs/ja/specdojo/guides/schedule-operation-guide.md +14 -0
  34. package/docs/ja/specdojo/guides/use-case-guide.md +537 -77
  35. package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +88 -86
  36. package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +96 -122
  37. package/docs/ja/specdojo/references/command-reference.md +69 -37
  38. package/docs/ja/specdojo/rulebooks/cdfd-d2-rulebook.md +367 -0
  39. package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +6 -5
  40. package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +96 -100
  41. package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +38 -47
  42. package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +108 -103
  43. package/docs/ja/specdojo/samples/cdfd-overview-sample.md +248 -140
  44. package/docs/ja/specdojo/samples/cdfd-uc-sample.md +128 -97
  45. package/docs/ja/specdojo/templates/cdfd-overview-template.md +161 -83
  46. package/docs/ja/specdojo/templates/cdfd-uc-template.md +127 -90
  47. package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +1 -0
  48. package/docs/specdojo/schemas/v1/specdojo-config.schema.yaml +1 -0
  49. package/package.json +5 -2
  50. package/templates/antigravity/README.md +19 -46
  51. package/templates/antigravity/exec-defaults-snippet.yaml +5 -6
  52. package/templates/antigravity/settings.edit.json +73 -0
  53. package/templates/antigravity/settings.orchestrator.json +15 -0
  54. package/templates/antigravity/settings.report.json +7 -0
  55. package/templates/antigravity/settings.review.json +7 -0
  56. package/templates/devcontainer/remote-host/devcontainer-tmux.sh +217 -0
  57. package/templates/devcontainer/remote-host/specdojo-tmux.sh.sample +8 -96
  58. package/templates/devcontainer/remote-host/ssh-config.sample +3 -1
  59. package/templates/init-agent-members.yaml +1 -0
  60. package/templates/init-exec-defaults.yaml +1 -1
@@ -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
- 全体概要で選定した一つの横断ユースケースについて、複数のプロセスグループを通る順序、グループ間で引き渡す情報、引き渡し条件、条件不成立時の戻り先を、表と Mermaid 図で合意可能にするためのルールです。グループ内部のプロセスと状態遷移は、それぞれプロセスグループ別 CDFD と STSD を参照します。
22
+ 全体概要で選定した一つのユースケースまたは系統について、開始から終了までの流れと、受け渡す情報・物を表と概念データフロー図(Mermaid または D2)で示すためのルールです。状態の定義と遷移は STSD を正本とします。
22
23
 
23
24
  ## 1. 全体方針
24
25
 
25
- - 一文書は、全体概要の「詳細 CDFD 一覧」にある一つのケース ID とユースケースを詳細化します。単一のプロセスグループに閉じる業務には作成しません。
26
- - 「プロセス領域」を順序とグループ別責務の正本、「データストア」を引き渡しで使う上位一覧の部分集合、「引き渡し」を情報・条件・戻す条件の正本、図を開始から終了までの横断順序の正本として併用します。
27
- - 図の一つのプロセスノードは一つのプロセスグループを表します。グループ内部の領域やプロセスを再掲せず、対応する `cdfd-<group>` を参照します。
28
- - 引き渡し条件は、送り元の成果が受け側の開始に足りることを判定できる形にします。条件を満たさない場合の戻り先、戻す情報、再開条件も定めます。
29
- - 状態名・成立条件・遷移元・遷移先・イベント・遷移条件は STSD を正本とします。本書は状態の定義や遷移表を持たず、グループ間の引き渡しだけを扱います。
30
- - 人間が担う承認や最終判断を省略しません。AI Agent やシステムは支援主体として扱えても、責任分担の正本は対応する方針文書を参照します。
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
- | 全体概要 | プロセス領域、プロセスグループ、データストア、詳細 CDFD の割り当てを定める `cdfd-overview` |
37
- | ユースケース別 CDFD | 複数のプロセスグループをまたぐ一つの業務について、グループ間の順序と引き渡し条件だけを定める CDFD |
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
- 全体概要は横断ユースケースの業務目的、ケース ID、参加グループを選定します。ユースケース別 CDFD はその選定を変えずにグループ間の順序と引き渡しを具体化し、各グループの内部はプロセスグループ別 CDFD へ委ねます。
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>` 形式をそのまま引き継ぎ、新しい ID を採番したり別のユースケースの ID を流用したりしません。
54
- - 引き渡し ID は文書内で一意な `H-<nn>` 形式とし、正常順序に沿って採番します。同じ引き渡しには、引き渡し表、図、例外時の戻り先で同じ ID を使います。
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 | 全体概要など、依存関係上許可された直接の内容根拠の ID | 任意 |
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
- - ケース ID、ユースケース名、対象者、開始・終了条件は本文で定義し、未定義の Frontmatter 項目を追加しません。
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 | 適用範囲 | ○ | ケース ID、開始イベント、終了条件、参加グループ、組織・システム境界、対象外、責任分担 |
81
- | 3 | プロセス領域 | ○ | グループごとの節。説明文、主要入力・主要出力・データストアの箇条書き、横断上の役割の表 |
82
- | 4 | データストア | ○ | 全体概要と同じ名称・区分を持つ、引き渡す情報または条件判定に使うデータストアの部分集合 |
83
- | 5 | 概念データフロー | ○ | 開始イベント、グループ代表ノード、引き渡し条件、関連データストア、終了条件だけを示す Mermaid 図と図直後の注記 |
84
- | 6 | 引き渡し | ○ | 引き渡し ID、送り元、受け側、引き渡す情報、引き渡し条件、戻す条件 |
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
- 「未決事項」を設ける場合は最終章とします。図を分割する場合は「概念データフロー」に `5.1.`、`5.2.` の節を設け、引き渡し ID を接続キーにします。
83
+ 「引き渡し」「例外時の戻り先」の章は設けません。図を分ける場合は「概念データフロー」に `5.1.`、`5.2.` の節を設けます。「例外時の戻り」は業務上重要な場合だけ同章内に追加できる任意の図であり、必須の章や表にしません。
89
84
 
90
85
  ## 6. 記述ガイド
91
86
 
92
- ### 6.1. 導入文と目的
87
+ ### 6.1. 描き方の選択
93
88
 
94
- - 導入文は「ケース `C-02` の欠品から補充まで」のように、全体概要のケース ID とユースケース名を明示し、どのグループ間の引き渡しを定めるかを一文で示します。
95
- - 目的は、誰が横断順序を承認し、誰がグループ間の入出力を設計へ使い、誰が重複・欠落を確認するかを利用結果と結び付けます。
96
- - 上位の業務目的を長く書き写さず、グループ境界の合意によって防ぐ欠落や手戻りを示します。
89
+ 全体概要で採用された方式から、次のどちらかを選びます。以下では、表の一行と図の一つのプロセスノードが表す対象を「参加単位」と呼びます。
97
90
 
98
- ### 6.2. 適用範囲
91
+ | 観点 | 通常の横断ユースケース | 系統の関係を描く方式の詳細 |
92
+ | ------------ | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
93
+ | 対象 | 二つ以上のプロセスグループを横断する一つの業務。単一グループに閉じる業務には作成しない | 全体概要で選定した一つの系統と、通過する共用領域 |
94
+ | 参加単位 | 一つのプロセスグループを一つの代表ノードにし、名称と含む領域 ID を併記 | 一つのプロセス領域を一つのノードにし、`P-xx 領域名` を表示 |
95
+ | 表のまとまり | 全体概要のプロセスグループごと | 全体概要の区分ごと。PDCA の段階で区分を置き換えない |
96
+ | 詳細化の境界 | グループ内部の領域・プロセス・主要例外は有効な `cdfd-<group>` へ委ねる | 対象系統と共用領域の流れを領域単位で示し、非推奨のグループ別 CDFD へ依存しない |
97
+ | 入口 | ケースの開始イベントを描く | 系統の入口の起点イベントを描き、文言を全体概要の「プロセス領域」の表と一致させる |
99
98
 
100
- - 全体概要からケース ID、ユースケース名、横断するプロセスグループを引き継ぎます。グループを追加・削除・改名する必要がある場合は、先に全体概要を変更します。
101
- - 開始イベントは最初のグループが動き始める出来事、終了条件は最後のグループが受け取った成果を利用可能と判断できる状態として記述します。
102
- - 対象外には、グループ内部の領域・プロセス・主要例外、補助操作、実装詳細、状態の定義・遷移を明記し、対応する `cdfd-<group>` と STSD へ委ねます。
103
- - 人間と AI Agent の責任分担は本文で再定義せず、対応する方針文書を参照します。参照先がない場合は、人間が承認と最終判断を担う原則だけを記載します。
99
+ ### 6.2. 導入文と目的
104
100
 
105
- ### 6.3. プロセス領域
101
+ - 導入文は「ケース `C-02` の欠品から補充まで」のように、ケース ID と業務名を明示します。
102
+ - 目的は、そのユースケースまたは系統が何のためにあるかを 1〜2 文で記述します。例: 「欠品した商品を補充し、売場で販売できるようにするために、在庫の補充判断から仕入・販売への流れを示す。」
103
+ - BA・QE・承認者など、読み手ごとの承認・設計・確認作業を目的に書きません。
106
104
 
107
- - 章の冒頭で、ケース ID、参加グループ数、正常系の通過順、全体概要との正本関係を示します。
108
- - 正常系で通過するプロセスグループごとに節(`3.1.`、`3.2.`、…)を設け、見出しは「グループ名(含む領域 ID の範囲)」とします。同じグループが正常系で再登場する場合は別の節とし、その理由を説明します。
109
- - 各節は、そのグループが前段から何を受け取り次段へ何を渡すかを示す 1〜3 文の説明、`**主要入力**`・`**主要出力**`・`**データストア**` の箇条書き、横断上の役割を示す表の順で構成します。
110
- - 表は「順序」「プロセスグループ」「含む領域」「横断上の役割」「参照先」の 5 列とし、一節に一行を記載します。グループ名と領域 ID は全体概要から引き継ぎ、参照先は `cdfd-<group>` 形式とします。
111
- - 内部プロセス、内部例外、担当は書き写しません。未作成の参照先も安定した ID をバッククォートで示し、作成状況は登録簿で追跡します。
105
+ ### 6.3. 適用範囲
112
106
 
113
- ### 6.4. データストア
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
- ### 6.5. 概念データフロー
113
+ - 章冒頭にケース ID、正常系の通過順、全体概要との正本関係を簡潔に示します。
114
+ - 全体概要と同じまとまりごとに節(`3.1.`、`3.2.`、…)を設け、見出しは「グループ名または区分名(含む領域 ID)」とします。各節には役割の表だけを置き、入力・出力やデータストアの箇条書きは置きません。
115
+ - 表の列は次のとおりです。同じ参加単位が再登場する場合は別の行にして役割を区別します。
121
116
 
122
- - Mermaid のノード、エッジ、形状、線種は Frontmatter の `includes` で指定した記法ルールに従います。
123
- - プロセスノードは「プロセス領域」の各表の一行に対応する代表ノードとし、ラベルにグループ名と含む領域 ID を記載します。内部プロセス ID や処理名は描きません。
124
- - 開始イベント、引き渡し条件、終了条件をイベントノードとして置き、引き渡し ID と情報名をエッジラベルまたはイベントラベルで追跡可能にします。
125
- - データストアは、引き渡し条件の判定または引き渡す情報の正本として必要なものだけを、全体概要と同じ名称・区分で置きます。個別プロセスの読み書きや項目は描きません。
126
- - 図直後に、全体概要に「凡例(本プロダクト共通)」がある場合はその参照、ない場合は `specdojo:cdfd-mermaid-rulebook` の既定凡例に従う旨を記載します。併せて、使用した線種、内部プロセスを省略したこと、図に置いたデータストアの選定理由を示します。
127
- - 一図で順序を追えない場合は連続する引き渡し単位で分割し、前図の終了側と後図の開始側へ同じ引き渡し ID を記載します。
117
+ | 列 | 記載内容 |
118
+ | ---------------------- | ---------------------------------------------------------------------------------------------------- |
119
+ | 順序 | 正常系で通過する順番 |
120
+ | プロセスグループ・区分 | 全体概要で領域をまとめている名称 |
121
+ | 含む領域 | 全体概要と同じ領域 ID。領域単位の行では領域名も併記し、「プロセス領域」という列名にしてよい |
122
+ | PDCA(任意) | 全体概要にある Plan、Do、Check、Action、全体などの位置付け。「プロセスグループ・区分」とは別の分類軸 |
123
+ | 横断上の役割 | このケースで担う業務上の責務 |
124
+ | 参照先 | 全体概要または有効な詳細文書。未作成の文書は ID をインラインコードで仮置き |
128
125
 
129
- ### 6.6. 引き渡し
126
+ ### 6.5. データストア
130
127
 
131
- - 一行を一つのグループ間引き渡しとし、「引き渡し ID」「送り元グループ」「受け側グループ」「引き渡す情報」「引き渡し条件」「戻す条件」の 6 列を使用します。
132
- - 引き渡す情報は「補充依頼」「承認済みの評価結果」のような業務上の名詞で記述し、ファイル形式や API 項目へ展開しません。
133
- - 引き渡し条件は、必要情報、承認、記録確認などの成立を第三者が yes / no で判定できる形にします。「処理が終わった」「問題がない」だけで終わらせません。
134
- - 戻す条件は、どの不足または不一致で受け側が開始できないかを示します。戻しが発生しない引き渡しは、その根拠を記載し、空欄にしません。
128
+ - 全体概要と同じ「マスタ・構成データ」「トランザクションデータ」の節に分け、対象ケースで参照・更新する行だけを同じ名称・区分で示します。該当行がない区分は節ごと省略します。
129
+ - 表は「データストア」「関連する参加単位」「横断上の利用」の列とします。関連は参加単位の名称または領域 ID で示します。
130
+ - 各行を図の同名ノードへ対応させます。物理保管は全体概要の区分に従い、保管先の詳細や物理項目へ展開しません。
135
131
 
136
- ### 6.7. 例外時の戻り先
132
+ ### 6.6. 概念データフロー
137
133
 
138
- - 表は「対象引き渡し」「条件不成立」「戻り先グループ」「戻す情報」「再開条件」の 5 列とし、すべての引き渡し ID を一度以上確認します。
139
- - 戻り先は補完・再判断の責任を持つ参加グループから選びます。グループ内部のどのプロセスへ戻すかは、対応するプロセスグループ別 CDFD に委ねます。
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
- - 表は「論点」「影響するケース・引き渡し」「決定者」「決定時期」の 4 列とし、本文中の `_UNDECIDED_` と対応させます。
147
- - 調査で埋める不足は `_TODO_`、意思決定待ちは `_UNDECIDED_`、仮置きする前提は `_ASSUMPTION_` として区別します。
150
+ - 境界、名称、責務、判断者のいずれかが未確定な場合だけ設け、ない場合は章ごと省略します。
151
+ - 表は「論点」「影響するケース・参加単位」「決定者」「決定時期」の 4 列とし、本文中の `_UNDECIDED_` と対応させます。
148
152
 
149
153
  ### 6.9. 完成判定
150
154
 
151
- - 全体概要のケース ID、ユースケース名、業務目的、参加グループと矛盾せず、二つ以上のプロセスグループを横断しています。
152
- - 正常系の全参加グループが「プロセス領域」の節と図へ同じ順序・名称・領域 ID で登場し、各節が説明文、三つの箇条書き、役割表の順で構成されています。
153
- - 隣接するグループ間に引き渡し ID があり、引き渡す情報、引き渡し条件、戻す条件が空欄なく定義されています。
154
- - 図の各プロセスノードが一つのプロセスグループを表し、内部領域・内部プロセス・グループ内例外を再掲していません。
155
- - 関連データストアの名称・区分が全体概要と一致し、引き渡し条件に不要なデータストアや物理項目がありません。
156
- - 「データストア」は全体概要の部分集合で、各行が引き渡し ID と図の同名ノードに対応しています。
157
- - 例外時の戻り先から、条件不成立、戻す情報、補完責任、再開条件を説明できます。
158
- - 状態定義、遷移表、状態遷移図を持たず、必要な STSD と各 `cdfd-<group>` を参照しています。
159
- - `_TODO_` が残っていません。`_UNDECIDED_` は「未決事項」と対応しています。
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
- - 単一グループに閉じる業務へユースケース別 CDFD を作成したり、全体概要にないケースを先に詳細化したりしません。
164
- - product 成果物 ID を `<project-id>:cdfd-uc-<topic>` にしたり、`cdfd-<group>` と同じ命名で作成したりしません。
165
- - ケース ID を採番し直したり、引き渡し ID を図・引き渡し表・例外時の戻り先で不一致にしたりしません。
166
- - グループ内部の領域、個別プロセス、プロセス入出力、主要例外、操作手順を再掲しません。
167
- - プロセスグループ別 CDFD と異なる責務をグループ代表ノードへ割り当てたり、全体概要と異なる領域 ID・データストア名・区分を使ったりしません。
168
- - 状態名・成立条件を定義したり、遷移元・遷移先・遷移条件の表や状態遷移図を複製したりしません。
169
- - 引き渡し条件や再開条件を「完了した」「適切になった」「問題がなくなった」のような判定不能な表現だけで記述しません。
170
- - 物理テーブル、カラム、SQL、実装クラス、詳細 API、画面操作を概念フローへ記載しません。
171
- - 受け側グループ、戻り先グループ、引き渡す情報のいずれかがない矢印や表行を残しません。
172
- - 作成状況やレビュー状態を成果物本文へ記載せず、登録簿で追跡します。
170
+ - プロセス領域に主要入力・主要出力・データストアの箇条書きを置く、または図をなぞる長文の注記を書く。
171
+ - 詳細 CDFD に独自の凡例を再掲・重複定義する。
172
+ - 全体概要にないケースや領域分割を作る、または「描き方の選択」の粒度・詳細化の境界を越えて内部処理を再掲する。
173
+ - 全体概要と異なるグループ名・区分名・領域 ID・データストア名を使う、または PDCA の値をグループ・区分の列に入れる。
174
+ - 引き渡し ID を採番する、引き渡し条件のイベントを図に置く、引き渡し・戻す条件・再開条件の表を設ける。
175
+ - Orchestrator の調整を詳細の図に複製する、または対象範囲内の担当者を外部主体にする。
176
+ - `deprecated` の文書を `based_on` または本文から参照する。
177
+ - 状態定義・遷移表・状態遷移図を複製する、または物理テーブル、カラム、SQL、実装クラス、詳細 API、画面操作を記載する。