specdojo 0.8.0 → 0.9.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 +4 -1
- package/CHANGELOG.md +64 -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/where.js +25 -0
- package/dist/dashboard/dashboard.js +5 -3
- package/dist/dashboard/routines.js +4 -7
- package/dist/dashboard/timeline.js +14 -14
- 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/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 +84 -0
- package/dist/exec/repo-integration-sync.js +17 -5
- 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 +4 -1
- 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 +1 -1
- package/dist/exec/smoke.js +190 -0
- package/dist/exec/strategy.js +13 -3
- 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 +9 -1
- 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/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 +9 -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/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 +257 -117
- package/docs/ja/specdojo/references/deliverables-reference.md +21 -12
- package/docs/ja/specdojo/references/specdojo-config-reference.md +37 -2
- 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
|
@@ -16,7 +16,7 @@ specdojo:
|
|
|
16
16
|
|
|
17
17
|
Deliverables Catalog Index Documentation Rules
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
本ドキュメントは、成果物カタログ索引 `dct-index.yaml` に書くドメインの分類・表示順・名称・概要と、scaffold に用いるプロジェクト規模の判断基準を定めます。
|
|
20
20
|
|
|
21
21
|
## 1. 全体方針
|
|
22
22
|
|
|
@@ -24,48 +24,36 @@ Deliverables Catalog Index Documentation Rules
|
|
|
24
24
|
- `generated/dct-index.md` は `catalog build` が生成する表示専用ビューとし、直接編集しない。
|
|
25
25
|
- 各ドメインの成果物定義は `dct-<domain>.yaml` に置き、索引には表示名・概要・順序・グループだけを置く。
|
|
26
26
|
- `dct-index.yaml` の宣言ドメイン集合と実在する `dct-*.yaml` の `domain` 集合を一致させる。
|
|
27
|
-
-
|
|
27
|
+
- 文書の配置は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] を正本とし、要求・品質・受入の詳細は各ドメインの成果物へ委ねて、索引へ転載しない。
|
|
28
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、本書と成果物で言い直さない。
|
|
28
29
|
|
|
29
|
-
## 2.
|
|
30
|
+
## 2. 位置づけ
|
|
30
31
|
|
|
31
|
-
|
|
32
|
-
| ------------ | --------------------------- | ---------------------------------------------------------- |
|
|
33
|
-
| 索引宣言 | `dct-index.yaml` | 規模、グループ、ドメイン順、表示名、概要を宣言する |
|
|
34
|
-
| 索引ビュー | `generated/dct-index.md` | 宣言と実在カタログから生成されるプロジェクトの参照起点 |
|
|
35
|
-
| ドメイン正本 | `dct-<domain>.yaml` | ドメインに属する成果物、配置、依存関係、完了条件を定義する |
|
|
36
|
-
| ドメイン表示 | `generated/dct-<domain>.md` | 1 ドメインの成果物定義を読みやすい Markdown として表示する |
|
|
37
|
-
|
|
38
|
-
- `domain` は論理的な管理単位であり、物理ファイル名ではなく各 `dct-*.yaml` の `domain` 値で識別する。
|
|
39
|
-
- 同じ `domain` を持つ物理分割ファイルが複数あっても、索引宣言と索引ビューでは 1 ドメインとして扱う。
|
|
40
|
-
- グループはドメインを探すための分類、サブグループはその中の探索単位を表す。宣言できる階層は schema に従う。
|
|
41
|
-
- グループとサブグループの順序は、成果物定義の依存順や Schedule の実行順を意味しない。
|
|
32
|
+
- `domain` は論理的な管理単位であり、物理ファイル名ではなく各 `dct-*.yaml` の `domain` 値で識別する。物理分割ファイルが複数あっても、索引では 1 ドメインとして扱う。
|
|
42
33
|
|
|
43
34
|
## 3. ファイル命名・ID規則
|
|
44
35
|
|
|
45
|
-
- 索引宣言はカタログディレクトリ直下の `dct-index.yaml` とする。
|
|
46
|
-
-
|
|
47
|
-
- 索引宣言と索引ビューは `<project-id>:dct-index` を共有する。表示用の別 ID を作らず、既存の参照を維持する。
|
|
48
|
-
- ドメイン識別子や ID の文字種・形式は `docs/specdojo/schemas/v1/dct-index.schema.yaml` に従う。
|
|
36
|
+
- 索引宣言はカタログディレクトリ直下の `dct-index.yaml`、索引ビューは同ディレクトリの `generated/dct-index.md` とする。
|
|
37
|
+
- 両者は `<project-id>:dct-index` を共有する。表示用の別 ID を作らず、既存の参照を維持する。
|
|
49
38
|
|
|
50
39
|
## 4. 本文要件
|
|
51
40
|
|
|
52
|
-
構造・必須キー・型・列挙値・排他制約は `docs/specdojo/schemas/v1/dct-index.schema.yaml`
|
|
41
|
+
構造・必須キー・型・列挙値・排他制約は `docs/specdojo/schemas/v1/dct-index.schema.yaml` を正本とし、本章は内容の判断基準を示す。独立 YAML のためメタ情報もトップレベルに置く。コマンドの構文は [[specdojo:command-reference|コマンドリファレンス]] の「catalog / deliverable」を参照する。
|
|
53
42
|
|
|
54
43
|
### 4.1. ルート項目
|
|
55
44
|
|
|
56
|
-
| 項目 | 必須 | 目的・記述規約
|
|
57
|
-
| ------------------------------ | ---- |
|
|
58
|
-
| `id` / `project_id` | ○ | 対象プロジェクトを識別し、他プロジェクトの索引との取り違えを防ぐ
|
|
59
|
-
| `type` / `status` / `rulebook` | ○ | 文書種別・成熟度・適用規約を示す。`status` は `draft` / `ready` / `deprecated`
|
|
60
|
-
| `title` | ○ | 読み手が参照起点と認識できる生成ビューの文書名
|
|
61
|
-
| `size` | ○ | 今後の scaffold で選択する成果物セットの規模(`small` / `medium` / `large`)。現在のドメイン数ではない
|
|
62
|
-
| `groups` | ○ | 管理対象ドメインを、読み手が探す分類と順序でまとめる
|
|
45
|
+
| 項目 | 必須 | 目的・記述規約 |
|
|
46
|
+
| ------------------------------ | ---- | ------------------------------------------------------------------------------------------------------ |
|
|
47
|
+
| `id` / `project_id` | ○ | 対象プロジェクトを識別し、他プロジェクトの索引との取り違えを防ぐ |
|
|
48
|
+
| `type` / `status` / `rulebook` | ○ | 文書種別・成熟度・適用規約を示す。`status` は `draft` / `ready` / `deprecated` のいずれか |
|
|
49
|
+
| `title` | ○ | 読み手が参照起点と認識できる生成ビューの文書名 |
|
|
50
|
+
| `size` | ○ | 今後の scaffold で選択する成果物セットの規模(`small` / `medium` / `large`)。現在のドメイン数ではない |
|
|
51
|
+
| `groups` | ○ | 管理対象ドメインを、読み手が探す分類と順序でまとめる |
|
|
63
52
|
|
|
64
53
|
### 4.2. グループとサブグループ
|
|
65
54
|
|
|
66
|
-
-
|
|
67
|
-
-
|
|
68
|
-
- 配列順を索引ビューとサイドバーの表示順として扱う。優先度・着手順・担当者順の管理には用いない。
|
|
55
|
+
- グループはドメインを探すための分類、サブグループはその中の探索単位である。`name` と、`domains` を直接置くか子 `groups` へ分けるかは「グループ分類の決め方」に従う。
|
|
56
|
+
- 配列順は索引ビューとサイドバーの表示順であり、成果物の依存順・Schedule の実行順・優先度を表さない。
|
|
69
57
|
|
|
70
58
|
### 4.3. ドメイン項目
|
|
71
59
|
|
|
@@ -75,19 +63,17 @@ Deliverables Catalog Index Documentation Rules
|
|
|
75
63
|
| `name` | ○ | 利用者向けの日本語表示名。索引ビューの表とサイドバーの表示名に使う |
|
|
76
64
|
| `overview` | ○ | ドメインが管理する成果物の関心領域を示す 1 文の概要 |
|
|
77
65
|
|
|
78
|
-
- 各要素のキーは `domain`、`name`、`overview` の順に書く。文書サイトのサイドバーは `domain` の直後の `name` を表示名として読むため、順序を入れ替えると表示名を解決できない。
|
|
79
|
-
|
|
80
66
|
### 4.4. 生成ビューの確認要件
|
|
81
67
|
|
|
82
|
-
-
|
|
83
|
-
-
|
|
84
|
-
-
|
|
68
|
+
- 宣言した分類・順序・表示名・概要が索引ビューへ反映されていること。
|
|
69
|
+
- 各ドメインの表示から、対応するドメイン別カタログへ到達できること。
|
|
70
|
+
- サイドバーでも索引と同じドメイン名・順序で探せること。
|
|
85
71
|
|
|
86
72
|
## 5. 記述ガイド
|
|
87
73
|
|
|
88
74
|
### 5.1. メタ情報と規模の決め方
|
|
89
75
|
|
|
90
|
-
|
|
76
|
+
`size` ごとの成果物セットは、カタログ template(`docs/ja/specdojo/templates/dct-*-template.yaml`)の章と成果物の `min_size` で決まる。scaffold は `min_size` が `size` 以下(`small` < `medium` < `large`)か未指定のものを取り込む。規模は、`min_size` で増える成果物が要るかで比べて決める。
|
|
91
77
|
|
|
92
78
|
| 判断 | 良い例 | 悪い例 |
|
|
93
79
|
| ---------------- | ----------------------------------------------------------------- | ------------------------------------------------------- |
|
|
@@ -98,9 +84,9 @@ Deliverables Catalog Index Documentation Rules
|
|
|
98
84
|
### 5.2. グループ分類の決め方
|
|
99
85
|
|
|
100
86
|
- 分類の正本は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] の文書構成図とする。ルートグループはプロジェクト成果物とプロダクト成果物のような文書分類、サブグループは構成図が示す論理的なまとまり(要件〜設計、品質保証、運用など)に対応させる。
|
|
101
|
-
-
|
|
102
|
-
-
|
|
103
|
-
-
|
|
87
|
+
- 成果物リファレンスの章(rulebook 単位)と分類が食い違う場合は、構成ガイドを正とする。
|
|
88
|
+
- 複数の分類に当てはまるように見えるドメインは、構成図で置かれた枠に従い、判断理由を YAML コメントに残す。
|
|
89
|
+
- サブグループは、ルートグループ内のドメインが読み手の探索単位として 2 つ以上に分かれる場合に限る。
|
|
104
90
|
|
|
105
91
|
| 判断 | 良い例 | 悪い例 |
|
|
106
92
|
| ------------ | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
|
@@ -110,29 +96,24 @@ Deliverables Catalog Index Documentation Rules
|
|
|
110
96
|
|
|
111
97
|
### 5.3. ドメインの選定と説明の書き方
|
|
112
98
|
|
|
113
|
-
-
|
|
114
|
-
- `name`
|
|
115
|
-
- `overview` は管理対象の関心領域を 1
|
|
99
|
+
- 管理対象を物理ファイル数や今後作る予定の文書から推測しない。
|
|
100
|
+
- `name` はドメインの表示名に限定し、状態・担当・件数など変動する情報や、親ノードの「成果物カタログ」を含めない。
|
|
101
|
+
- `overview` は管理対象の関心領域を 1 文で記述し、個別成果物を列挙しない。
|
|
116
102
|
|
|
117
|
-
| 項目 | 良い例
|
|
118
|
-
| ---------- |
|
|
119
|
-
| `name` | `データモデル`
|
|
120
|
-
| `overview` | `データの概念、論理構造、分類、状態を表す成果物を管理する。`
|
|
121
|
-
| 管理単位 | データモデルのカタログが物理分割されていても同じ `domain` として 1 件だけ宣言する | 分割ファイルごとに別ドメインを作る、または同じドメインを複数回宣言する |
|
|
103
|
+
| 項目 | 良い例 | 悪い例 |
|
|
104
|
+
| ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
|
105
|
+
| `name` | `データモデル` | `成果物カタログ(データモデル)`、`データモデル(作成中)` |
|
|
106
|
+
| `overview` | `データの概念、論理構造、分類、状態を表す成果物を管理する。` | `概念データモデル、論理データモデル、状態遷移表を管理する。` |
|
|
122
107
|
|
|
123
108
|
### 5.4. 変更時の影響確認
|
|
124
109
|
|
|
125
|
-
-
|
|
126
|
-
- 改訂・廃止の共通原則は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] の「文書の改訂・廃止とライフサイクル変更管理」に従う。個別成果物の非推奨化とドメインの除去は分けて判断し、同じドメインのカタログが残る間は索引から外さない。
|
|
127
|
-
- ARC は分類と参照先の構造整合、QE は索引ビュー・サイドバーからの到達と表示、PM は残る追従作業の担当・実行順を確認する。プロジェクト固有の役割分担がある場合は、その定義に従う。
|
|
128
|
-
|
|
129
|
-
| 判断 | 良い例 | 悪い例 |
|
|
130
|
-
| ---------- | ---------------------------------------------------------------- | --------------------------------------------------------- |
|
|
131
|
-
| 追加・改名 | ドメイン正本と索引を揃え、参照先へ到達できることまで確認する | 索引の表示名だけ変えて完了とする |
|
|
132
|
-
| 除去 | 同じドメインの残存カタログと参照元を調べ、追従対象を決める | 個別成果物を非推奨にしただけでドメイン全体を索引から外す |
|
|
133
|
-
| 完了判断 | 構造・実在ドメインとの整合・生成後の表示と到達をそれぞれ確かめる | YAML が読み込めること、または schema 検証だけで完了とする |
|
|
110
|
+
- ドメインの追加・削除・改名時は、索引とドメイン正本を同じ変更で整合させ、schema 検証・`catalog validate`・`catalog build` 後の「生成ビューの確認要件」で確かめる。
|
|
134
111
|
|
|
135
|
-
|
|
112
|
+
| 判断 | 良い例 | 悪い例 |
|
|
113
|
+
| ---------- | ------------------------------------------------------------------------ | -------------------------------------------------------- |
|
|
114
|
+
| 追加・改名 | ドメイン正本と索引を揃え、参照先へ到達できることまで確認する | 索引の表示名だけ変えて完了とする |
|
|
115
|
+
| 除去 | 同じドメインのカタログが残る間は索引から外さず、参照元の追従対象を決める | 個別成果物を非推奨にしただけでドメイン全体を索引から外す |
|
|
116
|
+
| 完了判断 | 構造・実在カタログとの整合・生成後の表示と到達をそれぞれ確かめる | schema 検証だけで完了とする |
|
|
136
117
|
|
|
137
118
|
## 6. 禁止事項
|
|
138
119
|
|