@guru-ai-product/ai-product-kit 0.1.251112172507

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.
Files changed (64) hide show
  1. package/README.md +107 -0
  2. package/bin/setup.js +89 -0
  3. package/package.json +24 -0
  4. package/skills/aipk_design/GURU_AI.md +10 -0
  5. package/skills/aipk_design/SKILL.md +33 -0
  6. package/skills/aipk_design/auto_panel_splitter/SKILL.md +360 -0
  7. package/skills/aipk_design/auto_panel_splitter/scripts/auto_panel_splitter.js +399 -0
  8. package/skills/aipk_design/auto_panel_splitter/scripts/panel_asset_mapper.js +445 -0
  9. package/skills/aipk_development/GURU_AI.md +8 -0
  10. package/skills/aipk_development/SKILL.md +20 -0
  11. package/skills/aipk_development/templates//345/256/236/346/226/275/350/256/241/345/210/222/346/226/207/346/241/243.md +302 -0
  12. package/skills/aipk_init_project/SKILL.md +188 -0
  13. package/skills/aipk_init_project/scripts/check_agents.sh +55 -0
  14. package/skills/aipk_init_project/template/AGENTS_TEMPLATE.md +138 -0
  15. package/skills/aipk_operations/GURU_AI.md +10 -0
  16. package/skills/aipk_operations/SKILL.md +37 -0
  17. package/skills/aipk_operations/aso_new_release/SKILL.md +84 -0
  18. package/skills/aipk_operations/aso_new_release/references/aso-update-notes-prompt.md +196 -0
  19. package/skills/aipk_operations/aso_new_release/references/aso-update-notes-template.md +162 -0
  20. package/skills/aipk_requirements/GURU_AI.md +39 -0
  21. package/skills/aipk_requirements/SKILL.md +243 -0
  22. package/skills/aipk_requirements/changes/SKILL.md +196 -0
  23. package/skills/aipk_requirements/changes/template/index.md +30 -0
  24. package/skills/aipk_requirements/changes/template//351/234/200/346/261/202/345/217/230/345/212/250/350/257/264/346/230/216/346/226/207/346/241/243/346/250/241/346/235/277.md +576 -0
  25. package/skills/aipk_requirements/changes/template//351/234/200/346/261/202/345/217/230/345/212/250/350/257/264/346/230/216/347/224/237/346/210/220Prompt.md +349 -0
  26. package/skills/aipk_requirements/changes/template//351/234/200/346/261/202/345/217/230/345/212/250/350/257/264/346/230/216/347/224/237/346/210/220/346/214/207/345/215/227.md +292 -0
  27. package/skills/aipk_requirements/documentation/SKILL.md +930 -0
  28. package/skills/aipk_requirements/documentation/template/1_/344/272/247/345/223/201/345/256/232/344/275/215/344/270/216/345/210/206/346/236/220.md +86 -0
  29. package/skills/aipk_requirements/documentation/template/2_/345/212/237/350/203/275/351/234/200/346/261/202.md +67 -0
  30. package/skills/aipk_requirements/documentation/template/3_/345/225/206/344/270/232/345/214/226/347/255/226/347/225/245.md +131 -0
  31. package/skills/aipk_requirements/documentation/template/4_/347/224/250/346/210/267/347/225/214/351/235/242/344/270/216/344/275/223/351/252/214.md +665 -0
  32. package/skills/aipk_requirements/documentation/template/AI /345/272/224/347/224/250/347/261/273APP/351/200/232/347/224/250/345/237/213/347/202/271/346/226/207/346/241/243.xlsx +0 -0
  33. package/skills/aipk_requirements/documentation/template/Draft_/344/272/247/345/223/201/351/234/200/346/261/202/350/215/211/347/250/277.md +60 -0
  34. package/skills/aipk_requirements/documentation/template/Draft_/347/224/250/346/210/267/346/227/205/347/250/213/350/215/211/347/250/277.md +84 -0
  35. package/skills/aipk_requirements/documentation/template/index.md +83 -0
  36. package/skills/aipk_requirements/documentation/template//345/237/213/347/202/271/350/247/204/350/214/203/346/226/207/346/241/243.md +372 -0
  37. package/skills/aipk_requirements/documentation/template//351/234/200/346/261/202/350/277/255/344/273/243/346/250/241/346/235/277.md +821 -0
  38. package/skills/aipk_requirements/documentation/template//351/234/200/346/261/202/350/277/255/344/273/243/347/264/242/345/274/225.md +30 -0
  39. package/skills/aipk_requirements/initiative_planning/SKILL.md +407 -0
  40. package/skills/aipk_requirements/initiative_planning/template/SWOT/345/210/206/346/236/220/346/250/241/346/235/277.md +381 -0
  41. package/skills/aipk_requirements/initiative_planning/template//344/272/247/345/223/201/350/247/204/345/210/222/346/250/241/346/235/277.md +322 -0
  42. package/skills/aipk_requirements/initiative_planning/template//345/225/206/344/270/232/345/214/226/350/247/204/345/210/222/346/250/241/346/235/277.md +201 -0
  43. package/skills/aipk_requirements/initiative_planning/template//345/270/202/345/234/272/344/270/216/345/225/206/344/270/232/345/210/206/346/236/220/346/250/241/346/235/277.md +176 -0
  44. package/skills/aipk_requirements/initiative_planning/template//346/212/200/346/234/257/350/247/204/345/210/222/346/250/241/346/235/277.md +314 -0
  45. package/skills/aipk_requirements/intake/SKILL.md +260 -0
  46. package/skills/aipk_requirements/intake/examples/K12/346/225/260/345/255/246/345/255/246/344/271/240/345/272/224/347/224/250/346/241/210/344/276/213.md +371 -0
  47. package/skills/aipk_requirements/intake/examples//347/224/265/345/225/206/345/271/263/345/217/260/344/274/230/345/214/226/346/241/210/344/276/213.md +426 -0
  48. package/skills/aipk_requirements/intake/references/Gemini_DeepResearch_/345/267/245/345/205/267/351/223/276/346/225/264/345/220/210/346/236/266/346/236/204/350/256/276/350/256/241.md +1272 -0
  49. package/skills/aipk_requirements/intake/template//344/272/247/345/223/201/351/234/200/346/261/202/345/217/221/347/216/260/344/270/216/351/252/214/350/257/201/346/250/241/346/235/277.md +53 -0
  50. package/skills/aipk_requirements/intake/template//345/270/202/345/234/272/346/234/272/344/274/232/350/257/204/344/274/260/344/270/216/347/253/236/344/272/211/345/210/206/346/236/220/346/250/241/346/235/277.md +53 -0
  51. package/skills/aipk_requirements/intake/template//346/212/200/346/234/257/346/226/271/346/241/210/350/257/204/344/274/260/344/270/216/345/217/257/350/241/214/346/200/247/345/210/206/346/236/220/346/250/241/346/235/277.md +72 -0
  52. package/skills/aipk_requirements/intake/template//346/267/261/345/272/246/347/224/250/346/210/267/350/241/214/344/270/272/344/270/216/351/234/200/346/261/202/346/264/236/345/257/237/346/250/241/346/235/277.md +59 -0
  53. package/skills/aipk_requirements/review/SKILL.md +218 -0
  54. package/skills/aipk_skill_generate/GURU_AI.md +8 -0
  55. package/skills/aipk_skill_generate/SKILL.md +259 -0
  56. package/skills/aipk_skill_generate/agent_skills_spec.md +79 -0
  57. package/skills/aipk_tool_prompts/AI/344/275/223/351/252/214/350/256/276/350/256/241/346/214/207/345/215/227.md +93 -0
  58. package/skills/aipk_tool_prompts/GURU_AI.md +13 -0
  59. package/skills/aipk_tool_prompts/Prompt/347/224/237/346/210/220.md +20 -0
  60. package/skills/aipk_tool_prompts/SKILL.md +55 -0
  61. package/skills/aipk_tool_prompts/images/20250710200701.png +0 -0
  62. package/skills/aipk_tool_prompts/images/20250710200802.png +0 -0
  63. package/skills/aipk_tool_prompts//346/240/207/350/256/260/346/226/207/346/241/243/346/233/264/346/226/260.md +33 -0
  64. package/skills/aipk_tool_prompts//347/224/237/346/210/220DrawIO/346/226/207/346/241/243.md +45 -0
@@ -0,0 +1,349 @@
1
+ # 需求变动说明生成Prompt
2
+
3
+ ## 基础Prompt
4
+
5
+ ```
6
+ 请看下当前<版本目录>的需求和<commit-hash>这个commit的差异,并形成一个变动说明文档。
7
+
8
+ 要求:
9
+ 1. 对比这两个commit之间的所有文件变化(不仅仅是这个commit涉及的文件,而是这个commit之后的所有文件的状态)
10
+ 2. 详细说明每个文档的新增、修改、删除内容
11
+ 3. 所有的修改说明希望能链接到具体的位置(文件名和行号)
12
+ 4. 在第3、4节中具体说明都做了哪些变动、新增、去除,便于跟踪变化
13
+ 5. 使用📄表示文件链接,📍表示位置链接
14
+ 6. 生成统计表格汇总变动情况
15
+ 7. 章节序号要连续正确
16
+ 8. 在标题上增加对比的两段日期的说明
17
+
18
+ 文档结构要求:
19
+ - 第1节:变动概述
20
+ - 第2节:Commit历史
21
+ - 第3节:文档级变动详情(详细说明新增、修改、删除内容及具体位置)
22
+ - 第4节:功能维度变动分析(从功能角度分析变动)
23
+ - 第5节:产品策略分析
24
+ - 第6节:附录(统计表、命令等)
25
+
26
+ 不要包含:
27
+ - 开发影响评估章节
28
+ - 待确认事项章节
29
+ - 建议后续行动章节
30
+ ```
31
+
32
+ ## 增强Prompt(包含更多细节)
33
+
34
+ ```
35
+ 我需要生成一份需求文档变动说明,对比<旧commit>和<新commit>(或HEAD)之间的变化。
36
+
37
+ ### 分析要求:
38
+
39
+ 1. **识别所有变更文件**
40
+ - 使用 git diff --stat 和 git diff --name-status 识别变更的文件
41
+ - 区分修改(M)、新增(A)、删除(D)的文件
42
+ - 分版本目录(如v2.0.0、v2.1.0)组织
43
+
44
+ 2. **详细分析每个文件**
45
+ - 对于修改的文件:
46
+ * 使用 git diff 查看具体变更
47
+ * 使用 grep "^## |^### " 获取章节结构
48
+ * 使用 grep -n 定位关键内容的行号
49
+ * 详细列出新增的章节、功能点(附带行号链接)
50
+ * 详细列出修改的内容(附带行号链接)
51
+ * 说明删除的内容
52
+
53
+ - 对于新增的文件:
54
+ * 获取文档的章节结构
55
+ * 列出主要章节并链接到具体行号
56
+ * 标注文档规模(总行数)
57
+ * 说明文档的功能类型
58
+
59
+ 3. **生成文档结构**
60
+
61
+ **第1节 - 变动概述**:
62
+ - 标题下方用引用块显示:变动周期(起止日期)、对比版本(commit号)
63
+ - 对比版本信息(commit号、日期、提交信息)
64
+ - 总体统计(文件数、行数变化)
65
+
66
+ **第2节 - Commit历史**:
67
+ - 列出期间所有commit
68
+ - 每个commit包含:hash、日期、提交信息、变更文件概要
69
+
70
+ **第3节 - 文档级变动详情**:
71
+ 按版本目录组织,对每个文档:
72
+ - 添加📄文件链接
73
+ - 标注变动量(+/-行数)
74
+ - **新增内容**:列表形式,重要项用📍链接到具体行号
75
+ - **修改内容**:列表形式,重要项用📍链接到具体行号
76
+ - **删除内容**:说明删除的内容
77
+
78
+ **第4节 - 功能维度变动分析**:
79
+ - 4.1 核心新功能:列出新增的重要功能,每个功能包含:
80
+ * 📄文档链接
81
+ * 功能定位
82
+ * 新增内容(各功能模块用📍链接)
83
+ * 技术要求(用📍链接)
84
+ * 开发复杂度预估
85
+
86
+ - 4.2 核心功能优化:列出优化的功能,包含:
87
+ * 📄文档链接
88
+ * 新增部分(用📍链接)
89
+ * 修改部分(用📍链接)
90
+ * 删除部分
91
+ * 开发影响预估
92
+
93
+ **第5节 - 产品策略分析**:
94
+ - 功能战略定位(创作能力、用户增长、商业化)
95
+ - 版本演进路径
96
+
97
+ **第6节 - 附录**:
98
+ - 完整变更文件清单
99
+ - 变动统计汇总表(markdown表格)
100
+ - Commit详情
101
+ - Git命令
102
+ - 文档结构树状图
103
+
104
+ ### 格式要求:
105
+
106
+ 1. **链接格式**:
107
+ - 文件链接:`📄 查看文件 (./文件名.md)` 或 `📄 查看完整文档 (../vX.X.X/文件名.md)`
108
+ - 行号链接:`📍 说明文字 → \`章节名称:行号\` (./文件名.md#L行号)`
109
+
110
+ 2. **图标使用**:
111
+ - 📄 文件链接
112
+ - 📍 位置链接
113
+ - ⭐⭐⭐ / ⭐⭐ / ⭐ 重要程度
114
+
115
+ 3. **表格格式**:
116
+ ```markdown
117
+ | 类型 | 数量 | 行数 |
118
+ |------|------|------|
119
+ | 修改文档 | X个 | +XXX/-XX |
120
+ ```
121
+
122
+ 4. **章节序号**:确保连续,无跳跃
123
+
124
+ 5. **引用块**:标题下方的关键信息用 `>` 引用
125
+
126
+ ### 输出文档
127
+
128
+ 文档命名:`YYYYMMDD_需求文档变动说明_<旧commit>至<新commit>.md`
129
+ 保存位置:`../../vX.X.X/`
130
+
131
+ 请开始分析并生成变动说明文档。
132
+
133
+ ```
134
+
135
+ ## 分步执行Prompt(适合复杂场景)
136
+
137
+ ### Step 1: 收集变更信息
138
+
139
+ ```
140
+
141
+ 第一步:收集变更信息
142
+
143
+ 请执行以下命令并记录结果:
144
+
145
+ 1. 查看变更文件列表:
146
+ git diff --name-status <旧commit>..<新commit> -- "../../requirements"
147
+
148
+ 2. 查看变更统计:
149
+ git diff --stat <旧commit>..<新commit> -- "../../requirements"
150
+
151
+ 3. 查看commit历史:
152
+ git log --oneline <旧commit>..<新commit>
153
+
154
+ 4. 对每个commit查看详情:
155
+ git show --stat <commit-hash>
156
+
157
+ 请整理并告诉我:
158
+
159
+ - 有哪些文件被修改了?(M)
160
+ - 有哪些文件是新增的?(A)
161
+ - 有哪些文件被删除了?(D)
162
+ - 每个文件的行数变化
163
+ - 涉及的commit数量和信息
164
+
165
+ ```
166
+
167
+ ### Step 2: 分析修改的文档
168
+
169
+ ```
170
+
171
+ 第二步:分析修改的文档
172
+
173
+ 对于每个被修改的文档(标记为M),请:
174
+
175
+ 1. 查看文档的章节结构:
176
+ grep -n "^## |^### |^#### " 文档路径
177
+
178
+ 2. 查看具体变更:
179
+ git diff <旧commit>..<新commit> -- "文档路径"
180
+
181
+ 3. 对每个文档生成变动说明,包括:
182
+ - 📄 文件链接
183
+ - 变动量(+X行/-Y行)
184
+ - **新增内容**:
185
+ - 新增的章节(章节名 + 行号链接)
186
+ - 新增的功能点(描述 + 行号链接)
187
+ - **修改内容**:
188
+ - 修改的章节(章节名 + 行号链接)
189
+ - 修改的内容描述
190
+ - **删除内容**:
191
+ - 删除的内容说明
192
+
193
+ 请分析:<文档名>
194
+
195
+ ```
196
+
197
+ ### Step 3: 分析新增的文档
198
+
199
+ ```
200
+
201
+ 第三步:分析新增的文档
202
+
203
+ 对于每个新增的文档(标记为A),请:
204
+
205
+ 1. 查看文档章节结构:
206
+ grep -n "^## |^### |^#### " 文档路径
207
+
208
+ 2. 查看文档行数:
209
+ wc -l 文档路径
210
+
211
+ 3. 生成文档说明,包括:
212
+ - 📄 文件链接
213
+ - 文档规模(总行数)
214
+ - **包含内容**(主要章节,每个章节链接到行号):
215
+ - 📍 章节1 → [`章节名称:行号`](路径#L行号)
216
+ - 📍 章节2 → [`章节名称:行号`](路径#L行号)
217
+ - 功能类型说明
218
+
219
+ 请分析:<文档名>
220
+
221
+ ```
222
+
223
+ ### Step 4: 生成完整文档
224
+
225
+ ```
226
+
227
+ 第四步:生成完整的变动说明文档
228
+
229
+ 基于前面收集的信息,生成完整文档,结构如下:
230
+
231
+ # [版本] 需求文档变动说明
232
+
233
+ > **变动周期**: <起始日期> → <结束日期>(X天)
234
+ > **对比版本**: `<旧commit>` → `<新commit>`
235
+
236
+ ## 1. 变动概述
237
+
238
+ [填入:版本信息、统计数据]
239
+
240
+ ## 2. Commit 历史
241
+
242
+ [填入:每个commit的信息]
243
+
244
+ ## 3. 文档级变动详情
245
+
246
+ [填入:每个文档的详细变动]
247
+
248
+ ## 4. 功能维度变动分析
249
+
250
+ [填入:功能级别的分析]
251
+
252
+ ## 5. 产品策略分析
253
+
254
+ [填入:战略层面的分析]
255
+
256
+ ## 6. 附录
257
+
258
+ [填入:统计表、命令等]
259
+
260
+ 请生成完整文档。
261
+
262
+ ```
263
+
264
+ ## 质量检查Prompt
265
+
266
+ ```
267
+
268
+ 请检查刚生成的变动说明文档,确认:
269
+
270
+ 1. **链接有效性**:
271
+ - [ ] 所有📄文件链接路径正确
272
+ - [ ] 所有📍行号链接格式正确(使用#L前缀)
273
+ - [ ] 相对路径使用正确(./同级,../上级)
274
+
275
+ 2. **内容完整性**:
276
+ - [ ] 所有修改的文档都有新增、修改、删除说明
277
+ - [ ] 重要功能点都有行号链接
278
+ - [ ] 统计数据准确(文件数、行数)
279
+ - [ ] Commit信息完整
280
+
281
+ 3. **格式规范**:
282
+ - [ ] 章节序号连续(1,2,3,4,5,6)
283
+ - [ ] 图标使用正确(📄📍⭐)
284
+ - [ ] 表格格式正确
285
+ - [ ] 代码块正确标记
286
+
287
+ 4. **可读性**:
288
+ - [ ] 结构清晰
289
+ - [ ] 描述准确
290
+ - [ ] 重点突出
291
+
292
+ 请指出发现的问题并修正。
293
+
294
+ ```
295
+
296
+ ## 使用示例
297
+
298
+ ### 示例1:基础使用
299
+
300
+ ```
301
+
302
+ 请看下当前v2.0.0的需求和90cad63faefa9edd7957c256493ae144bd4de5b5这个commit的差异,
303
+ 并形成一个变动说明文档。
304
+
305
+ 要求按照标准格式,包含详细的变动说明和具体位置链接。
306
+
307
+ ```
308
+
309
+ ### 示例2:多版本对比
310
+
311
+ ```
312
+
313
+ 请对比../../目录下v2.0.0和v2.1.0两个版本,
314
+ 在commit 90cad63 到 HEAD 之间的所有变化,生成变动说明文档。
315
+
316
+ 需要:
317
+
318
+ 1. 分别说明两个版本的变化
319
+ 2. v2.1.0是新增的版本目录,需要特别标注
320
+ 3. 所有重要变动都要有具体位置链接
321
+
322
+ ```
323
+
324
+ ### 示例3:重点功能分析
325
+
326
+ ```
327
+
328
+ 生成需求变动说明,重点分析以下功能的变化:
329
+
330
+ 1. Draw to Video功能(新增)
331
+ 2. 积分签到系统(新增)
332
+ 3. 多模式视频生成平台(大幅更新)
333
+ 4. 付费方案优化(新增)
334
+
335
+ 对每个功能详细说明:
336
+
337
+ - 功能模块及具体位置
338
+ - 技术实现要求及位置
339
+ - 开发工作量预估
340
+
341
+ ```
342
+
343
+ ## 注意事项
344
+
345
+ 1. **确保git仓库状态**:在分析前确认本地仓库是最新的
346
+ 2. **行号可能变化**:如果文档被修改,行号可能不准确,需要重新确认
347
+ 3. **相对路径**:注意文档之间的相对路径关系
348
+ 4. **图片文件**:图片文件标注类型和用途,不需要行号
349
+ 5. **draft文件**:draft文件简要说明即可,不需要详细分析
@@ -0,0 +1,292 @@
1
+ # 需求变动说明文档生成指南
2
+
3
+ ## 一、目标
4
+
5
+ 为两个git commit之间的需求文档变更生成一份详细的变动说明文档,帮助团队成员快速了解:
6
+
7
+ - 哪些文档发生了变化
8
+ - 具体新增、修改、删除了什么内容
9
+ - 每个变动的具体位置(可点击跳转)
10
+ - 变动对开发和产品的影响
11
+
12
+ ## 二、准备工作
13
+
14
+ ### 2.1 确定对比版本
15
+
16
+ ```bash
17
+ # 查看最近的commit历史
18
+ git log --oneline -20
19
+
20
+ # 确定要对比的两个commit
21
+ # 例如:90cad63 (旧版本) 和 HEAD (新版本)
22
+ ```
23
+
24
+ ### 2.2 获取变更信息
25
+
26
+ ```bash
27
+ # 查看两个版本之间的所有文件变更
28
+ git diff --stat <旧commit>..<新commit>
29
+
30
+ # 查看文件状态(新增A、修改M、删除D)
31
+ git diff --name-status <旧commit>..<新commit>
32
+
33
+ # 查看具体文件的变更
34
+ git diff <旧commit>..<新commit> -- "路径/文件名.md"
35
+
36
+ # 查看commit历史
37
+ git log --oneline <旧commit>..<新commit>
38
+ ```
39
+
40
+ ### 2.3 收集文档结构信息
41
+
42
+ ```bash
43
+ # 获取文档的章节结构(使用grep)
44
+ grep "^## |^### |^#### " 文件路径.md
45
+
46
+ # 查找特定内容的行号
47
+ grep -n "关键词" 文件路径.md
48
+ ```
49
+
50
+ ## 三、生成步骤
51
+
52
+ ### 3.1 创建文档基本信息
53
+
54
+ 1. **文档命名**:`YYYYMMDD_需求文档变动说明_<旧commit>至<新commit>.md`
55
+ 2. **标题设置**:
56
+ - 主标题:说明涉及的版本
57
+ - 副标题:标注变动周期和对比版本
58
+
59
+ ### 3.2 编写变动概述(第1节)
60
+
61
+ 包含内容:
62
+
63
+ - 对比版本信息(commit号、日期、提交信息)
64
+ - 变动周期(起止日期、天数)
65
+ - 总体变动统计(文件数、行数、新增文档数)
66
+
67
+ ### 3.3 记录Commit历史(第2节)
68
+
69
+ 对每个commit记录:
70
+
71
+ - Commit号和日期
72
+ - 提交信息
73
+ - 变更文件列表及行数统计
74
+
75
+ ### 3.4 详细分析文档变动(第3节)
76
+
77
+ **分版本说明**(如v2.0.0、v2.1.0):
78
+
79
+ #### 对于修改的文档
80
+
81
+ - 添加文档链接
82
+ - 标注变动量(+X行 / -Y行)
83
+ - **新增内容**:列出新增的章节、功能点,并链接到具体行号
84
+ - **修改内容**:说明优化和调整的部分,并链接到具体行号
85
+ - **删除内容**:说明删除的内容及原因
86
+
87
+ #### 对于新增的文档
88
+
89
+ - 添加文档链接
90
+ - 标注文档规模(总行数)
91
+ - 列出文档包含的主要章节,每个章节链接到具体行号
92
+ - 标注功能类型(如:新功能、商业化优化、用户运营等)
93
+
94
+ ### 3.5 功能维度分析(第4节)
95
+
96
+ #### 核心新功能(4.1)
97
+
98
+ 对每个新功能:
99
+
100
+ - 添加文档链接
101
+ - 功能定位(创作能力、用户留存、商业化等)
102
+ - **新增内容**:详细列出功能模块,链接到文档具体位置
103
+ - **技术要求**:列出技术实现要点,链接到相关章节
104
+ - **开发复杂度**:预估工作量
105
+
106
+ #### 核心功能优化(4.2)
107
+
108
+ 对优化的功能:
109
+
110
+ - 添加文档链接
111
+ - **新增部分**:列出新增内容及行号链接
112
+ - **修改部分**:列出修改内容及行号链接
113
+ - **删除部分**:说明删除内容
114
+ - **开发影响**:预估工作量
115
+
116
+ ### 3.6 产品策略分析(第5节)
117
+
118
+ - 功能战略定位(创作能力、用户增长、商业化)
119
+ - 版本演进路径(各版本的定位和重点)
120
+
121
+ ### 3.7 附录信息(第6节)
122
+
123
+ - 完整变更文件清单
124
+ - 变动统计汇总表
125
+ - Commit详情
126
+ - 查看差异的git命令
127
+ - 文档结构树状图
128
+
129
+ ## 四、关键要点
130
+
131
+ ### 4.1 链接格式
132
+
133
+ **文件链接**:
134
+
135
+ ```markdown
136
+ 📄 查看文件 (./文件名.md)
137
+ 📄 查看完整文档 (../v2.1.0/文件名.md)
138
+ ```
139
+
140
+ **章节行号链接**:
141
+
142
+ ```markdown
143
+ 📍 功能说明 → `章节名称:行号` (./文件名.md#L行号)
144
+ 📍 详细设计 → `3.1.1 页面设计:156` (./文件名.md#L156)
145
+ ```
146
+
147
+ ### 4.2 使用图标
148
+
149
+ - 📄 文件链接
150
+ - 📍 位置链接(行号)
151
+ - ⭐⭐⭐ 重要程度标识
152
+ - ✅ 完成状态
153
+ - 🔵 系统操作
154
+ - 🟢 用户操作
155
+ - 🟡 判断节点
156
+
157
+ ### 4.3 表格格式
158
+
159
+ ```markdown
160
+ | 类型 | 数量 | 行数 |
161
+ |------|------|------|
162
+ | 修改文档 | 2个 | +471/-102 |
163
+ | 新增文档 | 3个 | 1196行 |
164
+ | **合计** | **5个** | **+1725/-112** |
165
+ ```
166
+
167
+ ### 4.4 代码块格式
168
+
169
+ ```markdown
170
+ ```bash
171
+ git diff --stat 90cad63..HEAD
172
+ ```
173
+
174
+ ```
175
+
176
+ ## 五、质量检查清单
177
+
178
+ - [ ] 所有修改的文档都有详细的新增、修改、删除说明
179
+ - [ ] 重要功能点都有具体的行号链接
180
+ - [ ] 所有链接都可以正确跳转
181
+ - [ ] 章节序号连续无误
182
+ - [ ] 统计数据准确(文件数、行数)
183
+ - [ ] Commit信息完整(hash、日期、作者、提交信息)
184
+ - [ ] 文档结构清晰,易于阅读
185
+ - [ ] 使用了适当的图标和格式化
186
+ - [ ] 包含了开发工作量预估
187
+ - [ ] 提供了产品策略分析
188
+
189
+ ## 六、AI Prompt 示例
190
+
191
+ ```
192
+
193
+ 请看下当前<版本目录>的需求和<commit-hash>这个commit的差异,
194
+ 并形成一个变动说明文档。
195
+
196
+ 要求:
197
+
198
+ 1. 对比这两个commit之间的所有文件变化
199
+ 2. 详细说明每个文档的新增、修改、删除内容
200
+ 3. 所有的修改说明希望能链接到具体的位置(文件名和行号)
201
+ 4. 删除第5、7、8节,在第3、4节中具体说明变动、新增、去除
202
+ 5. 使用📄表示文件链接,📍表示位置链接
203
+ 6. 生成统计表格汇总变动情况
204
+ 7. 章节序号要连续正确
205
+ 8. 在标题上增加对比的两段日期的说明
206
+
207
+ ```
208
+
209
+ ## 七、工具和技巧
210
+
211
+ ### 7.1 快速获取章节结构
212
+
213
+ ```bash
214
+ # 获取二级标题
215
+ grep "^## " 文件.md
216
+
217
+ # 获取三级标题
218
+ grep "^### " 文件.md
219
+
220
+ # 获取所有标题并显示行号
221
+ grep -n "^#" 文件.md
222
+ ```
223
+
224
+ ### 7.2 快速定位关键词
225
+
226
+ ```bash
227
+ # 查找关键词并显示行号
228
+ grep -n "关键词" 文件.md
229
+
230
+ # 查找关键词并显示上下文
231
+ grep -C 3 "关键词" 文件.md
232
+ ```
233
+
234
+ ### 7.3 批量处理
235
+
236
+ ```bash
237
+ # 查看多个文件的变更
238
+ for file in $(git diff --name-only 90cad63..HEAD -- "../../requirements"); do
239
+ echo "=== $file ==="
240
+ git diff --stat 90cad63..HEAD -- "$file"
241
+ done
242
+ ```
243
+
244
+ ## 八、常见问题
245
+
246
+ ### Q1: 如何确定重要程度?
247
+
248
+ A: 根据以下标准:
249
+
250
+ - ⭐⭐⭐ 新增重要功能、重大修改(>300行)
251
+ - ⭐⭐ 中等功能优化、新增文档(100-300行)
252
+ - ⭐ 小幅优化、格式调整(<100行)
253
+
254
+ ### Q2: 链接失效怎么办?
255
+
256
+ A:
257
+
258
+ - 确保行号准确(使用grep -n查找)
259
+ - 相对路径要正确(同目录./,上级目录../)
260
+ - GitHub渲染需要使用#L前缀
261
+
262
+ ### Q3: 如何处理删除的文件?
263
+
264
+ A:
265
+
266
+ - 在变更清单中标注[已删除]
267
+ - 说明删除原因
268
+ - 如有替代方案,说明替代文件
269
+
270
+ ### Q4: 如何预估开发工作量?
271
+
272
+ A: 考虑因素:
273
+
274
+ - 功能复杂度(界面、交互、算法)
275
+ - 技术依赖(新技术、第三方库)
276
+ - 接口数量
277
+ - 测试难度
278
+ - 一般按2-3人日/100行代码估算
279
+
280
+ ## 九、示例参考
281
+
282
+ 参考文档:
283
+
284
+ - `20251017_需求文档变动说明_90cad63至fa5a716.md`
285
+
286
+ 该文档展示了完整的变动说明格式,包括:
287
+
288
+ - 清晰的文档结构
289
+ - 详细的变动说明
290
+ - 完整的链接系统
291
+ - 准确的统计数据
292
+ - 有价值的分析内容