yodogawa 2.1.3 → 2.2.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/CHANGELOG.md +134 -94
- package/LICENSE +1 -1
- package/README.md +351 -263
- package/bin/checks/id-trace.js +137 -0
- package/bin/checks/links.js +59 -0
- package/bin/checks/placeholder.js +132 -0
- package/bin/checks/structure.js +127 -0
- package/bin/cli.js +51 -67
- package/bin/commands/doctor.js +128 -0
- package/bin/commands/install.js +58 -0
- package/bin/commands/new-task.js +117 -0
- package/bin/lib/check-cli.js +19 -0
- package/bin/lib/findings.js +31 -0
- package/bin/lib/markdown.js +103 -0
- package/bin/lib/project-spec.js +138 -0
- package/bin/lib/walk-md.js +23 -0
- package/package.json +68 -55
- package/skills/a-001-setup-doc-structure/SKILL.md +68 -68
- package/skills/a-001-setup-doc-structure/reference/directory-structure.md +75 -75
- package/skills/a-002-initialize-project/SKILL.md +145 -118
- package/skills/a-002-initialize-project/reference/hearing-questions.md +91 -41
- package/skills/a-002-initialize-project/reference/structure-check.md +12 -22
- package/skills/a-002a-slice-mvp-scope/SKILL.md +105 -0
- package/skills/a-002b-define-user-stories/SKILL.md +80 -0
- package/skills/a-002b-define-user-stories/reference/user-stories-guide.md +78 -0
- package/skills/a-003-create-scenarios/SKILL.md +97 -96
- package/{templates/project/02-behavior/01-scenarios.md → skills/a-003-create-scenarios/reference/detailed-gherkin-template.md} +413 -406
- package/skills/a-003-create-scenarios/reference/structure-check.md +20 -17
- package/skills/a-004-define-domain-model/SKILL.md +107 -98
- package/skills/a-004-define-domain-model/reference/event-storming-guide.md +33 -7
- package/skills/a-004-define-domain-model/reference/ubiquitous-language-guide.md +49 -0
- package/skills/a-005-create-domain-diagram/SKILL.md +18 -17
- package/skills/a-006-review-requirements-domain/SKILL.md +59 -22
- package/skills/a-006-review-requirements-domain/examples/review-report-template.md +27 -7
- package/skills/a-006-review-requirements-domain/reference/consistency-checks.md +53 -18
- package/skills/a-007-define-tech-stack/SKILL.md +99 -99
- package/skills/a-008-define-repository-structure/SKILL.md +96 -96
- package/skills/a-009-define-screen-design/SKILL.md +103 -103
- package/skills/a-010-define-design-system/SKILL.md +130 -130
- package/skills/a-011-define-data-model/SKILL.md +118 -118
- package/skills/a-012-define-api-spec/SKILL.md +105 -105
- package/skills/a-013-define-architecture/SKILL.md +98 -98
- package/skills/a-014-define-infrastructure/SKILL.md +118 -110
- package/skills/{a-002-initialize-project → a-014-define-infrastructure}/examples/nfr-baseline.md +2 -1
- package/{templates/project/01-requirements/04-non-functional-requirements.md → skills/a-014-define-infrastructure/examples/non-functional-requirements.md} +120 -115
- package/skills/a-015-review-design/reference/consistency-checks.md +1 -1
- package/skills/b-001-create-task-directory/SKILL.md +68 -68
- package/skills/b-002-create-task-definition/SKILL.md +114 -114
- package/skills/b-003-create-task-research/SKILL.md +128 -128
- package/skills/b-004-create-task-implementation/SKILL.md +98 -98
- package/skills/b-005-review-task/reference/assessment-criteria.md +79 -79
- package/skills/c-001-implement-task/SKILL.md +186 -186
- package/skills/c-001-implement-task/reference/implementation-loop.md +65 -65
- package/skills/c-002-update-documentation/SKILL.md +159 -159
- package/skills/c-002-update-documentation/examples/project-doc-updates.md +4 -4
- package/skills/c-002-update-documentation/reference/doc-structure-and-checks.md +99 -97
- package/templates/project/01-requirements/01-product-brief.md +186 -0
- package/templates/project/01-requirements/02-mvp-scope.md +64 -0
- package/templates/project/01-requirements/03-parking-lot.md +29 -0
- package/templates/project/01-requirements/05-user-stories.md +28 -124
- package/templates/project/01-requirements/{02-features-implemented.md → 06-features-implemented.md} +77 -73
- package/templates/project/02-behavior/01-core-scenarios.md +80 -0
- package/templates/project/03-domain/01-domain-model.md +120 -339
- package/templates/project/03-domain/01-domain-sketch.md +90 -0
- package/templates/project/03-domain/02-ubiquitous-language.md +32 -153
- package/templates/project/04-design/01-tech-stack.md +367 -367
- package/templates/project/04-design/02-repository-structure.md +391 -391
- package/templates/project/04-design/03-screen-design.md +596 -596
- package/templates/project/04-design/04-design-system.md +261 -261
- package/templates/project/04-design/05-data-model.md +211 -211
- package/templates/project/04-design/06-api-spec.md +226 -226
- package/templates/project/04-design/07-architecture.md +183 -183
- package/templates/project/04-design/08-infrastructure.md +180 -180
- package/templates/project/AI_CONTEXT.md +55 -0
- package/templates/project/STAKEHOLDER-SUMMARY.md +66 -0
- package/templates/tasks/task-template/a-definition.md +143 -143
- package/templates/tasks/task-template/b-research.md +185 -185
- package/templates/tasks/task-template/c-implementation.md +200 -200
- package/templates/project/01-requirements/01-system-overview.md +0 -49
- package/templates/project/01-requirements/03-features-planned.md +0 -75
|
@@ -1,159 +1,159 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: c-002-update-documentation
|
|
3
|
-
description: 実装完了後にタスクドキュメント(a-definition / b-research / c-implementation)とプロジェクトドキュメント(要件・ドメイン・API・データモデル等)を実装結果に合わせて更新する。実装完了後、ドキュメントと実コードの整合を取る際に使用。
|
|
4
|
-
disable-model-invocation: true
|
|
5
|
-
allowed-tools: Read, Write, Edit, Bash, Grep, Glob
|
|
6
|
-
argument-hint: "[task-id]"
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
# UpdateDocumentation (c-002)
|
|
10
|
-
|
|
11
|
-
## 目的
|
|
12
|
-
|
|
13
|
-
- 実装完了後にタスクレベルのドキュメント(a-definition.md, b-research.md, c-implementation.md)を実装内容に合わせて更新する。
|
|
14
|
-
- プロジェクトレベルのドキュメント(要件・ドメイン・データモデル・API・画面設計等)を実装済み機能に合わせて更新する。
|
|
15
|
-
- 計画時と実装時の差異を記録し、次のタスクへのフィードバックとする。
|
|
16
|
-
- コードとドキュメントの一貫性を保ち、ドキュメント腐敗を防止する。
|
|
17
|
-
|
|
18
|
-
## 前提
|
|
19
|
-
|
|
20
|
-
- `/c-001-implement-task` で実装が完了していること
|
|
21
|
-
- タスクディレクトリ `docs/tasks/task000001-{スラッグ}/` とタスクドキュメントが存在すること
|
|
22
|
-
- 実装タスクリストの全ステップが完了していること
|
|
23
|
-
- プロジェクトドキュメント構造(`docs/01-requirements/`, `docs/03-domain/`, `docs/04-design/` など)が存在すること
|
|
24
|
-
|
|
25
|
-
## 手順
|
|
26
|
-
|
|
27
|
-
`$ARGUMENTS` が指定されている場合は `task{ID}-{SLUG}`(例: `task000003-auth-login`)として使用する。未指定の場合はユーザーに対象タスクを確認する。
|
|
28
|
-
|
|
29
|
-
### 1. 実装完了の確認
|
|
30
|
-
|
|
31
|
-
**タスクID を確認**し、以下を検証:
|
|
32
|
-
|
|
33
|
-
- [ ] `c-implementation.md` の全ステップが `[x]`
|
|
34
|
-
- [ ] 全フェーズの受け入れ基準が満たされている
|
|
35
|
-
- [ ] テストが全て通っている
|
|
36
|
-
- [ ] PR/MR が作成されている(該当する場合)
|
|
37
|
-
|
|
38
|
-
未完了なら「タスク {task-id} の実装がまだ完了していません。先に `/c-001-implement-task` を実行してください。」と案内する。
|
|
39
|
-
|
|
40
|
-
### 2. 実装内容の確認
|
|
41
|
-
|
|
42
|
-
**変更ファイルの特定**:
|
|
43
|
-
|
|
44
|
-
```bash
|
|
45
|
-
git diff main..HEAD --name-only
|
|
46
|
-
git log --name-only --oneline main..HEAD
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
確認対象: 新規/変更/削除ファイル、依存関係(package.json 等)、マイグレーション、環境変数。
|
|
50
|
-
|
|
51
|
-
**計画との差異**:
|
|
52
|
-
|
|
53
|
-
- 計画通りに実装されたステップ / 変更/追加/スキップしたステップ
|
|
54
|
-
- 技術スタック・アーキテクチャ・データモデル・API・画面遷移の変更点
|
|
55
|
-
|
|
56
|
-
### 3. タスクドキュメントの更新
|
|
57
|
-
|
|
58
|
-
#### 3.1. `a-definition.md`
|
|
59
|
-
|
|
60
|
-
- 実装内容・受け入れ基準の更新
|
|
61
|
-
- `## 実装時の技術的決定` セクションの追加(必要に応じて)
|
|
62
|
-
- `## 実装結果` セクションの追加(実装日、実装者、ブランチ、PR/MR、テスト結果、デプロイ)
|
|
63
|
-
|
|
64
|
-
記載例: [examples/task-doc-updates.md](examples/task-doc-updates.md)
|
|
65
|
-
|
|
66
|
-
#### 3.2. `b-research.md`
|
|
67
|
-
|
|
68
|
-
- 技術選定の更新(計画時と実際の差異、理由)
|
|
69
|
-
- `## 実装時に発見したベストプラクティス` の追記
|
|
70
|
-
- `## 技術的リスクの結果` の追記(計画時リスクの結果)
|
|
71
|
-
|
|
72
|
-
#### 3.3. `c-implementation.md`
|
|
73
|
-
|
|
74
|
-
- 全ステップのチェックボックスが `[x]` か確認
|
|
75
|
-
- 各ステップに `**実装メモ**` を追記(必要に応じて)
|
|
76
|
-
- 各フェーズに `**実装時間**` を記録
|
|
77
|
-
- `## 振り返り` セクション(うまくいったこと/改善すべきこと/次のタスクへのフィードバック)を追加
|
|
78
|
-
|
|
79
|
-
### 4. プロジェクトドキュメントの更新
|
|
80
|
-
|
|
81
|
-
実装内容に応じて以下を更新(記載例は [examples/project-doc-updates.md](examples/project-doc-updates.md) を参照):
|
|
82
|
-
|
|
83
|
-
**要件** (`docs/01-requirements/`):
|
|
84
|
-
|
|
85
|
-
- [ ] `
|
|
86
|
-
- [ ] `03-
|
|
87
|
-
- [ ] `05-user-stories.md`: ユーザーストーリーのステータス更新
|
|
88
|
-
|
|
89
|
-
**ドメイン** (`docs/03-domain/`):
|
|
90
|
-
|
|
91
|
-
- [ ] `01-domain-
|
|
92
|
-
- [ ] `02-ubiquitous-language.md`: 新しいドメイン用語の追加
|
|
93
|
-
|
|
94
|
-
**設計** (`docs/04-design/`):
|
|
95
|
-
|
|
96
|
-
- [ ] `03-screen-design.md`: 新しい画面・UI コンポーネント
|
|
97
|
-
- [ ] `04-data-model.md`: 新しいテーブル・カラム
|
|
98
|
-
- [ ] `05-api-spec.md`: 新しい API エンドポイント
|
|
99
|
-
- [ ] `06-architecture.md`: アーキテクチャ変更
|
|
100
|
-
|
|
101
|
-
**その他**:
|
|
102
|
-
|
|
103
|
-
- [ ] `README.md`: セットアップ手順、機能一覧、API ドキュメントリンク
|
|
104
|
-
- [ ] `CHANGELOG.md`: 変更履歴
|
|
105
|
-
- [ ] `.env.example`: 新しい環境変数
|
|
106
|
-
|
|
107
|
-
### 5. ドキュメント整合性の検証
|
|
108
|
-
|
|
109
|
-
- クロスリファレンス確認(要件 ↔ ドメイン ↔ データモデル ↔ API ↔ 実装)
|
|
110
|
-
- 用語の一貫性確認(ubiquitous-language.md との整合)
|
|
111
|
-
- リンク切れの確認
|
|
112
|
-
|
|
113
|
-
詳細なチェック項目は [reference/doc-structure-and-checks.md](reference/doc-structure-and-checks.md) を参照。
|
|
114
|
-
|
|
115
|
-
### 6. Git コミット
|
|
116
|
-
|
|
117
|
-
```bash
|
|
118
|
-
git status
|
|
119
|
-
git diff docs/
|
|
120
|
-
git add docs/tasks/task{id}-{スラッグ}/ docs/01-requirements/ docs/03-domain/ docs/04-design/
|
|
121
|
-
git add README.md CHANGELOG.md .env.example
|
|
122
|
-
```
|
|
123
|
-
|
|
124
|
-
コミットメッセージのテンプレートは [reference/doc-structure-and-checks.md](reference/doc-structure-and-checks.md#コミットメッセージのテンプレート) を参照。
|
|
125
|
-
|
|
126
|
-
### 7. PR への反映とレビュー依頼
|
|
127
|
-
|
|
128
|
-
- 既存 PR の場合: `git push origin task/{task-id}-{スラッグ}`
|
|
129
|
-
- 未作成の場合: `gh pr create` で作成
|
|
130
|
-
- レビュー観点(正確性・完全性・明確性・一貫性・最新性)は [reference/doc-structure-and-checks.md](reference/doc-structure-and-checks.md#ドキュメント品質のレビュー観点) を参照
|
|
131
|
-
|
|
132
|
-
### 8. 次のタスクへのフィードバック
|
|
133
|
-
|
|
134
|
-
- `c-implementation.md` の振り返りから共通化候補を特定
|
|
135
|
-
- ベストプラクティスを次タスクのリサーチ入力として記録
|
|
136
|
-
- 必要に応じてタスクテンプレート (`templates/tasks/task-template/`) を改善
|
|
137
|
-
|
|
138
|
-
## 完了条件
|
|
139
|
-
|
|
140
|
-
- [ ] 実装完了が確認されている
|
|
141
|
-
- [ ] タスクドキュメントが更新されている(a-definition / b-research / c-implementation)
|
|
142
|
-
- [ ] プロジェクトドキュメントが更新されている(要件・ドメイン・設計・README・CHANGELOG・.env.example)
|
|
143
|
-
- [ ] ドキュメント間の整合性が確認されている
|
|
144
|
-
- [ ] ドキュメント更新がコミットされている
|
|
145
|
-
- [ ] 次のタスクへのフィードバックが記録されている
|
|
146
|
-
|
|
147
|
-
## エスカレーション
|
|
148
|
-
|
|
149
|
-
- **実装未完了**: 「タスクの実装がまだ完了していません。先に `/c-001-implement-task` を実行してください。」
|
|
150
|
-
- **計画との差異が大きい**: 差異の理由と影響範囲を明確化し、関係者に共有。必要ならアーキテクチャレビューを実施。
|
|
151
|
-
- **ドキュメント更新が複雑**: 段階的更新を推奨(タスクドキュメント → プロジェクトドキュメント、重要度順)。
|
|
152
|
-
- **用語の不一致**: `ubiquitous-language.md` で用語を統一し、既存ドキュメントを一括修正。
|
|
153
|
-
- **コードとドキュメントの乖離**: どちらが正しいかを確認し、コードまたはドキュメントを修正。
|
|
154
|
-
|
|
155
|
-
## 参考
|
|
156
|
-
|
|
157
|
-
- [examples/task-doc-updates.md](examples/task-doc-updates.md) — a-definition/b-research/c-implementation への追記サンプル
|
|
158
|
-
- [examples/project-doc-updates.md](examples/project-doc-updates.md) — features/domain/data/api/screen/README/CHANGELOG/env の更新サンプル
|
|
159
|
-
- [reference/doc-structure-and-checks.md](reference/doc-structure-and-checks.md) — 整合性チェック項目、ベストプラクティス、ドキュメント構造、コミットテンプレート
|
|
1
|
+
---
|
|
2
|
+
name: c-002-update-documentation
|
|
3
|
+
description: 実装完了後にタスクドキュメント(a-definition / b-research / c-implementation)とプロジェクトドキュメント(要件・ドメイン・API・データモデル等)を実装結果に合わせて更新する。実装完了後、ドキュメントと実コードの整合を取る際に使用。
|
|
4
|
+
disable-model-invocation: true
|
|
5
|
+
allowed-tools: Read, Write, Edit, Bash, Grep, Glob
|
|
6
|
+
argument-hint: "[task-id]"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# UpdateDocumentation (c-002)
|
|
10
|
+
|
|
11
|
+
## 目的
|
|
12
|
+
|
|
13
|
+
- 実装完了後にタスクレベルのドキュメント(a-definition.md, b-research.md, c-implementation.md)を実装内容に合わせて更新する。
|
|
14
|
+
- プロジェクトレベルのドキュメント(要件・ドメイン・データモデル・API・画面設計等)を実装済み機能に合わせて更新する。
|
|
15
|
+
- 計画時と実装時の差異を記録し、次のタスクへのフィードバックとする。
|
|
16
|
+
- コードとドキュメントの一貫性を保ち、ドキュメント腐敗を防止する。
|
|
17
|
+
|
|
18
|
+
## 前提
|
|
19
|
+
|
|
20
|
+
- `/c-001-implement-task` で実装が完了していること
|
|
21
|
+
- タスクディレクトリ `docs/tasks/task000001-{スラッグ}/` とタスクドキュメントが存在すること
|
|
22
|
+
- 実装タスクリストの全ステップが完了していること
|
|
23
|
+
- プロジェクトドキュメント構造(`docs/01-requirements/`, `docs/03-domain/`, `docs/04-design/` など)が存在すること
|
|
24
|
+
|
|
25
|
+
## 手順
|
|
26
|
+
|
|
27
|
+
`$ARGUMENTS` が指定されている場合は `task{ID}-{SLUG}`(例: `task000003-auth-login`)として使用する。未指定の場合はユーザーに対象タスクを確認する。
|
|
28
|
+
|
|
29
|
+
### 1. 実装完了の確認
|
|
30
|
+
|
|
31
|
+
**タスクID を確認**し、以下を検証:
|
|
32
|
+
|
|
33
|
+
- [ ] `c-implementation.md` の全ステップが `[x]`
|
|
34
|
+
- [ ] 全フェーズの受け入れ基準が満たされている
|
|
35
|
+
- [ ] テストが全て通っている
|
|
36
|
+
- [ ] PR/MR が作成されている(該当する場合)
|
|
37
|
+
|
|
38
|
+
未完了なら「タスク {task-id} の実装がまだ完了していません。先に `/c-001-implement-task` を実行してください。」と案内する。
|
|
39
|
+
|
|
40
|
+
### 2. 実装内容の確認
|
|
41
|
+
|
|
42
|
+
**変更ファイルの特定**:
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
git diff main..HEAD --name-only
|
|
46
|
+
git log --name-only --oneline main..HEAD
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
確認対象: 新規/変更/削除ファイル、依存関係(package.json 等)、マイグレーション、環境変数。
|
|
50
|
+
|
|
51
|
+
**計画との差異**:
|
|
52
|
+
|
|
53
|
+
- 計画通りに実装されたステップ / 変更/追加/スキップしたステップ
|
|
54
|
+
- 技術スタック・アーキテクチャ・データモデル・API・画面遷移の変更点
|
|
55
|
+
|
|
56
|
+
### 3. タスクドキュメントの更新
|
|
57
|
+
|
|
58
|
+
#### 3.1. `a-definition.md`
|
|
59
|
+
|
|
60
|
+
- 実装内容・受け入れ基準の更新
|
|
61
|
+
- `## 実装時の技術的決定` セクションの追加(必要に応じて)
|
|
62
|
+
- `## 実装結果` セクションの追加(実装日、実装者、ブランチ、PR/MR、テスト結果、デプロイ)
|
|
63
|
+
|
|
64
|
+
記載例: [examples/task-doc-updates.md](examples/task-doc-updates.md)
|
|
65
|
+
|
|
66
|
+
#### 3.2. `b-research.md`
|
|
67
|
+
|
|
68
|
+
- 技術選定の更新(計画時と実際の差異、理由)
|
|
69
|
+
- `## 実装時に発見したベストプラクティス` の追記
|
|
70
|
+
- `## 技術的リスクの結果` の追記(計画時リスクの結果)
|
|
71
|
+
|
|
72
|
+
#### 3.3. `c-implementation.md`
|
|
73
|
+
|
|
74
|
+
- 全ステップのチェックボックスが `[x]` か確認
|
|
75
|
+
- 各ステップに `**実装メモ**` を追記(必要に応じて)
|
|
76
|
+
- 各フェーズに `**実装時間**` を記録
|
|
77
|
+
- `## 振り返り` セクション(うまくいったこと/改善すべきこと/次のタスクへのフィードバック)を追加
|
|
78
|
+
|
|
79
|
+
### 4. プロジェクトドキュメントの更新
|
|
80
|
+
|
|
81
|
+
実装内容に応じて以下を更新(記載例は [examples/project-doc-updates.md](examples/project-doc-updates.md) を参照):
|
|
82
|
+
|
|
83
|
+
**要件** (`docs/01-requirements/`):
|
|
84
|
+
|
|
85
|
+
- [ ] `06-features-implemented.md`: 実装済み機能リストに追加(existing モードのみ)
|
|
86
|
+
- [ ] `03-parking-lot.md`: 実装した(または不要判断した)アイデアを backlog から削除
|
|
87
|
+
- [ ] `05-user-stories.md`: ユーザーストーリーのステータス更新
|
|
88
|
+
|
|
89
|
+
**ドメイン** (`docs/03-domain/`):
|
|
90
|
+
|
|
91
|
+
- [ ] `01-domain-sketch.md`: 中核エンティティ・重要ルールの更新(Full DDD 採用時は `01-domain-model.md`)
|
|
92
|
+
- [ ] `02-ubiquitous-language.md`: 新しいドメイン用語の追加
|
|
93
|
+
|
|
94
|
+
**設計** (`docs/04-design/`):
|
|
95
|
+
|
|
96
|
+
- [ ] `03-screen-design.md`: 新しい画面・UI コンポーネント
|
|
97
|
+
- [ ] `04-data-model.md`: 新しいテーブル・カラム
|
|
98
|
+
- [ ] `05-api-spec.md`: 新しい API エンドポイント
|
|
99
|
+
- [ ] `06-architecture.md`: アーキテクチャ変更
|
|
100
|
+
|
|
101
|
+
**その他**:
|
|
102
|
+
|
|
103
|
+
- [ ] `README.md`: セットアップ手順、機能一覧、API ドキュメントリンク
|
|
104
|
+
- [ ] `CHANGELOG.md`: 変更履歴
|
|
105
|
+
- [ ] `.env.example`: 新しい環境変数
|
|
106
|
+
|
|
107
|
+
### 5. ドキュメント整合性の検証
|
|
108
|
+
|
|
109
|
+
- クロスリファレンス確認(要件 ↔ ドメイン ↔ データモデル ↔ API ↔ 実装)
|
|
110
|
+
- 用語の一貫性確認(ubiquitous-language.md との整合)
|
|
111
|
+
- リンク切れの確認
|
|
112
|
+
|
|
113
|
+
詳細なチェック項目は [reference/doc-structure-and-checks.md](reference/doc-structure-and-checks.md) を参照。
|
|
114
|
+
|
|
115
|
+
### 6. Git コミット
|
|
116
|
+
|
|
117
|
+
```bash
|
|
118
|
+
git status
|
|
119
|
+
git diff docs/
|
|
120
|
+
git add docs/tasks/task{id}-{スラッグ}/ docs/01-requirements/ docs/03-domain/ docs/04-design/
|
|
121
|
+
git add README.md CHANGELOG.md .env.example
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
コミットメッセージのテンプレートは [reference/doc-structure-and-checks.md](reference/doc-structure-and-checks.md#コミットメッセージのテンプレート) を参照。
|
|
125
|
+
|
|
126
|
+
### 7. PR への反映とレビュー依頼
|
|
127
|
+
|
|
128
|
+
- 既存 PR の場合: `git push origin task/{task-id}-{スラッグ}`
|
|
129
|
+
- 未作成の場合: `gh pr create` で作成
|
|
130
|
+
- レビュー観点(正確性・完全性・明確性・一貫性・最新性)は [reference/doc-structure-and-checks.md](reference/doc-structure-and-checks.md#ドキュメント品質のレビュー観点) を参照
|
|
131
|
+
|
|
132
|
+
### 8. 次のタスクへのフィードバック
|
|
133
|
+
|
|
134
|
+
- `c-implementation.md` の振り返りから共通化候補を特定
|
|
135
|
+
- ベストプラクティスを次タスクのリサーチ入力として記録
|
|
136
|
+
- 必要に応じてタスクテンプレート (`templates/tasks/task-template/`) を改善
|
|
137
|
+
|
|
138
|
+
## 完了条件
|
|
139
|
+
|
|
140
|
+
- [ ] 実装完了が確認されている
|
|
141
|
+
- [ ] タスクドキュメントが更新されている(a-definition / b-research / c-implementation)
|
|
142
|
+
- [ ] プロジェクトドキュメントが更新されている(要件・ドメイン・設計・README・CHANGELOG・.env.example)
|
|
143
|
+
- [ ] ドキュメント間の整合性が確認されている
|
|
144
|
+
- [ ] ドキュメント更新がコミットされている
|
|
145
|
+
- [ ] 次のタスクへのフィードバックが記録されている
|
|
146
|
+
|
|
147
|
+
## エスカレーション
|
|
148
|
+
|
|
149
|
+
- **実装未完了**: 「タスクの実装がまだ完了していません。先に `/c-001-implement-task` を実行してください。」
|
|
150
|
+
- **計画との差異が大きい**: 差異の理由と影響範囲を明確化し、関係者に共有。必要ならアーキテクチャレビューを実施。
|
|
151
|
+
- **ドキュメント更新が複雑**: 段階的更新を推奨(タスクドキュメント → プロジェクトドキュメント、重要度順)。
|
|
152
|
+
- **用語の不一致**: `ubiquitous-language.md` で用語を統一し、既存ドキュメントを一括修正。
|
|
153
|
+
- **コードとドキュメントの乖離**: どちらが正しいかを確認し、コードまたはドキュメントを修正。
|
|
154
|
+
|
|
155
|
+
## 参考
|
|
156
|
+
|
|
157
|
+
- [examples/task-doc-updates.md](examples/task-doc-updates.md) — a-definition/b-research/c-implementation への追記サンプル
|
|
158
|
+
- [examples/project-doc-updates.md](examples/project-doc-updates.md) — features/domain/data/api/screen/README/CHANGELOG/env の更新サンプル
|
|
159
|
+
- [reference/doc-structure-and-checks.md](reference/doc-structure-and-checks.md) — 整合性チェック項目、ベストプラクティス、ドキュメント構造、コミットテンプレート
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
SKILL.md 手順4で使うテンプレート。要件・ドメイン・設計・README など各ドキュメントに追記するサンプル。
|
|
4
4
|
|
|
5
|
-
## features-implemented.md
|
|
5
|
+
## 06-features-implemented.md
|
|
6
6
|
|
|
7
7
|
```markdown
|
|
8
8
|
## ユーザー認証・認可
|
|
@@ -27,10 +27,10 @@ SKILL.md 手順4で使うテンプレート。要件・ドメイン・設計・R
|
|
|
27
27
|
**PR/MR**: #123
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
##
|
|
30
|
+
## 03-parking-lot.md
|
|
31
31
|
|
|
32
|
-
-
|
|
33
|
-
- または、ステータスを「実装済み」に変更し `
|
|
32
|
+
- 実装完了した(または不要判断した)アイデアを backlog から削除
|
|
33
|
+
- または、ステータスを「実装済み」に変更し `06-features-implemented.md` への参照を追加
|
|
34
34
|
|
|
35
35
|
## domain-model.md
|
|
36
36
|
|
|
@@ -1,97 +1,99 @@
|
|
|
1
|
-
# ドキュメント構造と整合性チェック
|
|
2
|
-
|
|
3
|
-
SKILL.md 手順5(整合性検証)とベストプラクティスで参照する詳細資料。
|
|
4
|
-
|
|
5
|
-
## ドキュメント整合性の検証項目
|
|
6
|
-
|
|
7
|
-
### クロスリファレンスの確認
|
|
8
|
-
|
|
9
|
-
- [ ] **要件 ↔ ドメインモデル**: features-implemented.md の機能が domain-model.md に反映されているか
|
|
10
|
-
- [ ] **ドメインモデル ↔ データモデル**: domain-model.md のエンティティが data-model.md のテーブルに対応しているか
|
|
11
|
-
- [ ] **ドメインモデル ↔ API 仕様**: domain-model.md の振る舞いが api-spec.md のエンドポイントに対応しているか
|
|
12
|
-
- [ ] **API 仕様 ↔ 実装**: api-spec.md のエンドポイントが実際に実装されているか
|
|
13
|
-
- [ ] **データモデル ↔ 実装**: data-model.md のテーブル定義がマイグレーションファイルと一致しているか
|
|
14
|
-
|
|
15
|
-
### 用語の一貫性確認
|
|
16
|
-
|
|
17
|
-
- [ ] ドキュメント全体で同じ用語を使用しているか
|
|
18
|
-
- [ ] ubiquitous-language.md に記載された用語が各ドキュメントで使用されているか
|
|
19
|
-
- [ ] コード内のクラス名・変数名がドメイン用語と一致しているか
|
|
20
|
-
|
|
21
|
-
### リンク切れの確認
|
|
22
|
-
|
|
23
|
-
- [ ] 内部リンクが正しいパスを指しているか
|
|
24
|
-
- [ ] 参照先のドキュメント・セクションが存在するか
|
|
25
|
-
|
|
26
|
-
## ドキュメント品質のレビュー観点
|
|
27
|
-
|
|
28
|
-
- [ ] **正確性**: 実装内容と一致しているか
|
|
29
|
-
- [ ] **完全性**: すべての変更が記載されているか
|
|
30
|
-
- [ ] **明確性**: 第三者が理解できる内容か
|
|
31
|
-
- [ ] **一貫性**: ドキュメント間で用語・形式が統一されているか
|
|
32
|
-
- [ ] **最新性**: 古い情報が削除されているか
|
|
33
|
-
|
|
34
|
-
## ベストプラクティス
|
|
35
|
-
|
|
36
|
-
- **実装直後に更新**: 記憶が新しいうちに記録する
|
|
37
|
-
- **差異を記録**: 計画と実装の差異は必ず記録し、次のタスクへのフィードバックとする
|
|
38
|
-
- **スクリーンショット活用**: UI 変更の場合、スクリーンショットを添付して視覚的に記録
|
|
39
|
-
- **リンクを活用**: ドキュメント間でリンクを張り、関連情報にすぐアクセスできるようにする
|
|
40
|
-
- **バージョン管理**: ドキュメントもコードと同様に Git で管理
|
|
41
|
-
- **段階的更新**: 大規模な更新は段階的に行い、一度に全てを更新しない
|
|
42
|
-
- **レビューを受ける**: 重要な更新はチームレビューで正確性を担保
|
|
43
|
-
- **テンプレート活用**: 繰り返し更新するドキュメントはテンプレート化
|
|
44
|
-
- **自動化**: 可能な部分は自動化(API ドキュメント生成、データモデル図生成など)
|
|
45
|
-
- **定期的な棚卸し**: ドキュメント全体を定期的にレビューし古い情報を削除
|
|
46
|
-
|
|
47
|
-
## ドキュメント構造の参考
|
|
48
|
-
|
|
49
|
-
### タスクレベル(`docs/tasks/task{id}-{スラッグ}/`)
|
|
50
|
-
|
|
51
|
-
- `a-definition.md`: タスク定義(目的、ユーザーストーリー、受け入れ基準)
|
|
52
|
-
- `b-research.md`: リサーチ(ベストプラクティス、技術選定)
|
|
53
|
-
- `c-implementation.md`: 実装タスクリスト(フェーズ、ステップ)
|
|
54
|
-
|
|
55
|
-
### プロジェクトレベル(`docs/`)
|
|
56
|
-
|
|
57
|
-
- `01-requirements/`: 要件定義
|
|
58
|
-
- `
|
|
59
|
-
- `
|
|
60
|
-
- `
|
|
61
|
-
- `
|
|
62
|
-
- `
|
|
63
|
-
|
|
64
|
-
- `
|
|
65
|
-
- `
|
|
66
|
-
|
|
67
|
-
- `
|
|
68
|
-
- `
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
-
|
|
88
|
-
- Update
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
-
|
|
93
|
-
-
|
|
94
|
-
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
1
|
+
# ドキュメント構造と整合性チェック
|
|
2
|
+
|
|
3
|
+
SKILL.md 手順5(整合性検証)とベストプラクティスで参照する詳細資料。
|
|
4
|
+
|
|
5
|
+
## ドキュメント整合性の検証項目
|
|
6
|
+
|
|
7
|
+
### クロスリファレンスの確認
|
|
8
|
+
|
|
9
|
+
- [ ] **要件 ↔ ドメインモデル**: 06-features-implemented.md の機能が domain-model.md に反映されているか
|
|
10
|
+
- [ ] **ドメインモデル ↔ データモデル**: domain-model.md のエンティティが data-model.md のテーブルに対応しているか
|
|
11
|
+
- [ ] **ドメインモデル ↔ API 仕様**: domain-model.md の振る舞いが api-spec.md のエンドポイントに対応しているか
|
|
12
|
+
- [ ] **API 仕様 ↔ 実装**: api-spec.md のエンドポイントが実際に実装されているか
|
|
13
|
+
- [ ] **データモデル ↔ 実装**: data-model.md のテーブル定義がマイグレーションファイルと一致しているか
|
|
14
|
+
|
|
15
|
+
### 用語の一貫性確認
|
|
16
|
+
|
|
17
|
+
- [ ] ドキュメント全体で同じ用語を使用しているか
|
|
18
|
+
- [ ] ubiquitous-language.md に記載された用語が各ドキュメントで使用されているか
|
|
19
|
+
- [ ] コード内のクラス名・変数名がドメイン用語と一致しているか
|
|
20
|
+
|
|
21
|
+
### リンク切れの確認
|
|
22
|
+
|
|
23
|
+
- [ ] 内部リンクが正しいパスを指しているか
|
|
24
|
+
- [ ] 参照先のドキュメント・セクションが存在するか
|
|
25
|
+
|
|
26
|
+
## ドキュメント品質のレビュー観点
|
|
27
|
+
|
|
28
|
+
- [ ] **正確性**: 実装内容と一致しているか
|
|
29
|
+
- [ ] **完全性**: すべての変更が記載されているか
|
|
30
|
+
- [ ] **明確性**: 第三者が理解できる内容か
|
|
31
|
+
- [ ] **一貫性**: ドキュメント間で用語・形式が統一されているか
|
|
32
|
+
- [ ] **最新性**: 古い情報が削除されているか
|
|
33
|
+
|
|
34
|
+
## ベストプラクティス
|
|
35
|
+
|
|
36
|
+
- **実装直後に更新**: 記憶が新しいうちに記録する
|
|
37
|
+
- **差異を記録**: 計画と実装の差異は必ず記録し、次のタスクへのフィードバックとする
|
|
38
|
+
- **スクリーンショット活用**: UI 変更の場合、スクリーンショットを添付して視覚的に記録
|
|
39
|
+
- **リンクを活用**: ドキュメント間でリンクを張り、関連情報にすぐアクセスできるようにする
|
|
40
|
+
- **バージョン管理**: ドキュメントもコードと同様に Git で管理
|
|
41
|
+
- **段階的更新**: 大規模な更新は段階的に行い、一度に全てを更新しない
|
|
42
|
+
- **レビューを受ける**: 重要な更新はチームレビューで正確性を担保
|
|
43
|
+
- **テンプレート活用**: 繰り返し更新するドキュメントはテンプレート化
|
|
44
|
+
- **自動化**: 可能な部分は自動化(API ドキュメント生成、データモデル図生成など)
|
|
45
|
+
- **定期的な棚卸し**: ドキュメント全体を定期的にレビューし古い情報を削除
|
|
46
|
+
|
|
47
|
+
## ドキュメント構造の参考
|
|
48
|
+
|
|
49
|
+
### タスクレベル(`docs/tasks/task{id}-{スラッグ}/`)
|
|
50
|
+
|
|
51
|
+
- `a-definition.md`: タスク定義(目的、ユーザーストーリー、受け入れ基準)
|
|
52
|
+
- `b-research.md`: リサーチ(ベストプラクティス、技術選定)
|
|
53
|
+
- `c-implementation.md`: 実装タスクリスト(フェーズ、ステップ)
|
|
54
|
+
|
|
55
|
+
### プロジェクトレベル(`docs/`)
|
|
56
|
+
|
|
57
|
+
- `01-requirements/`: 要件定義
|
|
58
|
+
- `01-product-brief.md`: Product Brief
|
|
59
|
+
- `02-mvp-scope.md`: MVP スコープ(Must / Not Now / Won't)
|
|
60
|
+
- `03-parking-lot.md`: アイデア backlog
|
|
61
|
+
- `05-user-stories.md`: ユーザーストーリー
|
|
62
|
+
- `06-features-implemented.md`: 実装済み機能(existing モード)
|
|
63
|
+
- `03-domain/`: ドメイン
|
|
64
|
+
- `01-domain-sketch.md`: ドメイン(Full DDD 採用時は `01-domain-model.md`)
|
|
65
|
+
- `02-ubiquitous-language.md`: ユビキタス言語
|
|
66
|
+
- `04-design/`: 設計
|
|
67
|
+
- `03-screen-design.md`: 画面設計
|
|
68
|
+
- `04-data-model.md`: データモデル
|
|
69
|
+
- `05-api-spec.md`: API 仕様
|
|
70
|
+
- `06-architecture.md`: アーキテクチャ
|
|
71
|
+
|
|
72
|
+
### その他
|
|
73
|
+
|
|
74
|
+
- `README.md`: プロジェクト概要、セットアップ手順
|
|
75
|
+
- `CHANGELOG.md`: 変更履歴
|
|
76
|
+
- `.env.example`: 環境変数テンプレート
|
|
77
|
+
|
|
78
|
+
## 自動化のヒント
|
|
79
|
+
|
|
80
|
+
将来的に、コミットログからの変更抽出やコードからの API 仕様生成などで、ドキュメント更新を一部自動化することを検討。
|
|
81
|
+
|
|
82
|
+
## コミットメッセージのテンプレート
|
|
83
|
+
|
|
84
|
+
```
|
|
85
|
+
docs(task-{task-id}): update documentation for {機能名}
|
|
86
|
+
|
|
87
|
+
Task-level documentation:
|
|
88
|
+
- Update a-definition.md with implementation results
|
|
89
|
+
- Update b-research.md with discovered best practices
|
|
90
|
+
- Update c-implementation.md with implementation notes and retrospective
|
|
91
|
+
|
|
92
|
+
Project-level documentation:
|
|
93
|
+
- Add {機能名} to 06-features-implemented.md
|
|
94
|
+
- Update domain-model.md / data-model.md / api-spec.md
|
|
95
|
+
- Update README.md with setup instructions
|
|
96
|
+
- Add changelog entry
|
|
97
|
+
|
|
98
|
+
Related: task{task-id}-{スラッグ}
|
|
99
|
+
```
|