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
|
@@ -14,7 +14,6 @@ specdojo:
|
|
|
14
14
|
Conceptual Data Stores Definition (CDSD) Documentation Rules
|
|
15
15
|
|
|
16
16
|
業務で継続的に保持・参照する情報の集合について、管理単位・用途・更新責務を定義する基準を定めます。
|
|
17
|
-
BA が業務上の境界を合意し、ARC・DEV が設計へ接続し、QE が整合性確認の対象を識別できる一覧を作ります。
|
|
18
17
|
|
|
19
18
|
## 1. 全体方針
|
|
20
19
|
|
|
@@ -22,30 +21,18 @@ BA が業務上の境界を合意し、ARC・DEV が設計へ接続し、QE が
|
|
|
22
21
|
- **入力**: 成果物カタログの対象範囲・依存・受入条件、上位の目的、関連する BDD・プロセス仕様を確認します。主要な管理単位の採否と用途を、それらの根拠に対応付けます。
|
|
23
22
|
- **記載レベル**: 一覧の各行は独立した管理単位とします。ファイルが複数あることだけで分割せず、正本区分、粒度、更新責務が異なる場合は区別します。
|
|
24
23
|
- **対象外**: 全項目の型・許容値、保存形式、コマンド構文、状態遷移、復旧操作の詳細は、それぞれの schema・型定義・リファレンス・状態定義・運用手順を参照します。概念上の管理境界を判断するための説明だけを残します。
|
|
24
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めません。
|
|
25
25
|
|
|
26
26
|
## 2. 位置づけと用語定義
|
|
27
27
|
|
|
28
28
|
- **概念データストア**: 業務上ひとまとまりとして保持・参照する情報です。物理的な保管場所や DB テーブルと一対一とは限りません。
|
|
29
29
|
- **隣接仕様との分担**: BDD は項目の業務的意味、CCD は概念間の関連、プロセス仕様・CDFD は情報の生成・利用の流れ、保管場所一覧は物理的・論理的な場所を扱います。CDSD はこれらを管理単位と更新責務でつなぎます。
|
|
30
|
-
- **共通事項の正本**: メタ情報・改訂と廃止は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]]、配置は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] に従います。共通方針は上位文書を参照し、各 CDSD へ再掲しません。
|
|
31
|
-
|
|
32
|
-
| Role code | 作成・確認・利用の責務 |
|
|
33
|
-
| --------- | ------------------------------------------------------------------------------------------------------------------------------------ |
|
|
34
|
-
| BA | 主作成者・業務確認者として、対象者の課題、管理境界、名称、用途と上位根拠の対応を整理する。業務担当者による確認が必要な箇所を特定する |
|
|
35
|
-
| ARC | 正本・派生物の区別、生成元、外部依存と後続設計への引き渡しを確認する |
|
|
36
|
-
| DEV | 保存単位と正本の参照先、schema・型・生成処理への変更影響を確認する |
|
|
37
|
-
| QE | 対象の網羅、必須情報、検証対象と合否条件を照合する |
|
|
38
|
-
| PM | 未決事項の担当・依存順・判断時期を計画へ接続し、課題・リスク等を報告する |
|
|
39
|
-
| OPS | 公開前確認、継続更新・再生成・問い合わせの導線を確認する |
|
|
40
|
-
| PO | 管理境界と用途を最終合意し、公開範囲・確定・置き換えを人間として承認する |
|
|
41
|
-
|
|
42
|
-
業務担当者や「運用担当」などの呼称を使う場合は、適用先の組織定義の Role code に対応付けます。実担当者・兼務は組織・メンバー定義を参照します。
|
|
43
30
|
|
|
44
31
|
## 3. ファイル命名・ID規則
|
|
45
32
|
|
|
46
33
|
- ファイル名は `cdsd-<term>.md` とし、`<term>` は対象業務領域を表す kebab-case とします。プロセス群など、読者が管理境界を合意できる単位でまとめます。
|
|
47
34
|
- プロジェクト成果物の文書 ID は `<project-id>:cdsd-<term>` とします。例は `prj-0001:cdsd-execution` です。文書内のデータストアは名称で一意に対応付け、同名で異なる管理単位を混在させません。
|
|
48
|
-
-
|
|
35
|
+
- 配置は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] に従い、カタログの `base_path` と成果物の `path` から解決します。業務仕様のデータモデル配下を基本とし、既存カタログのパスを推測で変更しません。
|
|
49
36
|
|
|
50
37
|
## 4. 推奨 Frontmatter 項目
|
|
51
38
|
|
|
@@ -53,19 +40,18 @@ BA が業務上の境界を合意し、ARC・DEV が設計へ接続し、QE が
|
|
|
53
40
|
|
|
54
41
|
- `type` は `data`、`rulebook` は `specdojo:cdsd-rulebook` とします。表示名は対象領域が分かる H1 に置き、`title` を併記する場合は H1 と意味を一致させます。
|
|
55
42
|
- `based_on` には実際に読んで直接の根拠とした作成済み文書を記録します。カタログがある場合は `depends_on` の推移閉包内に限定します。単なる関連先や未作成文書を追加しません。
|
|
56
|
-
- `status` の確定判断、`supersedes` による置き換えは共通規約に従います。agent は `draft` のまま編集し、人間の PO による承認へ渡します。
|
|
57
43
|
|
|
58
44
|
## 5. 本文要件
|
|
59
45
|
|
|
60
|
-
|
|
46
|
+
本文は次の5章構成を標準とします。
|
|
61
47
|
|
|
62
|
-
| 章 | 必須 | 内容・受入条件
|
|
63
|
-
| -------------------- | -------- |
|
|
64
|
-
| 概要 | 必須 | 対象者、利用場面、業務課題と放置時の影響、期待する判断結果、対象・対象外とその根拠を示す。上位文書で説明済みの内容は参照する
|
|
65
|
-
| 概念データストア一覧 | 必須 | 対象の全管理単位を標準6列で定義し、カタログの対象範囲と照合できること
|
|
66
|
-
| 正本区分と更新責務 | 必須 | 一覧の全行について、正本か派生・参照情報か、生成元、更新契機、利用制約、担当 Role code を識別できること
|
|
67
|
-
| 関連仕様と検証 | 必須 | 各管理単位から、根拠となる辞書・プロセス・制約の正本、検証対象と確認手順を辿れること
|
|
68
|
-
| 確認事項と変更影響 | 条件付き |
|
|
48
|
+
| 章 | 必須 | 内容・受入条件 |
|
|
49
|
+
| -------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
|
50
|
+
| 概要 | 必須 | 対象者、利用場面、業務課題と放置時の影響、期待する判断結果、対象・対象外とその根拠を示す。上位文書で説明済みの内容は参照する |
|
|
51
|
+
| 概念データストア一覧 | 必須 | 対象の全管理単位を標準6列で定義し、カタログの対象範囲と照合できること |
|
|
52
|
+
| 正本区分と更新責務 | 必須 | 一覧の全行について、正本か派生・参照情報か、生成元、更新契機、利用制約、担当 Role code を識別できること |
|
|
53
|
+
| 関連仕様と検証 | 必須 | 各管理単位から、根拠となる辞書・プロセス・制約の正本、検証対象と確認手順を辿れること |
|
|
54
|
+
| 確認事項と変更影響 | 条件付き | 未決・欠落・矛盾、または改訂・廃止がある場合に、論点と影響(当面の扱い)を示す。なければ「なし」または省略とする |
|
|
69
55
|
|
|
70
56
|
### 5.1. 一覧の標準列
|
|
71
57
|
|
|
@@ -92,41 +78,36 @@ BA が業務上の境界を合意し、ARC・DEV が設計へ接続し、QE が
|
|
|
92
78
|
|
|
93
79
|
- 関連 BDD・CCD・用語集・プロセス仕様・CDFD、該当する保管場所一覧(SLL)を文書 ID で特定します。名称・内容・粒度・入出力・管理場所のうち何を照合するかを対応付けます。関連文書がない種別を形式的に作成する必要はありません。
|
|
94
80
|
- schema・型・実装・リファレンスが正本の場合は、BDD 等の参照先を辿れるようにし、外部システムを含む入力元・出力先と更新制約を確認します。構造の詳細を CDSD 独自の定義として複製しません。
|
|
95
|
-
-
|
|
81
|
+
- 関連文書が未整備の場合は、欠ける根拠と現時点で判断できる範囲を「確認事項と変更影響」に残します。依存未整備を対象行の黙示的な除外理由にしません。
|
|
96
82
|
|
|
97
83
|
### 5.4. 検証と受入条件
|
|
98
84
|
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
| 確認 | 合格条件・証跡 |
|
|
102
|
-
| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
|
|
103
|
-
| BA: 業務範囲と用途 | カタログの対象と一覧の対応に欠落・重複がなく、標準6列が埋まり、用途が概要の課題・期待価値へつながる |
|
|
104
|
-
| ARC・DEV: 境界と依存 | 一覧と更新責務の対象集合が一致し、正本・生成元・担当・制約と、参照する BDD 等の定義が矛盾しない |
|
|
105
|
-
| QE: 整形・メタ情報 | リポジトリに導入された Prettier・Markdown lint・Frontmatter schema 検査で対象ファイルのエラーがない。コマンド・対象・結果を実行記録へ残す |
|
|
106
|
-
| QE・OPS: データと運用 | 管理単位ごとに検証対象、適用 schema または手動確認基準、確認コマンド・手順、期待結果、失敗時の対応を参照できる |
|
|
85
|
+
対象範囲と一覧を手動照合し、正本区分・生成元と依存を確認した後、管理単位ごとのデータ検証を行います。
|
|
107
86
|
|
|
108
|
-
|
|
87
|
+
| 確認 | 合格条件・証跡 |
|
|
88
|
+
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
89
|
+
| 業務範囲と用途 | カタログの対象と一覧の対応に欠落・重複がなく、標準6列が埋まり、用途が概要の課題・期待価値へつながる |
|
|
90
|
+
| 境界と依存 | 一覧と更新責務の対象集合が一致し、正本・生成元・担当・制約と、参照する BDD 等の定義が矛盾しない |
|
|
91
|
+
| データと運用 | 管理単位ごとに検証対象、適用 schema または手動確認基準、確認コマンド・手順、期待結果、失敗時の対応を参照でき、実行・照合結果が期待結果と一致する |
|
|
109
92
|
|
|
110
|
-
|
|
93
|
+
参照先データの schema 検証はその正本で定める手順を用い、手動照合とともに実行記録へ対象と結果を残します。失敗時は担当へ差し戻して修正・再確認し、未解決を合格として扱いません。
|
|
111
94
|
|
|
112
95
|
### 5.5. 未決事項・変更・公開判断
|
|
113
96
|
|
|
114
|
-
-
|
|
115
|
-
-
|
|
116
|
-
- 本 rulebook の変更時は、Frontmatter で宣言する関連 Kata と適用済み CDSD を照合し、本文要件・標準列・禁止事項の差分と同期対象を実行記録に残します。段階的な整備では未同期箇所・担当・次の作業を明記し、矛盾時は rulebook を正とします。要否判断を見直す場合も BA・ARC が理由と影響を提示し、人間の PO が合意します。
|
|
117
|
-
- 公開・`ready` 化の前に、BA・ARC・QE の受入確認と OPS の公開前確認を完了します。公開対象と閲覧範囲、個人情報・非公開情報の有無、未決事項・未解決指摘と影響を提示し、人間の PO が承認・保留・差し戻しを判断します。本 rulebook 自体の確定には関連 Kata の同期確認も必要です。公開後の問い合わせは BA、再生成・運用上の問題は OPS が受け、仕様変更が必要なら PM へつなぎます。
|
|
97
|
+
- 管理境界・粒度・更新責務の未決、根拠の欠落・矛盾は「確認事項と変更影響」に論点と業務影響、当面の扱いを示します。
|
|
98
|
+
- 名称・用途・粒度の変更では、BDD・CCD・用語集・プロセス仕様・SLL、schema・型・生成処理・コマンド、参照元の受入条件と既存記録への影響を特定します。
|
|
118
99
|
|
|
119
100
|
## 6. 記述ガイド
|
|
120
101
|
|
|
121
102
|
章ごとの判断は次の基準で行います。共通事項は上位文書を正本とし、良い例の短文は判断点だけを示すものです。
|
|
122
103
|
|
|
123
|
-
| 対象章 | 判断の基準
|
|
124
|
-
| -------------------- |
|
|
125
|
-
| 概要 | 対象者・放置時の影響・期待する判断と、境界の理由が分かる
|
|
126
|
-
| 概念データストア一覧 | 代表情報・更新契機・最小単位・用途を区別できる
|
|
127
|
-
| 正本区分と更新責務 | 更新元と参照先、担当と許可される扱いが分かる
|
|
128
|
-
| 関連仕様と検証 | 参照先・比較内容・合否を辿れる
|
|
129
|
-
| 確認事項と変更影響 |
|
|
104
|
+
| 対象章 | 判断の基準 | 良い例 | 悪い例 |
|
|
105
|
+
| -------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
|
|
106
|
+
| 概要 | 対象者・放置時の影響・期待する判断と、境界の理由が分かる | 「担当交代時の更新漏れを防ぐため、BA が販売記録の更新責務を確認する。在庫は別領域の定義を参照する」 | 「データを一覧にする」のみ、または対象を根拠なく省く |
|
|
107
|
+
| 概念データストア一覧 | 代表情報・更新契機・最小単位・用途を区別できる | 「売上台帳/販売、会計/販売日・金額/イベント(会計確定時)/販売取引毎/店主の売上確認」 | 「SalesTbl/販売/全項目/随時/データ毎/管理」 |
|
|
108
|
+
| 正本区分と更新責務 | 更新元と参照先、担当と許可される扱いが分かる | 「売上集計は売上台帳から日次再生成。OPS が生成し、BA が元帳との一致を確認。集計の直接訂正はしない」 | 「システムが適切に更新する」 |
|
|
109
|
+
| 関連仕様と検証 | 参照先・比較内容・合否を辿れる | 「売上台帳に対応する BDD の文書 ID と検証手順を示し、取引粒度の一致と検証エラー0件を確認する」 | 「BDD 等と整合すること」のみ |
|
|
110
|
+
| 確認事項と変更影響 | 未決の論点と当面の扱い、決まったときに直す管理単位が分かる | 「販売記録の粒度変更は未決。現行粒度を維持し、決定後に日次集計の生成元と既存記録の照合基準を見直す」 | 「詳細は後日」、未決の粒度で集計を確定する |
|
|
130
111
|
|
|
131
112
|
業務名称と正式な識別子の対応が必要なら、名称の初出で短く補足するか正本を参照します。物理名を独立して示す必要がある場合だけ任意の `physicalName` 列を標準6列の後ろに追加し、既存の正本の表記を使います。CDSD のために綴りや命名規則を変換しません。
|
|
132
113
|
|
|
@@ -136,5 +117,3 @@ CDSD 本文は標準6列・行の網羅・参照対応を手動照合します
|
|
|
136
117
|
- カタログの対象を未記載のまま除外したり、未決の粒度・更新責務を確定済みとして扱ったりすること。
|
|
137
118
|
- 全項目・型・許容値・状態遷移・コマンド構文・詳細パスを正本から複製し、二重管理すること。
|
|
138
119
|
- 派生・参照情報を正本と混同し、生成元や更新担当の不明なまま後続設計へ渡すこと。
|
|
139
|
-
- 表を空行で分断すること、存在しない文書へのリンクや未確認の検証成功を記載すること。
|
|
140
|
-
- agent に公開可否・`ready` 昇格・置き換えの最終承認を委ねること。
|
|
@@ -15,59 +15,47 @@ specdojo:
|
|
|
15
15
|
|
|
16
16
|
Code Table (CDT) Documentation Rules
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
分類一覧(CDT)は、スキーマ・実装・リファレンスを正本とし、そこから読み取れない値の選定条件と判断境界を補います。
|
|
19
19
|
|
|
20
20
|
## 1. 全体方針
|
|
21
21
|
|
|
22
|
-
- **目的と適用範囲**: BDD
|
|
23
|
-
- **正本参照**:
|
|
24
|
-
- **完成条件**:
|
|
25
|
-
-
|
|
22
|
+
- **目的と適用範囲**: BDD の属性、画面選択肢、集計軸に使う分類を Markdown で記述し、対象と利用者の判断を明らかにする。
|
|
23
|
+
- **正本参照**: 許容値の正本の選び方は「分類定義」、定義方式ごとの内容は「値の業務的意味と使い分けの要件」に従う。
|
|
24
|
+
- **完成条件**: 「本文要件」を満たし、「成果物の検証」で正本との対応、判断境界、利用先との整合を確認できること。
|
|
25
|
+
- **共通の運用**: 役割は適用先のメンバー定義、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。文書の整形・lint はリポジトリの検証で扱う。
|
|
26
26
|
|
|
27
27
|
## 2. 位置づけと用語定義
|
|
28
28
|
|
|
29
|
-
- **成果物の責務**: CDT
|
|
30
|
-
- **分類種別**:
|
|
31
|
-
-
|
|
29
|
+
- **成果物の責務**: CDT は分類の選び方を担う。属性は BDD、語義は用語集、表示・操作は画面仕様、詳細な業務規則・状態遷移・承認は対応仕様へ委ねる。
|
|
30
|
+
- **分類種別**: 業務分類は業務判断の区分、コード表はシステム・外部連携の識別体系、動的分類は利用者が運用中に値を増減する区分。件数だけで種別・管理方式を決めない。
|
|
31
|
+
- **スタンドアロン定義**: 実装に値の定義がない業務区分を CDT 自体で定義する方式。既存の正本を読めない場合の代替にはしない。
|
|
32
32
|
|
|
33
33
|
## 3. ファイル命名・ID規則
|
|
34
34
|
|
|
35
|
-
- **ID**:
|
|
36
|
-
- **ファイル名と配置**: `cdt-<term>.md
|
|
37
|
-
-
|
|
35
|
+
- **ID**: `<project-id>:cdt-<term>`(例: `prj-0001:cdt-register-type`)。`<term>` は分類の主題を表す英小文字の kebab-case とする。
|
|
36
|
+
- **ファイル名と配置**: `cdt-<term>.md`。成果物カタログの `base_path`・`path` と [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] に従う。
|
|
37
|
+
- **文書名(H1)**: 分類の主題を示す(例: `# 分類一覧(登録項目の種別)`)。
|
|
38
38
|
|
|
39
39
|
## 4. 推奨 Frontmatter 項目
|
|
40
40
|
|
|
41
|
-
-
|
|
42
|
-
- `specdojo
|
|
43
|
-
-
|
|
44
|
-
|
|
45
|
-
最小メタデータ例:
|
|
46
|
-
|
|
47
|
-
```yaml
|
|
48
|
-
---
|
|
49
|
-
specdojo:
|
|
50
|
-
id: prj-0001:cdt-register-type
|
|
51
|
-
type: data
|
|
52
|
-
status: draft
|
|
53
|
-
rulebook: specdojo:cdt-rulebook
|
|
54
|
-
---
|
|
55
|
-
```
|
|
41
|
+
- 共通項目は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]]、許可項目・型制約は `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` に従う。
|
|
42
|
+
- `specdojo.type` は `data`、`specdojo.rulebook` は `specdojo:cdt-rulebook` とし、CDT 固有項目は追加しない。
|
|
43
|
+
- `schema_ref`・`type_ref` は本文の正本参照欄の表記であり、Frontmatter 項目ではない。
|
|
56
44
|
|
|
57
45
|
## 5. 本文要件
|
|
58
46
|
|
|
59
|
-
本文は次の章を基本とする。
|
|
47
|
+
本文は次の章を基本とする。
|
|
60
48
|
|
|
61
49
|
| 章タイトル | 必須 | 目的・内容要件 |
|
|
62
50
|
| ------------------------ | ---- | --------------------------------------------------------------------------------------------------- |
|
|
63
|
-
| 概要 | ○ |
|
|
51
|
+
| 概要 | ○ | 業務目的、対象エンティティ、適用範囲、誰がどの判断に使うかを示す |
|
|
64
52
|
| 分類定義 | ○ | 対象エンティティ、分類定義名、種別、正本参照、説明を表形式で特定する |
|
|
65
53
|
| 値の業務的意味と使い分け | ○ | 正本参照あり・スタンドアロン・動的分類の方式に応じて、選定条件と境界または管理規約を示す |
|
|
66
54
|
| 関連仕様との関係 | 任意 | BDD・画面・業務ルール・状態定義などへの参照と、分類の利用先・変更影響を示す。概要等で明確なら省略可 |
|
|
67
55
|
|
|
68
56
|
### 5.1. 分類定義の要件
|
|
69
57
|
|
|
70
|
-
「定義項目」「内容」の 2
|
|
58
|
+
「定義項目」「内容」の 2 列に次の項目を置く。複数の分類軸は軸ごとに定義と説明を対応付ける。
|
|
71
59
|
|
|
72
60
|
| 定義項目 | 内容 |
|
|
73
61
|
| ---------------- | -------------------------------------------------------------------------------------------------- |
|
|
@@ -79,25 +67,25 @@ specdojo:
|
|
|
79
67
|
|
|
80
68
|
### 5.2. 値の業務的意味と使い分けの要件
|
|
81
69
|
|
|
82
|
-
| 定義方式 | 必須内容
|
|
83
|
-
| -------------- |
|
|
84
|
-
| 正本参照あり |
|
|
85
|
-
| スタンドアロン |
|
|
86
|
-
| 動的分類 |
|
|
70
|
+
| 定義方式 | 必須内容 |
|
|
71
|
+
| -------------- | ----------------------------------------------------------------------------------------------- |
|
|
72
|
+
| 正本参照あり | 正本の識別子をキーに各値の意味・選定条件・境界を記す。許容値は再定義しない |
|
|
73
|
+
| スタンドアロン | 値・分類名・表示名・説明と成立条件を定義する。表示名が分類名と同じならその旨を示す |
|
|
74
|
+
| 動的分類 | 管理元、作成・変更権限、命名規約、削除・アーカイブ時の扱いを示す。属性・参照構造は BDD に委ねる |
|
|
87
75
|
|
|
88
76
|
## 6. 記述ガイド
|
|
89
77
|
|
|
90
|
-
|
|
78
|
+
共通事項はメタ情報標準・文書構成ガイド、語義は用語集を正本とする。以下は判断基準を示す部分例である。
|
|
91
79
|
|
|
92
80
|
### 6.1. 概要
|
|
93
81
|
|
|
94
|
-
- **判断基準**:
|
|
82
|
+
- **判断基準**: 誰がどの場面で何を選ぶかを示し、対象外の判断は対応仕様へ委ねる。
|
|
95
83
|
- **良い例**: 「起票者が、すでに起きた問題と未発生の懸念を分けて追跡するための分類を定義する。状態遷移は状態定義を参照する。」
|
|
96
84
|
- **悪い例**: 「登録項目の分類を適切に管理する。」目的・利用者・判断の境界が分からない。
|
|
97
85
|
|
|
98
86
|
### 6.2. 分類定義
|
|
99
87
|
|
|
100
|
-
|
|
88
|
+
参照先のファイル・定義位置を確認する。スキーマと実装が併存する場合も正本は一つとし、他方は対応確認先とする。
|
|
101
89
|
|
|
102
90
|
| 参照方式 | 選定基準 | 正本参照欄の良い例 |
|
|
103
91
|
| -------------- | ------------------------------------------------ | -------------------------------------------------------------------------------------------- |
|
|
@@ -106,47 +94,46 @@ specdojo:
|
|
|
106
94
|
| スタンドアロン | 実装に定義がなく、人が業務判断に使う区分である | `なし(スタンドアロン定義)` とし、その区分を判断する主体を説明する |
|
|
107
95
|
| 動的分類 | 利用者が運用中に分類値を増減する | 管理元となる BDD のエンティティを参照し、値を確定するマスタの所在を示す |
|
|
108
96
|
|
|
109
|
-
- **判断基準**:
|
|
97
|
+
- **判断基準**: 分類種別と参照方式は別に判断する。固定分類は正本の有無で方式を選び、動的分類は管理元を参照する。
|
|
110
98
|
- **良い例**: 分類定義名を「分類(`item_type`)」とし、スキーマの `ItemType` を正本、CLI の検証定義を対応確認先として示す。
|
|
111
|
-
- **悪い例**:
|
|
99
|
+
- **悪い例**: 「登録項目」「ソースコード参照」だけでは、分類軸や参照先を解決できない。
|
|
112
100
|
|
|
113
101
|
### 6.3. 値の業務的意味と使い分け
|
|
114
102
|
|
|
115
103
|
#### 6.3.1. 正本参照あり
|
|
116
104
|
|
|
117
|
-
- **判断基準**:
|
|
118
|
-
- **推奨表**:
|
|
105
|
+
- **判断基準**: 各正本値に説明が対応し、混同する値を条件で区別できること。識別子は対応付けに用いる。
|
|
106
|
+
- **推奨表**: `値`(正本の識別子)、`分類名`(BDD・用語集に合わせた業務名)、`業務上の意味と使い分け`(選定条件・隣接値との境界)。
|
|
119
107
|
- **良い例**: 「`issue` はすでに起きている問題。まだ起きていない懸念には `risk` を使う。」
|
|
120
108
|
- **悪い例**: 「`issue` は課題、`risk` はリスク。」名称の言い換えだけでは選定できない。
|
|
121
109
|
|
|
122
110
|
#### 6.3.2. スタンドアロン定義
|
|
123
111
|
|
|
124
|
-
- **判断基準**:
|
|
112
|
+
- **判断基準**: CDT が正本を担うため、識別可能な値と条件を揃え、条件が重なる場合は優先順位・例外を示す。
|
|
125
113
|
- **推奨表**: `値`(コード)、`分類名`(正式名称)、`表示名`(利用者向け名称)、`説明・成立条件`(選定条件)。
|
|
126
114
|
- **良い例**: 「`experimental`/試験商品/お試し: 店主が新規取扱を試す区分。入荷後30日間の売れ行きで定番化を判断する。」
|
|
127
115
|
- **悪い例**: 「`experimental`/その他/その他: 適宜使用する。」適用条件と判断主体を特定できない。
|
|
128
116
|
|
|
129
117
|
#### 6.3.3. 動的分類
|
|
130
118
|
|
|
131
|
-
- **判断基準**:
|
|
119
|
+
- **判断基準**: 値の追加・変更権限と既存参照の扱いを判断できること。
|
|
132
120
|
- **良い例**: 「店主がタグを追加する。使用済みタグは削除せずアーカイブし、新規付与だけを停止する。」管理元の属性定義は BDD を参照する。
|
|
133
121
|
- **悪い例**: 現在のタグを BDD の enum として列挙する。運用中に追加される値を表現できない。
|
|
134
122
|
|
|
135
123
|
### 6.4. 関連仕様との関係
|
|
136
124
|
|
|
137
|
-
- **判断基準**:
|
|
138
|
-
- **良い例**: 「業務データ辞書の `item_type`
|
|
125
|
+
- **判断基準**: 参照文書と分類を使う属性・判断を対にする。税率・状態遷移・承認・構文の詳細は各正本へ委ねる。
|
|
126
|
+
- **良い例**: 「業務データ辞書の `item_type` に対応する。分類別の終端・承認者は状態定義を参照する。」
|
|
139
127
|
- **悪い例**: 関連文書名だけを並べる、または状態遷移表や CLI オプション一覧を転記する。利用関係を示せないか、正本との二重管理になる。
|
|
140
128
|
|
|
141
129
|
### 6.5. 成果物の検証
|
|
142
130
|
|
|
143
|
-
1.
|
|
144
|
-
2.
|
|
145
|
-
3.
|
|
131
|
+
1. **参照と対応**: 正本のファイル・定義位置と説明表を照合する。各許容値に説明が過不足なく対応し、CLI 等の検証値を併記する場合は正本と同じ集合であること。
|
|
132
|
+
2. **業務判断**: 境界事例を当てはめ、隣接値を選び分けられること、スタンドアロン分類に重複・漏れがないこと、動的分類の権限・参照保持を判断できることを確認する。
|
|
133
|
+
3. **変更影響**: BDD・用語・画面・業務ルール・関連実装の利用箇所を辿り、意味・表示に不整合がないことを確認する。未解消の不一致は論点と影響を実行結果に残す。
|
|
146
134
|
|
|
147
135
|
## 7. 禁止事項
|
|
148
136
|
|
|
149
|
-
- **正本の再掲**: 値だけの一覧、enum・union
|
|
137
|
+
- **正本の再掲**: 値だけの一覧、enum・union 型、型制約、コマンド構文、状態遷移表を転記しない。
|
|
150
138
|
- **判断できない説明**: 名称の直訳や「適切に選ぶ」だけで条件を済ませない。根拠のない値数の目安を分類種別・管理方式の必須条件にしない。
|
|
151
139
|
- **責務の混同**: 動的分類を固定 enum 化しない。分類の業務判断に寄与しない DDL・SQL・内部関数の詳細を混入しない。
|
|
152
|
-
- **共通規約違反**: 未定義の Frontmatter 項目、番号なし見出し、章番号末尾のピリオド欠落を使用しない。
|
|
@@ -16,27 +16,19 @@ specdojo:
|
|
|
16
16
|
|
|
17
17
|
Command Line Interface Specification (CLIS) Authoring Rule
|
|
18
18
|
|
|
19
|
-
システム自身が提供する CLI
|
|
19
|
+
システム自身が提供する CLI コマンド群について、利用目的、操作の流れ、入出力の要点、終了時の判断と回復を定義する基準を定めます。
|
|
20
20
|
|
|
21
21
|
## 1. 全体方針
|
|
22
22
|
|
|
23
|
-
- 1
|
|
24
|
-
-
|
|
25
|
-
-
|
|
26
|
-
-
|
|
27
|
-
-
|
|
28
|
-
-
|
|
23
|
+
- 1 ファイルは一つの業務目的または機能領域のコマンド群とし、利用者の課題と達成結果を対応付けます。
|
|
24
|
+
- 人の直接操作と自動実行の設定・監視について、対象者、開始条件、結果の確認方法を記述します。
|
|
25
|
+
- CLIS は利用者側の操作仕様として `ui`、システムが外部コマンドを呼ぶ契約は `ifx-cmd` として `api` に分類します。
|
|
26
|
+
- 構文・引数・既定値はコマンドリファレンス、データの値・構造はファイル仕様・schema・連携契約を正本とし、操作の選択と結果の判断に必要な要点を残します。
|
|
27
|
+
- 共通事項は上位の索引、個別仕様は差分と参照先を示します。索引が未作成なら、その旨と作成後の照合対象を記録します。
|
|
28
|
+
- 推奨表の列は必須情報を保って統合できます。
|
|
29
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。文書の整形・lint はリポジトリの検証で扱い、業務の受入確認に含めません。
|
|
29
30
|
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
| 対象者 | 解決する課題 | 確認する内容 |
|
|
33
|
-
| -------------------------------------------- | -------------------------------------- | ------------------------------------------------------------ |
|
|
34
|
-
| 業務担当者・運用者(OPS) | 開始・中断・回復時に操作を選べない | 目的に合う経路、実行後の状態、次の手を判断できる |
|
|
35
|
-
| 業務分析担当(BA)・プロダクトオーナー(PO) | 操作が業務目的に応えるか合意できない | 対象範囲、達成結果、確認・合意を担う役割が分かる |
|
|
36
|
-
| アーキテクト(ARC)・開発者(DEV) | CLI とデータ・外部連携の責務が重複する | 正本の所在と入出力の方向、未確定の契約が分かる |
|
|
37
|
-
| 品質保証担当(QE) | 完了・回復の合否を判定できない | 条件、表示、終了状態、保持される成果から期待結果を確認できる |
|
|
38
|
-
|
|
39
|
-
## 2. 位置づけと用語定義
|
|
31
|
+
## 2. 位置づけ
|
|
40
32
|
|
|
41
33
|
CLIS は業務プロセス仕様やシステム化機能を受け、利用者とシステムの操作境界を定めます。
|
|
42
34
|
|
|
@@ -48,87 +40,81 @@ graph TD
|
|
|
48
40
|
CLIS -.->|"中身の正本参照"| OUT["出力情報の仕様<br/>ファイル・API・外部コマンド等の正本"]
|
|
49
41
|
```
|
|
50
42
|
|
|
51
|
-
| 用語 | この文書での意味 |
|
|
52
|
-
| ------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
|
53
|
-
| 入力情報 | CLI が受け取るもの。ファイル、標準入力、環境変数、対話入力、API 応答、外部コマンドの実行結果を含む |
|
|
54
|
-
| 出力情報 | CLI が外へ送り出すもの。標準出力・標準エラー、ファイルの作成・更新、API への送信、外部コマンドの起動を含む |
|
|
55
|
-
| 外部コマンド連携仕様(ifx-cmd) | システムが外部コマンドを呼ぶ契約。利用者が自システムを操作する CLIS とは責務が異なる |
|
|
56
|
-
|
|
57
43
|
## 3. ファイル命名・ID規則
|
|
58
44
|
|
|
59
45
|
命名の共通原則は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] に従います。
|
|
60
46
|
|
|
61
47
|
- ファイル名は `clis-<機能名またはコマンド群名>.md` とします。例: `clis-exec-commands.md`。
|
|
62
|
-
-
|
|
63
|
-
-
|
|
48
|
+
- ID はプロダクト文書が `clis-<kebab-case>`、プロジェクト文書が `<project-id>:clis-<kebab-case>`、同梱の完成例が `specdojo:` 付きとします。
|
|
49
|
+
- H1 はコマンド名だけでなく、対象の機能領域を識別できる名前にします。
|
|
64
50
|
|
|
65
51
|
## 4. 推奨 Frontmatter 項目
|
|
66
52
|
|
|
67
|
-
|
|
53
|
+
共通項目と制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従います。
|
|
68
54
|
|
|
69
55
|
- `type` は本 rulebook の `deliverable_type` に対応する `ui`、`rulebook` は `specdojo:clis-rulebook` とします。
|
|
70
|
-
- `part_of` は所属する索引、`based_on`
|
|
71
|
-
- 未作成の依存先や根拠を接続できない理由は「メモ /
|
|
56
|
+
- `part_of` は所属する索引、`based_on` は根拠とした業務プロセス・システム化機能等を示し、カタログの依存関係と照合します。
|
|
57
|
+
- 未作成の依存先や根拠を接続できない理由は「メモ / 将来課題」へ記録します。
|
|
72
58
|
|
|
73
59
|
## 5. 本文要件
|
|
74
60
|
|
|
75
|
-
|
|
61
|
+
次の順に構成し、「入力と出力の要点」は「入力情報」「出力情報」に分けます。
|
|
76
62
|
|
|
77
|
-
| 章 | 必須・任意 | 目的と内容要件
|
|
78
|
-
| -------------------------------------- | ---------- |
|
|
79
|
-
| 概要 | 必須 | コマンド群で達成する結果と対象範囲を 1〜2 文で示す
|
|
80
|
-
| 利用目的と対象ユーザー | 必須 |
|
|
81
|
-
| 操作の流れ | 必須 |
|
|
82
|
-
| 操作とコマンド参照 | 必須 |
|
|
83
|
-
| 入力と出力の要点 | 必須 | 受け取るものと送り出すものを分離し、対象・役割・正本と入力失敗時の扱いを示す
|
|
84
|
-
| 終了コードとエラー表示・利用者の次の手 | 必須 |
|
|
85
|
-
| メモ / 将来課題 | 任意 |
|
|
63
|
+
| 章 | 必須・任意 | 目的と内容要件 |
|
|
64
|
+
| -------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------ |
|
|
65
|
+
| 概要 | 必須 | コマンド群で達成する結果と対象範囲を 1〜2 文で示す |
|
|
66
|
+
| 利用目的と対象ユーザー | 必須 | 対象者の課題、対象外の操作と引き渡し先、手順・完了判断の確認者を示す |
|
|
67
|
+
| 操作の流れ | 必須 | 開始条件、標準経路、分岐、中断・再開、完了時の確認結果を示す |
|
|
68
|
+
| 操作とコマンド参照 | 必須 | 操作・コマンドと構文の正本を対応付ける。フローで意味が分かれば説明列は任意 |
|
|
69
|
+
| 入力と出力の要点 | 必須 | 受け取るものと送り出すものを分離し、対象・役割・正本と入力失敗時の扱いを示す |
|
|
70
|
+
| 終了コードとエラー表示・利用者の次の手 | 必須 | 正常・警告・異常の判断、表示要点、回復条件と操作。対象なし・スキップも扱う |
|
|
71
|
+
| メモ / 将来課題 | 任意 | 未作成の参照先、未確認の動作、未決事項の論点と影響・当面の扱いを示す。該当事項があれば省略しない |
|
|
86
72
|
|
|
87
73
|
## 6. 記述ガイド
|
|
88
74
|
|
|
89
|
-
|
|
75
|
+
完成例は frontmatter の `sample` を参照します。
|
|
90
76
|
|
|
91
77
|
### 6.1. 概要
|
|
92
78
|
|
|
93
|
-
- 判断基準:
|
|
79
|
+
- 判断基準: 達成結果と引き継ぐものが分かること。内部処理は含めません。
|
|
94
80
|
- 良い例: 「作業指示の準備から実行・進捗確認・再開をつなぎ、結果と判断を次の担当者へ引き継ぐコマンド群。」
|
|
95
81
|
- 悪い例: 「引数を解析し、内部関数を呼び出す CLI。」利用者が得る結果を判断できません。
|
|
96
82
|
|
|
97
83
|
### 6.2. 利用目的と対象ユーザー
|
|
98
84
|
|
|
99
|
-
- 判断基準:
|
|
85
|
+
- 判断基準: 対象者と達成結果が対応し、操作・結果確認・合意の役割が分かること。自動実行は設定・監視する人も示します。
|
|
100
86
|
- 良い例: 「運用者は停止した作業の状態と残存成果を確認して再開する。レビュー担当は記録から完了条件の充足を確認する。」
|
|
101
87
|
- 悪い例: 「対象は全ユーザー。目的はコマンドの実行。」課題、達成結果、確認者が特定できません。
|
|
102
88
|
|
|
103
89
|
### 6.3. 操作の流れ
|
|
104
90
|
|
|
105
|
-
- 判断基準:
|
|
106
|
-
-
|
|
91
|
+
- 判断基準: 開始前から結果確認まで進め、分岐を選べること。中断時は同じ試行の再開と新規のやり直しを区別し、保持成果と再開先を示します。
|
|
92
|
+
- 順序付きリストまたは Mermaid を使い、併用時は分岐と選択条件などを分担します。状態や実行主体の固有語は初出で定義または正本へ案内します。
|
|
107
93
|
- 良い例: 「状況確認 → 対象を選んで実行 → 記録と差分で結果を確認。中断時は保存済みの試行と成果を確認して該当段から再開する。」
|
|
108
94
|
- 悪い例: 「実行後は常に完了。失敗したら最初から実行。」業務上の完了確認と既存成果の扱いが欠けます。
|
|
109
95
|
|
|
110
96
|
### 6.4. 操作とコマンド参照
|
|
111
97
|
|
|
112
|
-
- 判断基準:
|
|
113
|
-
-
|
|
114
|
-
- 良い例: 「状況確認 → `exec status` → [[specdojo:command-reference#7-exec|CLIコマンドリファレンス: exec]]
|
|
98
|
+
- 判断基準: 操作からコマンドと構文の正本を特定できること。該当する小節があればそこへ、なければ章へ接続します。
|
|
99
|
+
- 推奨列は「操作」「対象コマンド」「正本リファレンス」。用途を選べなくなるコマンドは行を分け、フローにない操作の意味はここで補います。
|
|
100
|
+
- 良い例: 「状況確認 → `exec status` → [[specdojo:command-reference#7-exec|CLIコマンドリファレンス: exec]]」。
|
|
115
101
|
- 悪い例: 全フラグの型・既定値・組合せを表へ転載する。構文の変更を二重管理することになります。
|
|
116
102
|
|
|
117
103
|
### 6.5. 入力と出力の要点
|
|
118
104
|
|
|
119
|
-
|
|
105
|
+
判断基準は、情報の方向、利用する操作、目的、中身の正本を追えることです。入力・出力を表に分け、操作は専用列か対象欄で識別します。同じ扱いの操作はまとめ、該当なし行は作りません。
|
|
120
106
|
|
|
121
107
|
#### 6.5.1. 入力情報
|
|
122
108
|
|
|
123
|
-
-
|
|
109
|
+
- 入力は CLI が受け取るもの。必須情報は「種類」「対象」「役割」「正本の参照」「ない/壊れている/届かないときの扱い」。ファイル、標準入力、対話、環境変数、API 応答、外部処理の結果を確認します。
|
|
124
110
|
- 失敗時は停止・代替・再入力・警告継続を区別し、対応する事象名または参照でエラー章につなげます。欠落と破損で扱いが異なれば分けて示します。
|
|
125
111
|
- 良い例: 「設定ファイルを実行条件の解決に使う。中身は schema を参照し、欠落時は既定設定、破損時は『設定不正』として停止する。」
|
|
126
112
|
- 悪い例: 「設定を読む。なければ適切に処理する。」停止するか続行するかを判断できません。
|
|
127
113
|
|
|
128
114
|
#### 6.5.2. 出力情報
|
|
129
115
|
|
|
130
|
-
-
|
|
131
|
-
-
|
|
116
|
+
- 出力は CLI が外へ送り出すもの。必須情報は「種類」「対象」「役割」「正本の参照」。標準出力・標準エラー、ファイルの作成・更新、外部への送信・起動を扱います。
|
|
117
|
+
- 表示先は契約に合わせ、標準出力に診断が出る場合も区別します。表示要点は利用者が確認する内容に絞ります。
|
|
132
118
|
- 良い例: 「実行記録を保存し、次の担当が結果と再開段を確認する。項目と形式は記録の schema を参照する。」
|
|
133
119
|
- 悪い例: 保存する JSON の全フィールドや API のペイロードを列挙する。中身の正本と重複します。
|
|
134
120
|
|
|
@@ -142,18 +128,18 @@ graph TD
|
|
|
142
128
|
| 外部コマンド | [[specdojo:ifx-cmd-rulebook\|外部コマンド連携仕様作成ルール]] に従う契約 | 起動する目的、渡すもの、受け取る結果、失敗時の扱い |
|
|
143
129
|
|
|
144
130
|
- API への送信は出力、応答は入力です。取得と更新を兼ねる呼出しは両方に挙げます。外部コマンドも起動を出力、実行結果を入力に挙げます。
|
|
145
|
-
-
|
|
146
|
-
-
|
|
131
|
+
- 未作成の正本は ID かファイル名をインラインコードで示し、その旨と影響を記録します。独立した正本が不要な対話表示などは、理由を添えて参照なしとします。
|
|
132
|
+
- 成果物本文では別の型の sample を契約例として参照できます。学習例と実案件を区別し、対象操作と用途を示します。本型の sample・recipe・template の対応宣言とは別です。
|
|
147
133
|
|
|
148
134
|
### 6.6. 終了コードとエラー表示・利用者の次の手
|
|
149
135
|
|
|
150
|
-
- 判断基準:
|
|
151
|
-
-
|
|
136
|
+
- 判断基準: 発生条件、終了コードの意味、表示要点、次の確認・操作から完了・回復を判定できること。表示から分からない原因は補います。
|
|
137
|
+
- 終了コードの値と伝播は対象コマンドの正本に従い、外部処理のコードを CLI 全体へ一律に当てはめません。警告継続・対象なし・スキップは、正常終了でも未実施・未完了になり得るかを示します。
|
|
152
138
|
- 再試行の前に確認する状態・保持成果・担当を示します。再実行で二重処理や成果の消失が起こり得る場合は、回避条件を記述します。
|
|
153
139
|
- 良い例: 「対象なしの正常終了は新規作業の完了を意味しない。運用者は依存関係と対象条件を確認してから選択をやり直す。」
|
|
154
140
|
- 悪い例: 「非ゼロなら再実行する。」原因の解消、残存成果、再開先が判断できません。
|
|
155
141
|
|
|
156
|
-
|
|
142
|
+
入出力章は表示先・役割、次の推奨表は事象ごとの判断と回復を扱います。
|
|
157
143
|
|
|
158
144
|
| 列 | 記述する内容 |
|
|
159
145
|
| -------------- | ---------------------------------------------------------------------- |
|
|
@@ -164,24 +150,21 @@ graph TD
|
|
|
164
150
|
|
|
165
151
|
### 6.7. メモ / 将来課題
|
|
166
152
|
|
|
167
|
-
- 判断基準:
|
|
168
|
-
- 良い例: 「外部 agent
|
|
169
|
-
- 悪い例:
|
|
153
|
+
- 判断基準: 確定仕様と未確定事項を区別し、影響する操作・回復経路と当面の扱いが分かること。
|
|
154
|
+
- 良い例: 「外部 agent 契約は未作成。終了状態と再開条件が決まるまで、当該経路の受入判断を保留する。」
|
|
155
|
+
- 悪い例: 「今後検討する。」論点と影響する経路が分かりません。
|
|
170
156
|
|
|
171
157
|
## 7. 禁止事項
|
|
172
158
|
|
|
173
|
-
| 禁止する記述
|
|
174
|
-
|
|
|
175
|
-
| 構文・値・構造・実装詳細の正本の再掲
|
|
176
|
-
| 外部コマンド連携契約や GUI レイアウトの混入
|
|
177
|
-
| 入力と出力の混同、正本未作成を隠したリンク
|
|
178
|
-
| 次の手を伴わないエラー列挙、一律の再実行指示
|
|
179
|
-
| 認証情報の値の記載 | 仕様には名前と用途のみが必要である |
|
|
180
|
-
| フロー・表・図での同じ説明の繰り返し | 利用者の判断を増やさず保守箇所だけを増やす |
|
|
181
|
-
| 本文への sample・recipe・template のリンク章や wikilink の設置 | 対応関係は frontmatter で宣言する |
|
|
159
|
+
| 禁止する記述 | 理由 |
|
|
160
|
+
| -------------------------------------------- | -------------------------------------------------------- |
|
|
161
|
+
| 構文・値・構造・実装詳細の正本の再掲 | 引数表、ペイロード、内部クラス、SQL 等の二重管理を避ける |
|
|
162
|
+
| 外部コマンド連携契約や GUI レイアウトの混入 | 利用者の CLI 操作という責務を保つ |
|
|
163
|
+
| 入力と出力の混同、正本未作成を隠したリンク | 情報の方向と仕様の確定範囲を誤認させる |
|
|
164
|
+
| 次の手を伴わないエラー列挙、一律の再実行指示 | 回復条件を判断できず、二重処理や成果消失につながる |
|
|
182
165
|
|
|
183
166
|
## 8. 運用ルール
|
|
184
167
|
|
|
185
168
|
- コマンド構文だけの変更は正本へ反映し、参照先を確認します。利用目的、操作の流れ、入出力の要点、終了時の判断、回復条件が変わる場合は CLIS も改訂します。
|
|
186
|
-
-
|
|
187
|
-
-
|
|
169
|
+
- 受入確認では標準経路・分岐と入力失敗・警告・異常をたどり、表示・終了コード・保持成果・次の操作を正本と照合します。
|
|
170
|
+
- 完了・回復が期待結果と一致し、二重処理・成果消失を避ける再試行条件を確認できれば合格とします。
|