create-ai-project 1.20.2 → 1.20.3
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/.claude/agents-en/acceptance-test-generator.md +3 -2
- package/.claude/agents-en/code-reviewer.md +133 -25
- package/.claude/agents-en/design-sync.md +5 -6
- package/.claude/agents-en/integration-test-reviewer.md +2 -2
- package/.claude/agents-en/prd-creator.md +2 -4
- package/.claude/agents-en/quality-fixer-frontend.md +1 -1
- package/.claude/agents-en/quality-fixer.md +1 -1
- package/.claude/agents-en/requirement-analyzer.md +7 -7
- package/.claude/agents-en/scope-discoverer.md +2 -2
- package/.claude/agents-en/solver.md +1 -2
- package/.claude/agents-en/task-decomposer.md +2 -2
- package/.claude/agents-en/task-executor-frontend.md +1 -1
- package/.claude/agents-en/task-executor.md +1 -1
- package/.claude/agents-en/technical-designer-frontend.md +5 -5
- package/.claude/agents-en/technical-designer.md +2 -2
- package/.claude/agents-en/ui-spec-designer.md +1 -1
- package/.claude/agents-en/work-planner.md +1 -1
- package/.claude/agents-ja/acceptance-test-generator.md +3 -2
- package/.claude/agents-ja/code-reviewer.md +133 -25
- package/.claude/agents-ja/design-sync.md +5 -5
- package/.claude/agents-ja/integration-test-reviewer.md +2 -2
- package/.claude/agents-ja/prd-creator.md +2 -4
- package/.claude/agents-ja/quality-fixer-frontend.md +1 -1
- package/.claude/agents-ja/quality-fixer.md +1 -1
- package/.claude/agents-ja/requirement-analyzer.md +7 -7
- package/.claude/agents-ja/scope-discoverer.md +2 -2
- package/.claude/agents-ja/solver.md +1 -2
- package/.claude/agents-ja/task-decomposer.md +2 -2
- package/.claude/agents-ja/task-executor-frontend.md +1 -1
- package/.claude/agents-ja/task-executor.md +1 -1
- package/.claude/agents-ja/technical-designer-frontend.md +5 -5
- package/.claude/agents-ja/technical-designer.md +2 -2
- package/.claude/agents-ja/ui-spec-designer.md +1 -1
- package/.claude/agents-ja/work-planner.md +1 -1
- package/.claude/commands-en/build.md +17 -8
- package/.claude/commands-en/front-build.md +25 -41
- package/.claude/commands-en/front-design.md +49 -17
- package/.claude/commands-en/front-plan.md +17 -10
- package/.claude/commands-en/front-review.md +37 -33
- package/.claude/commands-en/review.md +10 -5
- package/.claude/commands-ja/build.md +17 -8
- package/.claude/commands-ja/front-build.md +25 -41
- package/.claude/commands-ja/front-design.md +48 -18
- package/.claude/commands-ja/front-plan.md +22 -15
- package/.claude/commands-ja/front-review.md +37 -33
- package/.claude/commands-ja/review.md +10 -5
- package/.claude/skills-en/coding-standards/references/security-checks.md +4 -2
- package/.claude/skills-en/documentation-criteria/SKILL.md +8 -28
- package/.claude/skills-en/documentation-criteria/references/adr-template.md +5 -1
- package/.claude/skills-en/documentation-criteria/references/design-template.md +7 -8
- package/.claude/skills-en/documentation-criteria/references/plan-template.md +11 -6
- package/.claude/skills-en/documentation-criteria/references/prd-template.md +32 -10
- package/.claude/skills-en/documentation-criteria/references/task-template.md +2 -2
- package/.claude/skills-en/subagents-orchestration-guide/SKILL.md +20 -37
- package/.claude/skills-en/task-analyzer/references/skills-index.yaml +0 -2
- package/.claude/skills-ja/coding-standards/references/security-checks.md +4 -2
- package/.claude/skills-ja/documentation-criteria/SKILL.md +8 -29
- package/.claude/skills-ja/documentation-criteria/references/adr-template.md +5 -1
- package/.claude/skills-ja/documentation-criteria/references/design-template.md +7 -2
- package/.claude/skills-ja/documentation-criteria/references/plan-template.md +11 -6
- package/.claude/skills-ja/documentation-criteria/references/prd-template.md +32 -10
- package/.claude/skills-ja/documentation-criteria/references/task-template.md +2 -2
- package/.claude/skills-ja/subagents-orchestration-guide/SKILL.md +20 -35
- package/.claude/skills-ja/task-analyzer/references/skills-index.yaml +0 -2
- package/CHANGELOG.md +40 -0
- package/README.ja.md +51 -30
- package/README.md +58 -34
- package/docs/guides/en/skills-editing-guide.md +10 -0
- package/docs/guides/ja/skills-editing-guide.md +12 -2
- package/package.json +1 -1
|
@@ -6,13 +6,16 @@ description: 設計ドキュメントからフロントエンド作業計画書
|
|
|
6
6
|
|
|
7
7
|
## オーケストレーター定義
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
**コアアイデンティティ**: 「私はオーケストレーターである。」(subagents-orchestration-guideスキル参照)
|
|
10
10
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
11
|
+
**実行プロトコル**:
|
|
12
|
+
1. **全ての作業をサブエージェントに委譲** — サブエージェントを呼び出し、データを橋渡しし、結果を報告する
|
|
13
|
+
2. **subagents-orchestration-guideスキルの計画フローに従う**:
|
|
14
|
+
- 以下に定義されたステップを実行
|
|
15
|
+
- **完了前に停止し、計画内容の承認を取得する**
|
|
16
|
+
3. **スコープ**: 下記スコープ境界を参照
|
|
14
17
|
|
|
15
|
-
|
|
18
|
+
**重要**: work-plannerの前に必ずacceptance-test-generatorを実行すること — テストスケルトンはsubagents-orchestration-guideの中規模/大規模フローで必須の入力。
|
|
16
19
|
|
|
17
20
|
## スコープ境界
|
|
18
21
|
|
|
@@ -24,29 +27,33 @@ description: 設計ドキュメントからフロントエンド作業計画書
|
|
|
24
27
|
|
|
25
28
|
**責務境界**: このコマンドは作業計画書承認で責務完了。
|
|
26
29
|
|
|
27
|
-
|
|
30
|
+
以下の計画プロセスに従う:
|
|
28
31
|
|
|
29
32
|
## 実行プロセス
|
|
30
33
|
|
|
31
|
-
### 1
|
|
32
|
-
! ls -la docs/design/*.md | head -10
|
|
33
|
-
- 設計ドキュメントの存在を確認、なければユーザーに通知
|
|
34
|
-
- 複数ある場合は選択肢を提示($ARGUMENTSで指定可能)
|
|
34
|
+
### Step 1: 設計ドキュメント選択
|
|
35
|
+
! ls -la docs/design/*.md | head -10
|
|
36
|
+
- 設計ドキュメントの存在を確認、なければユーザーに通知
|
|
37
|
+
- 複数ある場合は選択肢を提示($ARGUMENTSで指定可能)
|
|
35
38
|
|
|
36
|
-
### 2
|
|
37
|
-
Agent
|
|
39
|
+
### Step 2: テストスケルトン生成
|
|
40
|
+
Agentツールでacceptance-test-generatorを呼び出す:
|
|
38
41
|
- `subagent_type`: "acceptance-test-generator"
|
|
39
42
|
- `description`: "テストスケルトン生成"
|
|
40
43
|
- UI Specあり: `prompt: "[パス]のDesign Docからテストスケルトンを生成。UI Specは[ui-specパス]。"`
|
|
41
44
|
- UI Specなし: `prompt: "[パス]のDesign Docからテストスケルトンを生成。"`
|
|
42
45
|
|
|
43
|
-
|
|
44
|
-
|
|
46
|
+
統合テストファイルパスとE2Eテストファイルパスを、subagents-orchestration-guideの「acceptance-test-generator → work-planner」セクションに従いwork-plannerに渡す。
|
|
47
|
+
|
|
48
|
+
### Step 3: 作業計画書作成
|
|
49
|
+
Agentツールでwork-plannerを呼び出す:
|
|
45
50
|
- `subagent_type`: "work-planner"
|
|
46
51
|
- `description`: "作業計画書作成"
|
|
47
52
|
- `prompt`: "[パス]のDesign Docから作業計画を作成。統合テストファイル: [ステップ2の統合テストパス]。E2Eテストファイル: [ステップ2のE2Eテストパス]。統合テストは各フェーズ実装と同時に作成、E2Eテストは最終フェーズでのみ実行。"
|
|
48
53
|
|
|
49
|
-
|
|
54
|
+
- subagents-orchestration-guideのPrompt Construction Ruleに従い追加パラメータを構成
|
|
55
|
+
- 作業計画書をユーザーに提示しレビューを受ける。変更要望があればwork-plannerを修正パラメータで再実行
|
|
56
|
+
- スコープが不明確なステップや外部依存があるステップを強調し、ユーザーに確認を求める
|
|
50
57
|
|
|
51
58
|
**スコープ**: 作業計画書作成と計画内容の承認取得まで。
|
|
52
59
|
|
|
@@ -4,24 +4,25 @@ description: Design Doc準拠検証とセキュリティ検証、必要に応じ
|
|
|
4
4
|
|
|
5
5
|
**コマンドコンテキスト**: React/TypeScriptフロントエンド向け実装後品質保証コマンド
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## オーケストレーター定義
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
- セキュリティ検証 -> security-reviewerが実行
|
|
11
|
-
- ルール分析 -> rule-advisorが実行
|
|
12
|
-
- 修正実装 -> task-executor-frontendが実行
|
|
13
|
-
- 品質チェック -> quality-fixer-frontendが実行
|
|
14
|
-
- 再検証 -> code-reviewer / security-reviewerが実行
|
|
9
|
+
**コアアイデンティティ**: 「私はオーケストレーターである。」(subagents-orchestration-guideスキル参照)
|
|
15
10
|
|
|
16
|
-
|
|
11
|
+
**初回アクション**: 実行前にTaskCreateでStep 1-11を登録する。
|
|
17
12
|
|
|
18
|
-
|
|
13
|
+
## 実行方法
|
|
14
|
+
|
|
15
|
+
- 準拠検証 → code-reviewerが実行
|
|
16
|
+
- セキュリティ検証 → security-reviewerが実行
|
|
17
|
+
- 修正実装 → task-executor-frontendが実行
|
|
18
|
+
- 品質チェック → quality-fixer-frontendが実行
|
|
19
|
+
- 再検証 → code-reviewer / security-reviewerが実行
|
|
19
20
|
|
|
20
|
-
|
|
21
|
+
Design Doc(省略時は直近のもの): $ARGUMENTS
|
|
21
22
|
|
|
22
23
|
## 実行フロー
|
|
23
24
|
|
|
24
|
-
### 1
|
|
25
|
+
### Step 1: 前提条件チェック
|
|
25
26
|
```bash
|
|
26
27
|
# Design Docを特定
|
|
27
28
|
ls docs/design/*.md | grep -v template | tail -1
|
|
@@ -30,15 +31,15 @@ ls docs/design/*.md | grep -v template | tail -1
|
|
|
30
31
|
git diff --name-only main...HEAD
|
|
31
32
|
```
|
|
32
33
|
|
|
33
|
-
### 2
|
|
34
|
+
### Step 2: code-reviewer実行
|
|
34
35
|
Agent toolでcode-reviewerを呼び出す:
|
|
35
36
|
- `subagent_type`: "code-reviewer"
|
|
36
37
|
- `description`: "コード準拠レビュー"
|
|
37
|
-
- `prompt`: "Design Doc: [path]. Implementation files: [git diff file list]. Review mode: full. Design Doc
|
|
38
|
+
- `prompt`: "Design Doc: [path]. Implementation files: [git diff file list]. Review mode: full. Design Doc準拠を検証し、構造化JSONレポートを返却。"
|
|
38
39
|
|
|
39
40
|
**出力を保存**: `$STEP_2_OUTPUT`
|
|
40
41
|
|
|
41
|
-
### 3
|
|
42
|
+
### Step 3: security-reviewer実行
|
|
42
43
|
Agent toolでsecurity-reviewerを呼び出す:
|
|
43
44
|
- `subagent_type`: "security-reviewer"
|
|
44
45
|
- `description`: "セキュリティレビュー"
|
|
@@ -46,7 +47,7 @@ Agent toolでsecurity-reviewerを呼び出す:
|
|
|
46
47
|
|
|
47
48
|
**出力を保存**: `$STEP_3_OUTPUT`
|
|
48
49
|
|
|
49
|
-
### 4
|
|
50
|
+
### Step 4: 判定と対応
|
|
50
51
|
|
|
51
52
|
**security-reviewerが`blocked`を返した場合**: 即座に停止。blockedの検出結果を報告しユーザーにエスカレーション。修正ステップには進まない。
|
|
52
53
|
|
|
@@ -63,10 +64,15 @@ Agent toolでsecurity-reviewerを呼び出す:
|
|
|
63
64
|
```
|
|
64
65
|
Code Compliance: [code-reviewerのcomplianceRate]
|
|
65
66
|
Verdict: [code-reviewerのverdict]
|
|
67
|
+
Identifier Match Rate: [code-reviewerのidentifierMatchRate]
|
|
66
68
|
Acceptance Criteria:
|
|
67
|
-
- [fulfilled] [item]
|
|
69
|
+
- [fulfilled] [item] (confidence: [high/medium/low])
|
|
68
70
|
- [partially_fulfilled] [item]: [gap] — [suggestion]
|
|
69
71
|
- [unfulfilled] [item]: [gap] — [suggestion]
|
|
72
|
+
Identifier Mismatches:
|
|
73
|
+
- [identifier]: DD=[designDocValue] Code=[codeValue] at [location]
|
|
74
|
+
Quality Findings:
|
|
75
|
+
- [category] [location]: [description] — [rationale]
|
|
70
76
|
|
|
71
77
|
Security Review: [security-reviewerのstatus]
|
|
72
78
|
Findings by category:
|
|
@@ -79,46 +85,44 @@ Security Review: [security-reviewerのstatus]
|
|
|
79
85
|
修正を実行しますか? (y/n):
|
|
80
86
|
```
|
|
81
87
|
|
|
82
|
-
両方合格でユーザーが`n`を選択:
|
|
88
|
+
両方合格でユーザーが`n`を選択: Steps 5-10をスキップし、Step 11へ。
|
|
83
89
|
|
|
84
|
-
|
|
90
|
+
### Step 5: タスクテンプレートの読み込み
|
|
85
91
|
|
|
86
|
-
|
|
92
|
+
documentation-criteriaスキルを読み込み、Step 6用のタスクファイルテンプレート(references/task-template.md)を取得。
|
|
87
93
|
|
|
88
|
-
###
|
|
89
|
-
Agent toolでrule-advisorを呼び出す:
|
|
90
|
-
- `subagent_type`: "rule-advisor"
|
|
91
|
-
- `description`: "修正アプローチの分析"
|
|
92
|
-
- `prompt`: "Task: レビュー検出結果の修正。Code issues: $STEP_2_OUTPUT. Security findings: $STEP_3_OUTPUT. 修正の本質を分析し適切なルールを選択。"
|
|
94
|
+
### Step 6: タスクファイル作成
|
|
93
95
|
|
|
94
|
-
|
|
95
|
-
|
|
96
|
+
`docs/plans/tasks/review-fixes-YYYYMMDD.md` にタスクファイルを作成。
|
|
97
|
+
コード準拠の問題とセキュリティのrequiredFixesの両方を含める。
|
|
96
98
|
|
|
97
|
-
### 7
|
|
99
|
+
### Step 7: 修正実行
|
|
98
100
|
Agent toolでtask-executor-frontendを呼び出す:
|
|
99
101
|
- `subagent_type`: "task-executor-frontend"
|
|
100
102
|
- `description`: "レビュー修正の実行"
|
|
101
103
|
- `prompt`: "Task file: docs/plans/tasks/review-fixes-YYYYMMDD.md. 段階的修正を適用(5ファイルで停止)。"
|
|
102
104
|
|
|
103
|
-
### 8
|
|
105
|
+
### Step 8: 品質チェック
|
|
104
106
|
Agent toolでquality-fixer-frontendを呼び出す:
|
|
105
107
|
- `subagent_type`: "quality-fixer-frontend"
|
|
106
108
|
- `description`: "品質ゲートチェック"
|
|
107
109
|
- `prompt`: "修正ファイルの品質ゲート通過を確認。"
|
|
108
110
|
|
|
109
|
-
### 9
|
|
111
|
+
### Step 9: code-reviewer再検証
|
|
112
|
+
|
|
110
113
|
Agent toolでcode-reviewerを呼び出す:
|
|
111
114
|
- `subagent_type`: "code-reviewer"
|
|
112
115
|
- `description`: "準拠の再検証"
|
|
113
|
-
- `prompt`: "修正後のDesign Doc
|
|
116
|
+
- `prompt`: "修正後のDesign Doc準拠を再検証。Design Doc: [path]. Implementation files: [file list]. 前回の準拠問題: $STEP_2_OUTPUT。各問題が解決されたことを確認。"
|
|
114
117
|
|
|
115
|
-
### 10
|
|
116
|
-
|
|
118
|
+
### Step 10: security-reviewer再検証
|
|
119
|
+
|
|
120
|
+
Agent toolでsecurity-reviewerを呼び出す(セキュリティ修正が実行された場合のみ):
|
|
117
121
|
- `subagent_type`: "security-reviewer"
|
|
118
122
|
- `description`: "セキュリティの再検証"
|
|
119
123
|
- `prompt`: "修正後のセキュリティを再検証。前回の検出結果: $STEP_3_OUTPUT。Design Doc: [path]. Implementation files: [file list]。"
|
|
120
124
|
|
|
121
|
-
### 最終レポート
|
|
125
|
+
### Step 11: 最終レポート
|
|
122
126
|
```
|
|
123
127
|
Code Compliance:
|
|
124
128
|
初回: [X]%
|
|
@@ -33,7 +33,7 @@ git diff --name-only main...HEAD
|
|
|
33
33
|
Agent toolでcode-reviewerを呼び出す:
|
|
34
34
|
- `subagent_type`: "code-reviewer"
|
|
35
35
|
- `description`: "コード準拠レビュー"
|
|
36
|
-
- `prompt`: "Design Doc: [path]. Implementation files: [git diff file list]. Review mode: full. Design Doc
|
|
36
|
+
- `prompt`: "Design Doc: [path]. Implementation files: [git diff file list]. Review mode: full. Design Doc準拠を検証し、構造化JSONレポートを返却。"
|
|
37
37
|
|
|
38
38
|
**出力を保存**: `$STEP_2_OUTPUT`
|
|
39
39
|
|
|
@@ -62,10 +62,15 @@ Agent toolでsecurity-reviewerを呼び出す:
|
|
|
62
62
|
```
|
|
63
63
|
Code Compliance: [code-reviewerのcomplianceRate]
|
|
64
64
|
Verdict: [code-reviewerのverdict]
|
|
65
|
+
Identifier Match Rate: [code-reviewerのidentifierMatchRate]
|
|
65
66
|
Acceptance Criteria:
|
|
66
|
-
- [fulfilled] [item]
|
|
67
|
+
- [fulfilled] [item] (confidence: [high/medium/low])
|
|
67
68
|
- [partially_fulfilled] [item]: [gap] — [suggestion]
|
|
68
69
|
- [unfulfilled] [item]: [gap] — [suggestion]
|
|
70
|
+
Identifier Mismatches:
|
|
71
|
+
- [identifier]: DD=[designDocValue] Code=[codeValue] at [location]
|
|
72
|
+
Quality Findings:
|
|
73
|
+
- [category] [location]: [description] — [rationale]
|
|
69
74
|
|
|
70
75
|
Security Review: [security-reviewerのstatus]
|
|
71
76
|
Findings by category:
|
|
@@ -80,9 +85,9 @@ Security Review: [security-reviewerのstatus]
|
|
|
80
85
|
|
|
81
86
|
両方合格でユーザーが`n`を選択: Steps 5-10をスキップし、Step 11へ。
|
|
82
87
|
|
|
83
|
-
### 5.
|
|
88
|
+
### 5. タスクテンプレートの読み込み
|
|
84
89
|
|
|
85
|
-
|
|
90
|
+
documentation-criteriaスキルを読み込み、Step 6用のタスクファイルテンプレート(references/task-template.md)を取得。
|
|
86
91
|
|
|
87
92
|
### 6. タスクファイル作成
|
|
88
93
|
|
|
@@ -108,7 +113,7 @@ Agent toolでquality-fixerを呼び出す:
|
|
|
108
113
|
Agent toolでcode-reviewerを呼び出す:
|
|
109
114
|
- `subagent_type`: "code-reviewer"
|
|
110
115
|
- `description`: "準拠の再検証"
|
|
111
|
-
- `prompt`: "修正後のDesign Doc
|
|
116
|
+
- `prompt`: "修正後のDesign Doc準拠を再検証。Design Doc: [path]. Implementation files: [file list]. 前回の準拠問題: $STEP_2_OUTPUT。各問題が解決されたことを確認。"
|
|
112
117
|
|
|
113
118
|
### 10. security-reviewer再検証
|
|
114
119
|
|
|
@@ -49,12 +49,14 @@ Sources: OWASP Top 10:2025, DryRun Agentic Coding Security Report (2026-03)
|
|
|
49
49
|
- Endpoints or route handlers defined without authentication middleware
|
|
50
50
|
- Resource access operations (read, update, delete) without authorization verification
|
|
51
51
|
- Administrative or destructive operations accessible without elevated permissions
|
|
52
|
-
-
|
|
52
|
+
- AI-generated code frequently omits authentication middleware and authorization checks — flag every route handler and resource access operation for explicit verification during review
|
|
53
|
+
- Detection approach: search for route/endpoint handler definitions that lack authentication middleware, and resource operations (read, update, delete) without authorization checks in the call chain
|
|
53
54
|
|
|
54
55
|
### Mishandling of Exceptional Conditions (OWASP A10:2025)
|
|
55
56
|
- Error handlers that expose internal system details (stack traces, database errors, file paths) in responses
|
|
56
|
-
- Error handlers that
|
|
57
|
+
- Error handlers that grant access, skip authentication, or bypass authorization when an exception occurs (fail-open behavior)
|
|
57
58
|
- Missing error handling on security-critical operations (authentication, authorization, cryptographic operations)
|
|
59
|
+
- Detection approach: search for catch/error handler blocks that return stack traces, database error messages, or file paths in responses; search for catch blocks that call next() or return success without re-validating security state
|
|
58
60
|
|
|
59
61
|
### Software Supply Chain Patterns (OWASP A03:2025)
|
|
60
62
|
- Dependencies imported without version pinning
|
|
@@ -50,18 +50,14 @@ description: Guides PRD, ADR, Design Doc, and Work Plan creation. Use when creat
|
|
|
50
50
|
|
|
51
51
|
**Includes**:
|
|
52
52
|
- Business requirements and user value
|
|
53
|
-
- Success metrics and KPIs (
|
|
53
|
+
- Success metrics and KPIs (each metric specifies a numeric target, measurement method, and timeframe)
|
|
54
54
|
- User stories and use cases
|
|
55
55
|
- MoSCoW prioritization (Must/Should/Could/Won't)
|
|
56
56
|
- MVP and Future phase separation
|
|
57
57
|
- User journey diagram (required)
|
|
58
58
|
- Scope boundary diagram (required)
|
|
59
59
|
|
|
60
|
-
**
|
|
61
|
-
- Technical implementation details (->Design Doc)
|
|
62
|
-
- Technical selection rationale (->ADR)
|
|
63
|
-
- **Implementation phases** (->Work Plan)
|
|
64
|
-
- **Task breakdown** (->Work Plan)
|
|
60
|
+
**Scope**: Business requirements, user value, success metrics, user stories, and prioritization only. Implementation details belong in Design Doc, technical selection rationale in ADR, phases and task breakdown in Work Plan.
|
|
65
61
|
|
|
66
62
|
### ADR (Architecture Decision Record)
|
|
67
63
|
|
|
@@ -74,11 +70,7 @@ description: Guides PRD, ADR, Design Doc, and Work Plan creation. Use when creat
|
|
|
74
70
|
- Architecture impact
|
|
75
71
|
- Principled implementation guidelines (e.g., "Use dependency injection")
|
|
76
72
|
|
|
77
|
-
**
|
|
78
|
-
- Implementation schedule, duration (->Work Plan)
|
|
79
|
-
- Detailed implementation procedures (->Design Doc)
|
|
80
|
-
- Specific code examples (->Design Doc)
|
|
81
|
-
- Resource assignments (->Work Plan)
|
|
73
|
+
**Scope**: Decision, rationale, option comparison, architecture impact, and principled guidelines only. Implementation procedures and code examples belong in Design Doc, schedule and resource assignments in Work Plan.
|
|
82
74
|
|
|
83
75
|
### UI Specification
|
|
84
76
|
|
|
@@ -94,11 +86,7 @@ description: Guides PRD, ADR, Design Doc, and Work Plan creation. Use when creat
|
|
|
94
86
|
- Visual acceptance criteria (golden states, layout constraints)
|
|
95
87
|
- Accessibility requirements (keyboard, screen reader, contrast)
|
|
96
88
|
|
|
97
|
-
**
|
|
98
|
-
- Technical implementation details (-> Design Doc)
|
|
99
|
-
- API contracts and data layer design (-> Design Doc)
|
|
100
|
-
- Test implementation (-> acceptance-test-generator skeletons)
|
|
101
|
-
- Implementation schedule (-> Work Plan)
|
|
89
|
+
**Scope**: Screen structure, transitions, component decomposition, interaction design, and visual acceptance criteria only. Technical implementation and API contracts belong in Design Doc, test implementation in acceptance-test-generator skeletons, schedule in Work Plan.
|
|
102
90
|
|
|
103
91
|
**Required Structural Elements**:
|
|
104
92
|
- At least one component with state x display matrix and interaction table
|
|
@@ -123,7 +111,7 @@ description: Guides PRD, ADR, Design Doc, and Work Plan creation. Use when creat
|
|
|
123
111
|
- **Technical dependencies and implementation constraints** (required implementation order)
|
|
124
112
|
- Interface and type definitions
|
|
125
113
|
- Data flow and component design
|
|
126
|
-
- **Acceptance criteria (EARS format
|
|
114
|
+
- **Acceptance criteria (EARS format — see design-template.md; each criterion specifies a verifiable condition with pass/fail threshold)**
|
|
127
115
|
- Change impact map (clearly specify direct impact/indirect impact/no ripple effect)
|
|
128
116
|
- Complete enumeration of integration points
|
|
129
117
|
- Data contract clarification
|
|
@@ -137,10 +125,7 @@ description: Guides PRD, ADR, Design Doc, and Work Plan creation. Use when creat
|
|
|
137
125
|
- Correctness proof method (what "correct" means for this change, how it's verified, when)
|
|
138
126
|
- Early verification point (first target to prove the approach works, success criteria, failure response)
|
|
139
127
|
|
|
140
|
-
**
|
|
141
|
-
- Why that technology was chosen (->Reference ADR)
|
|
142
|
-
- When to implement, duration (->Work Plan)
|
|
143
|
-
- Who will implement (->Work Plan)
|
|
128
|
+
**Scope**: Technical implementation methods, interfaces, data flow, acceptance criteria, and verification strategy only. Technology selection rationale belongs in ADR, schedule and assignments in Work Plan.
|
|
144
129
|
|
|
145
130
|
### Work Plan
|
|
146
131
|
|
|
@@ -154,28 +139,23 @@ description: Guides PRD, ADR, Design Doc, and Work Plan creation. Use when creat
|
|
|
154
139
|
- **Final Quality Assurance Phase (required)**
|
|
155
140
|
- Progress records (checkbox format)
|
|
156
141
|
|
|
157
|
-
**
|
|
158
|
-
- Technical rationale (->ADR)
|
|
159
|
-
- Design details (->Design Doc)
|
|
142
|
+
**Scope**: Task breakdown, dependencies, schedule, verification strategy summary, and progress tracking only. Technical rationale belongs in ADR, design details in Design Doc.
|
|
160
143
|
|
|
161
144
|
**Phase Division Criteria** (adapt to implementation approach from Design Doc):
|
|
162
145
|
|
|
163
146
|
**When Vertical Slice selected**:
|
|
164
147
|
- Each phase = one value unit (feature, component, or migration target)
|
|
165
148
|
- Each phase includes its own implementation + verification per Verification Strategy
|
|
166
|
-
- Final Phase: Quality Assurance (cross-cutting verification, all tests passing)
|
|
167
149
|
|
|
168
150
|
**When Horizontal Slice selected**:
|
|
169
151
|
1. **Phase 1: Foundation Implementation** - Type definitions, interfaces, test preparation
|
|
170
152
|
2. **Phase 2: Core Feature Implementation** - Business logic, unit tests
|
|
171
153
|
3. **Phase 3: Integration Implementation** - External connections, presentation layer
|
|
172
|
-
4. **Final Phase: Quality Assurance (Required)** - Acceptance criteria achievement, all tests passing, quality checks
|
|
173
154
|
|
|
174
155
|
**When Hybrid selected**:
|
|
175
156
|
- Combine vertical and horizontal as defined in Design Doc implementation approach
|
|
176
|
-
- Final Phase: Quality Assurance (Required)
|
|
177
157
|
|
|
178
|
-
**All approaches**: Final phase is always Quality Assurance. Each phase's verification method follows Verification Strategy from Design Doc.
|
|
158
|
+
**All approaches**: Final phase is always Quality Assurance (acceptance criteria achievement, all tests passing, quality checks). Each phase's verification method follows Verification Strategy from Design Doc.
|
|
179
159
|
|
|
180
160
|
**Three Elements of Task Completion Definition**:
|
|
181
161
|
1. **Implementation Complete**: Code is functional
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
## Status
|
|
4
4
|
|
|
5
|
-
[Proposed | Accepted | Deprecated | Superseded]
|
|
5
|
+
[Proposed | Accepted | Deprecated | Superseded | Rejected]
|
|
6
6
|
|
|
7
7
|
## Context
|
|
8
8
|
|
|
@@ -54,6 +54,10 @@
|
|
|
54
54
|
|
|
55
55
|
- [List changes that are neither good nor bad]
|
|
56
56
|
|
|
57
|
+
## Architecture Impact
|
|
58
|
+
|
|
59
|
+
[Describe how this decision affects existing architecture: (1) components that change, (2) new dependencies introduced, (3) architectural constraints added or removed]
|
|
60
|
+
|
|
57
61
|
## Implementation Guidance
|
|
58
62
|
|
|
59
63
|
[Principled direction only. Implementation procedures go to Design Doc]
|
|
@@ -222,11 +222,16 @@ Invariants:
|
|
|
222
222
|
|
|
223
223
|
### Error Handling
|
|
224
224
|
|
|
225
|
-
|
|
225
|
+
| Error Category | Example | Detection | Recovery Strategy | User Impact |
|
|
226
|
+
|---------------|---------|-----------|-------------------|-------------|
|
|
227
|
+
| [Validation / External / Infrastructure / Business logic] | [Specific error] | [How detected] | [Retry / Fallback / Propagate / Log-and-continue] | [User-facing message or silent handling] |
|
|
226
228
|
|
|
227
229
|
### Logging and Monitoring
|
|
228
230
|
|
|
229
|
-
[
|
|
231
|
+
- **Log events**: [Key events to log: state transitions, external calls, error occurrences, performance thresholds]
|
|
232
|
+
- **Log levels**: [Which events at DEBUG/INFO/WARN/ERROR]
|
|
233
|
+
- **Sensitive data**: [Fields to mask or exclude — coordinate with Security Considerations]
|
|
234
|
+
- **Monitoring**: [Metrics to track, alert thresholds, dashboard requirements]
|
|
230
235
|
|
|
231
236
|
## Implementation Plan
|
|
232
237
|
|
|
@@ -246,12 +251,6 @@ Invariants:
|
|
|
246
251
|
- Technical Reason: [Technical necessity to implement after A]
|
|
247
252
|
- Prerequisites: [Required pre-implementations]
|
|
248
253
|
|
|
249
|
-
### Integration Points
|
|
250
|
-
|
|
251
|
-
**Integration Point 1: [Name]**
|
|
252
|
-
- Components: [Component A] -> [Component B]
|
|
253
|
-
- Contract: [Interface/API contract between components]
|
|
254
|
-
|
|
255
254
|
### Migration Strategy
|
|
256
255
|
|
|
257
256
|
[Technical migration approach, ensuring backward compatibility]
|
|
@@ -47,7 +47,8 @@ Related Issue/PR: #XXX (if any)
|
|
|
47
47
|
|
|
48
48
|
Select ONE phase structure based on implementation approach from Design Doc.
|
|
49
49
|
See documentation-criteria skill for detailed Phase Division Criteria.
|
|
50
|
-
|
|
50
|
+
All quality checks follow Quality Check Workflow from coding-standards skill.
|
|
51
|
+
**Delete the unused Option entirely from the final plan.** For hybrid approach, use Option C.
|
|
51
52
|
|
|
52
53
|
### Option A: Vertical Slice Phase Structure
|
|
53
54
|
|
|
@@ -60,7 +61,7 @@ Use when implementation approach is Vertical Slice. Each phase = one value unit
|
|
|
60
61
|
##### Tasks
|
|
61
62
|
- [ ] Task 1: Implementation
|
|
62
63
|
- [ ] Task 2: Verification per Verification Strategy
|
|
63
|
-
- [ ] Quality check
|
|
64
|
+
- [ ] Quality check (staged)
|
|
64
65
|
|
|
65
66
|
##### Phase Completion Criteria
|
|
66
67
|
- [ ] Early verification point passed
|
|
@@ -89,7 +90,7 @@ Use when implementation approach is Horizontal Slice. Phases follow Foundation
|
|
|
89
90
|
##### Tasks
|
|
90
91
|
- [ ] Task 1: Specific work content
|
|
91
92
|
- [ ] Task 2: Specific work content
|
|
92
|
-
- [ ] Quality check
|
|
93
|
+
- [ ] Quality check (staged)
|
|
93
94
|
- [ ] Unit tests: All related tests pass
|
|
94
95
|
|
|
95
96
|
##### Phase Completion Criteria
|
|
@@ -102,7 +103,7 @@ Use when implementation approach is Horizontal Slice. Phases follow Foundation
|
|
|
102
103
|
##### Tasks
|
|
103
104
|
- [ ] Task 1: Specific work content
|
|
104
105
|
- [ ] Task 2: Specific work content
|
|
105
|
-
- [ ] Quality check
|
|
106
|
+
- [ ] Quality check (staged)
|
|
106
107
|
- [ ] Integration tests: Verify overall feature functionality
|
|
107
108
|
|
|
108
109
|
##### Phase Completion Criteria
|
|
@@ -115,13 +116,17 @@ Use when implementation approach is Horizontal Slice. Phases follow Foundation
|
|
|
115
116
|
##### Tasks
|
|
116
117
|
- [ ] Task 1: Specific work content
|
|
117
118
|
- [ ] Task 2: Specific work content
|
|
118
|
-
- [ ] Quality check
|
|
119
|
+
- [ ] Quality check (staged)
|
|
119
120
|
- [ ] Integration tests: Verify component coordination
|
|
120
121
|
|
|
121
122
|
##### Phase Completion Criteria
|
|
122
123
|
- [ ] [Functional completion criteria]
|
|
123
124
|
- [ ] [Quality completion criteria]
|
|
124
125
|
|
|
126
|
+
### Option C: Hybrid Phase Structure
|
|
127
|
+
|
|
128
|
+
Use when implementation approach is Hybrid. Combine vertical and horizontal phases as defined in Design Doc implementation approach. Structure phases per Design Doc specification, ensuring each phase has Tasks, Verification, and Phase Completion Criteria sections matching the format above.
|
|
129
|
+
|
|
125
130
|
### Final Phase: Quality Assurance (Required) (Estimated commits: 1)
|
|
126
131
|
|
|
127
132
|
This phase is required for ALL implementation approaches.
|
|
@@ -137,7 +142,7 @@ This phase is required for ALL implementation approaches.
|
|
|
137
142
|
- [ ] Document updates
|
|
138
143
|
|
|
139
144
|
### Quality Assurance
|
|
140
|
-
- [ ]
|
|
145
|
+
- [ ] Quality check (staged)
|
|
141
146
|
|
|
142
147
|
## Risks and Countermeasures
|
|
143
148
|
| Risk | Countermeasure |
|
|
@@ -25,23 +25,45 @@ So that [expected value/benefit]
|
|
|
25
25
|
2. [Specific usage scenario 2]
|
|
26
26
|
3. [Specific usage scenario 3]
|
|
27
27
|
|
|
28
|
+
### User Journey Diagram
|
|
29
|
+
```mermaid
|
|
30
|
+
journey
|
|
31
|
+
title [Feature Name] User Journey
|
|
32
|
+
section [Phase 1]
|
|
33
|
+
[Step]: [satisfaction score]: [actor]
|
|
34
|
+
```
|
|
35
|
+
[Map the end-to-end user experience from trigger event to goal completion]
|
|
36
|
+
|
|
37
|
+
### Scope Boundary Diagram
|
|
38
|
+
```mermaid
|
|
39
|
+
C4Context
|
|
40
|
+
Boundary(scope, "In Scope") {
|
|
41
|
+
[Components in scope]
|
|
42
|
+
}
|
|
43
|
+
Boundary(out, "Out of Scope") {
|
|
44
|
+
[Components out of scope]
|
|
45
|
+
}
|
|
46
|
+
```
|
|
47
|
+
[Clarify what is and is not included in this feature]
|
|
48
|
+
|
|
28
49
|
## Functional Requirements
|
|
29
50
|
|
|
30
|
-
### Must Have (MVP)
|
|
51
|
+
### Must Have (P1 - MVP)
|
|
31
52
|
- [ ] Requirement 1: [Detailed description]
|
|
32
53
|
- AC: [Acceptance criteria - Given/When/Then format or measurable standard]
|
|
33
54
|
- [ ] Requirement 2: [Detailed description]
|
|
34
55
|
- AC: [Acceptance criteria]
|
|
35
|
-
|
|
56
|
+
|
|
57
|
+
### Should Have (P2)
|
|
58
|
+
- [ ] Requirement 1: [Detailed description]
|
|
36
59
|
- AC: [Acceptance criteria]
|
|
37
60
|
|
|
38
|
-
###
|
|
61
|
+
### Could Have (P3)
|
|
39
62
|
- [ ] Requirement 1: [Detailed description]
|
|
40
|
-
- [ ] Requirement 2: [Detailed description]
|
|
41
63
|
|
|
42
|
-
###
|
|
43
|
-
- Item 1: [Description and reason]
|
|
44
|
-
- Item 2: [Description and reason]
|
|
64
|
+
### Won't Have (this release)
|
|
65
|
+
- Item 1: [Description and reason for exclusion]
|
|
66
|
+
- Item 2: [Description and reason for exclusion]
|
|
45
67
|
|
|
46
68
|
## Non-Functional Requirements
|
|
47
69
|
|
|
@@ -69,9 +91,9 @@ So that [expected value/benefit]
|
|
|
69
91
|
## Success Criteria
|
|
70
92
|
|
|
71
93
|
### Quantitative Metrics
|
|
72
|
-
1. [
|
|
73
|
-
2. [
|
|
74
|
-
3. [
|
|
94
|
+
1. [Metric name]: [numeric target] measured by [method] within [timeframe]
|
|
95
|
+
2. [Metric name]: [numeric target] measured by [method] within [timeframe]
|
|
96
|
+
3. [Metric name]: [numeric target] measured by [method] within [timeframe]
|
|
75
97
|
|
|
76
98
|
### Qualitative Metrics
|
|
77
99
|
1. [User experience metric 1]
|
|
@@ -38,7 +38,7 @@ Files to read before starting implementation (file path, with optional search hi
|
|
|
38
38
|
- **Verification method**: [What to verify and how — e.g., "compare new implementation output against existing implementation at src/legacy/order_calc", "run endpoint against test database and verify response matches contract"]
|
|
39
39
|
- **Success criteria**: [Observable outcome that proves correctness — e.g., "output matches existing implementation for all input combinations", "API returns 200 with expected schema"]
|
|
40
40
|
- **Failure response**: [What to do if verification fails — e.g., "reassess approach before proceeding", "escalate to user"]
|
|
41
|
-
- **Verification level**: [L1/L2/L3
|
|
41
|
+
- **Verification level**: [L1: Functional operation as end-user feature / L2: New tests added and passing / L3: Code builds without errors]
|
|
42
42
|
|
|
43
43
|
## Completion Criteria
|
|
44
44
|
- [ ] All added tests pass
|
|
@@ -47,4 +47,4 @@ Files to read before starting implementation (file path, with optional search hi
|
|
|
47
47
|
|
|
48
48
|
## Notes
|
|
49
49
|
- Impact scope: [Areas where changes may propagate]
|
|
50
|
-
-
|
|
50
|
+
- Scope boundary: [Files to preserve unchanged — path and reason]
|