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
|
@@ -11,45 +11,45 @@ specdojo:
|
|
|
11
11
|
|
|
12
12
|
Conceptual Data Flow Diagram Overview Writing Recipe
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
業務または運用の全体像を、プロセス領域のまとまりと、それらが読み書きするデータの関係として示すための作成手順です。今の方式(プロセスグループ別 CDFD を置く方式)と、系統の関係を描く方式(区分を代表ノードにし、各系統をユースケース別 CDFD で詳細化する方式)から選びます。
|
|
15
15
|
|
|
16
16
|
## 1. このレシピの使い方
|
|
17
17
|
|
|
18
18
|
- 最初に、対象業務・運用の範囲と、プロセス領域・データストアの候補を粗く書き出します。
|
|
19
|
-
-
|
|
20
|
-
-
|
|
19
|
+
- 次に、各章の問いに答えながら、目的、適用範囲、プロセス領域の表、データストア、概念データフロー(概要)、詳細 CDFD 一覧を具体化します。
|
|
20
|
+
- 最後に、レビュー観点で「表と図の名称が対応し、受け渡しが図で読み取れるか」「領域単位の詳細を書きすぎていないか」を確認します。
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
この成果物は、プロセスグループまたは区分とデータストアの名称を軸に、プロセス領域の表・データストア・図・詳細 CDFD 一覧の四点を対応させ、上位の業務目的を領域分割の理由として引き継ぎます。領域内の手順や実装方式は作り込まず、各要素の対応関係で判断を追跡できるようにします(Trace)。
|
|
23
23
|
|
|
24
24
|
## 2. 作成前に集める情報
|
|
25
25
|
|
|
26
|
-
| 項目
|
|
27
|
-
|
|
|
28
|
-
|
|
|
29
|
-
| 対象範囲
|
|
30
|
-
| 対象外
|
|
31
|
-
| 領域候補
|
|
32
|
-
|
|
|
33
|
-
| 主な担当
|
|
34
|
-
| 起点イベント
|
|
35
|
-
| データストア
|
|
36
|
-
| 保管先
|
|
37
|
-
| 主要な受け渡し
|
|
38
|
-
| 物理保管
|
|
39
|
-
| 外部主体
|
|
40
|
-
| 横断ユースケース
|
|
41
|
-
| 未決事項
|
|
26
|
+
| 項目 | 集める情報 |
|
|
27
|
+
| ------------------ | --------------------------------------------------------------------------------------------------------------- |
|
|
28
|
+
| 全体像 | 対象業務を構成するプロセス領域のまとまりと、読み書きするデータの関係 |
|
|
29
|
+
| 対象範囲 | 開始点、終了点、対象業務、組織、システム境界 |
|
|
30
|
+
| 対象外 | 補助操作、領域内の手順、実装詳細、別成果物が責任を持つ事項 |
|
|
31
|
+
| 領域候補 | 固有の業務目的、主な担当、起点イベントを持つ責務のまとまり |
|
|
32
|
+
| グループ・区分候補 | 業務の性質が近い領域のまとまり。系統の関係を描く方式では、系統・実行サイクル・調整役などの区分 |
|
|
33
|
+
| 主な担当 | 各領域を主に担うロール、複数ロールが担う場合の管理責任、人間の最終判断者 |
|
|
34
|
+
| 起点イベント | 各領域の開始を判定できる出来事 |
|
|
35
|
+
| データストア | 各グループまたは区分が参照・更新する論理的な正本と、その内容。マスタ・構成かトランザクションかの区分 |
|
|
36
|
+
| 保管先 | データストアの物理的な所在。実装が先にある場合は確定値、設計中は候補、概念段階では扱わない |
|
|
37
|
+
| 主要な受け渡し | グループまたは区分とデータストアの間で移動する情報・物、区分間の実行要求、調整役の直接読み書きと CLI 経由の区別 |
|
|
38
|
+
| 物理保管 | 現物(商品・現金など)を保管する場所(物の流れを図示する場合) |
|
|
39
|
+
| 外部主体 | 対象範囲外から入力を渡す人・組織・システムと、結果を受け取る主体。対象範囲内の参加者は含めない |
|
|
40
|
+
| 横断ユースケース | 今の方式では複数グループをまたぐ業務、系統の関係を描く方式では各系統の流れ |
|
|
41
|
+
| 未決事項 | 境界、名称、責務、判断者、保管先が未確定な論点と、影響、決定者、決定時期 |
|
|
42
42
|
|
|
43
43
|
## 3. 全体の作成手順
|
|
44
44
|
|
|
45
|
-
1.
|
|
45
|
+
1. 全体像として示す関係を 1〜2 文で書き、開始点、終了点、対象外を定義します。
|
|
46
46
|
2. 開始から結果利用までの業務成果を並べ、起点イベントと最終出力が異なるまとまりへ分け、各まとまりへ安定した領域 ID を付けます。
|
|
47
47
|
3. 一覧、検索、状態参照、検証、dry-run など、独立した業務成果を持たない候補を支援先の領域へ戻します。
|
|
48
|
-
4.
|
|
49
|
-
5.
|
|
50
|
-
6.
|
|
51
|
-
7.
|
|
52
|
-
8.
|
|
48
|
+
4. 業務の性質が近い領域を、今の方式ではプロセスグループへ、系統の関係を描く方式では区分へまとめ、8 以下にします。各節には領域の表だけを置き、必要なら PDCA 列を追加します。受け渡しの正本は図とし、主要入力・主要出力の箇条書きは置きません。
|
|
49
|
+
5. 各グループまたは区分が参照・更新するデータストアを集め、更新契機でマスタ・構成データとトランザクションデータに区分し、一覧にします。保管先は確定度に応じて列を置くか省略します。
|
|
50
|
+
6. グループまたは区分を代表ノードにし、データストアとの関係と区分間の要求を名詞のラベル付きの線で描きます。16 ノードを超える場合は選択した方式で分けます。系統の関係を描く方式ではデータの種類で分け、区分の位置をそろえ、線のない区分を省きます。調整役の指示は別図にし、直接読み書きするストアだけを調整役につなぎます。
|
|
51
|
+
7. 今の方式ではプロセスグループ別 CDFD の表と、横断業務のユースケース別 CDFD の表を作ります。系統の関係を描く方式では、各系統の流れをユースケース別 CDFD の表に載せます。
|
|
52
|
+
8. 名称を使って領域表、データストア、図、詳細 CDFD 一覧を突き合わせ、重複、欠落、名称ゆれを解消します。
|
|
53
53
|
9. 確定できない論点は影響と決定時期を添えて未決事項へ分離します。
|
|
54
54
|
|
|
55
55
|
## 4. 各章の書き方
|
|
@@ -58,17 +58,17 @@ Conceptual Data Flow Diagram Overview Writing Recipe
|
|
|
58
58
|
|
|
59
59
|
問い:
|
|
60
60
|
|
|
61
|
-
-
|
|
62
|
-
-
|
|
61
|
+
- どの業務または運用の全体像を示しますか。
|
|
62
|
+
- その全体像を構成するプロセス領域のまとまりと、読み書きするデータの関係は何ですか。
|
|
63
63
|
|
|
64
|
-
|
|
64
|
+
全体像として何を示すかを 1〜2 文で書きます。例えば「店舗運営の全体像として、仕入・販売・在庫・顧客・締めと、それらが読み書きするデータの関係を示す」とします。PO の承認や引き継ぎなどの作業、読み手の役割は目的に含めません。対象範囲と領域分割の PO 承認記録は、目的とは別に `ready` 昇格の完成判定で確認します。
|
|
65
65
|
|
|
66
66
|
### 4.2. 適用範囲
|
|
67
67
|
|
|
68
68
|
問い:
|
|
69
69
|
|
|
70
70
|
- どの出来事から、どの成果または判断までを扱いますか。
|
|
71
|
-
-
|
|
71
|
+
- 領域内部として選択した方式の詳細 CDFD へ委ねるものと、業務成果を持たないため補助操作として除外するものは何ですか。
|
|
72
72
|
- 人間が責任を持つ判断と、AI Agent やシステムが支援できる処理の境界はどこですか。対応する責任分担文書はありますか。
|
|
73
73
|
- 特定プロジェクトの実行計画・スケジュール上のフェーズ名を、前提知識のない読者への説明なく持ち込んでいませんか。
|
|
74
74
|
|
|
@@ -79,12 +79,11 @@ Conceptual Data Flow Diagram Overview Writing Recipe
|
|
|
79
79
|
問い:
|
|
80
80
|
|
|
81
81
|
- 各領域には、他の領域と区別できる固有の起点イベントと業務成果がありますか。定義系の領域の起点を実行の契機で書いていませんか。
|
|
82
|
-
-
|
|
83
|
-
-
|
|
84
|
-
- データストアの名称は「データストア」と一致していますか。
|
|
82
|
+
- グループまたは区分の見出しと領域表から、そのまとまりの業務目的が読み取れますか。
|
|
83
|
+
- 各領域は一つのグループまたは区分にだけ属していますか。PDCA を示す場合は任意の列にしていますか。
|
|
85
84
|
- 主な担当を「全員」だけで終わらせず、管理責任のロールを示していますか。
|
|
86
85
|
|
|
87
|
-
|
|
86
|
+
グループまたは区分ごとに節を設け、領域 ID、プロセス領域、業務目的、主な担当、起点イベントの表だけを置きます。PDCA は任意の列です。受け渡しは図を正本とし、主要入力・主要出力の箇条書きは置きません。業務目的は手段名ではなく、対象者が利用する成果または維持したい状態で書きます。領域を分けるか迷う場合は、起点、最終出力、更新する正本の三点を比較します。領域内部の詳細は選択した方式の詳細 CDFD へ委ねます。
|
|
88
87
|
|
|
89
88
|
### 4.4. データストア
|
|
90
89
|
|
|
@@ -92,7 +91,7 @@ Conceptual Data Flow Diagram Overview Writing Recipe
|
|
|
92
91
|
|
|
93
92
|
- 各データストアは、何の正本かが分かる名称ですか。生成物の場合は生成元、退避先の場合は退避対象が主な内容に書かれていますか。
|
|
94
93
|
- 区分は更新契機で判定していますか。定義から生成される生成物を、生成元と同じ区分にしていませんか。
|
|
95
|
-
- 保管先の列を置く場合、確定度に合った書き方(確定値、`_UNDECIDED_
|
|
94
|
+
- 保管先の列を置く場合、確定度に合った書き方(確定値、`_UNDECIDED_`、列の省略)になっていますか。保管先を共有・包含する場合は、論理境界と共有相手を注記していますか。
|
|
96
95
|
- リポジトリ基盤や開発環境の設定など、業務データでないものを除外していますか。
|
|
97
96
|
|
|
98
97
|
マスタ・構成データとトランザクションデータの 2 表に分けます。図に置くデータストアはこの一覧の行と一対一にするため、図で使いたい名称をここで確定します。
|
|
@@ -101,27 +100,28 @@ Conceptual Data Flow Diagram Overview Writing Recipe
|
|
|
101
100
|
|
|
102
101
|
問い:
|
|
103
102
|
|
|
104
|
-
-
|
|
105
|
-
-
|
|
106
|
-
-
|
|
107
|
-
-
|
|
108
|
-
-
|
|
109
|
-
-
|
|
110
|
-
-
|
|
103
|
+
- 今の方式と、系統の関係を描く方式のどちらを使いますか。凡例または章冒頭で宣言していますか。
|
|
104
|
+
- 代表ノードはグループまたは区分ごとに一つで、名称と含む領域 ID をラベルにしていますか。`subgraph` で囲んでいませんか。
|
|
105
|
+
- データストアは一覧の各行と一対一で名称が一致していますか。同じストアを複数図に再掲する場合も同じ名称ですか。
|
|
106
|
+
- 線のラベルは、何がどこからどこへ渡るか分かる名詞ですか。区分から区分への「対応要求」「実行要求」なども名詞のラベルで描いていますか。
|
|
107
|
+
- 対象範囲内の参加者を外部主体にしていませんか。外部主体は対象範囲外の入力元・出力先だけですか。
|
|
108
|
+
- 16 ノードを超える場合、選択した方式で分割していますか。今の方式ではデータストアの区分または使い方の流れで分け、名称を統一していますか。
|
|
109
|
+
- 系統の関係を描く方式では、データの種類で分けた図の間で区分の位置がそろっていますか。受け渡しの線のない区分をその図から省き、各区分をいずれかの図に出していますか。配置制御の非表示の線を受け渡しとして数えていませんか。
|
|
110
|
+
- 系統の関係を描く方式では、調整役(Orchestrator)をデータの図から外し、必要なら指示の図を別に設けていますか。調整役からストアへの線は直接の読み書きだけですか。CLI 経由のものはデータの図で該当区分からの線になっていますか。
|
|
111
|
+
- 図の題は業務の言葉で付けていますか。図の説明は、図から読み取れることを 1 文で書き、作図の約束は凡例に任せていますか。
|
|
111
112
|
|
|
112
|
-
|
|
113
|
+
系統の関係を描く方式では、例えば「PDCA のプロセスとデータの関係」「プロセスを実行する設定・構成情報の流れ」「Orchestrator による PDCA の調整」の 3 図にします。実行要求をトランザクションの図だけに限定する規則は設けず、調整役の指示は指示の図に描きます。グループや区分の内部は詳細 CDFD へ委ねます。物の流れがある場合は物理保管も図の要素として扱い、線種は採用した記法の凡例に従います。
|
|
113
114
|
|
|
114
115
|
### 4.6. 詳細 CDFD 一覧
|
|
115
116
|
|
|
116
117
|
問い:
|
|
117
118
|
|
|
118
|
-
-
|
|
119
|
-
-
|
|
120
|
-
-
|
|
121
|
-
- ユースケース別 CDFD の表に載せた業務は、複数のグループを横断し、順序と引き渡し条件を定める必要がありますか。単一グループに閉じる業務を載せていませんか。
|
|
119
|
+
- 選択した方式に応じた詳細 CDFD の役割分担を示していますか。状態の定義と遷移は STSD を正本にしていますか。
|
|
120
|
+
- 今の方式では、プロセスグループ別 CDFD の表に全グループが 1 行ずつあり、各領域がちょうど一つの行に属していますか。ユースケース別 CDFD は複数グループを横断する順序と引き渡し条件だけを扱っていますか。
|
|
121
|
+
- 系統の関係を描く方式では、各系統の流れをユースケース別 CDFD でプロセス領域の単位に詳細化していますか。プロセスグループ別 CDFD の表は省略するか、移行期・非推奨の記録として扱っていますか。
|
|
122
122
|
- 「未作成」などの作成状況を本文に書いていませんか。
|
|
123
123
|
|
|
124
|
-
作成状況は登録簿で追跡し、本文には ID
|
|
124
|
+
作成状況は登録簿で追跡し、本文には ID だけを書きます。今の方式で単一グループに閉じる業務はグループ別 CDFD で扱い、ユースケース別 CDFD は横断業務が必要になった時点で追加します。
|
|
125
125
|
|
|
126
126
|
### 4.7. 凡例(本プロダクト共通)(任意)
|
|
127
127
|
|
|
@@ -129,7 +129,7 @@ Conceptual Data Flow Diagram Overview Writing Recipe
|
|
|
129
129
|
|
|
130
130
|
- 本プロダクトに複数の詳細 CDFD があり、共通のノード形状・色・絵文字を使いますか。
|
|
131
131
|
- 全体概要と詳細 CDFD の各図が、この章の定義を再掲せず参照する形になっていますか。
|
|
132
|
-
-
|
|
132
|
+
- サンプル図には、採用する記法(Mermaid または D2)の rulebook が定義する全ノード種別が一つずつ含まれていますか。
|
|
133
133
|
|
|
134
134
|
詳細 CDFD が複数あり、色・絵文字の割り当てを毎回説明し直すと負担になる場合に設けます。単一の CDFD しかない場合は省略します。
|
|
135
135
|
|
|
@@ -146,53 +146,55 @@ Conceptual Data Flow Diagram Overview Writing Recipe
|
|
|
146
146
|
|
|
147
147
|
1. 各領域の目的から逆向きにたどり、その領域が応える利用者の判断または業務課題を確認します。
|
|
148
148
|
2. 各領域の起点イベントを見て、定義系の領域が実行の契機で書かれていないか、同じグループ内で同文になっていないかを確認します。
|
|
149
|
-
3.
|
|
149
|
+
3. 図の出力の線から順向きにたどり、他グループ・区分または外部主体が利用するか、データストアに残るかを確認します。
|
|
150
150
|
4. 同じデータストアを更新する複数グループを並べ、更新責務が重複していないか確認します。
|
|
151
|
-
5.
|
|
152
|
-
6.
|
|
151
|
+
5. 図の線を一本ずつたどり、領域表の業務目的とストアの主な内容に照らして、欠けた受け渡しや不要な線を修正します。
|
|
152
|
+
6. 「データストア」の各行がいずれかの図に登場し、再掲時も名称が一致するか確認します。保管先が重なる場合は論理境界と共有相手の注記を確認します。
|
|
153
153
|
7. コマンド名、画面名、ファイル名を隠しても目的と受け渡しを説明できるか確認し、説明できない行を概念粒度へ戻します。
|
|
154
154
|
8. 補助操作を除外したことで必要な検証入力が失われていないか確認し、独立領域ではなく支援先の入力として残します。
|
|
155
155
|
|
|
156
156
|
## 6. 良い例 / 悪い例
|
|
157
157
|
|
|
158
|
-
| 観点 | 良い例
|
|
159
|
-
| ------------ |
|
|
160
|
-
| 業務目的 | 現金販売を記録し、商品を顧客へ渡す
|
|
161
|
-
| 起点イベント | 定期実行定義は「定期的に確認・実行する事項が判明した」
|
|
162
|
-
| グループ粒度 | 店頭販売とつけ販売を「販売」グループにまとめ、値引きや取消の手順は詳細 CDFD へ委ねる
|
|
163
|
-
| 入出力 | 入力は購入依頼と支払、売価、つけ上限。出力は販売記録とつけ販売の記録
|
|
164
|
-
| データストア | 販売取引の正本である「販売記録」と、その生成物である「日次締め記録」を分ける
|
|
165
|
-
| 区分 | 定期実行定義(定義)はマスタ・構成、実行記録(活動の記録)はトランザクション
|
|
166
|
-
| 保管先 | 実装があるのでパスを書く。設計中は `_UNDECIDED_`。概念段階は列を省略
|
|
167
|
-
| 補助操作 | 商品検索は販売の入力確認として扱う
|
|
168
|
-
| 図の要素 | 顧客と仕入先を外部主体、店主を各領域の担当として内側に置く
|
|
169
|
-
| ノード数 | 代表ノード 6 とデータストア 15 の計 21
|
|
170
|
-
| 詳細化先 | 販売グループを `cdfd-sales` へ、つけ販売から精算までを `cdfd-uc-credit-sales` へ割り当てる
|
|
158
|
+
| 観点 | 良い例 | 悪い例 |
|
|
159
|
+
| ------------ | ----------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
|
|
160
|
+
| 業務目的 | 現金販売を記録し、商品を顧客へ渡す | 販売登録画面を実行する |
|
|
161
|
+
| 起点イベント | 定期実行定義は「定期的に確認・実行する事項が判明した」 | 定期実行定義に「指定された時期が到来した」(実行の契機) |
|
|
162
|
+
| グループ粒度 | 店頭販売とつけ販売を「販売」グループにまとめ、値引きや取消の手順は詳細 CDFD へ委ねる | 全体概要に値引き、取消、再入力を別ノードで並べる |
|
|
163
|
+
| 入出力 | 入力は購入依頼と支払、売価、つけ上限。出力は販売記録とつけ販売の記録 | 入力はフォーム、出力は JSON |
|
|
164
|
+
| データストア | 販売取引の正本である「販売記録」と、その生成物である「日次締め記録」を分ける | `sales-table`。または販売記録と締め記録を一つにまとめる |
|
|
165
|
+
| 区分 | 定期実行定義(定義)はマスタ・構成、実行記録(活動の記録)はトランザクション | 定義と記録を同じ区分にする |
|
|
166
|
+
| 保管先 | 実装があるのでパスを書く。設計中は `_UNDECIDED_`。概念段階は列を省略 | 未定なのに推測でパスを書く |
|
|
167
|
+
| 補助操作 | 商品検索は販売の入力確認として扱う | 商品検索を独立したプロセス領域にする |
|
|
168
|
+
| 図の要素 | 顧客と仕入先を外部主体、店主を各領域の担当として内側に置く | 店主を外部主体として描く |
|
|
169
|
+
| ノード数 | 代表ノード 6 とデータストア 15 の計 21 なのでデータの種類で分け、調整役がいれば指示を別図にする | 21 ノードを 1 図に並べる |
|
|
170
|
+
| 詳細化先 | 販売グループを `cdfd-sales` へ、つけ販売から精算までを `cdfd-uc-credit-sales` へ割り当てる | 領域ごとに詳細 CDFD を作り、横断業務を各図に重複記載する |
|
|
171
171
|
|
|
172
172
|
## 7. レビュー観点
|
|
173
173
|
|
|
174
|
-
| 観点 | 確認内容
|
|
175
|
-
| ---------- |
|
|
176
|
-
| 業務価値 | 各領域の目的が、対象者の課題、判断、期待する業務成果のどれに応えるか説明できる
|
|
177
|
-
| 対象境界 | 領域、プロセスグループ、補助操作、領域内部、人間の最終判断、外部主体の境界を承認できる
|
|
178
|
-
| 詳細化入力 |
|
|
179
|
-
| 網羅性 |
|
|
180
|
-
| 用語整合 |
|
|
181
|
-
| 粒度 |
|
|
182
|
-
| 可読性 |
|
|
174
|
+
| 観点 | 確認内容 | 主な確認者 |
|
|
175
|
+
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
|
|
176
|
+
| 業務価値 | 各領域の目的が、対象者の課題、判断、期待する業務成果のどれに応えるか説明できる | BA |
|
|
177
|
+
| 対象境界 | 領域、プロセスグループ、補助操作、領域内部、人間の最終判断、外部主体の境界を承認できる | PO |
|
|
178
|
+
| 詳細化入力 | 各グループまたは区分の受け渡し、データストア、詳細化先を識別できる | ARC |
|
|
179
|
+
| 網羅性 | 各領域が一つのグループまたは区分に属し、選択した方式の詳細 CDFD へ対応し、受け渡しに欠落がない | QE |
|
|
180
|
+
| 用語整合 | 領域、グループ、データストアの名称が表、一覧、図、詳細 CDFD 一覧で一致する | BA、QE |
|
|
181
|
+
| 粒度 | 全体概要がグループまたは区分単位の受け渡しに留まり、領域単位の入出力、手順、状態、例外、実装詳細を詳細化先へ委譲する | BA、ARC |
|
|
182
|
+
| 可読性 | グループまたは区分が 8 以下で、16 ノードを超える場合は選択した方式で分割され、系統の関係を描く方式では区分の位置と指示の別図が適切である | BA、ARC |
|
|
183
183
|
|
|
184
184
|
## 8. 仕上げチェック
|
|
185
185
|
|
|
186
|
-
-
|
|
187
|
-
|
|
188
|
-
-
|
|
189
|
-
-
|
|
190
|
-
-
|
|
191
|
-
-
|
|
192
|
-
-
|
|
193
|
-
-
|
|
194
|
-
-
|
|
195
|
-
-
|
|
196
|
-
-
|
|
186
|
+
最終的な完成判定は [[specdojo:cdfd-overview-rulebook|作成ルール]] の完成判定を正本とし、ここでは作成中の整合を確かめます。
|
|
187
|
+
|
|
188
|
+
- 目的は全体像として何を示すかを 1〜2 文で書き、対象範囲、対象外、責任分担は適用範囲に書いた。
|
|
189
|
+
- 各領域に ID、業務目的、担当、起点イベントがあり、各グループまたは区分の節は領域表だけにした。PDCA 列は必要な場合だけ追加した。
|
|
190
|
+
- グループまたは区分が 8 以下である。
|
|
191
|
+
- データストアをマスタ・構成とトランザクションに分け、保管先列を確定度に合った扱いにした。
|
|
192
|
+
- 代表ノード、領域表、データストア、詳細 CDFD 一覧の名称と ID が対応し、`subgraph` を使っていない。
|
|
193
|
+
- 受け渡しの全線に名詞のラベルがあり、区分間の実行要求も内容を読み取れる。
|
|
194
|
+
- 16 ノードを超える場合は選択した方式で分割した。系統の関係を描く方式ではデータの図で区分の位置をそろえ、線のない区分を省き、各区分はいずれかの図に出した。
|
|
195
|
+
- 系統の関係を描く方式では、調整役はデータの図に置かず、必要な指示の図に置いた。直接読み書きするストアだけにつなぎ、CLI 経由の読み書きはデータの図の該当区分から描いた。
|
|
196
|
+
- 図の題は業務の言葉で、図の説明は読み取れることを 1 文で書き、作図の約束を凡例にまとめた。
|
|
197
|
+
- 対象範囲内の参加者を外部主体にせず、補助操作を独立領域にしていない。
|
|
198
|
+
- 詳細 CDFD 一覧は選択した方式に従い、作成状況を書いていない。領域内部の詳細と状態定義はそれぞれの正本へ委ねた。
|
|
199
|
+
- 未決事項は `_UNDECIDED_` で区別し、影響、決定者、決定時期、状態を記載した。未決事項がなければ章を設けていない。
|
|
197
200
|
- 作業メモを HTML コメントで本文に残していない。
|
|
198
|
-
- 「凡例(本プロダクト共通)」を設けた場合、各図の注記がその定義を再掲せず参照している。
|