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-overview-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,47 +19,50 @@ specdojo:
|
|
|
18
19
|
|
|
19
20
|
Conceptual Data Flow Diagram Overview Documentation Rulebook
|
|
20
21
|
|
|
21
|
-
|
|
22
|
+
業務または運用の全体像を、プロセス領域のまとまりと、それらが読み書きするデータの関係として示すためのルールです。プロセスグループを代表ノードにする今の方式と、プロセス領域の区分を代表ノードにする「系統の関係を描く」方式の粒度を定めます。
|
|
22
23
|
|
|
23
24
|
## 1. 全体方針
|
|
24
25
|
|
|
25
|
-
-
|
|
26
|
-
-
|
|
26
|
+
- 全体概要は、業務または運用を構成するプロセス領域、そのまとまり、データストアと受け渡しの全体像を示す概念仕様とします。
|
|
27
|
+
- 全体概要の構成として、今の方式(プロセスグループ別 CDFD を置く方式)と「系統の関係を描く」方式のいずれかを選択できます。今の方式では、データストアの区分またはプロセスの流れで図を分け、各プロセスグループの内部をプロセスグループ別 CDFD へ委ねます。「系統の関係を描く」方式では、プロセス領域の区分(例: プロジェクト構成の構築・管理、register 系、schedule 系、routine 系、実行サイクル、文書の廃棄、Orchestrator)を代表ノードとし、区分とデータの関係を描きます。各系統の流れはユースケース別 CDFD でプロセス領域の単位で描きます。プロセス領域の表、データストアの表、凡例は全体概要に置きます。凡例で方式を宣言しない場合の既定は今の方式のままとします。
|
|
28
|
+
- プロセス領域は業務の性質が近いものを、今の方式ではプロセスグループに、系統の関係を描く方式では区分にまとめ、概念データフローでは各まとまりを一つの代表ノードで表します。領域単位の内部プロセス、状態を変える処理と例外経路は詳細 CDFD へ委ね、状態の定義と遷移は STSD へ委ねます。
|
|
27
29
|
- データストアは論理的な正本として一覧化し、マスタ・構成データとトランザクションデータに分けて定義します。図に置くデータストアは一覧の各行と一対一に対応させます。
|
|
28
|
-
-
|
|
29
|
-
-
|
|
30
|
-
-
|
|
30
|
+
- プロセス領域の表を領域定義の正本、「データストア」をデータストア定義の正本、概念データフロー図(Mermaid または D2)をグループまたは区分とデータストアの間の受け渡し、およびグループ間・区分間の要求の正本とします。プロセス領域に主要入力・主要出力の箇条書きは設けず、受け渡しは図を正本とします。
|
|
31
|
+
- 各プロセス領域には業務目的、主な担当、起点イベントを割り当て、表で簡潔に定義します。起点イベントはプロセス領域の表に記載します。系統の関係を描く方式では、全体概要の図に系統の入口の起点イベントを描いて構いません(今の方式では図に描きません)。
|
|
32
|
+
- 目的は全体像として何を示すかを 1〜2 文、適用範囲は対象と対象外を 1 行ずつとし、人間と AI Agent の責任分担などの共通原則は 1 か所に置いて参照します。
|
|
31
33
|
|
|
32
34
|
## 2. 位置づけと用語定義
|
|
33
35
|
|
|
34
|
-
| 用語 | 定義
|
|
35
|
-
| ----------------------- |
|
|
36
|
-
| 全体概要 |
|
|
37
|
-
| プロセス領域 | 固有の業務目的、主な担当、起点イベントを持つ責務のまとまり。`P-01` 形式の領域 ID を持つ
|
|
38
|
-
| プロセスグループ | 業務の性質が近いプロセス領域をまとめた集合。概念データフローの代表ノードであり、プロセスグループ別 CDFD の単位
|
|
39
|
-
|
|
|
40
|
-
|
|
|
41
|
-
|
|
|
42
|
-
|
|
|
43
|
-
|
|
|
44
|
-
|
|
|
45
|
-
|
|
|
46
|
-
|
|
|
47
|
-
|
|
|
48
|
-
|
|
|
49
|
-
|
|
|
50
|
-
|
|
|
51
|
-
|
|
|
52
|
-
|
|
|
53
|
-
|
|
54
|
-
|
|
36
|
+
| 用語 | 定義 |
|
|
37
|
+
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
38
|
+
| 全体概要 | プロセスグループまたは区分とデータの関係を表す最上位の CDFD |
|
|
39
|
+
| プロセス領域 | 固有の業務目的、主な担当、起点イベントを持つ責務のまとまり。`P-01` 形式の領域 ID を持つ |
|
|
40
|
+
| プロセスグループ | 業務の性質が近いプロセス領域をまとめた集合。概念データフローの代表ノードであり、プロセスグループ別 CDFD の単位 |
|
|
41
|
+
| 区分 | 系統の関係を描く方式で、プロセス領域を業務の性質でまとめた単位。系統、実行サイクル、構成管理、調整役などを含む |
|
|
42
|
+
| 代表ノード | 全体概要で一つのプロセスグループまたは区分を表す角丸長方形のノード(Mermaid または D2)。`subgraph` やコンテナではなくノードとして描く |
|
|
43
|
+
| 起点イベント | プロセス領域を開始させる、発生した時点を判定できる出来事。プロセス領域の表に記載する。系統の関係を描く方式では、全体概要の図に系統の入口の起点イベントを描いてよい(今の方式では図に描かない) |
|
|
44
|
+
| 系統の関係を描く方式 | プロセス領域の区分を代表ノードとし、区分とデータの関係を描く全体概要の構成方式。各系統の流れはユースケース別 CDFD でプロセス領域の単位に詳細化する |
|
|
45
|
+
| データストア | プロセスグループまたは区分が参照または更新する、台帳、文書、ファイル、設定などの論理的な正本。マスタ・構成データとトランザクションデータに区分する |
|
|
46
|
+
| マスタ・構成データ | 他のプロセスから参照される比較的安定した基準情報。更新契機は承認された変更である |
|
|
47
|
+
| トランザクションデータ | 業務活動に伴い都度更新される記録。生成物や退避先を含む |
|
|
48
|
+
| 保管先 | データストアの物理的な所在(ファイルパス、帳簿、システムなど)。概念段階では未確定でよい |
|
|
49
|
+
| STSD | ステータス定義(Status Definition)。状態名、意味、成立条件、遷移元、遷移先、イベント、遷移条件の単一正本。作成規範は `specdojo:stsd-rulebook` |
|
|
50
|
+
| Role code | 責務・判断権限・専門性を表す識別子。共通定義は `specdojo:people-and-organization-definition-standard`、プロジェクトで採用する値は `<project-id>:pm-roles` を正本とする |
|
|
51
|
+
| PO | Project Owner を表す標準 Role code。目的、スコープ、優先順位、公開方針、最終判断を担う |
|
|
52
|
+
| retrofit | 既存実装をエビデンスとして現状の成果物へ反映する作成アプローチ。保管先など実装から確定できる事実を推測せず記録する |
|
|
53
|
+
| Orchestrator | 利用者または自動実行の意図を受け、各プロセスグループまたは区分へ要求を振り分ける調整役。採用する場合は、対象業務での責務と入力元を本文で定義する |
|
|
54
|
+
| 補助操作 | 一覧、検索、状態参照、検証、dry-run など、独立した業務成果を作らず他の領域を支援する操作 |
|
|
55
|
+
| プロセスグループ別 CDFD | 一つのプロセスグループを引き継ぎ、領域の内部プロセス、起点イベント、例外・復旧、データストアの読み書きを定め、状態定義・遷移は STSD を参照する詳細 CDFD |
|
|
56
|
+
| ユースケース別 CDFD | 今の方式では複数グループ間の順序と引き渡し条件を定め、系統の関係を描く方式では各系統の流れをプロセス領域の単位で定める詳細 CDFD。構造規範は `specdojo:cdfd-uc-rulebook` |
|
|
57
|
+
|
|
58
|
+
全体概要はプロセス領域のまとまりとデータストアの分割、およびそれらの関係を定義します。今の方式ではプロセスグループ別 CDFD が一グループの内部を、ユースケース別 CDFD がグループ間の順序を詳細化します。系統の関係を描く方式では、全体概要で区分とデータの関係を定義し、各系統の流れはユースケース別 CDFD でプロセス領域の単位で詳細化します。いずれの方式でも、全体概要と同じ領域 ID、プロセスグループ名または区分名、データストア名を引き継ぎます。
|
|
55
59
|
|
|
56
60
|
## 3. ファイル命名・ID規則
|
|
57
61
|
|
|
58
62
|
- ファイル名は `cdfd-overview.md`、ドキュメント ID は `cdfd-overview` を基本とします。product 文書ではプロジェクト修飾(`<project-id>:`)を付けず、プロジェクト固有の現状分析をプロジェクト文書配下へ置く場合だけ `<project-id>:cdfd-overview` とします。
|
|
59
63
|
- 配置は対象プロダクトの業務仕様配下にあるデータフローディレクトリを基本とします。
|
|
60
64
|
- 領域 ID は文書内で一意な `P-01` 形式とし、プロセス領域の表、代表ノードのラベル、詳細 CDFD 一覧で同じ値を使います。採番順に業務上の意味を持たせず、名称変更後も同じ責務を表す限り維持します。
|
|
61
|
-
-
|
|
65
|
+
- プロセスグループ名(系統の関係を描く方式では区分名)は英語の短い名詞(例: Plan、Do、Check、Action)または日本語の短い名詞句とし、代表ノードのラベルには `P-02〜P-06` のように含む領域 ID の範囲を併記します。
|
|
62
66
|
- プロセスグループ別 CDFD の ID は `cdfd-<group>`、ユースケース別 CDFD の ID は `cdfd-uc-<topic>` とします。`<group>` はプロセスグループ名の英小文字、`<topic>` はユースケースを表す英小文字のスラッグです。
|
|
63
67
|
- ユースケース ID は文書内で一意な `C-01` 形式とします。
|
|
64
68
|
|
|
@@ -74,27 +78,27 @@ Conceptual Data Flow Diagram Overview Documentation Rulebook
|
|
|
74
78
|
| supersedes | 置き換える旧全体概要の ID | 任意 |
|
|
75
79
|
|
|
76
80
|
- `based_on` は直接の内容根拠だけを列挙し、プロジェクト共通の参考文脈や図中要素を機械的に転記しません。
|
|
77
|
-
-
|
|
81
|
+
- 目的、対象範囲は本文で定義し、未定義の Frontmatter 項目を追加しません。
|
|
78
82
|
- 作成途中の `status` は `draft` とします。`ready` へ昇格できるのは、「完成判定」の全項目を満たし、対象範囲と領域分割を PO が承認した記録(登録簿の決定記録またはレビュー結果)がある場合です。
|
|
79
83
|
|
|
80
84
|
## 5. 本文要件
|
|
81
85
|
|
|
82
86
|
見出し順・表・記入欄の骨組みは template を正本とします。本章は各章の目的と必須・任意を定めます。
|
|
83
87
|
|
|
84
|
-
| 番号 | 見出し | 必須 | 内容(要点)
|
|
85
|
-
| ---- | ------------------------ | -------- |
|
|
86
|
-
| 冒頭 | 導入文 | ○ | 対象業務・運用を一文で定義
|
|
87
|
-
| 1 | 目的 | ○ |
|
|
88
|
-
| 2 | 適用範囲 | ○ |
|
|
89
|
-
| 3 | プロセス領域 | ○ |
|
|
90
|
-
| 4 | データストア | ○ | マスタ・構成データとトランザクションデータの 2 表。列はデータストア、主な内容、保管先(条件付き)
|
|
91
|
-
| 5 | 概念データフロー(概要) | ○ |
|
|
92
|
-
| 6 | 詳細 CDFD 一覧 | ○ | プロセスグループ別 CDFD の表と、横断するユースケース別 CDFD
|
|
93
|
-
| 7 | 凡例(本プロダクト共通) | 任意 | 本プロダクトの全 CDFD
|
|
94
|
-
| 8 | 未決事項 | 条件付き | 境界、名称、責務、判断者が未確定な論点。未決事項がある場合だけ設ける
|
|
88
|
+
| 番号 | 見出し | 必須 | 内容(要点) |
|
|
89
|
+
| ---- | ------------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
90
|
+
| 冒頭 | 導入文 | ○ | 対象業務・運用を一文で定義 |
|
|
91
|
+
| 1 | 目的 | ○ | 全体像として示すプロセス領域のまとまりとデータの関係(1〜2 文) |
|
|
92
|
+
| 2 | 適用範囲 | ○ | 対象と対象外を 1 行ずつ。共通の原則(人間と AI Agent の責任分担など)は 1 か所を参照 |
|
|
93
|
+
| 3 | プロセス領域 | ○ | プロセスグループまたは区分ごとの節。各節は領域の表のみ(主要入力・主要出力の箇条書きは不要) |
|
|
94
|
+
| 4 | データストア | ○ | マスタ・構成データとトランザクションデータの 2 表。列はデータストア、主な内容、保管先(条件付き) |
|
|
95
|
+
| 5 | 概念データフロー(概要) | ○ | プロセスグループまたは区分の代表ノードとデータストアの図(Mermaid または D2)。調整役の指示は別図にできる。各図の説明は読み取れることを 1 文 |
|
|
96
|
+
| 6 | 詳細 CDFD 一覧 | ○ | プロセスグループ別 CDFD の表と、横断するユースケース別 CDFD の表(系統の関係を描く方式では各系統の流れをユースケース別 CDFD で示し、プロセスグループ別 CDFD 表を省略または非推奨として扱える) |
|
|
97
|
+
| 7 | 凡例(本プロダクト共通) | 任意 | 本プロダクトの全 CDFD が共通して参照する記法(Mermaid または D2)、ノード形状・色・絵文字のサンプル図と対応表(全体概要にのみ設置) |
|
|
98
|
+
| 8 | 未決事項 | 条件付き | 境界、名称、責務、判断者が未確定な論点。未決事項がある場合だけ設ける |
|
|
95
99
|
|
|
96
100
|
- 「凡例(本プロダクト共通)」を省略する場合、章番号は詰めます。「未決事項」は最終章とします。
|
|
97
|
-
-
|
|
101
|
+
- 「概念データフロー(概要)」を複数図に分ける場合は `5.1.`、`5.2.`、… の節を設け、分けない場合は節を設けず 1 図を置きます。
|
|
98
102
|
|
|
99
103
|
## 6. 記述ガイド
|
|
100
104
|
|
|
@@ -107,26 +111,22 @@ Conceptual Data Flow Diagram Overview Documentation Rulebook
|
|
|
107
111
|
|
|
108
112
|
### 6.2. 目的
|
|
109
113
|
|
|
110
|
-
-
|
|
111
|
-
-
|
|
112
|
-
-
|
|
114
|
+
- 全体像として、どの業務または運用の、どのプロセス領域のまとまりとデータの関係を示すかを 1〜2 文で記述します。
|
|
115
|
+
- 例: 「店舗運営の全体像として、仕入・販売・在庫・顧客・締めの各グループと、それらが読み書きするデータの関係を示す。」
|
|
116
|
+
- PO の承認、詳細化への引き継ぎなどの作業や、読み手ごとの役割は目的に書きません。PO の承認記録は `ready` 昇格の手続きとして完成判定で確認します。
|
|
113
117
|
|
|
114
118
|
### 6.3. 適用範囲
|
|
115
119
|
|
|
116
|
-
-
|
|
117
|
-
-
|
|
118
|
-
-
|
|
119
|
-
- 人間と AI Agent の責任分担は、対応するプロジェクト方針文書があればそれを参照し、なければ「承認・完了判断・構成変更の承認・非推奨化の判断は人間が担い、成果物の作成・評価・派生生成は人が担うほか AI Agent へ委譲できる」のように原則を一文で書きます。
|
|
120
|
-
- 特定プロジェクトの実行計画・スケジュール上のフェーズ名は、全体概要では扱いません。
|
|
120
|
+
- 対象と対象外をそれぞれ 1 行(1 文)で明示します。
|
|
121
|
+
- 領域内部(個別コマンドの操作手順、ファイル単位の更新内容、処理の分岐、状態を変える処理と起点イベント、例外時の復旧手順)は対象外とし、今の方式ではプロセスグループ別 CDFD、系統の関係を描く方式ではユースケース別 CDFD へ委ねることを明記します。状態の定義と遷移は STSD が正本であることも示します。
|
|
122
|
+
- 補助操作の扱い、人間と AI Agent の責任分担などの共通原則は本文で冗長に再定義せず、プロジェクト共通方針文書(または全体概要の適用範囲内の 1 文)に置いて参照します。
|
|
121
123
|
|
|
122
124
|
### 6.4. プロセス領域
|
|
123
125
|
|
|
124
|
-
-
|
|
125
|
-
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
- 領域の表。
|
|
129
|
-
- プロセスグループの数は 8 以下とします。超える場合は業務の性質が近いグループを統合します。1 領域だけのグループも認めます。
|
|
126
|
+
- 章の冒頭で、領域数、プロセスグループ数または区分数、正本の所在(領域の分割は本書の表、受け渡しは本書の図、領域内部は選択した方式の詳細 CDFD)を簡潔に示します。
|
|
127
|
+
- プロセスグループまたは区分ごとに節(`3.1.`、`3.2.`、…)を設け、見出しは「グループ名または区分名(含む領域 ID の範囲)」とします。
|
|
128
|
+
- 各節は領域の表のみで構成します。主要入力・主要出力・データストアの箇条書きは記載せず、受け渡しは概念データフロー図を正本とします。
|
|
129
|
+
- プロセスグループまたは区分の数は 8 以下とします。超える場合は業務の性質が近いまとまりを統合します。1 領域だけのまとまりも認めます。
|
|
130
130
|
|
|
131
131
|
<!-- prettier-ignore -->
|
|
132
132
|
| 列 | 記載内容 | 判定基準 |
|
|
@@ -135,100 +135,96 @@ Conceptual Data Flow Diagram Overview Documentation Rulebook
|
|
|
135
135
|
| プロセス領域 | 業務目的が分かる短い名称 | コマンド名や実装部品名だけにしない |
|
|
136
136
|
| 業務目的 | 対象者に生じる成果または維持する状態 | 手順や機能の列挙にしない |
|
|
137
137
|
| 主な担当 | 主担当ロール。複数ロールが担う場合は管理責任のロールを併記する | 同じ表では採用済み Role code または組織定義にある役割名のどちらかへ統一し、個人名や「全員」だけで終わらせない |
|
|
138
|
+
| PDCA(任意) | 各領域の位置付け(Plan、Do、Check、Action、全体など) | プロセス領域の区分とは別の分類軸として、必要な場合だけ追加する |
|
|
138
139
|
| 起点イベント | 領域の開始を判定できる出来事。定義系の領域は「要件が判明した」、実行系の領域は「指示された」「到来した」のように区別する | 「必要に応じて」で終わらせない。同じグループ内で同文にしない |
|
|
139
140
|
|
|
140
141
|
- 独立領域にするのは、固有の起点イベントと業務成果を持ち、他領域と区別できる入力、出力、またはデータストアがある場合です。補助操作は、独立した判断結果や更新成果を持たない限り領域にしません。
|
|
141
|
-
-
|
|
142
|
-
- プロジェクト管理を対象とする文書の「主な担当」は、`<project-id>:pm-roles` に定義された Role code を使います。業務担当の役割名を使う文書は組織定義にある名称へ統一し、Role code と自由記述の呼称を同じ列へ混在させません。task owner や runner のような実行主体を補足する場合も、管理責任を持つ Role code または役割名と区別します。
|
|
142
|
+
- プロジェクト管理を対象とする文書の「主な担当」は、`<project-id>:pm-roles` に定義された Role code を使います。
|
|
143
143
|
|
|
144
144
|
### 6.5. データストア
|
|
145
145
|
|
|
146
|
-
- 章の冒頭で、区分の意味、パスの略記(例: `<project-id>`
|
|
146
|
+
- 章の冒頭で、区分の意味、パスの略記(例: `<project-id>` が指す範囲)、データストアとして扱わないもの(リポジトリ基盤、開発環境の設定など)を簡潔に示します。
|
|
147
147
|
- マスタ・構成データとトランザクションデータの 2 表に分け、各行は次の列で構成します。
|
|
148
148
|
|
|
149
149
|
<!-- prettier-ignore -->
|
|
150
150
|
| 列 | 記載内容 | 判定基準 |
|
|
151
151
|
| --- | --- | --- |
|
|
152
|
-
| データストア | 論理的な正本の名称 |
|
|
152
|
+
| データストア | 論理的な正本の名称 | 図のノードラベル、詳細 CDFD と同じ名称を使う |
|
|
153
153
|
| 主な内容 | 保持する情報の種別。生成物なら生成元、退避先なら退避対象を書く | 「各種データ」のような抽象語だけにしない |
|
|
154
154
|
| 主な保管先 | 物理的な所在。複数ある場合は `、<br>` で区切る | 原則として別のデータストアと重ならない範囲に限定し、共有・包含する場合は論理境界と共有相手を注記する |
|
|
155
155
|
|
|
156
156
|
- 「主な保管先」列は条件付きです。実装が先にある場合(retrofit)は必須とし、実装エビデンスとして記載します。設計中で候補がある場合は列を置き、未確定のセルは `_UNDECIDED_` とします。保管先を扱わない概念段階では列ごと省略します。
|
|
157
|
-
-
|
|
158
|
-
-
|
|
159
|
-
- 区分の判定基準は更新契機です。承認された変更で更新されるものはマスタ・構成データ、業務活動に伴い都度更新されるものはトランザクションデータとします。定義から生成される生成物は、生成元の定義がマスタ・構成データであっても、生成物自体はトランザクションデータとします。
|
|
160
|
-
- 生成物の集約先(評価結果、報告、派生ビューなど)や退避先(保管庫など)も、プロセスグループが更新するならデータストアとして一覧に含めます。
|
|
157
|
+
- 一つの帳簿、ファイル、ディレクトリを複数の論理データストアが共有する場合は、境界と共有相手を注記します。
|
|
158
|
+
- 区分の判定基準は更新契機です。承認された変更で更新されるものはマスタ・構成データ、業務活動に伴い都度更新されるものはトランザクションデータとします。
|
|
161
159
|
|
|
162
160
|
### 6.6. 概念データフロー(概要)
|
|
163
161
|
|
|
164
|
-
-
|
|
165
|
-
-
|
|
166
|
-
-
|
|
162
|
+
- グループまたは区分とデータストアの間の受け渡しの正本とします。エッジラベルには名詞形の具体的なデータ名を用います。更新エッジは更新前の参照を含みます。グループ間・区分間の実行要求も、「対応要求」「実行要求」などの名詞のラベルを付けて線にして構いません。線は実行順や毎回の通過を意味しません。
|
|
163
|
+
- 図の題は「PDCA のプロセスとデータの関係」「プロセスを実行する設定・構成情報の流れ」「Orchestrator による PDCA の調整」のように業務の言葉で付けます。各図の説明は、図から読み取れることを 1 文で書きます。ノード形状、線種、色、絵文字、省略の約束などの作図規則は凡例にまとめます。
|
|
164
|
+
- 代表ノードはプロセスグループまたは区分ごとに一つとし、ラベルにその名称と含む領域 ID の範囲を書きます。`subgraph` で領域や代表ノードを囲みません。同じ代表ノードを複数図に再掲して構いませんが、一つの図で内部領域を別々のノードへ展開しません。
|
|
165
|
+
- データストアのノードは「データストア」の各行と一対一とし、同じ名称を使います。同じデータストアを複数図に再掲しても、論理的には一つとして扱います。
|
|
167
166
|
- 対象範囲内の参加者(ロール)は各領域の担当として業務プロセスの内側にいるため、外部主体として描きません。外部主体を描くのは対象範囲外の入力元・出力先だけです。
|
|
168
|
-
-
|
|
169
|
-
-
|
|
170
|
-
-
|
|
171
|
-
-
|
|
172
|
-
-
|
|
173
|
-
- ノード形状、線種、色、絵文字の記法は `specdojo:cdfd-mermaid-rulebook` に従います。全体概要の図に含める要素の種別(代表ノード、データストア、必要に応じた外部主体)は本節の規定を優先します。
|
|
167
|
+
- 起点イベントは「プロセス領域」の表に記載し、図には描きません。ただし、系統の関係を描く方式では、全体概要の図に系統の入口の起点イベントを描いて構いません。
|
|
168
|
+
- 図のノード総数は、代表ノードとデータストアの合計で数え、外部主体は含めません。合計が 16 を超える場合は図を分割します。今の方式ではデータストアの区分または使い方の流れで分けます。系統の関係を描く方式では、区分とデータの関係をデータの種類で分けた図にし、必要に応じて調整役の指示を別図にします。凡例(または章冒頭)で構成方式を宣言しない場合は、データストアの区分で分ける今の方式として扱います。全図で代表ノードとデータストアの名称を統一します。
|
|
169
|
+
- 系統の関係を描く方式では、データの種類で分けた図の間で区分の位置をそろえます。受け渡しの線のない区分はその図に置かず、各区分はデータの図または指示の図のどれかに必ず出します。配置制御のための非表示の線は受け渡しに数えません。
|
|
170
|
+
- 系統の関係を描く方式では、調整役(Orchestrator)はデータの図に置かず、指示の図を別に設けて構いません。調整役からデータストアへの線は、直接読み書きするものだけに引きます。CLI 経由の読み書きはデータの図で該当する区分からの線として表し、調整役から重複して線を引きません。
|
|
171
|
+
- ノード形状、線種、色、絵文字の記法は、本プロダクト共通の凡例で選択した記法ルール([[specdojo:cdfd-mermaid-rulebook|Mermaid 記法ルール]] または [[specdojo:cdfd-d2-rulebook|D2 記法ルール]])に従います。凡例で記法を宣言しない場合は Mermaid 記法に従います。
|
|
174
172
|
|
|
175
173
|
### 6.7. 詳細 CDFD 一覧
|
|
176
174
|
|
|
177
|
-
-
|
|
178
|
-
- プロセスグループ別 CDFD の表は、プロセスグループ、含む領域、CDFD の ID の 3
|
|
179
|
-
- ユースケース別 CDFD の表は、ケース ID
|
|
175
|
+
- 章の冒頭で、詳細 CDFD の役割分担を簡潔に示します。今の方式ではプロセスグループ別 CDFD がグループ内部のプロセス・例外・データストア読み書きの正本、ユースケース別 CDFD が `specdojo:cdfd-uc-rulebook` に従ってグループ間の順序と引き渡し条件だけを定めます。系統の関係を描く方式では、区分とデータの関係を全体概要に示した上で、各系統(例: register 系・schedule 系・routine 系)の流れをユースケース別 CDFD でプロセス領域の単位で詳細化します。いずれも内部プロセスを二重管理せず、状態の定義と遷移は STSD が正本であることも示します。
|
|
176
|
+
- プロセスグループ別 CDFD の表は、プロセスグループ、含む領域、CDFD の ID の 3 列とし、今の方式では全プロセスグループを 1 行ずつ載せます。系統の関係を描く方式では本表を省略するか、移行期・非推奨の記録として扱います。
|
|
177
|
+
- ユースケース別 CDFD の表は、ケース ID、ユースケース(または系統名)、業務目的、横断するプロセスグループ(または対象系統・領域)、CDFD の ID の 5 列とします。今の方式では複数のプロセスグループを横断し順序と引き渡し条件を定める業務を載せ、系統の関係を描く方式では各系統の流れを定める詳細 CDFD を載せます。
|
|
180
178
|
- 未作成の CDFD に「(未作成)」などの状態表記を付けません。作成状況は登録簿で追跡します。
|
|
181
179
|
|
|
182
180
|
### 6.8. 凡例(本プロダクト共通)
|
|
183
181
|
|
|
184
|
-
- 本プロダクトの詳細 CDFD
|
|
185
|
-
-
|
|
186
|
-
-
|
|
187
|
-
-
|
|
182
|
+
- 本プロダクトの詳細 CDFD が複数存在し、共通の記法(Mermaid または D2)、ノード形状・色・絵文字を使う場合に設けます。凡例は全体概要にだけ書きます。
|
|
183
|
+
- 本章で採用する記法(Mermaid または D2)を明示的に宣言します。全体概要の構成方式(今の方式としてデータストアの区分またはプロセスの流れで図を分ける方式、あるいは系統の関係を描く方式)も宣言できます。
|
|
184
|
+
- 詳細 CDFD は本章を再掲せず、全体概要の凡例への参照に留めます。
|
|
185
|
+
- 本章を省略した場合、または記法を明示しない場合、全 CDFD は Mermaid 記法(`specdojo:cdfd-mermaid-rulebook` の既定凡例)に従います。全体概要の構成方式を宣言しない場合も、既定の今の方式(データストアの区分による分割、プロセスグループ別 CDFD を置く構成)に従います。
|
|
188
186
|
|
|
189
187
|
### 6.9. 未決事項
|
|
190
188
|
|
|
191
189
|
- 境界、名称、責務、判断者、保管先のいずれかが未確定な論点がある場合だけ設けます。ない場合は章ごと省略します。
|
|
192
190
|
- 表は論点、影響、決定者、決定時期、状態の 5 列とします。本文中の未確定箇所には `_UNDECIDED_` を付け、表の論点と対応させます。
|
|
193
|
-
- 確定した論点は、本文へ反映したうえで表から削除します。
|
|
194
191
|
|
|
195
192
|
### 6.10. 完成判定
|
|
196
193
|
|
|
197
|
-
本節だけを `ready`
|
|
194
|
+
本節だけを `ready` 昇格のチェックリストの正本とします。次の全項目を満たす必要があります。
|
|
198
195
|
|
|
199
|
-
- Frontmatter に `id`、`type: flow`、`status`、`rulebook: specdojo:cdfd-overview-rulebook` があり、`id` と `status` が「推奨 Frontmatter
|
|
196
|
+
- Frontmatter に `id`、`type: flow`、`status`、`rulebook: specdojo:cdfd-overview-rulebook` があり、`id` と `status` が「推奨 Frontmatter 項目」の制約を満たしています。
|
|
200
197
|
- H1 直下の導入文が対象業務または運用を一文で定義しています。
|
|
201
|
-
-
|
|
202
|
-
-
|
|
203
|
-
- 「プロセス領域」は 8
|
|
204
|
-
- 「主な担当」は同じ表内で採用済み Role code
|
|
205
|
-
-
|
|
206
|
-
-
|
|
207
|
-
-
|
|
208
|
-
-
|
|
209
|
-
-
|
|
210
|
-
-
|
|
211
|
-
-
|
|
212
|
-
- 「凡例(本プロダクト共通)」を設けた場合、記法規範の全ノード種別について採用する形状・色・絵文字を示し、他の CDFD は定義を再掲せず参照しています。
|
|
213
|
-
- `_TODO_` と作業メモの HTML コメントが残っていません。`_UNDECIDED_` がある場合は最終章の「未決事項」に論点、影響、決定者、決定時期、状態があり、本文の未確定箇所と対応しています。
|
|
198
|
+
- 「目的」が、業務または運用の全体像として示すプロセス領域のまとまりとデータの関係を 1〜2 文で定義しています。PO の承認や引き継ぎなどの作業、読み手の役割を目的に含めていません。
|
|
199
|
+
- 「適用範囲」に対象と対象外が 1 行ずつ明記され、共通の原則(人間と AI Agent の責任分担など)が 1 か所を参照しています。領域内部と状態定義・遷移の正本も特定できます。
|
|
200
|
+
- 「プロセス領域」は 8 以下のプロセスグループまたは区分からなり、各節が領域表だけで構成されています(主要入力・主要出力・データストアの箇条書きを含まない)。領域表には「領域 ID」「プロセス領域」「業務目的」「主な担当」「起点イベント」の全列があり、各領域は一つのグループまたは区分にだけ属しています。「PDCA」は任意の列として追加できます。プロセス領域の表、データストアの表、凡例は全体概要に置かれています。
|
|
201
|
+
- 「主な担当」は同じ表内で採用済み Role code または組織定義にある役割名へ統一されています。
|
|
202
|
+
- 「データストア」が「マスタ・構成データ」と「トランザクションデータ」に分かれ、各表に「データストア」「主な内容」と、確定度に応じた「主な保管先」があります。
|
|
203
|
+
- 概念データフローはプロセスグループまたは区分を代表ノードにし、一つの図で同じ代表ノードを重複させず(系統の関係を描く方式では区分とデータの関係が描かれている)、`subgraph` を使っていません。データストアのノードは「データストア」の各行と一対一で、表、図、詳細 CDFD 一覧の名称が一致しています。ノード数が 16 を超えて分割する場合は、選択した構成・分割方式(データストアの区分、使い方の流れ、または系統の関係を描く方式)に従って一貫して分割されています。系統の関係を描く方式では、全体概要の図に系統の入口の起点イベントを描いて構いません。
|
|
204
|
+
- 概念データフロー図がグループまたは区分とデータストアの間の受け渡しの正本となっており、各エッジに名詞形のデータ名または実行要求名があります。図の題は業務の言葉で付き、各図の説明は図から読み取れることを 1 文で示しています。作図規則は凡例にあります。
|
|
205
|
+
- 系統の関係を描く方式では、データの種類で分けた図の間で区分の位置がそろい、受け渡しの線のない区分をその図に置かず、各区分がいずれかの図に出ています。調整役はデータの図に置かず、採用する場合は指示の図に描かれています。調整役とデータストアの線は直接の読み書きだけであり、CLI 経由の読み書きはデータの図で該当区分から描かれています。
|
|
206
|
+
- 「詳細 CDFD 一覧」について、今の方式ではプロセスグループ別 CDFD 表に全グループがありユースケース別 CDFD 表の各行は複数グループを横断しています。系統の関係を描く方式では、各系統の流れがユースケース別 CDFD 表に定義されています。
|
|
207
|
+
- 「凡例(本プロダクト共通)」を設けた場合、採用する記法(Mermaid または D2)、形状・色・絵文字を示し、詳細 CDFD から参照可能になっています。凡例で構成方式を宣言しない場合の既定は今の方式に従っています。
|
|
208
|
+
- `_TODO_` と作業メモの HTML コメントが残っていません。`_UNDECIDED_` がある場合は最終章の「未決事項」に対応しています。
|
|
214
209
|
- 対象範囲と領域分割を PO が承認した記録を、登録簿の決定記録またはレビュー結果から特定できます。
|
|
215
210
|
|
|
216
211
|
## 7. 禁止事項
|
|
217
212
|
|
|
218
|
-
|
|
213
|
+
本章は完成判定に反する代表例と、その理由を示します。
|
|
219
214
|
|
|
220
215
|
<!-- prettier-ignore -->
|
|
221
216
|
| 禁止事項 | 理由 |
|
|
222
217
|
| --- | --- |
|
|
223
|
-
|
|
|
218
|
+
| プロセス領域に主要入力・主要出力・データストアの箇条書きを記載する、または図の受け渡しを文章でなぞる長文の注記を書く | 受け渡しの正本である図と重複し、文書の冗長化や不整合を招くため |
|
|
219
|
+
| プロセスグループや区分を `subgraph` で表す、または一つの図で一つの領域を複数の代表ノードへ分割する | 代表ノードとグループ・区分の対応が崩れ、表・図・詳細 CDFD の突き合わせができなくなるため |
|
|
224
220
|
| 業務の性質が異なる領域を、理由の説明なく一つのプロセスグループへ統合する | 詳細化先の境界が不明瞭になり、重複・欠落の確認ができなくなるため |
|
|
225
|
-
|
|
|
221
|
+
| 全体概要に領域内部の操作手順、状態を変える処理、例外分岐、物理テーブル・カラム、SQL、実装クラス、詳細 API、コマンドオプションを記載する | 詳細 CDFD の責務であり、二重管理と粒度超過を招くため |
|
|
226
222
|
| 全体概要または詳細 CDFD で状態の定義・遷移表を正本化する | 状態の定義と遷移は STSD が正本であり、CDFD との二重管理を招くため |
|
|
227
223
|
| 一覧、検索、状態参照、検証、dry-run などを、固有の業務成果がないまま独立領域にする | 補助操作を業務成果と誤認させるため |
|
|
228
|
-
|
|
|
224
|
+
| プロセス領域の表、データストア、図、詳細 CDFD 一覧で、同じ領域・グループ・データストアに異なる名称を使う | 読み手が同一対象と判断できなくなるため |
|
|
229
225
|
| ラベルのないエッジ、起点または到達先のないエッジ、「データストア」に行のないデータストアのノードを残す | 受け渡しの内容・方向・対応関係が読み取れなくなるため |
|
|
230
226
|
| 対象範囲内の参加者(ロール)を外部主体として描く | 業務プロセスの内側にいる担当を外部に置き、責任の所在を誤って示すため |
|
|
231
227
|
| 人間が責任を持つ主要判断、承認、公開可否を AI Agent またはシステムの自動処理として表す | 責任の所在を誤って示すため |
|
|
232
|
-
|
|
|
228
|
+
| 詳細 CDFD に独自の凡例を再掲・重複定義する | 全体概要の凡例を参照すべきであり、保守負荷と不整合を招くため |
|
|
233
229
|
| 詳細 CDFD 一覧や本文に「未作成」「TODO」などの作成状況を書く | 作成状況は登録簿で追跡するものであり、成果物本文が陳腐化するため |
|
|
234
230
|
| 作業メモや検討中の論点を HTML コメントで本文に残す | 読み手に見えない未決事項が生まれるため。「未決事項」章または登録簿へ移す |
|
|
@@ -10,6 +10,7 @@ specdojo:
|
|
|
10
10
|
template: specdojo:cdfd-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,17 +19,17 @@ specdojo:
|
|
|
18
19
|
|
|
19
20
|
Conceptual Data Flow Diagram Process Group Documentation Rulebook
|
|
20
21
|
|
|
21
|
-
|
|
22
|
+
全体概要で定めた一つのプロセスグループを引き継ぎ、グループに属する全領域の内部プロセス、領域間の受け渡し、主要例外、グループ外への委譲を、表と概念データフロー図(Mermaid または D2)で合意可能にするためのルールです。状態を変えるプロセスと起動条件は示しますが、状態の定義と遷移は STSD を参照します。
|
|
22
23
|
|
|
23
24
|
## 1. 全体方針
|
|
24
25
|
|
|
25
26
|
- 一文書は、全体概要で定めた一つのプロセスグループと、そのグループに属する一つ以上のプロセス領域を詳細化します。各領域はちょうど一つのプロセスグループ別 CDFD に属します。単一領域のグループも、その領域だけを含む一つのプロセスグループ別 CDFD として扱います。
|
|
26
|
-
-
|
|
27
|
+
- 「プロセス領域」をプロセスの業務目的・担当・起動条件・完了条件・必須性の表の正本とし、主要入力・主要出力の箇条書きは設けず、受け渡しは概念データフロー図を正本とします。「データストア」を本グループが読み書きする上位一覧の部分集合、「個別プロセス主要入出力」をプロセス単位の入出力の正本とします。
|
|
27
28
|
- 一つのプロセスノードは、一つの業務目的と完了条件を持つ処理だけを表します。コマンドや画面の一操作を無条件に一プロセスへ分割せず、複数の判断・更新・生成を一ノードに詰め込みません。
|
|
28
29
|
- 同一グループ内の領域間の受け渡しは内部フローとして図に描きます。他グループの内部処理は展開せず、プロセスグループ別 CDFD またはユースケース別 CDFD へ委譲します。
|
|
29
30
|
- 状態を変えるプロセスとその起点イベントは記載しますが、状態名・成立条件・遷移元・遷移先・イベント・遷移条件は STSD を正本とし、本書では参照関係だけを示します。
|
|
30
31
|
- 正常系だけでなく、業務結果を変える主要例外を、検出条件、扱い、継続・再開条件で定義します。ログや内部エラーの全列挙は行いません。
|
|
31
|
-
-
|
|
32
|
+
- 目的は 1〜2 文、適用範囲は対象と対象外を 1 行ずつとし、人間と AI Agent の責任分担などの共通原則は全体概要を参照します。凡例は全体概要の凡例を参照し、本書で再定義しません。
|
|
32
33
|
|
|
33
34
|
## 2. 位置づけと用語定義
|
|
34
35
|
|
|
@@ -77,11 +78,11 @@ Conceptual Data Flow Diagram Process Group Documentation Rulebook
|
|
|
77
78
|
|
|
78
79
|
| 番号 | 見出し | 必須 | 内容 |
|
|
79
80
|
| ---- | ---------------------------- | ---- | ------------------------------------------------------------------------------------------------------------------- |
|
|
80
|
-
| 1 | 目的 | ○ |
|
|
81
|
-
| 2 | 適用範囲 | ○ |
|
|
82
|
-
| 3 | プロセス領域 | ○ |
|
|
81
|
+
| 1 | 目的 | ○ | 対象者と利用場面(1〜2 文) |
|
|
82
|
+
| 2 | 適用範囲 | ○ | 対象と対象外を 1 行ずつ。共通の原則(人間と AI Agent の責任分担など)は全体概要を参照 |
|
|
83
|
+
| 3 | プロセス領域 | ○ | 領域ごとの節。各節はプロセスの表のみ(主要入力・主要出力・データストアの箇条書きは不要) |
|
|
83
84
|
| 4 | データストア | ○ | 全体概要と同じ名称・区分を持つ、本グループが読み書きするデータストアの部分集合と読み書きの別 |
|
|
84
|
-
| 5 | 概念データフロー | ○ |
|
|
85
|
+
| 5 | 概念データフロー | ○ | 一ノード一プロセスの図(Mermaid または D2)。図の説明は 1〜2 文。凡例は全体概要を参照 |
|
|
85
86
|
| 6 | 個別プロセス主要入出力 | ○ | プロセスごとの主要入力・主要出力・データストア。図を分割した場合は同じ単位で節を設ける |
|
|
86
87
|
| 7 | 状態遷移の参照 | ○ | 状態を変えるプロセスと STSD の対応。該当プロセスがない場合はその事実と確認根拠 |
|
|
87
88
|
| 8 | 主要例外とグループ外への委譲 | ○ | 主要例外の検出・停止範囲・扱い・再開、および他の CDFD への委譲。各区分が 0 件でも該当なしの事実と確認根拠を記録する |
|
|
@@ -91,19 +92,17 @@ Conceptual Data Flow Diagram Process Group Documentation Rulebook
|
|
|
91
92
|
|
|
92
93
|
### 6.1. 目的と適用範囲
|
|
93
94
|
|
|
94
|
-
-
|
|
95
|
-
-
|
|
96
|
-
-
|
|
97
|
-
- 人間と AI Agent の責任分担は本文で再定義せず、対応する方針文書を参照します。
|
|
98
|
-
- 特定プロジェクトの実行フェーズ名や一時的な仮称を持ち込まず、対象プロダクトの現在の正本として読める語彙を使います。
|
|
95
|
+
- 目的は、誰がグループ内部のフロー、領域間の受け渡し、主要例外、グループ外への委譲を合意または設計入力とするかを、1〜2 文で簡潔に記述します。
|
|
96
|
+
- 適用範囲は、対象(対象グループ・期間・境界)と対象外(領域内部の詳細化先、他グループの責務、横断ユースケース)をそれぞれ 1 行(1 文)で明記します。
|
|
97
|
+
- 人間と AI Agent の責任分担などの共通原則は本文で再定義せず、全体概要(またはプロジェクト方針文書)を参照します。
|
|
99
98
|
|
|
100
99
|
### 6.2. プロセス領域
|
|
101
100
|
|
|
102
|
-
-
|
|
103
|
-
- 領域ごとに節(`3.1.`、`3.2.`、…)を設け、見出しは「領域名(領域 ID
|
|
101
|
+
- 章の冒頭で、対象グループ名、含む領域数、全体概要との正本関係を簡潔に示します。全体概要の対象グループ名と、そこに属する全領域の ID・名称を引き継ぎ、領域を追加・削除・別グループへ移動しません。
|
|
102
|
+
- 領域ごとに節(`3.1.`、`3.2.`、…)を設け、見出しは「領域名(領域 ID)」とします。
|
|
103
|
+
- 各節はプロセスの表のみで構成します。主要入力・主要出力・データストアの箇条書きは記載せず、受け渡しは概念データフロー図を正本とします。
|
|
104
104
|
- 領域 ID、名称、業務目的、主な担当、起点イベントは全体概要を正本とします。本章では領域 ID と名称を見出しの対応キーとして使い、業務目的・担当・起点イベントを書き写しません。
|
|
105
|
-
-
|
|
106
|
-
- 各節の表は一行を一つのプロセスノードへ対応させます。主要入力・主要出力・データストアは箇条書きと「個別プロセス主要入出力」へ記載し、表の列には含めません。
|
|
105
|
+
- 各節の表は一行を一つのプロセスノードへ対応させます。
|
|
107
106
|
|
|
108
107
|
| 列 | 記載内容 | 判定基準 |
|
|
109
108
|
| ----------- | ---------------------------------------------- | ----------------------------------------------------------- |
|
|
@@ -119,67 +118,59 @@ Conceptual Data Flow Diagram Process Group Documentation Rulebook
|
|
|
119
118
|
|
|
120
119
|
- 全体概要の「データストア」と同じ「マスタ・構成データ」「トランザクションデータ」の節に分け、本グループが読み書きする行だけを掲載します。該当する行がない区分は節ごと省略します。
|
|
121
120
|
- 表の列は「データストア」「読み書き」「本グループでの利用」とします。「読み書き」は「参照」「更新」「参照・更新」のいずれかとし、物の保管先を扱う場合は利用内容に現物の受け渡しであることを示します。
|
|
122
|
-
-
|
|
123
|
-
- 名称と区分は全体概要から変更しません。新しいデータストアまたは区分変更が必要なら先に全体概要を変更し、本章だけへ追加しません。
|
|
124
|
-
- プロセス領域の全箇条書きと個別プロセス主要入出力にあるデータストアを過不足なく含め、各データストアがどの領域またはプロセスで参照・更新されるかを利用内容で説明します。
|
|
121
|
+
- 名称と区分は全体概要から変更しません。
|
|
125
122
|
- 概念データフローを複数図に分けて同じデータストアを再掲する場合を除き、表の各行と図のデータストアノードを一対一に対応させ、名称を一致させます。
|
|
126
123
|
|
|
127
124
|
### 6.4. 概念データフロー
|
|
128
125
|
|
|
129
|
-
-
|
|
126
|
+
- ノード、エッジ、形状、線種は、全体概要の「凡例(本プロダクト共通)」で選択された記法ルール(`specdojo:cdfd-mermaid-rulebook` または `specdojo:cdfd-d2-rulebook`)に従います。全体概要で記法が宣言されていない場合は Mermaid 記法に従います。
|
|
130
127
|
- 全体概要の各領域を一つの代表ノードとして再掲せず、「プロセス領域」の各表の行を一つずつ個別のプロセスノードとして配置します。
|
|
131
128
|
- 同一グループ内の領域間の受け渡しは、双方のプロセスを同じ図または対応する分割図に置いて示します。他グループは内部プロセスを描かず、委譲先の代表ノードまたは起点・完了イベントだけを置きます。
|
|
132
|
-
-
|
|
133
|
-
-
|
|
129
|
+
- 図は領域ごと、または業務の性質が近いプロセスごとに分けることを基本とします。
|
|
130
|
+
- 各図の直後に、全体概要の「凡例(本プロダクト共通)」を参照する旨、および省略事項を 1〜2 文で簡潔に注記します(色・絵文字の割り当ては再掲しません)。
|
|
134
131
|
- 状態名をノードとして並べたり、状態間の矢印を描いたりしません。状態を変える業務はプロセスと起点イベントだけを示し、「状態遷移の参照」から STSD へ接続します。
|
|
135
132
|
|
|
136
133
|
### 6.5. 個別プロセス主要入出力
|
|
137
134
|
|
|
138
135
|
- 図を領域単位で分けた場合は領域ごと、業務の性質で分けた場合は同じまとまりごとに節を設けます。
|
|
139
136
|
- プロセス ID ごとに、主要入力、主要出力、データストアを表で示します。業務目的、担当、起動条件、必須性は「プロセス領域」の表から重複させません。
|
|
140
|
-
-
|
|
137
|
+
- データストアの名称と区分は「データストア」および全体概要と一致させます。
|
|
141
138
|
- 全プロセスをちょうど一度掲載し、一プロセスだけのまとまりでも同じ表構成を省略しません。
|
|
142
139
|
|
|
143
140
|
### 6.6. 状態遷移の参照
|
|
144
141
|
|
|
145
142
|
- 状態を変えるプロセスがある場合、表の列は「対象」「状態を変えるプロセス」「ステータス定義(STSD)」とします。該当プロセスがない場合は、その事実と確認根拠を一文で記載して表を省略します。
|
|
146
143
|
- STSD は状態名・意味・成立条件と、遷移元・遷移先・イベント・遷移条件の単一正本として参照します。
|
|
147
|
-
- CDFD
|
|
148
|
-
- プロセスの業務目的や入出力は CDFD に残し、状態定義だけを STSD へ委ねます。参照によってフローの説明を空洞化させません。
|
|
144
|
+
- CDFD には状態の一覧、遷移表、状態を頂点とする状態遷移図を複製しません。
|
|
149
145
|
|
|
150
146
|
### 6.7. 主要例外とグループ外への委譲
|
|
151
147
|
|
|
152
|
-
- 主要例外は「例外 ID
|
|
153
|
-
- 条件付きプロセスを起動しない判断そのものは主要例外に含めません。非起動時の正常な扱いは「プロセス領域」の表にある必須性と図で示します。
|
|
148
|
+
- 主要例外は「例外 ID」「対象プロセス」「検出条件」「停止範囲」「本グループでの扱い」「継続・再開条件」の表で示します。
|
|
154
149
|
- グループ外委譲は「委譲先」「委譲する事項」「引き渡す情報」「本グループへ戻す条件」の表で示します。
|
|
155
|
-
-
|
|
156
|
-
- 委譲先 CDFD の内部プロセス、状態遷移、例外処理は展開しません。未作成の委譲先は文書 ID をバッククォートで示します。
|
|
157
|
-
- 主要例外が 0 件の場合も「主要例外」の節を残し、正常系・条件付きプロセス・更新失敗を確認した範囲と、業務結果または後続起動を変える例外がないという結論を一文で記載して表を省略します。
|
|
158
|
-
- グループ外委譲が 0 件の場合も「グループ外への委譲」の節を残し、対象外とした他グループの責務と横断ユースケースを確認した範囲、および委譲がないという結論を一文で記載して表を省略します。
|
|
150
|
+
- 主要例外またはグループ外委譲が 0 件の場合も対応する節を残し、確認範囲と該当なしの結論を一文で記載して表を省略します。
|
|
159
151
|
|
|
160
152
|
### 6.8. 完成判定
|
|
161
153
|
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
-
|
|
154
|
+
本節だけを `ready` 昇格のチェックリストの正本とします。次の全項目を満たす必要があります。
|
|
155
|
+
|
|
156
|
+
- Frontmatter に必須の `id`、`type`、`status`、`rulebook` があり、`id` とファイル名が命名規則に一致します。
|
|
157
|
+
- 「目的」が 1〜2 文で対象者と利用結果を定義し、「適用範囲」に対象と対象外が 1 行ずつ明記され、共通原則として全体概要が参照されています。
|
|
158
|
+
- 全体概要で対象グループに属する全領域が「プロセス領域」にちょうど一つの節として登場し、各節がプロセスの表だけで構成されています(箇条書きを含まない)。
|
|
165
159
|
- 各プロセスに業務目的、主な担当、起動条件、完了条件、必須性があり、完了条件は主要出力または正本の確定から yes / no で判定できます。
|
|
166
|
-
- 領域単位の主要入力・主要出力・データストアを合算すると、全体概要のグループ単位の箇条書きと矛盾せず、名称と区分が一致します。
|
|
167
160
|
- 全プロセスが領域ごとの表、図、個別プロセス主要入出力へ同じ ID と名称で登場し、ID が所属領域を示します。
|
|
168
|
-
-
|
|
161
|
+
- 「データストア」が全体概要の部分集合であり、名称・区分が一致します。
|
|
169
162
|
- 同一グループ内の領域間受け渡しを内部フローとしてたどれ、他グループの内部処理を作り込んでいません。
|
|
163
|
+
- 図の説明・注記は 1〜2 文で簡潔に記載され、凡例は全体概要の凡例を参照しています。
|
|
170
164
|
- 状態を変えるプロセスは STSD を参照し、CDFD 本文に状態の定義、遷移表、状態遷移図を重複記載していません。
|
|
171
165
|
- 主要例外の検出、停止範囲、継続・再開条件と、グループ外への引き渡しを確認者が説明できます。
|
|
172
|
-
- 主要例外またはグループ外委譲が 0 件の場合は、対応する節に確認範囲と該当なしの結論があり、空表やプレースホルダーが残っていません。
|
|
173
166
|
|
|
174
167
|
## 7. 禁止事項
|
|
175
168
|
|
|
176
|
-
-
|
|
177
|
-
-
|
|
178
|
-
-
|
|
179
|
-
- 全体概要と異なるデータストア名・区分を使用したり、物理テーブル名、物理カラム名、SQL、実装クラス、詳細 API
|
|
180
|
-
-
|
|
181
|
-
-
|
|
182
|
-
-
|
|
183
|
-
-
|
|
184
|
-
- プロセス領域の表と個別プロセス主要入出力、図直後の注記、例外表の間で同じ事実を重複記載しません。
|
|
185
|
-
- すべての内部エラー、ログ、再試行を主要例外として列挙せず、停止範囲や再開条件を判定できない曖昧な記述を残しません。
|
|
169
|
+
- プロセス領域に主要入力・主要出力・データストアの箇条書きを記載する、または図の受け渡しを文章でなぞる長文の注記を書く。
|
|
170
|
+
- 詳細 CDFD に独自の凡例を再掲・重複定義する。
|
|
171
|
+
- 複数領域を持つグループから一部の領域だけを切り出して別文書にしたり、一つの領域を複数のプロセスグループ別 CDFD に重複配置したりする。
|
|
172
|
+
- 全体概要と異なるデータストア名・区分を使用したり、物理テーブル名、物理カラム名、SQL、実装クラス、詳細 API を概念フローへ記載したりする。
|
|
173
|
+
- 状態名・意味を CDFD で定義したり、遷移元・遷移先・遷移条件の表や状態遷移図を複製したりする。
|
|
174
|
+
- 他グループの内部プロセスを展開したり、同一グループ内の領域間受け渡しをグループ外委譲として扱ったりする。
|
|
175
|
+
- 一覧、検索、状態参照、検証、dry-run など、独自の業務成果を持たない補助操作を独立プロセスにする。
|
|
176
|
+
- プロセス領域の表と個別プロセス主要入出力、図直後の注記、例外表の間で同じ事実を重複記載する。
|