specdojo 0.8.0 → 0.9.1
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 +4 -1
- package/CHANGELOG.md +77 -0
- package/dist/catalog/catalog.js +16 -14
- package/dist/commands/agent.js +5 -3
- package/dist/commands/build.js +69 -10
- package/dist/commands/git.js +206 -0
- package/dist/commands/init.js +4 -2
- package/dist/commands/orchestrator.js +5 -77
- package/dist/commands/where.js +25 -0
- package/dist/dashboard/dashboard.js +5 -3
- package/dist/dashboard/routines.js +4 -7
- package/dist/dashboard/shared.js +2 -2
- package/dist/dashboard/timeline.js +14 -14
- package/dist/deliverable/trash.js +2 -1
- package/dist/docs/index-command.js +2 -2
- package/dist/docs/yaml-business-tables.js +243 -0
- package/dist/docs/yaml-interface-tables.js +106 -0
- package/dist/docs/yaml-pages-command.js +5 -3
- package/dist/docs/yaml-pages.js +146 -3
- package/dist/docs/yaml-table-shared.js +70 -0
- package/dist/docs/yaml-tables.js +39 -0
- package/dist/exec/agent-config.js +9 -0
- package/dist/exec/agent-protected-config.js +2 -0
- package/dist/exec/commands.js +31 -18
- package/dist/exec/events.js +34 -14
- package/dist/exec/evidence.js +13 -3
- package/dist/exec/opencode-permissions.js +117 -0
- package/dist/exec/parent-validation.js +56 -3
- package/dist/exec/plans-core.js +21 -2
- package/dist/exec/plans-generation.js +6 -7
- package/dist/exec/post-integration.js +162 -0
- package/dist/exec/queue-command.js +166 -0
- package/dist/exec/queue.js +285 -0
- package/dist/exec/register-foreign-wait.js +82 -0
- package/dist/exec/repo-integration-sync.js +17 -5
- package/dist/exec/repo-trace.js +2 -1
- package/dist/exec/reporter.js +2 -2
- package/dist/exec/results.js +24 -4
- package/dist/exec/review-kata.js +4 -1
- package/dist/exec/run/agent-pipeline.js +3 -2
- package/dist/exec/run/agent.js +12 -6
- package/dist/exec/run/change-scope.js +365 -0
- package/dist/exec/run/deferred-cleanup.js +31 -0
- package/dist/exec/run/in-place.js +5 -2
- package/dist/exec/run/job-lock.js +66 -0
- package/dist/exec/run/job-sequence.js +137 -0
- package/dist/exec/run/job.js +56 -19
- package/dist/exec/run/lifecycle-commands.js +1 -1
- package/dist/exec/run/lock.js +22 -1
- package/dist/exec/run/register-command.js +8 -5
- package/dist/exec/run/register-mode.js +68 -8
- package/dist/exec/run/register-resume.js +68 -14
- package/dist/exec/run/register-state.js +13 -8
- package/dist/exec/run/register-worktree.js +140 -125
- package/dist/exec/run/schedule-mode.js +75 -14
- package/dist/exec/run/schedule-prepare.js +3 -0
- package/dist/exec/run/schedule-task.js +88 -38
- package/dist/exec/run/shared.js +5 -0
- package/dist/exec/schedule/schedule.js +116 -4
- package/dist/exec/shared.js +2 -2
- package/dist/exec/smoke.js +190 -0
- package/dist/exec/strategy.js +13 -3
- package/dist/exec/task-repos.js +19 -4
- package/dist/exec/task-view.js +6 -4
- package/dist/exec/trial-commands.js +5 -2
- package/dist/exec/trial-core.js +6 -1
- package/dist/exec/validation-metrics.js +181 -0
- package/dist/exec/worktree-cleanup-lock.js +26 -0
- package/dist/exec/worktree-command.js +12 -2
- package/dist/exec/worktree-ops-commit.js +2 -2
- package/dist/exec/worktree.js +13 -2
- package/dist/grade/command-apply.js +3 -3
- package/dist/grade/command-inspect.js +5 -3
- package/dist/grade/command-plan.js +1 -1
- package/dist/grade/command-run.js +5 -1
- package/dist/grade/run.js +64 -8
- package/dist/job/definition.js +84 -8
- package/dist/job/job.js +79 -23
- package/dist/register/authoring-sources.js +22 -16
- package/dist/register/maintenance-commands.js +2 -2
- package/dist/register/register.js +31 -7
- package/dist/register/renumber.js +1 -3
- package/dist/routine/definition.js +9 -0
- package/dist/routine/routine.js +137 -43
- package/dist/routine/status.js +62 -0
- package/dist/schedule/schedule.js +38 -39
- package/dist/shared/agent-types.js +5 -0
- package/dist/shared/cross-process-lock.js +9 -1
- package/dist/shared/dist-freshness.js +8 -2
- package/dist/shared/git-environment.js +2 -1
- package/dist/shared/git.js +44 -1
- package/dist/shared/lefthook-scaffold.js +3 -0
- package/dist/shared/local-config.js +244 -0
- package/dist/shared/specdojo-config.js +34 -20
- package/dist/shared/specdojo-gitignore.js +1 -0
- package/dist/shared/text.js +17 -1
- package/dist/shared/where-alias.js +13 -0
- package/dist/specdojo.js +4 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +2 -0
- package/docs/ja/specdojo/guides/exec-config-guide.md +23 -4
- package/docs/ja/specdojo/guides/exec-operation-guide.md +44 -1
- package/docs/ja/specdojo/guides/job-sequence-guide.md +77 -0
- package/docs/ja/specdojo/guides/orchestrator-operation-guide.md +1 -1
- package/docs/ja/specdojo/guides/quick-start-guide.md +3 -3
- package/docs/ja/specdojo/guides/register-operation-guide.md +1 -1
- package/docs/ja/specdojo/guides/routine-operation-guide.md +11 -6
- package/docs/ja/specdojo/guides/schedule-design-guide.md +20 -17
- package/docs/ja/specdojo/guides/waza-guide.md +12 -8
- package/docs/ja/specdojo/recipes/bac-recipe.md +66 -49
- package/docs/ja/specdojo/recipes/bes-recipe.md +90 -54
- package/docs/ja/specdojo/recipes/bps-recipe.md +88 -139
- package/docs/ja/specdojo/recipes/br-recipe.md +40 -47
- package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +97 -109
- package/docs/ja/specdojo/recipes/cdfd-recipe.md +85 -146
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +91 -110
- package/docs/ja/specdojo/recipes/cnd-recipe.md +79 -69
- package/docs/ja/specdojo/recipes/cpd-recipe.md +78 -64
- package/docs/ja/specdojo/recipes/cxd-recipe.md +92 -75
- package/docs/ja/specdojo/recipes/ifd-recipe.md +79 -68
- package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +78 -105
- package/docs/ja/specdojo/recipes/ifx-index-recipe.md +105 -71
- package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +60 -49
- package/docs/ja/specdojo/recipes/pm-members-recipe.md +50 -51
- package/docs/ja/specdojo/recipes/pm-organization-recipe.md +59 -51
- package/docs/ja/specdojo/recipes/pm-plan-recipe.md +69 -56
- package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +37 -56
- package/docs/ja/specdojo/recipes/pm-raci-recipe.md +39 -53
- package/docs/ja/specdojo/recipes/pm-roles-recipe.md +52 -79
- package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +64 -93
- package/docs/ja/specdojo/recipes/prj-charter-recipe.md +71 -106
- package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +78 -157
- package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +62 -111
- package/docs/ja/specdojo/recipes/prj-scope-recipe.md +67 -123
- package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +60 -96
- package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +61 -105
- package/docs/ja/specdojo/recipes/stsd-recipe.md +79 -109
- package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +78 -55
- package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +82 -73
- package/docs/ja/specdojo/recipes/sysd-index-recipe.md +78 -59
- package/docs/ja/specdojo/recipes/tsd-recipe.md +149 -129
- package/docs/ja/specdojo/references/command-reference.md +258 -118
- package/docs/ja/specdojo/references/deliverables-reference.md +21 -12
- package/docs/ja/specdojo/references/specdojo-config-reference.md +47 -10
- package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +101 -257
- package/docs/ja/specdojo/rulebooks/atc-rulebook.md +102 -228
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +19 -28
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +16 -67
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +30 -51
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +41 -61
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +22 -50
- package/docs/ja/specdojo/rulebooks/bps-rulebook.md +24 -56
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +13 -38
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +41 -76
- package/docs/ja/specdojo/rulebooks/cdfd-d2-rulebook.md +18 -93
- package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +18 -52
- package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +109 -147
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +80 -108
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +21 -46
- package/docs/ja/specdojo/rulebooks/cdr-rulebook.md +144 -0
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +27 -48
- package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +37 -50
- package/docs/ja/specdojo/rulebooks/clis-rulebook.md +52 -69
- package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +33 -86
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +16 -32
- package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +45 -131
- package/docs/ja/specdojo/rulebooks/cop-rulebook.md +69 -275
- package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +20 -112
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +23 -56
- package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +12 -145
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +39 -47
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +37 -56
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +118 -175
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +5 -14
- package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +22 -66
- package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +36 -94
- package/docs/ja/specdojo/rulebooks/dss-rulebook.md +59 -81
- package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +31 -131
- package/docs/ja/specdojo/rulebooks/etc-rulebook.md +50 -104
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +51 -61
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +38 -45
- package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +14 -20
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +26 -38
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +26 -107
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +42 -49
- package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +14 -22
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +21 -44
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +41 -64
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +14 -38
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +34 -61
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +27 -50
- package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +70 -199
- package/docs/ja/specdojo/rulebooks/itc-rulebook.md +65 -153
- package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +74 -150
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +11 -23
- package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +99 -176
- package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +35 -61
- package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +75 -117
- package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +31 -60
- package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +26 -81
- package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +32 -70
- package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +45 -87
- package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +48 -101
- package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +44 -80
- package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +59 -127
- package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +31 -50
- package/docs/ja/specdojo/rulebooks/opd-rulebook.md +42 -109
- package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +29 -42
- package/docs/ja/specdojo/rulebooks/opr-rulebook.md +29 -87
- package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +62 -84
- package/docs/ja/specdojo/rulebooks/otp-rulebook.md +11 -61
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +91 -106
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +25 -34
- package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +30 -53
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +23 -35
- package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +27 -45
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +37 -45
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +45 -46
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +37 -48
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +25 -29
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +28 -35
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +36 -41
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +5 -18
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +16 -37
- package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +23 -97
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +39 -57
- package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +43 -116
- package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +16 -51
- package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +47 -92
- package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +25 -84
- package/docs/ja/specdojo/rulebooks/sac-rulebook.md +44 -107
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +39 -49
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +42 -49
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +64 -89
- package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +90 -189
- package/docs/ja/specdojo/rulebooks/stc-rulebook.md +45 -105
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +6 -12
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +49 -68
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +51 -60
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +46 -50
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +39 -64
- package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +47 -60
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +69 -70
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +65 -72
- package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +35 -46
- package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +49 -66
- package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +64 -139
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +41 -108
- package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +49 -144
- package/docs/ja/specdojo/rulebooks/utc-rulebook.md +67 -155
- package/docs/ja/specdojo/samples/bds-sample.md +58 -71
- package/docs/ja/specdojo/samples/bes-index-sample.md +20 -37
- package/docs/ja/specdojo/samples/bes-sample.md +43 -53
- package/docs/ja/specdojo/samples/bps-sample.md +42 -54
- package/docs/ja/specdojo/samples/br-sample.md +40 -52
- package/docs/ja/specdojo/samples/ccd-sample.md +0 -1
- package/docs/ja/specdojo/samples/cdr-sample.md +78 -0
- package/docs/ja/specdojo/samples/cdsd-sample.md +47 -63
- package/docs/ja/specdojo/samples/clis-sample.md +70 -77
- package/docs/ja/specdojo/samples/dec-sample.md +2 -3
- package/docs/ja/specdojo/samples/ifx-api-sample.yaml +0 -2
- package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +0 -2
- package/docs/ja/specdojo/samples/job-sequence.yaml +67 -0
- package/docs/ja/specdojo/samples/mip-index-sample.md +98 -20
- package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +26 -19
- package/docs/ja/specdojo/samples/pm-organization-sample.md +39 -50
- package/docs/ja/specdojo/samples/pm-plan-sample.md +61 -67
- package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +31 -45
- package/docs/ja/specdojo/samples/pm-raci-sample.md +31 -37
- package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +32 -48
- package/docs/ja/specdojo/samples/prj-charter-sample.md +42 -59
- package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +55 -61
- package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +30 -33
- package/docs/ja/specdojo/samples/sf-index-sample.md +13 -55
- package/docs/ja/specdojo/samples/sf-sample.md +73 -85
- package/docs/ja/specdojo/samples/sld-sample.md +60 -79
- package/docs/ja/specdojo/samples/uis-sample.md +98 -121
- package/docs/ja/specdojo/standards/job-definition-standard.md +24 -9
- package/docs/ja/specdojo/templates/cdr-template.md +58 -0
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +2 -1
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +42 -5
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +35 -0
- package/docs/specdojo/schemas/v1/job-run.schema.yaml +23 -0
- package/docs/specdojo/schemas/v1/job.schema.yaml +63 -2
- package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +2 -2
- package/package.json +9 -6
- package/templates/antigravity/orchestrator.md +4 -1
- package/templates/claude/agents/specdojo-orchestrator.md +4 -1
- package/templates/codex/agents/specdojo-orchestrator.toml +4 -1
- package/templates/codex/orchestrator.md +4 -1
- package/templates/init-exec-defaults.yaml +13 -0
- package/templates/lefthook/tools/specdojo-pre-commit.mjs +8 -0
- package/templates/opencode/agents/specdojo-orchestrator.md +5 -2
|
@@ -19,158 +19,130 @@ specdojo:
|
|
|
19
19
|
|
|
20
20
|
Conceptual Data Flow Diagram Process Group Documentation Rulebook
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
全体概要の一つのプロセスグループについて、全領域の内部プロセス、領域間の受け渡し、主要例外、グループ外委譲を、表と概念データフロー図(Mermaid または D2)で合意するためのルールです。
|
|
23
23
|
|
|
24
24
|
## 1. 全体方針
|
|
25
25
|
|
|
26
|
-
-
|
|
27
|
-
-
|
|
28
|
-
-
|
|
29
|
-
-
|
|
30
|
-
-
|
|
31
|
-
-
|
|
32
|
-
-
|
|
26
|
+
- 一文書で一つのプロセスグループに属する全領域を詳細化し、各領域をちょうど一文書に所属させます。単一領域のグループも同じ構成とします。
|
|
27
|
+
- プロセスの業務目的・担当・起動条件・完了条件・必須性は「プロセス領域」、受け渡しは図、プロセス単位の入出力は「個別プロセス主要入出力」を正本とします。
|
|
28
|
+
- 一ノードは一つの業務目的と完了条件を持つ処理とします。一操作ごとの機械的な分割や、複数の判断・更新・生成の詰め込みを避けます。
|
|
29
|
+
- 同一グループ内の領域間は内部フローとして描き、他グループの内部処理と横断順序は対応する CDFD へ委譲します。
|
|
30
|
+
- 状態を変えるプロセスと起点イベントだけを示し、状態名・成立条件・遷移元・遷移先・イベント・遷移条件は STSD を正本とします。
|
|
31
|
+
- 業務結果を変える主要例外を扱い、ログや内部エラーの全列挙は行いません。
|
|
32
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。整形・lint はリポジトリの検証で扱い、業務の受入確認に含めません。
|
|
33
33
|
|
|
34
34
|
## 2. 位置づけと用語定義
|
|
35
35
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
|
39
|
-
|
|
|
40
|
-
|
|
|
41
|
-
|
|
|
42
|
-
|
|
|
43
|
-
| データストア | 全体概要で名称と区分が定義された、情報の正本または継続的な保管先 |
|
|
44
|
-
| 主要例外 | 正常系と異なる業務判断、生成結果、引き渡し可否を生じさせ、再開条件の合意が必要な分岐 |
|
|
45
|
-
| グループ外委譲 | 他グループの内部処理を作り込まず、委譲先 CDFD、引き渡す情報、戻す条件によって責任境界を示すこと |
|
|
46
|
-
| 状態遷移の参照 | 状態を変えるプロセスから、状態一覧と状態遷移図を統合した STSD をたどる対応。状態名や遷移表そのものは含めない |
|
|
47
|
-
| 個別プロセス主要入出力 | プロセスごとの主要入力・主要出力・データストアを示す章。「プロセス領域」の表と項目を重複させない |
|
|
48
|
-
|
|
49
|
-
全体概要は領域とグループの分割、およびグループとデータストアの間の受け渡しを定義します。プロセスグループ別 CDFD は一グループの内部を詳細化し、ユースケース別 CDFD は複数グループを横断する順序と引き渡し条件だけを定義します。
|
|
36
|
+
全体概要は領域・グループの分割とグループ・データストア間の受け渡し、本書は一グループの内部、ユースケース別 CDFD は複数グループを横断する順序と引き渡し条件を定義します。
|
|
37
|
+
|
|
38
|
+
| 用語 | 区別する意味 |
|
|
39
|
+
| ---------------- | ----------------------------------------------------------------------- |
|
|
40
|
+
| プロセスグループ | 業務の性質が近い領域の集合。一文書の単位 |
|
|
41
|
+
| プロセス領域 | 全体概要で ID・名称・業務目的・担当・起点イベントを定めた責務のまとまり |
|
|
42
|
+
| プロセス | 起動条件と入力を受け、一つの業務上の出力または状態変化を生む処理単位 |
|
|
50
43
|
|
|
51
44
|
## 3. ファイル命名・ID規則
|
|
52
45
|
|
|
53
|
-
-
|
|
54
|
-
-
|
|
55
|
-
-
|
|
56
|
-
-
|
|
57
|
-
-
|
|
58
|
-
- 主要例外 ID は、対象領域の番号に二桁の枝番を付けた `E-<nn>-<nn>` 形式とします。複数領域にまたがる例外は、最初に検出するプロセスの領域番号を使います。
|
|
59
|
-
- プロセス ID と例外 ID は名称変更後も同じ対象を示す限り維持し、一覧、図、入出力表、例外表で同じ値を使います。
|
|
46
|
+
- 対象プロダクトの業務仕様のデータフローディレクトリに `cdfd-<group>.md` を置きます。`<group>` は全体概要のグループ名を表す英小文字・数字・ハイフンのスラッグです。
|
|
47
|
+
- product 成果物 ID は修飾なしの `cdfd-<group>`(例: `cdfd-sales`)とします。全体概要の `cdfd-overview` とユースケース別の `cdfd-uc-<topic>` は対象外です。
|
|
48
|
+
- プロセス ID は領域 ID `P-<nn>` に二桁の枝番を付けた `P-<nn>-<nn>`(例: `P-03-02`)とし、文書内一意の `P-01` 形式は使いません。
|
|
49
|
+
- 例外 ID は `E-<nn>-<nn>` とし、複数領域にまたがる場合は最初に検出する領域の番号を使います。
|
|
50
|
+
- 同じプロセス・例外の ID は名称変更後も維持し、表・図で一致させます。
|
|
60
51
|
|
|
61
52
|
## 4. 推奨 Frontmatter 項目
|
|
62
53
|
|
|
63
|
-
|
|
64
|
-
| ---------- | ----------------------------------------------------- | ---- |
|
|
65
|
-
| id | `cdfd-<group>` | ○ |
|
|
66
|
-
| type | `flow` | ○ |
|
|
67
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
68
|
-
| rulebook | `specdojo:cdfd-rulebook` | ○ |
|
|
69
|
-
| based_on | 全体概要など、依存関係上許可された直接の内容根拠の ID | 任意 |
|
|
70
|
-
| supersedes | 置き換える旧 CDFD の ID | 任意 |
|
|
54
|
+
共通の必須項目・許可キー・型制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` に従います。
|
|
71
55
|
|
|
72
|
-
-
|
|
73
|
-
- `based_on`
|
|
74
|
-
-
|
|
75
|
-
- 作成途中の `status` は `draft` とします。`ready` へ昇格できるのは、「完成判定」の全項目を満たし、対象プロジェクトのロール定義または責任分担文書で特定した承認者による業務境界・主要例外・委譲境界の承認記録を、登録簿の決定記録またはレビュー結果から特定できる場合です。
|
|
56
|
+
- `id` は「ファイル命名・ID規則」、`type` は `flow`、`rulebook` は `specdojo:cdfd-rulebook` とします。
|
|
57
|
+
- `based_on` は、全体概要など実際に直接の根拠とした文書の ID とし、成果物カタログの `depends_on` の推移閉包内に限ります。product 文書は参照先も修飾なしの ID を使います。
|
|
58
|
+
- タイトルと利用目的は H1 と「目的」に記載します。
|
|
76
59
|
|
|
77
60
|
## 5. 本文要件
|
|
78
61
|
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
|
82
|
-
|
|
|
83
|
-
|
|
|
84
|
-
|
|
|
85
|
-
|
|
|
86
|
-
|
|
|
87
|
-
|
|
|
88
|
-
|
|
|
89
|
-
|
|
|
62
|
+
章の順序・骨組みは Frontmatter で宣言した template を使い、各章を次の条件で受け入れます。
|
|
63
|
+
|
|
64
|
+
| 見出し | 必須 | 内容 |
|
|
65
|
+
| ---------------------------- | ---- | --------------------------------------------------------------------------- |
|
|
66
|
+
| 目的 | ○ | 対象者と利用場面を 1〜2 文で示す |
|
|
67
|
+
| 適用範囲 | ○ | 対象と対象外を各 1 行で示す |
|
|
68
|
+
| プロセス領域 | ○ | 領域ごとにプロセス表だけを置く |
|
|
69
|
+
| データストア | ○ | 全体概要の部分集合を同名・同区分で示し、読み書きを区別する |
|
|
70
|
+
| 概念データフロー | ○ | 一ノード一プロセスの図と、1〜2 文の説明・注記 |
|
|
71
|
+
| 個別プロセス主要入出力 | ○ | 図の分割単位に対応するプロセス単位の入出力表 |
|
|
72
|
+
| 状態遷移の参照 | ○ | 状態を変えるプロセスと STSD の対応。該当なしでも事実と確認根拠を記載 |
|
|
73
|
+
| 主要例外とグループ外への委譲 | ○ | 検出・停止範囲・扱い・再開と委譲境界。各区分が 0 件でも事実と確認根拠を記載 |
|
|
74
|
+
| 未決事項 | 任意 | 未決論点と影響する領域・プロセス・例外・委譲 |
|
|
90
75
|
|
|
91
76
|
## 6. 記述ガイド
|
|
92
77
|
|
|
93
78
|
### 6.1. 目的と適用範囲
|
|
94
79
|
|
|
95
|
-
-
|
|
96
|
-
-
|
|
97
|
-
- 人間と AI Agent
|
|
80
|
+
- 目的は、誰が内部フロー・領域間の受け渡し・主要例外・委譲を合意または設計入力に使うかを示します。
|
|
81
|
+
- 適用範囲の対象はグループ・期間・組織・システム境界・開始と終了、対象外は他グループの責務・横断ユースケース・詳細化先を示します。
|
|
82
|
+
- 人間と AI Agent の責任分担などの共通原則は全体概要またはプロジェクト方針を参照します。
|
|
98
83
|
|
|
99
84
|
### 6.2. プロセス領域
|
|
100
85
|
|
|
101
|
-
-
|
|
102
|
-
-
|
|
103
|
-
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
|
108
|
-
|
|
|
109
|
-
|
|
|
110
|
-
|
|
|
111
|
-
|
|
|
112
|
-
|
|
|
113
|
-
|
|
|
114
|
-
| 完了条件 | 業務目的を達成したと判定できる出力または事実 | yes / no で判定でき、主要出力または正本の確定と対応している |
|
|
115
|
-
| 必須性 | 必須、条件付き、選択のいずれか | 条件付き・選択では起動条件と非起動時の正常な扱いを示す |
|
|
86
|
+
- 冒頭でグループ名・領域数・全体概要との正本関係を示します。所属する全領域の ID・名称を引き継ぎ、追加・削除・移動はしません。
|
|
87
|
+
- 領域ごとに「領域名(領域 ID)」の節を設け、プロセス表だけを置きます。領域の業務目的・担当・起点イベントは全体概要から書き写しません。
|
|
88
|
+
- 各領域に一つ以上のプロセスを置き、一行を一ノードに対応させます。
|
|
89
|
+
|
|
90
|
+
| 列 | 記載内容と判定基準 |
|
|
91
|
+
| ----------- | -------------------------------------------------------------------------- |
|
|
92
|
+
| プロセス ID | 所属領域の枝番。表と図で一致 |
|
|
93
|
+
| プロセス | 一つの業務目的が分かる短い名称。複数処理や操作列を詰め込まない |
|
|
94
|
+
| 業務目的 | 対象者に生じる成果または維持する状態。手順・遷移の列挙にしない |
|
|
95
|
+
| 主な担当 | 主担当ロールまたは外部主体。個人名を使わず、人間の最終判断を明示 |
|
|
96
|
+
| 起動条件 | 判定可能なイベント・前段完了・承認条件。「必要に応じて」で終わらせない |
|
|
97
|
+
| 完了条件 | 主要出力または正本の確定に対応し、yes / no で判定できる事実 |
|
|
98
|
+
| 必須性 | 必須/条件付き/選択。条件付き・選択は起動条件と非起動時の正常な扱いを示す |
|
|
116
99
|
|
|
117
100
|
### 6.3. データストア
|
|
118
101
|
|
|
119
|
-
-
|
|
120
|
-
-
|
|
121
|
-
-
|
|
122
|
-
- 概念データフローを複数図に分けて同じデータストアを再掲する場合を除き、表の各行と図のデータストアノードを一対一に対応させ、名称を一致させます。
|
|
102
|
+
- 全体概要の「マスタ・構成データ」「トランザクションデータ」と同じ区分に、本グループが読み書きする行だけを置きます。該当行がない区分は節ごと省略します。
|
|
103
|
+
- 列は「データストア」「読み書き」「本グループでの利用」。読み書きは「参照」「更新」「参照・更新」とし、現物の保管先は利用内容に現物の受け渡しを示します。
|
|
104
|
+
- 名称・区分は上位と一致させ、表の行と図のノードを一対一に対応させます。分割図で同じノードを再掲する場合も名称を保ちます。
|
|
123
105
|
|
|
124
106
|
### 6.4. 概念データフロー
|
|
125
107
|
|
|
126
|
-
-
|
|
127
|
-
-
|
|
128
|
-
-
|
|
129
|
-
-
|
|
130
|
-
-
|
|
131
|
-
- 状態名をノードとして並べたり、状態間の矢印を描いたりしません。状態を変える業務はプロセスと起点イベントだけを示し、「状態遷移の参照」から STSD へ接続します。
|
|
108
|
+
- 全体概要の「凡例(本プロダクト共通)」で選ばれた [[specdojo:cdfd-mermaid-rulebook|Mermaid 記法ルール]] または [[specdojo:cdfd-d2-rulebook|D2 記法ルール]] を適用し、記法未宣言時は Mermaid とします。
|
|
109
|
+
- 「プロセス領域」の各行を個別ノードにし、全体概要の領域代表ノードを再掲しません。
|
|
110
|
+
- 領域間の受け渡しは双方のプロセスを同じ図または対応する分割図に置きます。他グループは委譲先代表ノードまたは起点・完了イベントだけを置きます。
|
|
111
|
+
- 領域ごと、または業務の性質が近いプロセスごとに分けます。条件付き・選択プロセスは、起動時と非起動でも正常完了する経路をたどれるようにします。
|
|
112
|
+
- 図直後の注記は、記法ルールの「凡例と可読性」に従い、凡例の適用元・使用線種・省略した入出力と理由・共有ノードを 1〜2 文で示します。色・絵文字の割り当ては再掲しません。
|
|
132
113
|
|
|
133
114
|
### 6.5. 個別プロセス主要入出力
|
|
134
115
|
|
|
135
|
-
-
|
|
136
|
-
-
|
|
137
|
-
-
|
|
138
|
-
- 全プロセスをちょうど一度掲載し、一プロセスだけのまとまりでも同じ表構成を省略しません。
|
|
116
|
+
- 図と同じ分割単位で節を設け、全プロセスをちょうど一度掲載します。一プロセスだけでも表を省略しません。
|
|
117
|
+
- 列は「プロセス ID」「プロセス」「主要入力」「主要出力」「データストア」。業務目的・担当・起動条件・必須性は重複させません。
|
|
118
|
+
- データストアの名称・区分は「データストア」と全体概要に一致させます。
|
|
139
119
|
|
|
140
120
|
### 6.6. 状態遷移の参照
|
|
141
121
|
|
|
142
|
-
|
|
143
|
-
- STSD は状態名・意味・成立条件と、遷移元・遷移先・イベント・遷移条件の単一正本として参照します。
|
|
144
|
-
- CDFD には状態の一覧、遷移表、状態を頂点とする状態遷移図を複製しません。
|
|
122
|
+
列は「対象」「状態を変えるプロセス」「ステータス定義(STSD)」とします。該当プロセスがない場合は、事実と確認根拠を一文で記載して表を省略します。
|
|
145
123
|
|
|
146
124
|
### 6.7. 主要例外とグループ外への委譲
|
|
147
125
|
|
|
148
|
-
-
|
|
149
|
-
-
|
|
150
|
-
-
|
|
126
|
+
- 主要例外の列は「例外 ID」「対象プロセス」「検出条件」「停止範囲」「本グループでの扱い」「継続・再開条件」。停止範囲には起動・確定してはならない後続プロセス・出力・委譲を示します。
|
|
127
|
+
- 委譲の列は「委譲先」「委譲する事項」「引き渡す情報」「本グループへ戻す条件」。
|
|
128
|
+
- 各区分が 0 件でも節を残し、確認範囲と該当なしの結論を一文で記載して表を省略します。
|
|
151
129
|
|
|
152
130
|
### 6.8. 完成判定
|
|
153
131
|
|
|
154
|
-
|
|
132
|
+
「本文要件」と「記述ガイド」、選択した記法ルール、型固有の禁止事項を併用して全必須条件を照合します。確認者は次の順に表と図をたどり、条件ごとに pass / fail を判断します。条件付き要件が非該当なら、その根拠を確認します。必須条件に欠落・不一致があれば不合格です。
|
|
155
133
|
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
- 全プロセスが領域ごとの表、図、個別プロセス主要入出力へ同じ ID と名称で登場し、ID が所属領域を示します。
|
|
161
|
-
- 「データストア」が全体概要の部分集合であり、名称・区分が一致します。
|
|
162
|
-
- 同一グループ内の領域間受け渡しを内部フローとしてたどれ、他グループの内部処理を作り込んでいません。
|
|
163
|
-
- 図の説明・注記は 1〜2 文で簡潔に記載され、凡例は全体概要の凡例を参照しています。
|
|
164
|
-
- 状態を変えるプロセスは STSD を参照し、CDFD 本文に状態の定義、遷移表、状態遷移図を重複記載していません。
|
|
165
|
-
- 主要例外の検出、停止範囲、継続・再開条件と、グループ外への引き渡しを確認者が説明できます。
|
|
134
|
+
1. 目的・適用範囲を読み、全体概要の全所属領域が一節ずつあることを照合します。
|
|
135
|
+
2. 各プロセスの起動から主要出力・正本確定までを追い、完了条件と条件付き・選択の非起動時の正常完了を確認します。表・図・入出力表の ID・名称、入出力表への一度だけの掲載、データストアの名称・区分・読み書きを照合します。
|
|
136
|
+
3. 領域間の内部フローと図直後の注記を確認し、状態を変える全プロセスから STSD を特定します。
|
|
137
|
+
4. 各主要例外について検出から停止・対応・再開、各委譲について受け手・責務・情報・戻す条件を表の全列で確認します。0 件の区分も確認根拠を読みます。
|
|
166
138
|
|
|
167
139
|
## 7. 禁止事項
|
|
168
140
|
|
|
169
|
-
-
|
|
141
|
+
- プロセス領域に主要入力・主要出力・データストアの箇条書きを置く、図を文章でなぞる長文注記を書く。
|
|
170
142
|
- 詳細 CDFD に独自の凡例を再掲・重複定義する。
|
|
171
|
-
-
|
|
172
|
-
-
|
|
173
|
-
- 状態名・意味を CDFD
|
|
174
|
-
-
|
|
175
|
-
-
|
|
176
|
-
-
|
|
143
|
+
- 所属領域の一部を別文書に切り出す、一領域を複数文書に重複配置する。
|
|
144
|
+
- 物理テーブル・カラム・SQL・実装クラス・詳細 API を概念フローに書く。
|
|
145
|
+
- 状態名・意味を CDFD で定義する、遷移元・遷移先・条件の表や状態を頂点とする遷移図を複製する。
|
|
146
|
+
- 他グループの内部処理を展開する、内部の領域間受け渡しをグループ外委譲として扱う。
|
|
147
|
+
- 一覧・検索・状態参照・検証・dry-run など、独自の業務成果がない補助操作を独立プロセスにする。
|
|
148
|
+
- プロセス表・入出力表・図直後注記・例外表の間で同じ事実を重複記載する。
|
|
@@ -24,23 +24,13 @@ Conceptual Data Flow Diagram Use Case Documentation Rulebook
|
|
|
24
24
|
## 1. 全体方針
|
|
25
25
|
|
|
26
26
|
- 一文書は、全体概要の「詳細 CDFD 一覧」にある一つのケース ID と、そのユースケースまたは系統を詳細化します。描く単位と詳細化の境界は「描き方の選択」に従います。
|
|
27
|
-
-
|
|
28
|
-
-
|
|
29
|
-
-
|
|
30
|
-
- 目的はその業務が何のためにあるかを 1〜2 文、適用範囲は対象と対象外を 1 行ずつとします。人間と AI Agent の責任分担などの共通原則と凡例は、全体概要を参照し、本書で再定義しません。
|
|
31
|
-
- 状態名・成立条件・遷移元・遷移先・イベント・遷移条件は STSD を正本とします。本書は状態の定義や遷移表を持ちません。
|
|
27
|
+
- 開始から終了までの横断順序と受け渡しは「概念データフロー」の図だけを正本とします。「プロセス領域」は責務の正本であり、順序欄と章冒頭の通過順は図に一致させる対応表現です。不一致時は図を根拠に表・通過順を修正し、順序を変えるときは図を先に改訂します。「データストア」は全体概要の一覧の部分集合とします。
|
|
28
|
+
- 人間と AI Agent の責任分担などの共通原則と凡例は全体概要、状態の定義と遷移は STSD を正本とし、本書で再定義しません。
|
|
29
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎ、`deprecated` の文書を参照しないことは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、本書と成果物で言い直しません。文書の整形・lint はリポジトリの検証で扱い、「完成判定」に含めません。
|
|
32
30
|
|
|
33
|
-
## 2.
|
|
31
|
+
## 2. 位置づけ
|
|
34
32
|
|
|
35
|
-
|
|
36
|
-
| ---------------- | -------------------------------------------------------------------------- |
|
|
37
|
-
| 全体概要 | 領域のまとまり、データストア、詳細 CDFD の割り当てを定める `cdfd-overview` |
|
|
38
|
-
| ケース ID | 全体概要でユースケースまたは系統に割り当てられた `C-<nn>` 形式の識別子 |
|
|
39
|
-
| 起点イベント | 業務を始める、発生を判定できる出来事 |
|
|
40
|
-
| 関連データストア | 対象ケースで参照・更新する、全体概要と同じ名称・区分を持つ正本 |
|
|
41
|
-
| 例外時の戻り | 不足や不一致を、補完・再判断を担う参加単位へ返す業務上の流れ |
|
|
42
|
-
|
|
43
|
-
全体概要がケースの業務目的と対象範囲を選定し、本書がその流れを具体化します。領域の分割、名称、担当、起点イベントは全体概要を正本とします。構造・必須項目・禁止事項の判断は本 rulebook に従い、骨組みや作成手順と矛盾する場合もこの内容要件を優先します。
|
|
33
|
+
全体概要(`cdfd-overview`)がケース ID(`C-<nn>`)と業務目的・対象範囲を選定し、本書がその流れを具体化します。領域の分割、名称、担当、起点イベントは全体概要を正本とします。構造・必須項目・禁止事項の判断は本 rulebook に従い、骨組みや作成手順と矛盾する場合もこの内容要件を優先します。
|
|
44
34
|
|
|
45
35
|
## 3. ファイル命名・ID規則
|
|
46
36
|
|
|
@@ -54,20 +44,18 @@ Conceptual Data Flow Diagram Use Case Documentation Rulebook
|
|
|
54
44
|
|
|
55
45
|
- 共通の必須項目、値・構文・構造は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と同標準が参照するスキーマに従い、本書では再定義しません。成果物種別は本 rulebook の `deliverable_type` に従います。
|
|
56
46
|
- `based_on` に全体概要を記載する場合も product 成果物 ID を使用し、成果物カタログの `depends_on` の推移閉包に含まれる根拠だけを列挙します。
|
|
57
|
-
- status が `deprecated` の文書を `based_on` と本文の参照先にしません。有効な全体概要や後継文書へ参照を更新します。
|
|
58
47
|
- ケース ID、ユースケース名、開始・終了は本文で定義し、未定義の Frontmatter 項目を追加しません。
|
|
59
|
-
- 作成・改訂中は `status: draft` を維持します。人間による `ready` 昇格の承認者・証跡と確認手順は「完成判定」に従います。
|
|
60
48
|
|
|
61
49
|
## 5. 本文要件
|
|
62
50
|
|
|
63
51
|
見出し順・表・記入欄の骨組みは template を正本とし、本章では重複させず、必要な判断情報を定めます。
|
|
64
52
|
|
|
65
|
-
- **業務の識別と境界(必須)**: 導入文でケース ID
|
|
53
|
+
- **業務の識別と境界(必須)**: 導入文でケース ID と業務名、目的で業務の存在理由と成果、適用範囲で対象と対象外を示します。
|
|
66
54
|
- **責務と正本の利用(必須)**: プロセス領域で参加単位の責務と詳細化の境界を、データストアで全体概要から選んだ正本の用途を示します。各節は役割表または利用の表とし、入出力の列挙に展開しません。
|
|
67
55
|
- **流れの合意(必須)**: 概念データフローで開始・終了、参加単位、関連データストア、情報・物の受け渡しを示します。各図に業務の言葉による題と説明 1 文を付けます。
|
|
68
56
|
- **判断待ちの可視化(条件付き)**: 境界、名称、責務、判断者に未確定の論点がある場合だけ、未決事項を最終章に置きます。
|
|
69
57
|
|
|
70
|
-
「引き渡し」「例外時の戻り先」の章は設けません。図を分ける場合は「概念データフロー」に `5.1.`、`5.2.`
|
|
58
|
+
「引き渡し」「例外時の戻り先」の章は設けません。図を分ける場合は「概念データフロー」に `5.1.`、`5.2.` の節を設け、例外時の戻りも同章内の図で示します。
|
|
71
59
|
|
|
72
60
|
## 6. 記述ガイド
|
|
73
61
|
|
|
@@ -83,13 +71,13 @@ Conceptual Data Flow Diagram Use Case Documentation Rulebook
|
|
|
83
71
|
| 詳細化の境界 | グループ内部の領域・プロセス・主要例外は有効な `cdfd-<group>` へ委ねる | 対象系統と共用領域の流れを領域単位で示し、非推奨のグループ別 CDFD へ依存しない |
|
|
84
72
|
| 入口 | ケースの開始イベントを描く | 系統の入口の起点イベントを描き、文言を全体概要の「プロセス領域」の表と一致させる |
|
|
85
73
|
|
|
86
|
-
どちらの方式でも、複数の系統(ユースケース)が共通して通るプロセス領域(領域のまとまりを含む)の内部は、全体概要またはその領域の詳細文書の 1 か所だけで描きます。ほかの詳細文書では、その領域を 1
|
|
74
|
+
どちらの方式でも、複数の系統(ユースケース)が共通して通るプロセス領域(領域のまとまりを含む)の内部は、全体概要またはその領域の詳細文書の 1 か所だけで描きます。ほかの詳細文書では、その領域を 1 つのノードとして置き、領域との受け渡しの線だけを描きます。内部を描く文書を役割表の「参照先」に示し、内部のプロセス・データストアの読み書き・例外時の戻りを重複して展開しません。その領域から外へ返す例外の情報は、受け渡しとして省略せず描きます。
|
|
87
75
|
|
|
88
76
|
良い例: 共用する実行・評価・完了を 1 ノードにまとめ、内部の正本を参照する。悪い例: 系統ごとに共用領域の内部を描き直す。
|
|
89
77
|
|
|
90
78
|
### 6.2. 導入文と目的
|
|
91
79
|
|
|
92
|
-
- 導入文は、全体概要で選んだケース ID
|
|
80
|
+
- 導入文は、全体概要で選んだケース ID と業務名を一文で明示し、目的の前に置きます。
|
|
93
81
|
- 目的は、そのユースケースまたは系統が何のためにあるかを 1〜2 文で記述します。
|
|
94
82
|
- BA・QE・承認者など、読み手ごとの承認・設計・確認作業を目的に書きません。
|
|
95
83
|
|
|
@@ -98,8 +86,7 @@ Conceptual Data Flow Diagram Use Case Documentation Rulebook
|
|
|
98
86
|
### 6.3. 適用範囲
|
|
99
87
|
|
|
100
88
|
- 対象はケース ID、参加単位、開始イベント、終了時の成果、必要な組織・システム境界を 1 行(1 文)で示します。
|
|
101
|
-
- 対象外は操作手順、補助操作、実装詳細などを 1 行(1
|
|
102
|
-
- 人間と AI Agent の責任分担などの共通原則は、全体概要を参照します。
|
|
89
|
+
- 対象外は操作手順、補助操作、実装詳細などを 1 行(1 文)で示し、詳細化の境界は「描き方の選択」に従います。
|
|
103
90
|
|
|
104
91
|
良い例: 対象を「在庫の補充基準割れから販売の商品引受けまで」、対象外を「内部の発注手順・状態遷移は各正本へ委ねる」と分ける。悪い例: 「補充に関する全業務」とだけ書き、内部処理との境界を決めない。
|
|
105
92
|
|
|
@@ -133,7 +120,7 @@ Conceptual Data Flow Diagram Use Case Documentation Rulebook
|
|
|
133
120
|
- ノード、線種、色、絵文字は全体概要の「凡例(本プロダクト共通)」で選択された記法ルール([[specdojo:cdfd-mermaid-rulebook|Mermaid 記法ルール]] または [[specdojo:cdfd-d2-rulebook|D2 記法ルール]])に従います。記法の宣言がなければ Mermaid とし、sample と template は D2 の例とします。参加単位・方向・イベントの要件が記法部品と異なる場合は本書を優先し、Mermaid も `flowchart TB` で縦に描きます。
|
|
134
121
|
- ノードのラベルに絵文字を付けるか付けないかは、全体概要の凡例の方針に合わせ、文書内の全図と系統間でそろえます。付ける場合は凡例の割り当てに従い、同じ対象には同じ絵文字を使います。詳細文書だけで追加・削除・変更しません。
|
|
135
122
|
- 正常系を上から下へ並べます。D2 は `direction: down` とし、戻りの線は上にあるノードを左辺にした `a <- b` で書きます。
|
|
136
|
-
-
|
|
123
|
+
- プロセスノードを役割表の行へ対応させ、通常の流れ全体を通して開始イベントと終了の出来事を描きます(分割図・戻りの図へは再掲不要)。イベントは一つのノードに一つの出来事とし、発生を判定できる短い文にします。長い場合は改行し、原文を言い換えません。全体概要の起点イベントが複数の出来事を列挙している場合は、各出来事の文言を保ってノードを分けます。
|
|
137
124
|
- 参加単位どうし、または参加単位とデータストアを直接結び、渡す情報・物を名詞のラベルにします。必要な承認は「承認済みの補充依頼」のように成果の性質として表し、引き渡し条件を判定するイベントは置きません。
|
|
138
125
|
- Orchestrator とその調整要求・応答は描かず、全体概要の指示の図を参照します。対象範囲内の担当ロールを外部主体として追加しません。
|
|
139
126
|
- 図の題は「欠品から売場補充まで」「起票から完了記録まで」のように業務の言葉で付けます。説明は、その図から読み取れる流れや関係を 1 文で書きます。凡例への参照は別の短い注記にし、凡例を再定義しません。
|
|
@@ -144,55 +131,43 @@ Conceptual Data Flow Diagram Use Case Documentation Rulebook
|
|
|
144
131
|
|
|
145
132
|
### 6.7. 例外時の戻りの図
|
|
146
133
|
|
|
147
|
-
-
|
|
134
|
+
- 対象範囲に、不足や不一致を補完・再判断する参加単位へ返す流れがある場合は、「概念データフロー」に「例外時の戻り」の図を追加し、重要度で絞らずにすべて描きます(共用領域の内部は「描き方の選択」に従う)。すべての受け渡しを網羅する表は作りません。
|
|
148
135
|
- 補完・再判断を担う参加単位へ戻る線に「不足項目」「記録と受入品の差異」などの戻す情報を付けます。通常の図と同じ名称・領域 ID を使います。
|
|
149
136
|
- 再提示を示す場合も「修正・承認済みの補充依頼」のような情報の線で表し、戻す条件・再開条件の列や条件イベントは設けません。内部の再試行、ログ、操作手順は描きません。
|
|
150
|
-
-
|
|
137
|
+
- 線が多い場合は「概念データフロー」の分割の目安に従い、戻り先または業務の段ごとに図を分け、題に「補充依頼の補完」のように戻す対象を示します。読みやすさのために必要な戻りを削りません。
|
|
151
138
|
|
|
152
139
|
良い例: 仕入が不足項目を在庫へ返し、在庫が修正・再承認済みの補充依頼を再提示する。悪い例: 「エラー」を行き先なしで描く、または線が増えたので戻りを削る。
|
|
153
140
|
|
|
154
141
|
### 6.8. 未決事項
|
|
155
142
|
|
|
156
143
|
- 境界、名称、責務、判断者のいずれかが未確定な場合だけ設け、ない場合は章ごと省略します。
|
|
157
|
-
- 各論点は本文中の `_UNDECIDED_`
|
|
144
|
+
- 各論点は本文中の `_UNDECIDED_` と対応させ、論点と、影響するケース・参加単位を示します。解決済みの論点や論点のない空表は残しません。
|
|
158
145
|
|
|
159
|
-
良い例: 「共用領域の内部の正本が未確定。`C-01`〜`C-03`
|
|
146
|
+
良い例: 「共用領域の内部の正本が未確定。`C-01`〜`C-03` の共用領域のノードと参照先に影響」と示す。悪い例: 「詳細は後で検討」とだけ書く。
|
|
160
147
|
|
|
161
148
|
### 6.9. 完成判定
|
|
162
149
|
|
|
163
|
-
|
|
150
|
+
内容の確認は次の全項目で行います。
|
|
164
151
|
|
|
165
152
|
- ケース ID、業務名、目的、対象範囲、領域 ID・名称が全体概要と一致し、「描き方の選択」で決めた参加単位と詳細化の境界を守っています。
|
|
166
|
-
-
|
|
167
|
-
- 「目的」が業務の存在理由・成果を 1〜2 文で示し、読み手の役割を含みません。「適用範囲」は対象と対象外が 1
|
|
153
|
+
- 共用領域の内部を描く文書が 1 か所に定まり、ほかの詳細文書では 1 ノードと受け渡しの線で示しています。
|
|
154
|
+
- 「目的」が業務の存在理由・成果を 1〜2 文で示し、読み手の役割を含みません。「適用範囲」は対象と対象外が 1 行ずつです。
|
|
168
155
|
- 「プロセス領域」の各節は役割表だけで構成され、全体概要のグループ・区分と一致しています。PDCA の値を示す場合は独立した任意の列にしています。
|
|
169
156
|
- 図を正本として、役割表の順序欄と章冒頭の通過順が一致しています。全参加単位の名称・領域 ID が表と図で対応し、主経路と条件付きの経路を区別して開始から終了まで上から下へ追えます。開始・終了のイベントは一ノード一出来事の短い文で、入口の文言は選んだ方式の規定に従っています。
|
|
170
157
|
- 渡す情報・物を線のラベルから読み取れ、引き渡し ID や条件のイベント、「引き渡し」「例外時の戻り先」の章がありません。
|
|
171
158
|
- Orchestrator は図に含まれず、その調整は全体概要の指示の図へ委ねられています。
|
|
172
|
-
-
|
|
159
|
+
- 図には業務の言葉による題と説明 1 文があり、凡例は全体概要を参照しています。図を分けた場合も共有ノードと接続が追えます。
|
|
173
160
|
- ノードの絵文字の有無・割り当てが全体概要の凡例に合い、文書内の全図と系統間でそろっています。
|
|
174
161
|
- 関連データストアは全体概要と同じ名称・区分で、表の各行と図のノードが対応しています。
|
|
175
|
-
-
|
|
176
|
-
-
|
|
177
|
-
|
|
178
|
-
承認者と証跡は次の手順で確認します。
|
|
179
|
-
|
|
180
|
-
1. 対象プロジェクトの責任分担文書(RACI)の成果物確定・公開判断に対応する行から `A` の Role code を特定し、メンバー定義でそのロールを担う人間を確認します。RACI を管理しない場合は、ロール定義の承認権限とメンバー定義を参照します。対応関係は [[specdojo:people-and-organization-definition-standard|人と組織の定義標準]] に従い、承認者を特定できない場合は昇格せず未決事項へ記録します。
|
|
181
|
-
2. 対応する登録簿個票の「対応結果」または対応タスクの result に、対象文書 ID・承認対象の版(コミット等)・承認者・承認日・承認判断を記録します。同じ記録から、完成判定に用いたレビュー結果と検査証跡、承認者の根拠にした責任分担・ロール定義とメンバー定義を文書 ID または証跡の保管先で参照できるようにします。両方の記録がある場合は判断の正本を一方に定め、他方はその参照とします。
|
|
182
|
-
3. 公開前に、記録の版が昇格対象と一致し、完成判定を満たし、未解決指摘・未決事項の扱いを承認者が判断済みであることを確認します。証跡の欠落や版の不一致があれば `draft` を維持し、確認できた場合だけ人間が `ready` へ変更します。検査の成功だけで承認済みと判定しません。
|
|
183
|
-
|
|
184
|
-
改訂・廃止の影響追跡は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。BA は全体概要の詳細 CDFD 一覧、接続する系統の CDFD、状態を委ねる STSD、関連する BPS・受入条件への影響を確認し、ARC は境界と参照整合、QE は完成判定の再検証、PM は追従タスクの管理を担います。廃止・置き換えの最終判断は同標準の PO の責務に従います。
|
|
185
|
-
|
|
186
|
-
良い例: 承認記録から対象版、権限を持つ人間、レビュー結果と検査証跡をたどれる。悪い例: 「検査が通った」「承認済み」とだけ書いて `ready` にする。
|
|
162
|
+
- 対象範囲の例外時の戻りを重要度で省略せず、戻す情報と補完・再判断の責任を持つ参加単位を読み取れます。戻りがない場合だけ戻りの図を省略しています。
|
|
163
|
+
- 状態定義・遷移を複製せず、有効な STSD や詳細文書を参照しています。
|
|
187
164
|
|
|
188
165
|
## 7. 禁止事項
|
|
189
166
|
|
|
190
167
|
- プロセス領域に主要入力・主要出力・データストアの箇条書きを置く、または図をなぞる長文の注記を書く。
|
|
191
168
|
- 詳細 CDFD に独自の凡例を再掲・重複定義する。
|
|
192
|
-
- 共通して通る領域の内部を複数の詳細文書へ重複して描く、必要な例外時の戻りを重要度や線の多さを理由に省略する、または全体概要の凡例と異なる絵文字の有無・割り当てにする。
|
|
193
169
|
- 全体概要にないケースや領域分割を作る、または「描き方の選択」の粒度・詳細化の境界を越えて内部処理を再掲する。
|
|
194
170
|
- 全体概要と異なるグループ名・区分名・領域 ID・データストア名を使う、または PDCA の値をグループ・区分の列に入れる。
|
|
195
171
|
- 引き渡し ID を採番する、引き渡し条件のイベントを図に置く、引き渡し・戻す条件・再開条件の表を設ける。
|
|
196
172
|
- Orchestrator の調整を詳細の図に複製する、または対象範囲内の担当者を外部主体にする。
|
|
197
|
-
- `deprecated` の文書を `based_on` または本文から参照する。
|
|
198
173
|
- 状態定義・遷移表・状態遷移図を複製する、または物理テーブル、カラム、SQL、実装クラス、詳細 API、画面操作を記載する。
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:cdr-rulebook
|
|
4
|
+
type: rulebook
|
|
5
|
+
deliverable_type: architecture
|
|
6
|
+
status: draft
|
|
7
|
+
target_format: markdown
|
|
8
|
+
recipe: not-needed
|
|
9
|
+
sample: specdojo:cdr-sample
|
|
10
|
+
template: specdojo:cdr-template
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# コーディング規約(agent 向け instructions)作成ルール
|
|
14
|
+
|
|
15
|
+
Coding Rules (Agent Instructions) Documentation Rulebook
|
|
16
|
+
|
|
17
|
+
実装する agent がどの環境でも同じ規約で実装・検証できるよう、言語・枠組みごとの正本と環境別の薄いラッパーの要件を定めます。
|
|
18
|
+
|
|
19
|
+
## 1. 全体方針
|
|
20
|
+
|
|
21
|
+
- 実装の段の型はこの 1 種類とし、選定済みの技術を「どう書くか」「どう検証するか」に絞る。
|
|
22
|
+
- 実装する agent とレビューする人に向け、命令形の規則と実行できる検証コマンドで書く。
|
|
23
|
+
- ラッパーは適用先のメンバー定義・実行設定にある使用環境だけに用意する。
|
|
24
|
+
- **共通の運用**: 役割は適用先のメンバー定義、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。文書の整形・lint はリポジトリの検証で扱い、規約の受入確認に含めない。
|
|
25
|
+
|
|
26
|
+
## 2. 位置づけと用語定義
|
|
27
|
+
|
|
28
|
+
- 技術選定と実行基盤は `tsd-index`・`tsd-<term>`、モジュール分割・境界・依存方向と横断ルールは `cpd`・`sysd-*` を正本とする。コーディング規約から参照し、実装の設計書を別に置かない。
|
|
29
|
+
- 規則の本文は `.github/instructions/<言語>.instructions.md` を唯一の正本とする。Copilot は `applyTo` に従って直接読み、ほかの環境ではラッパーを使う。
|
|
30
|
+
- 機械で強制する細則は `eslint.config.*`・`tsconfig.json`・`.editorconfig` 等を正本とする。
|
|
31
|
+
|
|
32
|
+
## 3. ファイル命名・ID規則
|
|
33
|
+
|
|
34
|
+
- 正本はリポジトリルートの `.github/instructions/<言語>.instructions.md` に置く。`<言語>` は英小文字・数字・ハイフンの言語名(`typescript`・`csharp`・`python`)または枠組み名(`vitest`・`nextjs`・`unity-csharp`)とする。
|
|
35
|
+
- 1 ファイルは 1 つの適用範囲(`applyTo` の glob)とする。対象ファイルと規則が異なる場合だけ分ける。範囲が重なる場合は狭い方に追加規則だけを書き、広い方と矛盾させない。
|
|
36
|
+
- `id` は `<言語>-instructions` とする(例: `typescript-instructions`)。
|
|
37
|
+
- 成果物カタログでは、グループの `base_path` を `/.github/instructions`、各成果物の `path` を `<言語>.instructions.md`、`rulebook` を `specdojo:cdr-rulebook` とする。ラッパーはカタログへ載せない。
|
|
38
|
+
|
|
39
|
+
## 4. 推奨 Frontmatter 項目
|
|
40
|
+
|
|
41
|
+
共通の必須項目・型・参照形式は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。トップレベルに Copilot の `applyTo`、`specdojo:` 配下に SpecDojo の項目を置く。
|
|
42
|
+
|
|
43
|
+
| 項目 | 必須 | 値・記述内容 |
|
|
44
|
+
| ------------------- | ---- | ------------------------------------------------------------------------------ |
|
|
45
|
+
| `applyTo` | ○ | 適用する glob(例: `"{src,tests}/**/*.ts"`) |
|
|
46
|
+
| `specdojo.id` | ○ | `<言語>-instructions` |
|
|
47
|
+
| `specdojo.type` | ○ | `architecture` |
|
|
48
|
+
| `specdojo.rulebook` | ○ | `specdojo:cdr-rulebook` |
|
|
49
|
+
| `specdojo.based_on` | 推奨 | 前提とする `tsd-index`・`tsd-<term>`・`sysd-cross-cutting-policy` 等の ID 配列 |
|
|
50
|
+
|
|
51
|
+
## 5. 本文要件
|
|
52
|
+
|
|
53
|
+
見出しの順序と記入欄は template を正本とする。各章の目的と必須・任意は次のとおり。
|
|
54
|
+
|
|
55
|
+
| 章 | 必須 | 目的・記述要件 |
|
|
56
|
+
| ------------------- | -------- | ------------------------------------------------------------------------------------------------------------------ |
|
|
57
|
+
| 導入文 | ○ | H1 の直後に、対象の言語・枠組みと適用範囲を 1〜2 文で書く |
|
|
58
|
+
| 基本方針 | ○ | 型検査の厳しさ、既存コードの書き方への追従、変更の最小化など、全規則の前提になる方針を 3〜5 項目で書く |
|
|
59
|
+
| モジュールと import | ○ | モジュール方式、import の書き方、依存の向きの制約と、その制約を検査する仕組み(linter の規則名など)を書く |
|
|
60
|
+
| 型 | 条件付き | 静的型のある言語で必須。型の宣言、不明な外部入力の扱い、型の強制の制限を書く。動的型の言語は型ヒントの方針で代える |
|
|
61
|
+
| エラー処理 | ○ | 例外と戻り値の使い分け、エラーメッセージに含める文脈、握りつぶしの禁止を書く |
|
|
62
|
+
| 命名 | ○ | 識別子の大文字小文字の規則、略語の扱い、真偽値の名前を書く |
|
|
63
|
+
| テストと検証 | ○ | 変更後に実行するコマンドを、対象(型検査・lint・単体テスト・統合テスト)と実行条件ごとに書く |
|
|
64
|
+
| 禁止事項 | ○ | 破ると被害の大きい書き方と理由を表で書く。表に書いた禁止は本文の章で繰り返さない |
|
|
65
|
+
|
|
66
|
+
- `型` を省けるのは、動的型の言語で型ヒントも使わない場合に限る。省く場合は、その理由を導入文か基本方針に 1 行で書く。
|
|
67
|
+
- 枠組み固有の章(例: Unity のライフサイクル、Next.js のサーバーとクライアントの境界)は、上記の必須章の後ろに 1〜2 章まで追加してよい。
|
|
68
|
+
|
|
69
|
+
## 6. 記述ガイド
|
|
70
|
+
|
|
71
|
+
### 6.1. 規則の書き方
|
|
72
|
+
|
|
73
|
+
- 1 項目に 1 規則を書く。良い例は「型が不明な値は `unknown` で受けて検証する」、悪い例は「型をなるべく安全に扱う」(守ったか判定できない)。理由は判断を誤る場合だけ 1 文で添える。
|
|
74
|
+
- コード例は文章だけでは形が伝わらない場合に 10 行程度までとし、業務ロジックや API の詳細を含めない。
|
|
75
|
+
- 機械で強制する規則は、設定ファイル名・規則名と検査コマンドへの参照にまとめる。
|
|
76
|
+
- 1 ファイルは 300 行程度までを目安とし、超える場合は適用範囲の分割を検討する。
|
|
77
|
+
|
|
78
|
+
### 6.2. テストと検証の書き方
|
|
79
|
+
|
|
80
|
+
| 列 | 記述内容 | 例 |
|
|
81
|
+
| -------- | ---------------------------------------------------- | --------------------------------------- |
|
|
82
|
+
| コマンド | リポジトリの `package.json` などに定義済みのコマンド | `npm run typecheck` |
|
|
83
|
+
| 対象 | 何を検査するか | 型検査(`src`・`tests`) |
|
|
84
|
+
| 実行条件 | どの変更のときに実行するか | TypeScript を変更したとき(毎回) |
|
|
85
|
+
| 失敗時 | 失敗したときに agent が取る行動 | 型エラーを直す。`@ts-ignore` で隠さない |
|
|
86
|
+
|
|
87
|
+
- コマンドが未定義なら追加するか、該当する検査が無いと書く。
|
|
88
|
+
- 実 Git・子プロセス・外部サービスを使う重い検査は、sandbox と親 runner・CI の実行分担を書く。
|
|
89
|
+
- 規約の受入確認では、上位設計・設定と本文を照合し、各コマンドを指定環境で実行する。一致し、所定の検査が成功することを合格条件とする。未決の規則や未提供の検査は、論点・適用への影響・当面の扱いを該当箇所に書く。
|
|
90
|
+
|
|
91
|
+
### 6.3. 環境別のラッパーの作り方
|
|
92
|
+
|
|
93
|
+
ラッパーには適用範囲と正本への参照だけを書く。Claude Code の `<言語>` は正本とそろえる。
|
|
94
|
+
|
|
95
|
+
| 環境 | ラッパーの置き場所 | 正本の読み込ませ方 | 適用範囲の宣言 |
|
|
96
|
+
| -------------- | ------------------------------ | ----------------------------------------------------------------------- | ---------------------- |
|
|
97
|
+
| GitHub Copilot | 不要 | 正本を直接読む | 正本の `applyTo` |
|
|
98
|
+
| Claude Code | `.claude/rules/<言語>.md` | 本文に `@../../.github/instructions/<言語>.instructions.md` を 1 行書く | Frontmatter の `paths` |
|
|
99
|
+
| Codex など | リポジトリルートの `AGENTS.md` | 正本のパスと適用範囲を列挙し、該当ファイルの編集前に読むよう指示する | `AGENTS.md` の本文 |
|
|
100
|
+
| Gemini CLI | `GEMINI.md` | `@.github/instructions/<言語>.instructions.md` で読み込む | `GEMINI.md` の本文 |
|
|
101
|
+
|
|
102
|
+
Claude Code のラッパーの例:
|
|
103
|
+
|
|
104
|
+
```markdown
|
|
105
|
+
---
|
|
106
|
+
paths:
|
|
107
|
+
- "{src,tests}/**/*.ts"
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
# TypeScript Rules
|
|
111
|
+
|
|
112
|
+
@../../.github/instructions/typescript.instructions.md
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
`AGENTS.md` の参照節の例:
|
|
116
|
+
|
|
117
|
+
```markdown
|
|
118
|
+
## Coding Rules
|
|
119
|
+
|
|
120
|
+
次のファイルを編集する前に、対応する規約を読んで従う。
|
|
121
|
+
|
|
122
|
+
- `src/**/*.ts`・`tests/**/*.ts`: `.github/instructions/typescript.instructions.md`
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
- `paths` 等の適用範囲は正本の `applyTo` と同じ glob とし、変更時は同期する。使用環境ごとに対象・対象外のファイルで確認し、対象でのみ正本が読み込まれることを合格条件とする。
|
|
126
|
+
- 差し替えの対象は、成果物カタログの ID・パス、旧 instructions の `applyTo`、各環境のラッパーと `AGENTS.md`・`GEMINI.md` 等の参照節とする。旧正本を自動適用の対象外へ退避し、新正本の適用範囲と各参照をそろえて上記の読み込み確認を行う。旧規約が読み込まれず、新規約が指定範囲で有効になることを切替の完了条件とする。
|
|
127
|
+
- 未決事項・読み込み不具合・参照の切替漏れは、影響する環境・ファイル範囲と当面の扱いを記す。
|
|
128
|
+
|
|
129
|
+
### 6.4. ほかの言語・枠組みへの当てはめ
|
|
130
|
+
|
|
131
|
+
- 章立てを保ち、中身を言語の慣習に合わせる。
|
|
132
|
+
- 枠組みの規則(TypeScript に Next.js の規則を足す等)は固有章に置き、適用範囲が異なる場合は「ファイル命名・ID規則」に従って分ける。
|
|
133
|
+
- Unity の C# 等は、エンジンの命名・ライフサイクルを `命名` と固有章で扱う。検証はエディタ不要の検査(`dotnet format` 等)と起動が必要な検査に分ける。
|
|
134
|
+
|
|
135
|
+
## 7. 禁止事項
|
|
136
|
+
|
|
137
|
+
| 禁止事項 | 理由 |
|
|
138
|
+
| ------------------------------------------------ | ------------------------------------------------------------------------------- |
|
|
139
|
+
| 言語・ライブラリの選定理由や版を書く | `tsd` と二重管理になり、選定の変更が規約に取り残されるため |
|
|
140
|
+
| モジュールの分割やコンポーネントの境界を設計する | 設計の段(`cpd`・`sysd-*`)の責務であり、実装の設計書を置かない方針に反するため |
|
|
141
|
+
| ラッパーに規則の本文を書く・正本を複製する | 環境ごとに規則がずれ、agent ごとに異なる実装になるため |
|
|
142
|
+
| ラッパーの適用範囲を正本の `applyTo` と変える | 環境によって規約が当たるファイルが変わるため |
|
|
143
|
+
| 実行できない・定義されていない検証コマンドを書く | agent が検証を失敗させるか、検証を省くため |
|
|
144
|
+
| linter で強制済みの細則を本文に再掲する | 設定の変更に本文が取り残されるため |
|