@dtt_siye/atool 1.5.0 → 1.6.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/VERSION +1 -1
- package/package.json +1 -1
- package/skills/clarify-before-build/SKILL.md +33 -0
- package/skills/development-pipeline/SKILL.md +168 -0
- package/skills/project-analyze/SKILL.md +1 -1
- package/skills/project-analyze/phases/phase1-setup.md +4 -4
- package/skills/project-analyze/phases/phase3-graph.md +2 -2
- package/skills/project-analyze/phases/phase5-export.md +16 -4
- package/skills/ui-ux-pro/SKILL.md +69 -0
- package/skills/writing-plans/SKILL.md +104 -0
package/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.6.1
|
package/package.json
CHANGED
|
@@ -105,3 +105,36 @@ version: 1.0.0
|
|
|
105
105
|
- **新功能 + 有测试要求** → `/test-driven-development`
|
|
106
106
|
- **重构 + 有回归风险** → `/systematic-debugging`
|
|
107
107
|
- **完成后** → 检查文档是否需要更新(`/doc-coauthoring`)
|
|
108
|
+
|
|
109
|
+
## Pre-Implementation Documentation Check
|
|
110
|
+
|
|
111
|
+
在复杂度评估和澄清问题之后,在路由到 brainstorming 或 writing-plans 之前,**检查文档完整性**:
|
|
112
|
+
|
|
113
|
+
### 检查清单:项目是否有必要的文档?
|
|
114
|
+
|
|
115
|
+
- [ ] 检查 `docs/300-requirements/` 是否存在并包含相关 PRD
|
|
116
|
+
- [ ] 检查 `docs/400-architecture/` 是否存在并包含相关架构文档
|
|
117
|
+
- [ ] 检查 `docs/500-design/` 是否存在并包含相关 UI 设计文档
|
|
118
|
+
|
|
119
|
+
### 缺失时的行为:
|
|
120
|
+
|
|
121
|
+
告知用户:"此功能需要 [PRD/架构文档/UI设计文档],但尚未创建。建议先创建再进入实施。"
|
|
122
|
+
|
|
123
|
+
主动提供调用相关技能:
|
|
124
|
+
- 缺少 PRD → 建议 `/requirements-writer`(Quick PRD 或 Full PRD)
|
|
125
|
+
- 缺少架构文档 → 建议 `/software-architecture`
|
|
126
|
+
- 缺少 UI 设计 → 建议 `/ui-ux-pro`(包含 HTML 原型)
|
|
127
|
+
|
|
128
|
+
### 路由增强:
|
|
129
|
+
|
|
130
|
+
| 场景 | 文档状态 | 建议行为 |
|
|
131
|
+
|------|---------|---------|
|
|
132
|
+
| Tier 2(新功能)+ 缺少 PRD | `docs/300-requirements/` 为空 | 先调用 `/requirements-writer` |
|
|
133
|
+
| Tier 3(架构级)+ 缺少架构文档 | `docs/400-architecture/` 为空 | 先调用 `/software-architecture` |
|
|
134
|
+
| 任何涉及 UI 的功能 + 缺少 UI 设计 | `docs/500-design/` 为空 | 先调用 `/ui-ux-pro`(含 HTML 原型) |
|
|
135
|
+
|
|
136
|
+
### 注意事项:
|
|
137
|
+
|
|
138
|
+
- 此检查适用于**新功能和架构级任务**,不适用于 bug 修复、配置调整、单行改动(Tier 0)
|
|
139
|
+
- 如果用户发出退出信号("直接做"、"stop asking"等),跳过此检查
|
|
140
|
+
- 已有完整文档的项目无需重复创建
|
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: development-pipeline
|
|
3
|
+
description: 管理从需求到交付的完整开发生命周期。当用户要求开发新功能、新项目时使用此技能编排全套研发流程。
|
|
4
|
+
version: 1.0.0
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Development Pipeline
|
|
8
|
+
|
|
9
|
+
完整的开发生命周期编排技能。将所有 aTool 研发技能串联为7个阶段,确保从需求发现到交付的每个步骤都被执行。
|
|
10
|
+
|
|
11
|
+
## 适用场景
|
|
12
|
+
|
|
13
|
+
- 用户要求"开发一个新功能"、"做一个新项目"
|
|
14
|
+
- 需要从零开始的完整研发流程
|
|
15
|
+
- 多模块、多步骤的复杂开发任务
|
|
16
|
+
|
|
17
|
+
**不适用于:**
|
|
18
|
+
- Bug 修复(直接用 `/systematic-debugging`)
|
|
19
|
+
- 配置调整、单行改动(直接执行)
|
|
20
|
+
- 已有完整文档和计划的项目(直接用 `/smart-dispatch` 执行计划)
|
|
21
|
+
|
|
22
|
+
## 7 阶段流程
|
|
23
|
+
|
|
24
|
+
### Phase 1: 需求发现
|
|
25
|
+
|
|
26
|
+
**目标:** 评估复杂度,澄清需求,防止幻觉和偏差。
|
|
27
|
+
|
|
28
|
+
**技能:** `/clarify-before-build`
|
|
29
|
+
|
|
30
|
+
- 评估任务复杂度(Tier 0-3)
|
|
31
|
+
- Tier 0: 直接执行,退出流程
|
|
32
|
+
- Tier 1: 问1-2个问题后执行
|
|
33
|
+
- Tier 2: 问3-5个结构化问题
|
|
34
|
+
- Tier 3: 进入 Phase 2
|
|
35
|
+
|
|
36
|
+
**前置文档检查:** 检查 `docs/300-requirements/`、`docs/400-architecture/`、`docs/500-design/` 是否已存在相关文档。
|
|
37
|
+
|
|
38
|
+
### Phase 2: 设计
|
|
39
|
+
|
|
40
|
+
**目标:** 通过协作探索产生设计规范,获得用户批准。
|
|
41
|
+
|
|
42
|
+
**技能:** `/brainstorming`
|
|
43
|
+
|
|
44
|
+
- 探索项目上下文
|
|
45
|
+
- 提出2-3个方案及权衡
|
|
46
|
+
- 按复杂度分段展示设计,逐段获得批准
|
|
47
|
+
- 输出:设计规范文档(`docs/superpowers/specs/`)
|
|
48
|
+
|
|
49
|
+
**注意:** brainstorming 的终态会调用 `/writing-plans`。Phase 3 的文档创建任务会在 writing-plans 的 Enhancement 0 中自动注入。
|
|
50
|
+
|
|
51
|
+
### Phase 3: 文档化(可在计划中并行执行)
|
|
52
|
+
|
|
53
|
+
**目标:** 在编号文档目录中创建结构化的专业文档。
|
|
54
|
+
|
|
55
|
+
根据项目范围,创建以下文档(通过 writing-plans Enhancement 0 的 Task 0.x 自动注入):
|
|
56
|
+
|
|
57
|
+
| 文档类型 | 目标目录 | 产出技能 | 触发条件 |
|
|
58
|
+
|---------|---------|---------|---------|
|
|
59
|
+
| PRD(产品需求文档) | `docs/300-requirements/` | `/requirements-writer` | 设计规范包含产品功能、用户故事 |
|
|
60
|
+
| 架构设计文档 | `docs/400-architecture/` | `/software-architecture` | 设计规范包含系统架构、微服务 |
|
|
61
|
+
| UI 设计文档 + HTML 原型 | `docs/500-design/` + `prototypes/` | `/ui-ux-pro`(Workflow Mode) | 设计规范包含 UI 组件、交互 |
|
|
62
|
+
|
|
63
|
+
**每个文档创建后:**
|
|
64
|
+
1. 用 `/doc-standards-enforcer` 验证(L1 格式 + L2 结构)
|
|
65
|
+
2. 用户审批(特别是 UI 原型需要用户确认)
|
|
66
|
+
3. 单独 commit
|
|
67
|
+
|
|
68
|
+
### Phase 4: 计划
|
|
69
|
+
|
|
70
|
+
**目标:** 将设计规范分解为可执行的 TDD 任务。
|
|
71
|
+
|
|
72
|
+
**技能:** `/writing-plans`(aTool 增强版)
|
|
73
|
+
|
|
74
|
+
- Enhancement 0: 前置文档阶段(Phase 3 的任务自动在此生成)
|
|
75
|
+
- TDD 任务分解(红-绿-重构循环)
|
|
76
|
+
- Enhancement 1: 后置文档同步任务
|
|
77
|
+
- Enhancement 5: Chunk 分组(支持并行执行)
|
|
78
|
+
|
|
79
|
+
输出:实施计划文档(`docs/superpowers/plans/`)
|
|
80
|
+
|
|
81
|
+
### Phase 5: 实施
|
|
82
|
+
|
|
83
|
+
**目标:** 按计划执行 TDD 开发,每个任务经过审查。
|
|
84
|
+
|
|
85
|
+
**技能选择(根据计划推荐):**
|
|
86
|
+
|
|
87
|
+
| 执行方式 | 技能 | 适用场景 |
|
|
88
|
+
|---------|------|---------|
|
|
89
|
+
| 并行执行 | `/smart-dispatch` | Chunk 化的计划,有 subagent 支持的平台 |
|
|
90
|
+
| 顺序审查 | `/subagent-driven-development` | 需要 per-task 审查的计划 |
|
|
91
|
+
| 单 agent | `/executing-plans` | 无 subagent 支持的平台 |
|
|
92
|
+
|
|
93
|
+
**每个任务遵循:**
|
|
94
|
+
1. 写失败测试
|
|
95
|
+
2. 验证测试失败
|
|
96
|
+
3. 写最小实现代码
|
|
97
|
+
4. 验证测试通过
|
|
98
|
+
5. 规格审查 + 代码质量审查
|
|
99
|
+
6. Commit
|
|
100
|
+
|
|
101
|
+
### Phase 6: 验证
|
|
102
|
+
|
|
103
|
+
**目标:** 用新鲜证据确认完成。
|
|
104
|
+
|
|
105
|
+
**技能:** `/verification-before-completion`
|
|
106
|
+
|
|
107
|
+
- 运行所有测试,确认通过
|
|
108
|
+
- 检查文档新鲜度(源文件 mtime vs 文档 mtime)
|
|
109
|
+
- 运行代码质量检查
|
|
110
|
+
- 修复所有 Critical 级别问题
|
|
111
|
+
|
|
112
|
+
### Phase 7: 交付
|
|
113
|
+
|
|
114
|
+
**目标:** 决定如何集成开发成果。
|
|
115
|
+
|
|
116
|
+
**技能:** `/finishing-a-development-branch`
|
|
117
|
+
|
|
118
|
+
- 验证测试通过(必须门禁)
|
|
119
|
+
- 提供选项:merge 到本地 / 创建 PR / 保留分支 / 丢弃
|
|
120
|
+
- 执行用户选择的操作
|
|
121
|
+
- 清理 worktree
|
|
122
|
+
|
|
123
|
+
## 流程图
|
|
124
|
+
|
|
125
|
+
```
|
|
126
|
+
用户请求
|
|
127
|
+
│
|
|
128
|
+
▼
|
|
129
|
+
Phase 1: clarify-before-build (Tier 评估)
|
|
130
|
+
│
|
|
131
|
+
├─ Tier 0/1 → 直接执行,退出流程
|
|
132
|
+
│
|
|
133
|
+
▼ Tier 2/3
|
|
134
|
+
Phase 2: brainstorming (设计规范)
|
|
135
|
+
│
|
|
136
|
+
▼
|
|
137
|
+
Phase 4: writing-plans (计划生成)
|
|
138
|
+
│
|
|
139
|
+
├─ Enhancement 0 自动注入 Phase 3 文档任务:
|
|
140
|
+
│ ├─ Task 0.1: /requirements-writer → docs/300-requirements/
|
|
141
|
+
│ ├─ Task 0.2: /software-architecture → docs/400-architecture/
|
|
142
|
+
│ └─ Task 0.3: /ui-ux-pro → docs/500-design/ + prototypes/
|
|
143
|
+
│
|
|
144
|
+
└─ 代码实施任务 (TDD)
|
|
145
|
+
│
|
|
146
|
+
▼
|
|
147
|
+
Phase 5: smart-dispatch / subagent-driven-development
|
|
148
|
+
│
|
|
149
|
+
▼
|
|
150
|
+
Phase 6: verification-before-completion
|
|
151
|
+
│
|
|
152
|
+
▼
|
|
153
|
+
Phase 7: finishing-a-development-branch
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
## 使用方式
|
|
157
|
+
|
|
158
|
+
直接调用:
|
|
159
|
+
|
|
160
|
+
```
|
|
161
|
+
/development-pipeline
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
或由 clarify-before-build 在 Tier 3 评估后自动路由。
|
|
165
|
+
|
|
166
|
+
## 与其他技能的关系
|
|
167
|
+
|
|
168
|
+
本技能是**编排器**,不替代任何子技能的具体逻辑。它定义的是技能之间的**调用顺序和依赖关系**,确保完整流程不被跳过。
|
|
@@ -378,7 +378,7 @@ jq '.refine_status' .atool-docs/analysis-state.json
|
|
|
378
378
|
| 问题 | 诊断命令 | 解决方案 |
|
|
379
379
|
|------|---------|---------|
|
|
380
380
|
| 没有检测到模块 | `cat .atool-docs/pre-scan/manifest.json \| jq '.modules'` | 检查源文件格式或 detect-stack 规则 |
|
|
381
|
-
| phase3_graph 失败 | `cat .atool-docs/analysis-state.json \| jq '.phases.phase3_graph'` | 运行 `source lib/knowledge-graph.sh; assemble_enhanced_graph` 检查错误 |
|
|
381
|
+
| phase3_graph 失败 | `cat .atool-docs/analysis-state.json \| jq '.phases.phase3_graph'` | 运行 `source "$HOME/.claude/skills/project-analyze/lib/knowledge-graph.sh"; assemble_enhanced_graph` 检查错误 |
|
|
382
382
|
| Sub-agent 无法读文件 | `cat .atool-docs/modules/{name}/data.json` | 检查 Phase 2 初稿是否生成 |
|
|
383
383
|
| 精炼 Gate 失败 | `cat atool-analysis/modules/{name}/prd.md \| wc -l` | PRD 文件小于 30 行,需要扩展初稿 |
|
|
384
384
|
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
> PROJECT_ROOT="$(pwd)"
|
|
20
20
|
> DOCS_DIR="$PROJECT_ROOT/.atool-docs"
|
|
21
21
|
> mkdir -p "$DOCS_DIR"
|
|
22
|
-
> source lib/detect-stack.sh 2>/dev/null || true
|
|
22
|
+
> source "$HOME/.claude/skills/project-analyze/lib/detect-stack.sh" 2>/dev/null || source lib/detect-stack.sh 2>/dev/null || true
|
|
23
23
|
> STACK=$(detect_stack "$PROJECT_ROOT" 2>/dev/null || echo "unknown")
|
|
24
24
|
> FILE_COUNT=$(find "$PROJECT_ROOT" -type f \
|
|
25
25
|
> ! -path "*/node_modules/*" ! -path "*/.git/*" \
|
|
@@ -50,7 +50,7 @@
|
|
|
50
50
|
> PROJECT_ROOT="$(pwd)"
|
|
51
51
|
> DOCS_DIR="$PROJECT_ROOT/.atool-docs"
|
|
52
52
|
> mkdir -p "$DOCS_DIR/pre-scan"
|
|
53
|
-
> source lib/pre-scan.sh 2>/dev/null
|
|
53
|
+
> source "$HOME/.claude/skills/project-analyze/lib/pre-scan.sh" 2>/dev/null || source lib/pre-scan.sh 2>/dev/null || true
|
|
54
54
|
> pre_scan_project "$PROJECT_ROOT" "$DOCS_DIR/pre-scan" 2>/dev/null
|
|
55
55
|
> if [ -f "$DOCS_DIR/pre-scan/manifest.json" ]; then
|
|
56
56
|
> echo "Pre-scan OK: $(jq '.modules | length' "$DOCS_DIR/pre-scan/manifest.json" 2>/dev/null || echo '?') modules"
|
|
@@ -154,8 +154,8 @@
|
|
|
154
154
|
如果 `lib/compute-importance.sh` 可用,运行重要性评分:
|
|
155
155
|
> **执行命令(可选):**
|
|
156
156
|
> ```bash
|
|
157
|
-
> source lib/compute-importance.sh 2>/dev/null
|
|
158
|
-
>
|
|
157
|
+
> source "$HOME/.claude/skills/project-analyze/lib/compute-importance.sh" 2>/dev/null || source lib/compute-importance.sh 2>/dev/null || true
|
|
158
|
+
> compute_importance_batch "$DOCS_DIR/pre-scan/manifest.json" "$PROJECT_ROOT" 2>/dev/null && \
|
|
159
159
|
> echo "Importance scoring done" || echo "Importance scoring skipped"
|
|
160
160
|
> ```
|
|
161
161
|
|
|
@@ -56,7 +56,7 @@
|
|
|
56
56
|
> PROJECT_ROOT="$(pwd)"
|
|
57
57
|
> DOCS_DIR="$PROJECT_ROOT/.atool-docs"
|
|
58
58
|
> cd "$PROJECT_ROOT"
|
|
59
|
-
> source lib/knowledge-graph.sh 2>/dev/null
|
|
59
|
+
> source "$HOME/.claude/skills/project-analyze/lib/knowledge-graph.sh" 2>/dev/null || source lib/knowledge-graph.sh 2>/dev/null || true
|
|
60
60
|
> assemble_enhanced_graph "$DOCS_DIR" "$PROJECT_ROOT" 2>/dev/null
|
|
61
61
|
> if [ -f "$DOCS_DIR/knowledge-graph.json" ]; then
|
|
62
62
|
> NODES=$(jq '.nodes | length' "$DOCS_DIR/knowledge-graph.json" 2>/dev/null || echo 0)
|
|
@@ -77,7 +77,7 @@
|
|
|
77
77
|
> PROJECT_ROOT="$(pwd)"
|
|
78
78
|
> DOCS_DIR="$PROJECT_ROOT/.atool-docs"
|
|
79
79
|
> cd "$PROJECT_ROOT"
|
|
80
|
-
> source lib/multi-dimensional-analysis.sh 2>/dev/null
|
|
80
|
+
> source "$HOME/.claude/skills/project-analyze/lib/multi-dimensional-analysis.sh" 2>/dev/null || source lib/multi-dimensional-analysis.sh 2>/dev/null || true
|
|
81
81
|
> run_multi_dimensional_analysis "$DOCS_DIR" 2>/dev/null
|
|
82
82
|
> if [ -f "$DOCS_DIR/multi-dimensional-analysis.json" ]; then
|
|
83
83
|
> echo "Multi-dimensional analysis complete"
|
|
@@ -92,11 +92,15 @@
|
|
|
92
92
|
> ```bash
|
|
93
93
|
> PROJECT_ROOT="$(pwd)"
|
|
94
94
|
> cd "$PROJECT_ROOT"
|
|
95
|
-
>
|
|
95
|
+
> _SKILL_LIB="$HOME/.claude/skills/project-analyze/lib"
|
|
96
|
+
> if [ -f "$_SKILL_LIB/export-analysis.sh" ]; then
|
|
97
|
+
> source "$_SKILL_LIB/export-analysis.sh"
|
|
98
|
+
> register_project "$PROJECT_ROOT"
|
|
99
|
+
> elif [ -f "lib/export-analysis.sh" ]; then
|
|
96
100
|
> source lib/export-analysis.sh
|
|
97
101
|
> register_project "$PROJECT_ROOT"
|
|
98
102
|
> else
|
|
99
|
-
> echo "WARNING:
|
|
103
|
+
> echo "WARNING: export-analysis.sh not found — project not registered in ~/.atool/projects.json"
|
|
100
104
|
> echo "Manual registration: add entry to ~/.atool/projects.json"
|
|
101
105
|
> fi
|
|
102
106
|
> ```
|
|
@@ -113,7 +117,15 @@
|
|
|
113
117
|
> # 检查 knowledge-graph.json 是否存在
|
|
114
118
|
> if [ -f "$DOCS_DIR/knowledge-graph.json" ]; then
|
|
115
119
|
> # 调用 generate-visualization.sh
|
|
116
|
-
>
|
|
120
|
+
> _SKILL_LIB="$HOME/.claude/skills/project-analyze/lib"
|
|
121
|
+
> if [ -f "$_SKILL_LIB/generate-visualization.sh" ]; then
|
|
122
|
+
> source "$_SKILL_LIB/generate-visualization.sh"
|
|
123
|
+
> generate_visualization "$DOCS_DIR"
|
|
124
|
+
> if [ -f "$DOCS_DIR/visualization/index.html" ]; then
|
|
125
|
+
> echo "✅ Visualization generated: $DOCS_DIR/visualization/index.html"
|
|
126
|
+
> du -h "$DOCS_DIR/visualization/index.html" | awk '{print "Size: " $1}'
|
|
127
|
+
> fi
|
|
128
|
+
> elif [ -f "$PROJECT_ROOT/lib/generate-visualization.sh" ]; then
|
|
117
129
|
> source "$PROJECT_ROOT/lib/generate-visualization.sh"
|
|
118
130
|
> generate_visualization "$DOCS_DIR"
|
|
119
131
|
> if [ -f "$DOCS_DIR/visualization/index.html" ]; then
|
|
@@ -121,7 +133,7 @@
|
|
|
121
133
|
> du -h "$DOCS_DIR/visualization/index.html" | awk '{print "Size: " $1}'
|
|
122
134
|
> fi
|
|
123
135
|
> else
|
|
124
|
-
> echo "⚠️
|
|
136
|
+
> echo "⚠️ generate-visualization.sh not found — skipping visualization"
|
|
125
137
|
> fi
|
|
126
138
|
> else
|
|
127
139
|
> echo "⚠️ knowledge-graph.json not found — cannot generate visualization"
|
|
@@ -138,3 +138,72 @@ Use this skill when:
|
|
|
138
138
|
- Overusing animations
|
|
139
139
|
- Cluttered interfaces
|
|
140
140
|
- Hidden important actions
|
|
141
|
+
|
|
142
|
+
## Workflow Mode (when invoked by other skills)
|
|
143
|
+
|
|
144
|
+
When ui-ux-pro is invoked by writing-plans, clarify-before-build, or directly for a UI design task, follow this structured workflow to produce deliverables:
|
|
145
|
+
|
|
146
|
+
### Step 1: Analyze Requirements
|
|
147
|
+
|
|
148
|
+
Read the spec/design document to understand UI needs:
|
|
149
|
+
- Identify all pages/screens needed
|
|
150
|
+
- Map user flows and navigation patterns
|
|
151
|
+
- List interactive components (forms, modals, buttons, filters)
|
|
152
|
+
- Identify component states: normal, loading, empty, error, disabled
|
|
153
|
+
- Determine responsive breakpoints needed
|
|
154
|
+
|
|
155
|
+
### Step 2: Create Design Document
|
|
156
|
+
|
|
157
|
+
Write a structured UI design document to `docs/500-design/YYYY-MM-DD-<feature-name>.md`:
|
|
158
|
+
|
|
159
|
+
The document should include:
|
|
160
|
+
- **Page inventory**: All pages with layout descriptions
|
|
161
|
+
- **Component specifications**: Each component with all states (normal/loading/empty/error)
|
|
162
|
+
- **Interaction flows**: Step-by-step user interaction sequences
|
|
163
|
+
- **Responsive behavior**: How layouts adapt across breakpoints
|
|
164
|
+
- **Accessibility requirements**: ARIA labels, keyboard navigation, screen reader support
|
|
165
|
+
- **Design tokens**: Colors, typography, spacing values (matching project theme)
|
|
166
|
+
- **Wireframe descriptions**: Text-based layout descriptions for each page
|
|
167
|
+
|
|
168
|
+
Validate with `/doc-standards-enforcer` (L1 format + L2 structure).
|
|
169
|
+
|
|
170
|
+
### Step 3: Create HTML Prototype
|
|
171
|
+
|
|
172
|
+
Generate an interactive HTML prototype as a single self-contained file at `prototypes/<feature-name>.html`:
|
|
173
|
+
|
|
174
|
+
The prototype must demonstrate:
|
|
175
|
+
- **All key page layouts** with realistic content (not Lorem ipsum)
|
|
176
|
+
- **Interactive elements**: clickable navigation, working modals, functional forms
|
|
177
|
+
- **Design tokens**: Actual colors, fonts, spacing matching the spec
|
|
178
|
+
- **Responsive behavior**: Works on mobile (375px) and desktop (1280px) widths
|
|
179
|
+
- **Component states**: Show at least normal and error states for forms
|
|
180
|
+
- **Self-contained**: All CSS inline or in `<style>`, no external dependencies
|
|
181
|
+
|
|
182
|
+
The prototype should be presentable to stakeholders for design review.
|
|
183
|
+
|
|
184
|
+
### Step 4: User Review
|
|
185
|
+
|
|
186
|
+
Present the HTML prototype to the user:
|
|
187
|
+
- Open the file in a browser for visual inspection
|
|
188
|
+
- Ask: "Does this design match your expectations? Any changes before implementation?"
|
|
189
|
+
- Wait for approval before proceeding
|
|
190
|
+
|
|
191
|
+
### Step 5: Commit Deliverables
|
|
192
|
+
|
|
193
|
+
```bash
|
|
194
|
+
git add docs/500-design/ prototypes/
|
|
195
|
+
git commit -m "docs: add UI design and prototype for <feature name>"
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
### When to Use Workflow Mode
|
|
199
|
+
|
|
200
|
+
- Invoked by writing-plans as Task 0.3 (pre-implementation documentation phase)
|
|
201
|
+
- Invoked by clarify-before-build when UI docs are missing
|
|
202
|
+
- User explicitly requests UI design or prototype creation
|
|
203
|
+
- Any new project with UI-facing features
|
|
204
|
+
|
|
205
|
+
### When NOT to Use Workflow Mode
|
|
206
|
+
|
|
207
|
+
- Quick design questions ("what color should this button be?")
|
|
208
|
+
- Code review of existing UI (use design review questions above)
|
|
209
|
+
- Small UI tweaks to existing components
|
|
@@ -10,6 +10,108 @@ This skill extends `superpowers:writing-plans` with **mandatory documentation sy
|
|
|
10
10
|
|
|
11
11
|
**Use the superpowers:writing-plans skill as the base**, then apply these additions:
|
|
12
12
|
|
|
13
|
+
## Enhancement 0: Pre-Implementation Documentation Phase (Mandatory First Check)
|
|
14
|
+
|
|
15
|
+
**Before creating ANY code implementation tasks, run this check.** This intercepts the brainstorming → writing-plans flow and ensures structured documents are created in numbered directories before code.
|
|
16
|
+
|
|
17
|
+
### Step 0: Documentation Completeness Assessment
|
|
18
|
+
|
|
19
|
+
Read the spec/design document. Determine what types of deliverables this project requires:
|
|
20
|
+
|
|
21
|
+
| Spec Contains | Required Document | Location | Producing Skill |
|
|
22
|
+
|---------------|------------------|----------|-----------------|
|
|
23
|
+
| Product features, user stories, business requirements | PRD | `docs/300-requirements/` | `/requirements-writer` |
|
|
24
|
+
| System architecture, microservices, data flow, deployment | Architecture Doc | `docs/400-architecture/` | `/software-architecture` |
|
|
25
|
+
| UI components, interactions, page layouts | UI Design Doc + HTML Prototype | `docs/500-design/` | `/ui-ux-pro` |
|
|
26
|
+
|
|
27
|
+
### Check Procedure:
|
|
28
|
+
|
|
29
|
+
1. Scan the spec for each category above
|
|
30
|
+
2. Check if the corresponding document already exists in the numbered directory
|
|
31
|
+
3. If MISSING → add a Task 0.x document creation task (see templates below) before any code tasks
|
|
32
|
+
4. If EXISTS → skip, proceed to code tasks
|
|
33
|
+
|
|
34
|
+
### Task 0.x Templates:
|
|
35
|
+
|
|
36
|
+
````markdown
|
|
37
|
+
### Task 0.1: Create PRD Document (if spec contains product requirements)
|
|
38
|
+
|
|
39
|
+
**Files:**
|
|
40
|
+
- Create: `docs/300-requirements/YYYY-MM-DD-<feature-name>.md`
|
|
41
|
+
|
|
42
|
+
- [ ] **Step 1: Invoke /requirements-writer**
|
|
43
|
+
Use the requirements-writer skill to produce a structured PRD from the design spec's requirements sections.
|
|
44
|
+
|
|
45
|
+
- [ ] **Step 2: Validate document**
|
|
46
|
+
Invoke /doc-standards-enforcer (L1 format + L2 structure) on the created document.
|
|
47
|
+
|
|
48
|
+
- [ ] **Step 3: Commit**
|
|
49
|
+
```bash
|
|
50
|
+
git add docs/300-requirements/
|
|
51
|
+
git commit -m "docs: add PRD for <feature name>"
|
|
52
|
+
```
|
|
53
|
+
````
|
|
54
|
+
|
|
55
|
+
````markdown
|
|
56
|
+
### Task 0.2: Create Architecture Document (if spec contains system architecture)
|
|
57
|
+
|
|
58
|
+
**Files:**
|
|
59
|
+
- Create: `docs/400-architecture/YYYY-MM-DD-<feature-name>.md`
|
|
60
|
+
|
|
61
|
+
- [ ] **Step 1: Invoke /software-architecture**
|
|
62
|
+
Use the software-architecture skill to produce a structured architecture document from the design spec's architecture sections.
|
|
63
|
+
|
|
64
|
+
- [ ] **Step 2: Validate document**
|
|
65
|
+
Invoke /doc-standards-enforcer (L1 format + L2 structure) on the created document.
|
|
66
|
+
|
|
67
|
+
- [ ] **Step 3: Commit**
|
|
68
|
+
```bash
|
|
69
|
+
git add docs/400-architecture/
|
|
70
|
+
git commit -m "docs: add architecture for <feature name>"
|
|
71
|
+
```
|
|
72
|
+
````
|
|
73
|
+
|
|
74
|
+
````markdown
|
|
75
|
+
### Task 0.3: Create UI Design Document + HTML Prototype (if spec contains UI/UX design)
|
|
76
|
+
|
|
77
|
+
**Files:**
|
|
78
|
+
- Create: `docs/500-design/YYYY-MM-DD-<feature-name>.md`
|
|
79
|
+
- Create: `prototypes/<feature-name>.html`
|
|
80
|
+
|
|
81
|
+
- [ ] **Step 1: Invoke /ui-ux-pro in Workflow Mode**
|
|
82
|
+
Use the ui-ux-pro skill to produce a structured UI design document AND an interactive HTML prototype.
|
|
83
|
+
|
|
84
|
+
- [ ] **Step 2: Validate document**
|
|
85
|
+
Invoke /doc-standards-enforcer (L1 format + L2 structure) on the design document.
|
|
86
|
+
|
|
87
|
+
- [ ] **Step 3: Present prototype to user**
|
|
88
|
+
Open the HTML prototype in browser. Get user approval on design before proceeding to code.
|
|
89
|
+
|
|
90
|
+
- [ ] **Step 4: Commit**
|
|
91
|
+
```bash
|
|
92
|
+
git add docs/500-design/ prototypes/
|
|
93
|
+
git commit -m "docs: add UI design and prototype for <feature name>"
|
|
94
|
+
```
|
|
95
|
+
````
|
|
96
|
+
|
|
97
|
+
**Only after all applicable Task 0.x tasks are complete, proceed to Chunk 1 (code implementation tasks).**
|
|
98
|
+
|
|
99
|
+
### Chunk Grouping Update:
|
|
100
|
+
|
|
101
|
+
When using Enhancement 5 chunk grouping, Task 0.x documents form **Chunk 0: Pre-Implementation Documentation**:
|
|
102
|
+
|
|
103
|
+
```markdown
|
|
104
|
+
## Chunk 0: Pre-Implementation Documentation
|
|
105
|
+
|
|
106
|
+
### Task 0.1: Create PRD Document
|
|
107
|
+
### Task 0.2: Create Architecture Document
|
|
108
|
+
### Task 0.3: Create UI Design + HTML Prototype
|
|
109
|
+
|
|
110
|
+
## Chunk 1: Foundation Tasks
|
|
111
|
+
**Depends on:** Chunk 0
|
|
112
|
+
...
|
|
113
|
+
```
|
|
114
|
+
|
|
13
115
|
## Enhancement 1: Documentation Update Task (Mandatory Last Task)
|
|
14
116
|
|
|
15
117
|
**Every plan MUST include a final task for documentation updates.** This is not optional.
|
|
@@ -61,6 +163,8 @@ git commit -m "docs: update documentation for [feature name]"
|
|
|
61
163
|
|
|
62
164
|
Add this item to the self-review checklist:
|
|
63
165
|
|
|
166
|
+
**0. Pre-implementation documentation check:** For specs covering product requirements, system architecture, or UI/UX design, does the plan include Task 0.x documentation creation tasks? If the spec covers these topics and no Task 0.x exists, STOP and add them before proceeding.
|
|
167
|
+
|
|
64
168
|
**4. Documentation coverage:** For each task that creates or modifies source files, does the final documentation sync task list all affected documentation? Are there code changes with no corresponding doc update planned?
|
|
65
169
|
|
|
66
170
|
## Enhancement 3: Task-Level Doc Hints
|