@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,930 @@
1
+ ---
2
+ name: requirements-documentation
3
+ description: Unified guide for requirement documentation and iteration templates, ensuring correct template selection and execution.
4
+ ---
5
+
6
+ # 需求文档与迭代模板指南
7
+
8
+ ## 执行指南
9
+
10
+ **重要提示:本指南专为自动化文档生成设计,请严格按照以下规则执行**
11
+
12
+ ### 执行原则
13
+
14
+ 1. **严格遵循模板结构**:生成文档时必须完全按照提供的模板结构,不得添加模板中未定义的章节或内容
15
+ 2. **模板优先原则**:当本指南与具体模板内容存在差异时,以模板内容为准
16
+ 3. **内容完整性**:必须生成完整的五个部分文档,不得遗漏任何模板中定义的内容
17
+ 4. **格式一致性**:严格按照模板中的格式要求,包括标题层级、表格格式、代码块等
18
+ 5. **无额外内容**:禁止在模板结构之外添加任何额外的章节、说明或内容
19
+
20
+ ### 模板选择确认(必需步骤)
21
+
22
+ **⚠️ 重要:在执行任何文档生成工作前,必须先完成模板选择确认**
23
+
24
+ Agent必须遵循以下流程:
25
+
26
+ 1. **分析用户需求场景**:
27
+ - 判断是新产品/功能开发(从0到1)还是现有功能迭代优化
28
+ - 分析需求的复杂度和范围
29
+ - 评估是否需要完整的产品定位、商业化策略等
30
+
31
+ 2. **给出模板推荐**:
32
+ - **推荐使用"需求文档模板"的情况**:
33
+ - 新产品开发(从0到1)
34
+ - 重大功能模块开发
35
+ - 需要完整的产品定位、市场分析、商业化策略
36
+ - 需要用户旅程设计和完整的UI/UX规划
37
+ - **推荐使用"需求迭代模板"的情况**:
38
+ - 现有功能的优化迭代
39
+ - 小功能新增或修改
40
+ - 基于现有产品的功能改进
41
+ - 只需要描述功能变更逻辑和实现方案
42
+
43
+ 3. **等待用户确认**:
44
+ - 明确告知用户推荐的模板类型及推荐理由
45
+ - **暂停执行,等待用户明确确认**使用哪个模板
46
+ - 只有获得用户确认后,才能继续执行后续流程
47
+
48
+ **确认格式示例**:
49
+
50
+ ```text
51
+ 根据您的需求描述,我建议使用 [需求文档模板/需求迭代模板]。
52
+
53
+ 推荐理由:
54
+ - [理由1]
55
+ - [理由2]
56
+ - [理由3]
57
+
58
+ 请确认是否使用该模板,或告知需要使用另一个模板。
59
+ ```
60
+
61
+ **模板选择决策树**:
62
+
63
+ ```text
64
+ 用户需求
65
+
66
+ ├─ 新产品开发(从0到1)?
67
+ │ └─ 是 → 需求文档模板
68
+
69
+ ├─ 需要完整的产品定位、市场分析、商业化策略?
70
+ │ └─ 是 → 需求文档模板
71
+
72
+ ├─ 需要用户旅程设计和完整的UI/UX规划?
73
+ │ └─ 是 → 需求文档模板
74
+
75
+ ├─ 现有产品功能迭代优化?
76
+ │ └─ 是 → 需求迭代模板
77
+
78
+ ├─ 只需要描述功能变更和实现方案?
79
+ │ └─ 是 → 需求迭代模板
80
+
81
+ └─ 其他情况 → 基于主要特征判断
82
+ ```
83
+
84
+ ### 执行流程
85
+
86
+ **重要说明**:确认模板后,根据选择的模板执行对应的流程:
87
+
88
+ - **如果选择"需求文档模板"**:执行下方的"需求文档模板执行流程"
89
+ - **如果选择"需求迭代模板"**:执行下方的"需求迭代模板执行流程"
90
+
91
+ **⚠️ 文件夹结构初始化(必需步骤)**:
92
+
93
+ 在执行任何文档生成工作前,必须先完成文件夹结构检查和创建:
94
+
95
+ 1. **检查 requirements 文件夹**:检查 `../requirements` 或项目根目录下的 `requirements` 文件夹是否存在,如果不存在则创建
96
+ 2. **检查版本文件夹**(⚠️ 兼容性优先):
97
+ - **首先检查老结构**:检查是否存在 `requirements/versions/` 文件夹(忽略大小写)
98
+ - 如果存在,**必须使用老结构**,不要创建新结构,不要迁移文件
99
+ - **然后检查新结构**:如果不存在老结构,检查 `requirements/vX.X.X/`
100
+ - **创建新结构**:如果两种结构都不存在,创建新结构:`requirements/v1.0.0/`(默认版本)
101
+ - **必须创建需求池**:无论使用哪种结构,都必须创建 `v0.0.0` 文件夹作为需求池
102
+ 3. **检查子文件夹**:在每个版本文件夹下(包括 v0.0.0)检查并创建以下子文件夹:
103
+ - `draft/`:草稿文档
104
+ - `archived/`:已废弃的文档
105
+ - `assets/`:素材文件
106
+ - `reference/`:参考资料
107
+ - `changes/`:变化日志(可使用 `@requirements-changes` 工具来检查和记录变化)
108
+
109
+ 详细说明请参考 [6.3.1 文档存储位置和版本管理](#631-文档存储位置和版本管理)
110
+
111
+ ---
112
+
113
+ ## 需求文档模板执行流程
114
+
115
+ **重要说明**:本执行流程与下方"3. 需求文档撰写全流程"中的各阶段紧密对应,请结合阅读。
116
+
117
+ **⚠️ 流程完整性要求**:阶段零的两个步骤是**必需**的,不得跳过。只有完成阶段零-1和阶段零-2的确认后,才能进入正式的需求文档撰写流程。
118
+
119
+ 1. **文件夹结构初始化**(**必需** - 在执行任何文档生成前)
120
+ - **目标**:确保文档存储结构完整,便于后续文档管理和组织
121
+ - **执行步骤**:
122
+ - 检查并创建 `skills/aipk_requirements`(项目主仓库的规范位置),如需在单独项目中落地可在项目根目录下创建 `requirements/`
123
+ - 检查并创建版本文件夹(默认 `v1.0.0`)
124
+ - **必须创建需求池**:创建 `v0.0.0` 文件夹作为需求池
125
+ - 检查并创建版本文件夹下的子文件夹(`draft/`、`archived/`、`assets/`、`reference/`、`changes/`)
126
+ - **详细说明**:参考 [6.3.1 文档存储位置和版本管理](#631-文档存储位置和版本管理)
127
+
128
+ 2. **阶段零-1:快速草稿阶段**(**必需** - 对应撰写流程的阶段零-1)
129
+ - **目标**:快速确定产品核心方向,避免后续返工
130
+ - **模板读取**:读取 [产品需求草稿模板](./template/Draft_产品需求草稿.md) 了解草稿格式
131
+ - **文档生成**:使用草稿模板快速梳理核心想法,文档保存在版本文件夹下的 `draft/` 子文件夹中
132
+ - **核心内容**:基于第一性原理,专注最核心问题:核心问题、产品形态、解决方案、商业模式、关键指标、最大风险
133
+ - **Review与确认**:**暂停执行,等待产品负责人确认产品方向**
134
+ - **通过标准**:产品负责人明确确认产品方向、形态和核心价值主张
135
+
136
+ 3. **阶段零-2:用户旅程草稿阶段**(**必需** - 对应撰写流程的阶段零-2)
137
+ - **目标**:基于确认的产品方向,梳理用户使用流程和关键节点
138
+ - **前置条件**:必须完成阶段零-1的确认
139
+ - **模板读取**:读取 [用户旅程草稿模板](./template/Draft_用户旅程草稿.md) 了解草稿格式
140
+ - **文档生成**:使用用户旅程草稿模板梳理用户使用流程,文档保存在版本文件夹下的 `draft/` 子文件夹中
141
+ - **核心内容**:基于已确认的产品需求草稿,设计用户从发现到使用的完整旅程,识别关键用户接触点和决策节点
142
+ - **Review与确认**:**暂停执行,等待产品负责人确认用户旅程设计**
143
+ - **通过标准**:产品负责人明确确认用户旅程设计的合理性和完整性
144
+
145
+ 4. **阶段一:需求探索与定义阶段**(对应撰写流程的阶段一)
146
+ - 读取 [需求收集](../intake/SKILL.md) 和相关分析模板
147
+ - 进行需求来源识别、分析与验证、优先级排序
148
+ - **Review与确认**:暂停执行,等待产品团队确认目标用户和市场定位
149
+
150
+ 5. **阶段二:核心内容撰写阶段**(对应撰写流程的阶段二)
151
+ - 读取 [需求文档模板索引](./template/index.md) 了解整体结构
152
+ - 读取 [第一部分:产品定位与分析](./template/1_产品定位与分析.md) 和 [第二部分:功能需求](./template/2_功能需求.md) 模板
153
+ - 严格按照模板结构生成产品定位分析和功能需求文档
154
+ - 确保文档内容与模板要求完全一致
155
+ - 保持文档间的逻辑连贯性和内容一致性
156
+ - **Review与确认**:暂停执行,等待产品经理确认文档结构和内容
157
+
158
+ 6. **阶段三:方案细化与评审阶段**(对应撰写流程的阶段三)
159
+ - 读取 [第三部分:商业化策略](./template/3_商业化策略.md) 和 [第四部分:用户界面与体验](./template/4_用户界面与体验.md) 模板
160
+ - 进行商业化策略设计、用户界面设计、方案细化
161
+ - 补充界面文案和交互设计内容
162
+ - **Review与确认**:暂停执行,等待跨部门评审确认
163
+
164
+ 7. **阶段四:定稿与发布阶段**(对应撰写流程的阶段四)
165
+ - 获取关键利益相关者的最终批准
166
+ - 将文档归档,并通知所有团队成员
167
+ - **Review与确认**:暂停执行,等待产品负责人最终确认
168
+
169
+ 8. **质量检查阶段**(贯穿整个流程)
170
+ - 验证生成的文档是否完全符合模板结构
171
+ - 检查是否遗漏了模板中的任何必要内容
172
+ - 确认没有添加模板外的额外内容
173
+
174
+ ---
175
+
176
+ ## 需求迭代模板执行流程
177
+
178
+ ### 历史文档检查(必需前置步骤)
179
+
180
+ **⚠️ 重要:在开始需求迭代前,必须先完成历史需求文档检查**
181
+
182
+ 在开始任何需求迭代工作前,必须执行以下步骤:
183
+
184
+ 1. **查找历史需求文档**:
185
+ - 在项目的 `requirements/` 或 `../` 目录下查找相关的历史需求文档
186
+ - 检查当前版本文件夹(如 `v1.0.0/`)及历史版本文件夹中的需求文档
187
+ - 查找与当前迭代功能相关的需求文档(包括需求文档模板和需求迭代模板生成的文档)
188
+
189
+ 2. **分析历史需求内容**:
190
+ - 仔细阅读历史需求文档中的相关功能描述、设计思路和实现方案
191
+ - 识别历史文档中的设计决策、交互流程、技术方案等关键信息
192
+ - 理解现有功能的完整上下文和设计意图
193
+
194
+ 3. **基于现状进行迭代**:
195
+ - **保持一致性**:尽量参考现有的设计(除了用户明确要调整的部分),保持统一和一致
196
+ - **继承现有设计**:对于用户未明确要求修改的部分,应继承历史文档中的设计思路和实现方案
197
+ - **明确变更范围**:清晰标识哪些是新增内容,哪些是对现有设计的修改
198
+ - **说明变更原因**:对于需要调整的部分,在需求背景中说明变更的原因和依据
199
+
200
+ 4. **文档引用**:
201
+ - 在需求背景或附录中引用相关的历史需求文档
202
+ - 明确说明本次迭代与历史文档的关系(继承、修改、扩展等)
203
+
204
+ **检查清单**:
205
+
206
+ - [ ] 已查找并阅读相关的历史需求文档
207
+ - [ ] 已理解现有功能的完整设计和实现方案
208
+ - [ ] 已明确本次迭代的变更范围和原因
209
+ - [ ] 已确保未明确要求修改的部分与历史文档保持一致
210
+ - [ ] 已在文档中引用相关的历史需求文档
211
+
212
+ ### 模板使用流程
213
+
214
+ 1. **历史文档检查**(**必需**):完成上述历史文档检查步骤
215
+ 2. **结构遵循**: 严格按照模板的章节结构填写,不得添加或删除章节
216
+ 3. **内容填写**: 逐章节填写实质性内容,确保每个章节都有明确的信息
217
+ 4. **格式保持**: 保持与模板相同的标题层级、编号格式和内容组织方式
218
+ 5. **质量检查**: 完成所有章节后,检查是否遗漏任何模板定义的章节
219
+
220
+ ### 模板使用要求
221
+
222
+ - 必须填写所有主要章节(需求背景、整体修改逻辑、客户端实现、服务端实现、附录)
223
+ - 根据功能特点选择适用的子章节,不适用的章节使用 `*略*` 标记
224
+ - 每个子部分都要有详细的实施说明
225
+ - 保持文档简洁,专注于核心内容
226
+
227
+ ### 模板内容处理规则
228
+
229
+ 1. **标题处理**: 将模板标题中的 `[功能名称] - [功能描述]` 替换为具体的功能名称和描述
230
+ 2. **占位符处理**: 将模板中的 `[内容]` 替换为实际内容,替换后不要保留中括号
231
+ 3. **条件内容**: 根据功能特点选择适用的子章节,不适用的章节使用 `*略*` 标记
232
+ 4. **可选内容**: 模板中标注为"可选"的内容,根据项目实际情况决定是否填写
233
+ 5. **示例内容**: 模板中的示例内容应替换为实际项目相关内容
234
+
235
+ ### 质量检查清单
236
+
237
+ - [ ] 文档标题已替换为具体的功能名称和描述
238
+ - [ ] 所有模板章节都已填写
239
+ - [ ] 没有添加模板外的章节
240
+ - [ ] 标题层级与模板一致
241
+ - [ ] 内容格式与模板保持一致
242
+ - [ ] 没有多余的说明或注释
243
+ - [ ] 所有占位符已替换为实际内容
244
+ - [ ] 不适用的章节已使用 `*略*` 标记
245
+ - [ ] 条件内容已根据实际情况处理
246
+
247
+ ### 文件命名规范
248
+
249
+ **文档文件命名格式**: `YYYYMMDD_功能模块_迭代描述.md`
250
+
251
+ **示例**:
252
+
253
+ - `20250818_PickForMe_菜单识别推荐功能.md`
254
+ - `20250818_健康指标_新增健康评分系统.md`
255
+ - `20250818_引导页_用户体验优化.md`
256
+
257
+ **文档标题格式**: `[功能名称] - [功能描述]`
258
+
259
+ **示例**:
260
+
261
+ - `PickForMe - 菜单识别推荐功能`
262
+ - `健康指标 - 新增健康评分系统`
263
+ - `引导页 - 用户体验优化`
264
+
265
+ ### 参考模板
266
+
267
+ - [需求迭代模板](./template/需求迭代模板.md) - 完整的需求迭代模板
268
+ - [需求迭代索引模板](./template/需求迭代索引.md) - 需求迭代索引模板
269
+
270
+ ### 关键约束
271
+
272
+ - **禁止添加**:任何模板中未定义的章节、说明、注意事项等
273
+ - **禁止修改**:模板中定义的标题结构、格式要求、内容组织方式
274
+ - **禁止扩展**:模板中未明确要求的内容范围或深度
275
+ - **必须包含**:模板中定义的所有必要章节和内容要求
276
+ - **AI体验要求**:如果产品涉及AI功能,必须严格按照 [4.6 AI体验感标准](#46-ai体验感标准) 进行设计和描述
277
+
278
+ ### 文档输出要求
279
+
280
+ - 严格按照 [8.3 文档输出规范](#83-文档输出规范) 中的要求生成文档
281
+ - 确保文件命名、目录结构、版本管理完全符合规范
282
+ - 索引文档必须包含完整的文档信息表格和修订历史
283
+ - 各部分文档必须包含正确的导航链接
284
+
285
+ ### 特别注意事项
286
+
287
+ 1. **流程完整性**:**阶段零的两个步骤是必需的,不得跳过**。必须完成阶段零-1和阶段零-2的确认后,才能进入正式的需求文档撰写流程。
288
+ 2. **模板依赖**:所有文档内容必须基于提供的模板生成,不得自行创建新的文档结构
289
+ 3. **内容限制**:严格按照模板中定义的内容范围进行撰写,不得超出模板要求
290
+ 4. **格式保持**:保持模板中定义的所有格式要求,包括标题、列表、表格、代码块等
291
+ 5. **链接完整性**:确保所有模板链接和导航链接的正确性
292
+ 6. **版本控制**:严格按照版本管理规范创建文档目录结构
293
+ 7. **AI体验标准**:如果产品涉及AI功能,必须严格遵循AI体验感标准,确保用户输入简化、输出透明、支持迭代优化
294
+
295
+ ### 流程完整性检查清单
296
+
297
+ 在开始任何需求文档撰写工作前,请确认以下检查项:
298
+
299
+ **需求文档模板检查项**:
300
+
301
+ - [ ] **文件夹结构已初始化**:requirements 文件夹、版本文件夹(vX.X.X)及子文件夹(draft、archived、assets、reference、changes)已创建
302
+ - [ ] **阶段零-1已完成**:产品需求草稿已生成并通过产品负责人确认
303
+ - [ ] **阶段零-2已完成**:用户旅程草稿已生成并通过产品负责人确认
304
+ - [ ] **产品方向明确**:核心问题、产品形态、解决方案、商业模式已确定
305
+ - [ ] **用户旅程清晰**:主要用户旅程和关键接触点已识别
306
+ - [ ] **团队共识达成**:所有关键利益相关者对产品方向达成一致
307
+
308
+ **需求迭代模板检查项**:
309
+
310
+ - [ ] **历史文档已检查**:已查找并阅读相关的历史需求文档
311
+ - [ ] **现有设计已理解**:已理解现有功能的完整设计和实现方案
312
+ - [ ] **变更范围已明确**:已明确本次迭代的变更范围和原因
313
+ - [ ] **一致性已确保**:已确保未明确要求修改的部分与历史文档保持一致
314
+
315
+ **注意**:如果以上任何一项未完成,请先完成相应的前置工作,再进行后续需求文档撰写。
316
+
317
+ ---
318
+
319
+ ## 1. 概述
320
+
321
+ 本指南旨在规范产品需求文档(PRD)的撰写流程和标准,确保需求文档的质量和一致性。高质量的需求文档是产品成功的基础,它能够清晰地传达产品愿景、目标和具体功能,为设计、开发和测试团队提供明确的指导。
322
+
323
+ **重要提示:模板使用指南**
324
+
325
+ 当您使用本指南时,请根据具体需求主动读取相关的模板文档。本指南中提到的所有模板链接都是可访问的,建议您:
326
+
327
+ 1. **根据当前任务阶段**,读取对应的模板文档以了解具体的撰写要求
328
+ 2. **在开始撰写前**,先阅读相关模板的结构和内容要求
329
+ 3. **在撰写过程中**,随时参考模板以确保格式和内容的准确性
330
+ 4. **对于复杂任务**,建议同时阅读多个相关模板以获得完整的指导
331
+
332
+ 本指南中的模板链接都是相对路径,您可以直接访问这些文件来获取详细的模板内容。
333
+
334
+ ## 2. 需求文档的目的
335
+
336
+ 在开始撰写之前,首先要明确需求文档的核心目的:
337
+
338
+ - **明确方向**: 定义产品的目标、范围和核心价值主张。
339
+ - **达成共识**: 作为团队沟通和协作的基础,确保所有利益相关者对需求有统一的理解。
340
+ - **指导执行**: 为产品开发、设计和测试工作提供清晰、可执行的路线图。
341
+ - **规避风险**: 详细描述功能与约束,确定技术依赖,提前识别潜在风险。
342
+
343
+ ## 3. 需求文档撰写全流程
344
+
345
+ 本节将详细介绍从需求探索到最终文档定稿的完整流程,并将需求分析、文档结构等概念融入其中。**本流程与上方"执行流程"部分紧密对应,请结合阅读。**
346
+
347
+ ### 3.1 流程概览图
348
+
349
+ ```mermaid
350
+ graph TD
351
+ A[阶段零-1:快速草稿<br/>**必需**] --> A1{Review & 确认};
352
+ A1 -- 通过 --> A2[阶段零-2:用户旅程草稿<br/>**必需**];
353
+ A1 -- 需要调整 --> A;
354
+ A2 --> A2_1{Review & 确认};
355
+ A2_1 -- 通过 --> B[阶段一:需求探索与定义];
356
+ A2_1 -- 需要调整 --> A2;
357
+ B --> B1{Review & 确认};
358
+ B1 -- 通过 --> C[阶段二:核心内容撰写];
359
+ B1 -- 需要调整 --> B;
360
+ C --> C1{Review & 确认};
361
+ C1 -- 通过 --> D[阶段三:方案细化与评审];
362
+ C1 -- 需要调整 --> C;
363
+ D --> D1{达成共识?};
364
+ D1 -- 是 --> E[阶段四:定稿与发布];
365
+ D1 -- 否 --> D;
366
+ E --> E1{Review & 确认};
367
+ E1 -- 通过 --> F[持续进行:需求变更管理];
368
+ E1 -- 需要调整 --> E;
369
+
370
+ %% 样式定义
371
+ classDef required fill:#ffebee,stroke:#d32f2f,stroke-width:3px
372
+ classDef normal fill:#e3f2fd,stroke:#1976d2,stroke-width:2px
373
+ classDef decision fill:#fff3e0,stroke:#f57c00,stroke-width:2px
374
+
375
+ class A,A2 required
376
+ class B,C,D,E,F normal
377
+ class A1,A2_1,B1,C1,D1,E1 decision
378
+ ```
379
+
380
+ **⚠️ 重要说明**:阶段零-1和阶段零-2是**必需**的,不得跳过。只有完成这两个阶段的确认后,才能进入正式的需求文档撰写流程。
381
+
382
+ ### 3.2 各阶段详解
383
+
384
+ **重要提示**:以下各阶段与上方"执行流程"中的对应阶段保持一致,每个阶段都包含模板读取、文档生成和Review确认三个核心环节。
385
+
386
+ #### 阶段零-1:快速草稿(**必需**)
387
+
388
+ - **目标**: 在产品初期快速确定方向,避免过度设计和后续返工。
389
+ - **重要性**: 这是整个需求文档撰写流程的**基础阶段**,必须完成,不得跳过。
390
+ - **对应执行流程**: 阶段零-1:快速草稿阶段
391
+ - **核心活动**:
392
+ - **模板读取**: 读取 **[产品需求草稿模板](./template/Draft_产品需求草稿.md)** 了解草稿的具体结构和要求
393
+ - **文档生成**: 使用草稿模板快速梳理核心想法,文档保存在版本文件夹下的 `draft/` 子文件夹中
394
+ - 基于第一性原理,专注最核心问题:核心问题、产品形态、解决方案、商业模式、关键指标、最大风险
395
+ - 团队内部快速讨论和确认产品方向
396
+ - **关键产出**:
397
+ - 产品核心定位和功能优先级
398
+ - 产品形态选择和技术方向
399
+ - 商业化方向确认
400
+ - 关键风险识别
401
+ - **Review与确认**:
402
+ - **暂停执行,等待人工确认**
403
+ - 产品负责人review草稿内容
404
+ - 确认产品方向和核心假设
405
+ - **必须获得明确确认**:产品方向、形态和核心价值主张
406
+ - 只有在获得人工确认后,才继续执行后续流程
407
+ - **通过标准**:
408
+ - 产品负责人明确确认产品方向
409
+ - 产品形态选择合理且可行
410
+ - 核心价值主张清晰明确
411
+ - 商业化方向基本确定
412
+ - **使用建议**:
413
+ - **所有产品需求文档撰写都必须从此阶段开始**
414
+ - 完成草稿后再进入用户旅程草稿撰写流程
415
+ - 草稿内容将作为完整需求文档的基础
416
+
417
+ #### 阶段零-2:用户旅程草稿(**必需**)
418
+
419
+ - **目标**: 在需求草稿确认后,快速梳理用户使用流程和关键节点,为后续详细设计提供基础。
420
+ - **重要性**: 这是确保产品设计以用户为中心的**关键阶段**,必须完成,不得跳过。
421
+ - **前置条件**: 必须完成阶段零-1的确认
422
+ - **对应执行流程**: 阶段零-2:用户旅程草稿阶段
423
+ - **核心活动**:
424
+ - **模板读取**: 读取 **[用户旅程草稿模板](./template/Draft_用户旅程草稿.md)** 了解草稿的具体结构和要求
425
+ - **文档生成**: 使用用户旅程草稿模板梳理用户使用流程,文档保存在版本文件夹下的 `draft/` 子文件夹中
426
+ - 基于已确认的产品需求草稿,设计用户从发现到使用的完整旅程
427
+ - 识别关键用户接触点和决策节点
428
+ - 团队内部快速讨论和确认用户旅程设计
429
+ - **关键产出**:
430
+ - 用户旅程地图和关键节点
431
+ - 用户接触点和交互流程
432
+ - 潜在的用户体验问题和优化机会
433
+ - 用户旅程相关的功能需求
434
+ - **Review与确认**:
435
+ - **暂停执行,等待人工确认**
436
+ - 产品负责人review用户旅程草稿内容
437
+ - 确认用户旅程设计的合理性和完整性
438
+ - **必须获得明确确认**:用户旅程设计合理且完整
439
+ - 只有在获得人工确认后,才继续执行后续流程
440
+ - **通过标准**:
441
+ - 用户旅程设计合理且完整
442
+ - 关键用户接触点识别准确
443
+ - 用户流程逻辑清晰
444
+ - 潜在问题识别充分
445
+ - **使用建议**:
446
+ - **所有产品需求文档撰写都必须完成此阶段**
447
+ - 完成用户旅程草稿后再进入正式的需求文档撰写流程
448
+ - 用户旅程草稿内容将作为后续详细设计的重要参考
449
+
450
+ #### 阶段一:需求探索与定义
451
+
452
+ - **目标**: 明确产品要解决的核心问题、目标用户和市场机会。这是所有后续工作的基础。
453
+ - **对应执行流程**: 阶段一:需求探索与定义阶段
454
+ - **核心活动**:
455
+ - **模板读取**: 读取 [需求收集](../intake/SKILL.md)、[市场机会评估与竞争分析模板](../intake/template/市场机会评估与竞争分析模板.md)、[深度用户行为与需求洞察模板](../intake/template/深度用户行为与需求洞察模板.md) 等模板文档
456
+ - **需求来源识别**: 从用户反馈、市场调研、竞品分析、内部业务需求、技术趋势等渠道收集原始需求。
457
+ - **需求分析与验证**:
458
+ - 使用**KANO模型**分析需求对用户满意度的影响。
459
+ - 通过**用户访谈**和**问卷调查**验证需求真伪。
460
+ - 运用**用户故事映射**将宏观需求转化为具体场景。
461
+ - **优先级排序**: 采用**优先级矩阵**或**影响力/工作量分析**对需求进行排序。
462
+ - **关键产出**:
463
+ - 市场分析报告
464
+ - 用户画像 (User Persona) 与用户旅程图
465
+ - 经过验证和排序的需求列表
466
+ - **Review与确认**:
467
+ - **暂停执行,等待人工确认**
468
+ - 产品团队review需求分析结果
469
+ - 确认目标用户和市场定位
470
+ - 验证需求优先级排序的合理性
471
+ - 只有在获得人工确认后,才继续执行后续流程
472
+ - **参考工具与指南**:
473
+ - [需求收集](../intake/SKILL.md)
474
+ - [市场机会评估与竞争分析模板](../intake/template/市场机会评估与竞争分析模板.md)
475
+ - [深度用户行为与需求洞察模板](../intake/template/深度用户行为与需求洞察模板.md)
476
+ > **提示**:请根据具体需求读取这些模板文档,了解详细的分析框架和工具使用方法
477
+
478
+ #### 阶段二:核心内容撰写
479
+
480
+ - **目标**: 基于第一阶段的分析,使用模块化模板撰写需求文档的核心内容,形成初稿。
481
+ - **对应执行流程**: 阶段二:核心内容撰写阶段
482
+ - **核心活动**:
483
+ - **模板读取**: 首先读取 [需求文档模板索引](./template/index.md) 了解整体结构,然后读取 [第一部分:产品定位与分析](./template/1_产品定位与分析.md) 和 [第二部分:功能需求](./template/2_功能需求.md) 模板
484
+ - **文档生成**: 严格按照模板结构生成产品定位分析和功能需求文档
485
+ - **文档信息**: 填写版本、作者等基本信息。
486
+ - **产品概述**: 描述产品背景、市场定位、愿景目标和核心价值。
487
+ - **用户与市场**: 详细描述目标用户、用户角色和市场分析。
488
+ - **功能与非功能需求**: 定义核心功能列表、详细描述及优先级,并明确性能、安全、兼容性等非功能要求。特别注意多语言支持需求(英文、日文、韩文)。
489
+ - **AI功能体验要求**: 如果产品涉及AI功能,必须按照 [4.6 AI体验感标准](#46-ai体验感标准) 的要求进行功能设计,确保用户输入简化、输出透明、支持迭代优化。
490
+ - **关键产出**:
491
+ - 包含产品定位分析和功能需求的PRD初稿 (v0.1)。
492
+ - **Review与确认**:
493
+ - **暂停执行,等待人工确认**
494
+ - 产品经理review文档结构和内容完整性
495
+ - 确认功能需求描述的准确性和可执行性
496
+ - 验证非功能需求的合理性
497
+ - 验证AI功能体验要求的合理性(如适用)
498
+ - 只有在获得人工确认后,才继续执行后续流程
499
+ - **参考模板**:
500
+ - [第一部分:产品定位与分析](./template/1_产品定位与分析.md)
501
+ - [第二部分:功能需求](./template/2_功能需求.md)
502
+ > **提示**:撰写需求文档时,请务必先读取这两个模板文档,了解具体的文档结构和内容要求
503
+
504
+ #### 阶段三:方案细化与评审
505
+
506
+ - **目标**: 协同设计和开发团队,将需求转化为具体的方案,并通过评审达成共识。
507
+ - **对应执行流程**: 阶段三:方案细化与评审阶段
508
+ - **核心活动**:
509
+ - **模板读取**: 读取 [第三部分:商业化策略](./template/3_商业化策略.md) 和 [第四部分:用户界面与体验](./template/4_用户界面与体验.md) 模板
510
+ - **商业化策略设计**: 设计商业化模式、IAA和IAP策略、定价策略、功能分层等。
511
+ - **用户界面设计**: 绘制信息架构图(使用Mermaid图表)、用户流程图,设计线框图和高保真原型,评估技术可行性。
512
+ - **AI交互设计**: 如果产品涉及AI功能,必须按照 [4.6 AI体验感标准](#46-ai体验感标准) 设计AI交互界面,确保输入简化、输出透明、支持迭代优化。
513
+ - **界面文案补充**: 为每个界面添加“界面文案 (Interface Copy)”小节,包含该界面所需的英文用户界面文案。可沿用现有需求文档模板中的写法,保持语调一致,尤其要覆盖 IAP 付费页面的文案要求。
514
+ > **提示**:请读取此模板文档,了解界面文案的具体格式要求和生成方法
515
+ - **组织评审**: 邀请所有利益相关者(产品、设计、开发、测试等)进行正式评审。详见 **第5节:需求文档评审**。
516
+ - **关键产出**:
517
+ - 商业化策略与定价方案
518
+ - 交互原型与UI设计稿
519
+ - AI交互设计方案(如适用)
520
+ - 评审会议纪要
521
+ - 修订后的需求文档
522
+ - **Review与确认**:
523
+ - **暂停执行,等待人工确认**
524
+ - 跨部门评审会议(产品、设计、开发、测试、业务)
525
+ - 确认技术可行性和资源需求
526
+ - 验证商业化策略的合理性
527
+ - 验证AI交互设计的合理性(如适用)
528
+ - 达成团队共识并记录决策
529
+ - 只有在获得人工确认后,才继续执行后续流程
530
+ - **参考模板**:
531
+ - [第三部分:商业化策略](./template/3_商业化策略.md)
532
+ - [第四部分:用户界面与体验](./template/4_用户界面与体验.md)
533
+ > **提示**:请根据当前任务需要,读取相应的模板文档,了解具体的撰写要求和格式规范
534
+
535
+ #### 阶段四:定稿与发布
536
+
537
+ - **目标**: 完成最终版需求文档,并正式发布给项目团队。
538
+ - **对应执行流程**: 阶段四:定稿与发布阶段
539
+ - **核心活动**:
540
+ - 获取关键利益相关者的最终批准。
541
+ - 将文档归档,并通知所有团队成员。
542
+ - 制定并沟通后续的变更管理流程。详见 **第6节:需求变更管理**。
543
+ - **关键产出**:
544
+ - 最终版产品需求文档 (PRD v1.0)
545
+ - **Review与确认**:
546
+ - **暂停执行,等待人工确认**
547
+ - 产品负责人最终review和批准
548
+ - 确认文档完整性和准确性
549
+ - 正式发布并通知所有相关团队
550
+ - 只有在获得人工确认后,才完成最终发布
551
+
552
+ ## 4. 需求文档撰写原则
553
+
554
+ ### 4.1 清晰性
555
+
556
+ - 使用简洁明了的语言,避免模糊和歧义的表述。
557
+ - 使用标准化的术语,并在附录中提供术语表。
558
+ - 提供具体的例子和场景。
559
+
560
+ ### 4.2 完整性
561
+
562
+ - 覆盖所有必要的产品方面,包括边界条件和异常情况。
563
+ - 明确说明约束和限制。
564
+
565
+ ### 4.3 可验证性
566
+
567
+ - 需求应该是可测试的,提供明确的验收标准。
568
+ - 避免主观和无法量化的描述,使用具体的指标和数值。
569
+
570
+ ### 4.4 一致性
571
+
572
+ - 保持文档内部以及与其他产品文档的一致性。
573
+ - 使用统一的格式和模板。
574
+
575
+ ### 4.5 可追溯性
576
+
577
+ - 为每个需求分配唯一标识符,记录其来源和理由。
578
+ - 建立需求之间的关联关系,并记录变更历史。
579
+
580
+ ### 4.6 AI体验感标准
581
+
582
+ **重要提示**:当产品涉及AI功能时,必须遵循以下AI体验感标准,确保用户获得流畅、直观的AI交互体验。
583
+
584
+ #### 4.6.1 用户输入简化原则
585
+
586
+ - **最小化输入**:用户的输入要尽量简单、符合直觉,用户的输入越少越好,步骤越短越好
587
+ - **智能预判**:基于用户历史行为和上下文,智能预判用户意图,减少用户输入需求
588
+ - **渐进式输入**:采用渐进式输入方式,先收集核心信息,再根据需要进行补充
589
+
590
+ #### 4.6.2 AI输出透明度原则
591
+
592
+ - **过程可视化**:如果涉及到AI的输出,输出的过程应该尽量透明,清晰体现过程的步骤甚至中间结果(如果能有的话)
593
+ - **实时反馈**:在AI处理过程中提供实时进度反馈,让用户了解当前处理状态
594
+ - **中间结果展示**:在可能的情况下,展示AI处理的中间步骤和思考过程
595
+
596
+ #### 4.6.3 迭代式改进原则
597
+
598
+ - **支持迭代式改进**:用户可以在现有的结果基础上进行编辑、优化,编辑过程需要的用户的输入依然要尽量简单、符合直觉
599
+ - **增量优化**:支持用户对AI输出结果进行增量式修改,而不是重新生成
600
+ - **智能建议**:在用户编辑过程中,提供智能建议和优化选项
601
+
602
+ #### 4.6.4 应用场景
603
+
604
+ 这些AI体验感标准应在以下文档部分中具体体现:
605
+
606
+ - **用户旅程设计**:在用户旅程草稿和核心用户旅程中体现AI交互流程
607
+ - **功能需求描述**:在功能需求文档中明确AI功能的交互要求
608
+ - **界面设计规范**:在用户界面与体验设计中体现AI交互界面要求
609
+ - **交互设计原则**:在交互设计部分详细说明AI交互的具体实现方式
610
+
611
+ ## 5. 需求文档评审
612
+
613
+ 需求文档评审是确保文档质量和团队共识的关键环节。关于详细的评审流程、标准和最佳实践,请参阅 [需求评审](../review/SKILL.md) 文档。
614
+
615
+ > **提示**:该文档包含了完整的评审框架、检查清单、AI辅助评审方法等详细内容
616
+
617
+ ## 6. 工具和资源
618
+
619
+ ### 6.1 AI辅助工具
620
+
621
+ - **Prompt生成工具**: [Prompt生成](../../tool_prompts/Prompt生成.md) - 用于生成高质量的AI Prompt
622
+ - **文档更新标记工具**: [标记文档更新](../../tool_prompts/标记文档更新.md) - 自动标记文档中的更新内容
623
+ - **图表生成工具**: [生成DrawIO文档](../../tool_prompts/生成DrawIO文档.md) - 自动生成DrawIO图表代码
624
+ - **AI体验设计工具**: [AI体验设计指南](../../tool_prompts/AI体验设计指南.md) - 用户输入简单需求,生成符合AI体验标准的交互设计指导
625
+ - **需求变动说明工具**: [需求变动说明工具](../changes/SKILL.md) (`@requirements-changes`) - 用于检查和记录需求文档的变化,生成变化日志文档
626
+
627
+ ### 6.2 模板和示例
628
+
629
+ **需求文档模板**:
630
+
631
+ - [需求文档模板索引](./template/index.md) - 包含快速草稿模板和四个模块化模板
632
+ - [产品需求草稿模板](./template/Draft_产品需求草稿.md) - 用于快速确定产品方向的简化模板
633
+ - [第一部分:产品定位与分析](./template/1_产品定位与分析.md)
634
+ - [第二部分:功能需求](./template/2_功能需求.md)
635
+ - [第三部分:商业化策略](./template/3_商业化策略.md)
636
+ - [第四部分:用户界面与体验](./template/4_用户界面与体验.md)
637
+
638
+ **需求迭代模板**:
639
+
640
+ - [需求迭代模板](./template/需求迭代模板.md) - 完整的需求迭代模板
641
+ - [需求迭代索引模板](./template/需求迭代索引.md) - 需求迭代索引模板
642
+
643
+ **通用指南模板**:
644
+
645
+ - [指南文档标准模板](../../../docs/guide_writing_standard/template/指南文档标准模板.md) - 用于撰写各类标准指南。
646
+ - [工具使用指南模板](../../../docs/guide_writing_standard/template/工具使用指南模板.md) - 用于撰写工具类的使用说明。
647
+ > **提示**:如需撰写其他类型的指南文档,请参考这些标准模板
648
+
649
+ ### 6.3 文档输出规范
650
+
651
+ #### 6.3.1 文档存储位置和版本管理
652
+
653
+ **重要:需求文档的存储位置和版本管理规范**
654
+
655
+ **存储位置要求**:
656
+
657
+ - **优先选择**:如果项目中已存在 `docs` 文件夹,则在 `docs` 目录下创建 `requirements` 文件夹
658
+ - **备选方案**:如果项目中没有 `docs` 文件夹,则在项目根目录下创建 `requirements` 文件夹
659
+ - 在 `requirements` 文件夹下创建版本文件夹(默认为 `v1.0.0`)
660
+ - 将所有需求文档文件放置在对应的版本文件夹下
661
+
662
+ **文件夹结构初始化流程**:
663
+
664
+ 在开始生成需求文档前,必须完成以下文件夹结构检查和创建:
665
+
666
+ 1. **检查 requirements 文件夹**:
667
+ - 检查 `../requirements` 或项目根目录下的 `requirements` 文件夹是否存在
668
+ - 如果不存在,则创建对应的 `requirements` 文件夹
669
+
670
+ 2. **检查版本文件夹结构**:
671
+ - **⚠️ 重要:兼容性优先原则**:如果项目中已存在老结构(`requirements/versions/` 或 `requirements/Versions/`,忽略大小写),必须保持使用该结构,**不要迁移到新结构**
672
+ - **检查顺序**:
673
+ 1. **首先检查老结构**:检查是否存在 `requirements/versions/` 文件夹(忽略大小写),且该文件夹下存在版本文件夹(格式:`vX.X.X`)
674
+ - 如果存在,则**必须使用老结构**,不要创建新结构,不要迁移文件
675
+ 2. **然后检查新结构**:如果不存在老结构,检查 `requirements` 文件夹下是否存在版本文件夹(格式:`vX.X.X`)
676
+ - 如果存在,则使用新结构
677
+ 3. **创建新结构**:如果两种结构都不存在,则创建新结构 `requirements/v1.0.0/`(默认版本)
678
+ - **需求池文件夹**:无论使用哪种结构,都必须创建 `v0.0.0` 文件夹作为需求池,用于存放暂未安排版本的需求文档
679
+ - 如果已存在版本文件夹,则使用最新的版本文件夹,或根据需求创建新版本
680
+
681
+ 3. **检查版本文件夹下的子文件夹**:
682
+ 在每个版本文件夹下,必须确保存在以下子文件夹:
683
+ - **`draft/`**:存放草稿文档(如产品需求草稿、用户旅程草稿等)
684
+ - **`archived/`**:存放已废弃的文档(保留历史记录但不再更新)
685
+ - **`assets/`**:存放素材文件(包括图片、设计资产等)
686
+ - **`reference/`**:存放参考资料(主要是外部的文档、研究报告等)
687
+ - **`changes/`**:存放变化日志文档(记录需求文档的变更历史)
688
+ - 如果这些子文件夹不存在,则必须创建
689
+
690
+ **目录结构示例**:
691
+
692
+ **新结构(推荐)**:版本文件夹直接位于 `skills/aipk_requirements` 下
693
+
694
+ **情况一:在 AI Product Kit 主仓库**
695
+
696
+ ```
697
+ 项目根目录/
698
+ ├── skills/
699
+ │ └── aipk_requirements/
700
+ │ ├── v0.0.0/ # 需求池(暂未安排版本的需求)
701
+ │ │ ├── draft/
702
+ │ │ ├── archived/
703
+ │ │ ├── assets/
704
+ │ │ ├── reference/
705
+ │ │ └── changes/
706
+ │ └── v1.0.0/ # 正式版本
707
+ │ ├── draft/ # 草稿文档
708
+ │ │ ├── Draft_产品需求草稿.md
709
+ │ │ └── Draft_用户旅程草稿.md
710
+ │ ├── archived/ # 已废弃的文档
711
+ │ ├── assets/ # 素材文件(图片、设计资产等)
712
+ │ ├── reference/ # 参考资料(外部文档、研究报告等)
713
+ │ ├── changes/ # 变化日志(需求文档变更记录)
714
+ │ │ └── YYYYMMDD_需求文档变动说明_版本范围.md
715
+ │ ├── index.md
716
+ │ ├── 1_产品定位与分析.md
717
+ │ ├── 2_功能需求.md
718
+ │ ├── 3_商业化策略.md
719
+ │ └── 4_用户界面与体验.md
720
+ └── 其他项目文件...
721
+ ```
722
+
723
+ **情况二:在业务仓库中落地(无 `skills/` 目录)**
724
+
725
+ ```
726
+ 项目根目录/
727
+ ├── requirements/
728
+ │ ├── v0.0.0/ # 需求池(暂未安排版本的需求)
729
+ │ │ ├── draft/
730
+ │ │ ├── archived/
731
+ │ │ ├── assets/
732
+ │ │ ├── reference/
733
+ │ │ └── changes/
734
+ │ └── v1.0.0/ # 正式版本
735
+ │ ├── draft/ # 草稿文档
736
+ │ │ ├── Draft_产品需求草稿.md
737
+ │ │ └── Draft_用户旅程草稿.md
738
+ │ ├── archived/ # 已废弃的文档
739
+ │ ├── assets/ # 素材文件(图片、设计资产等)
740
+ │ ├── reference/ # 参考资料(外部文档、研究报告等)
741
+ │ ├── changes/ # 变化日志(需求文档变更记录)
742
+ │ │ └── YYYYMMDD_需求文档变动说明_版本范围.md
743
+ │ ├── index.md
744
+ │ ├── 1_产品定位与分析.md
745
+ │ ├── 2_功能需求.md
746
+ │ ├── 3_商业化策略.md
747
+ │ └── 4_用户界面与体验.md
748
+ └── 其他项目文件...
749
+ ```
750
+
751
+ **老结构(兼容)**:版本文件夹位于 `requirements/versions/` 下(仅当已存在此结构时使用)
752
+
753
+ ```
754
+ 项目根目录/
755
+ ├── skills/
756
+ │ └── requirements/
757
+ │ └── versions/
758
+ │ ├── v0.0.0/ # 需求池(暂未安排版本的需求)
759
+ │ │ ├── draft/
760
+ │ │ ├── archived/
761
+ │ │ ├── assets/
762
+ │ │ ├── reference/
763
+ │ │ └── changes/
764
+ │ └── v1.0.0/ # 正式版本
765
+ │ ├── draft/
766
+ │ ├── archived/
767
+ │ ├── assets/
768
+ │ ├── reference/
769
+ │ ├── changes/
770
+ │ ├── index.md
771
+ │ └── ...
772
+ └── 其他项目文件...
773
+ ```
774
+
775
+ **结构选择规则**:
776
+
777
+ - **⚠️ 兼容性优先**:如果项目中已存在 `requirements/versions/` 结构(忽略大小写),**必须保持使用该结构**,不要迁移到新结构,不要改变已有的文件夹结构
778
+ - **新结构使用**:只有在完全不存在任何版本文件夹的情况下,才创建新结构 `requirements/vX.X.X/`
779
+ - **不混用**:同一项目中应统一使用一种结构,不要同时存在两种结构
780
+ - **不迁移**:如果已存在老结构,不要将文件迁移到新结构,保持原有结构不变
781
+ - **需求池文件夹**:无论使用哪种结构,都必须创建 `v0.0.0` 文件夹作为需求池,用于存放暂未安排版本的需求文档
782
+
783
+ **⚠️ 重要注意事项**:
784
+
785
+ - 根据项目中是否已存在 docs 文件夹来选择对应的存储位置,不要同时创建两个 requirements 文件夹
786
+ - **兼容性要求**:如果项目中已存在 `requirements/versions/` 结构(忽略大小写),**必须保持使用该结构**,不要迁移到新结构,不要改变已有的文件夹结构
787
+ - **结构检测**:检查时忽略大小写,`versions`、`Versions`、`VERSIONS` 都视为老结构
788
+ - **新结构创建**:只有在完全不存在任何版本文件夹的情况下,才创建新结构 `requirements/vX.X.X/`
789
+
790
+ **版本管理规范**:
791
+
792
+ - 使用语义化版本号(如 v1.0.0、v1.1.0、v2.0.0)
793
+ - **需求池版本**:`v0.0.0` 作为特殊版本号,用于存放暂未安排版本的需求文档
794
+ - 重大变更时递增主版本号
795
+ - 功能增加时递增次版本号
796
+ - 错误修复时递增修订版本号
797
+ - 每个版本创建独立的文件夹,保留历史版本
798
+ - 每个版本文件夹必须包含完整的子文件夹结构(draft、archived、assets、reference、changes)
799
+
800
+ **子文件夹用途说明**:
801
+
802
+ - **`draft/`**:存放所有草稿文档,包括产品需求草稿、用户旅程草稿等未正式确定的文档
803
+ - **`archived/`**:存放已废弃或不再使用的文档,保留历史记录但不再更新
804
+ - **`assets/`**:存放所有素材文件,包括图片、设计资产、UI组件示例等
805
+ - **`reference/`**:存放参考资料,包括外部文档、研究报告、竞品分析等参考资料
806
+ - **`changes/`**:存放变化日志文档,记录需求文档的变更历史。可以使用 [需求变动说明工具](../changes/SKILL.md) 来检查和记录变化
807
+
808
+ **变化日志管理**:
809
+
810
+ - **工具使用**:使用 `@requirements-changes` 工具来检查和记录需求文档的变化
811
+ - **文档生成**:参考 [需求变动说明生成指南](../changes/template/需求变动说明生成指南.md) 生成变化日志文档
812
+ - **文档命名**:变化日志文档命名格式为 `YYYYMMDD_需求文档变动说明_版本范围.md`,保存在对应版本文件夹下的 `changes/` 子文件夹中
813
+ - **文档内容**:变化日志应包含变动概述、Commit历史、文档级变动详情、功能维度变动分析、产品策略分析等
814
+
815
+ #### 6.3.2 文档文件结构要求
816
+
817
+ **重要:必须生成四个独立的文档文件,严格按照以下结构和命名规范:**
818
+
819
+ 1. **索引文件**:`index.md` - 提供各部分文档的导航和概览
820
+ - **作用**:通过 `index.md` 维护一个版本内的多个文档,作为版本文档的入口和导航中心
821
+ - **维护要求**:**必须保持更新**,当版本内添加、删除或修改文档时,需要同步更新 `index.md` 中的文档列表和链接
822
+ - **包含内容**:文档信息表格、修订历史、文档导航链接、文档概览说明
823
+ - **文档列表**:列出该版本下的所有文档,包括各部分文档、草稿文档、变化日志等
824
+ 2. **第一部分**:`1_产品定位与分析.md` - 基于研究报告的产品定位与市场分析
825
+ 3. **第二部分**:`2_功能需求.md` - 针对发现痛点的详细功能需求规格说明
826
+ 4. **第三部分**:`3_商业化策略.md` - 商业化模式、IAA和IAP策略、定价策略、功能分层
827
+ 5. **第四部分**:`4_用户界面与体验.md` - 符合用户洞察的界面与体验设计要求
828
+
829
+ #### 6.3.3 文档信息表格规范
830
+
831
+ **重要:文档信息表格和修订历史只在索引文档中包含**
832
+
833
+ - **索引文档** (`index.md`) 必须包含完整的文档信息表格和修订历史
834
+ - **索引文档维护**:`index.md` 是版本文档的管理中心,**必须保持更新**:
835
+ - 当添加新文档时,在 `index.md` 中添加文档链接和说明
836
+ - 当删除文档时,从 `index.md` 中移除对应条目
837
+ - 当文档状态变更时,更新 `index.md` 中的文档信息
838
+ - 当文档内容更新时,更新 `index.md` 中的修订历史
839
+ - **各部分文档** (1-5部分) 不包含文档信息表格和修订历史
840
+ - **文档信息表格格式**:
841
+
842
+ ```
843
+ ## 文档信息
844
+
845
+ | 项目 | 内容 |
846
+ |------|------|
847
+ | 版本号 | v1.0 |
848
+ | 作者 | [作者姓名] |
849
+ | 状态 | [草稿/审核中/已批准] |
850
+
851
+ ## 修订历史
852
+
853
+ | 版本 | 日期 | 描述 | 作者 |
854
+ |------|------|------|------|
855
+ | v0.1 | [日期] | 初稿 | [作者] |
856
+ | v0.2 | [日期] | [修改内容摘要] | [作者] |
857
+ | v1.0 | [日期] | 正式发布 | [作者] |
858
+ ```
859
+
860
+ #### 6.3.4 文档导航要求
861
+
862
+ - **索引文件** (`index.md`) 必须包含所有部分的链接和简要说明
863
+ - **文档列表维护**:`index.md` 应列出该版本下的所有文档,包括:
864
+ - 各部分正式文档(1-4部分)
865
+ - 草稿文档(位于 `draft/` 文件夹)
866
+ - 变化日志(位于 `changes/` 文件夹)
867
+ - 其他相关文档
868
+ - **保持更新**:当版本内文档发生变化时,**必须同步更新 `index.md`** 中的文档列表和链接
869
+ - **各部分文档**必须在开头包含导航链接,能够链接到前后文档
870
+ - **各部分文档**必须在结尾包含"上一部分"和"下一部分"的导航链接
871
+ - **Draft模板**不包含导航链接,作为独立文档使用,但应在 `index.md` 中列出
872
+
873
+ #### 6.3.5 UI草图要求
874
+
875
+ 在第四部分"用户界面与体验"中,**每个关键界面都必须包含UI草图**:
876
+
877
+ - 使用ASCII艺术或文字描述的方式绘制界面布局
878
+ - 包含主要界面元素的位置和功能说明
879
+ - 标注重要的交互流程和用户操作路径
880
+ - 确保草图与功能需求保持一致
881
+
882
+ **UI草图示例格式:**
883
+
884
+ ```
885
+ ┌─────────────────────────────────────┐
886
+ │ 应用标题栏 │
887
+ ├─────────────────────────────────────┤
888
+ │ [搜索框] [设置] │
889
+ ├─────────────────────────────────────┤
890
+ │ │
891
+ │ 主要功能区域 │
892
+ │ │
893
+ ├─────────────────────────────────────┤
894
+ │ [按钮1] [按钮2] [按钮3] │
895
+ └─────────────────────────────────────┘
896
+ ```
897
+
898
+ **界面分组要求**:
899
+
900
+ - 当界面数量超过5个时,建议按功能模块进行分组管理
901
+ - 每个分组包含相关界面的设计说明和UI草图
902
+ - 分组示例:引导页设计组(起始页、功能介绍页1-4)、主要功能界面组、设置界面组等
903
+ - 引导页设计必须包含起始页和3-4个功能介绍页,每页聚焦一个核心功能
904
+
905
+ #### 6.3.6 文档质量要求
906
+
907
+ 1. 符合团队协作标准的文档格式
908
+ 2. 确保需求文档与前期研究发现保持一致
909
+ 3. 基于提供的模板结构撰写完整内容
910
+ 4. 文档内容简洁明了,便于阅读和理解
911
+ 5. 前后内容保持统一,避免不一致情况
912
+ 6. 信息架构图使用Mermaid图表格式,确保清晰可读
913
+ 7. 界面文案使用英文,符合国际化要求
914
+ 8. 如果涉及AI功能,必须体现AI体验感标准,确保用户输入简化、输出透明、支持迭代优化
915
+
916
+ ## 7. 结语
917
+
918
+ 高质量的需求文档是成功产品开发的基础。通过遵循本指南中的原则和实践,产品团队可以创建清晰、完整且有价值的需求文档,为产品的设计和开发提供坚实的基础。记住,需求文档不仅仅是一份文档,它是团队共同理解和愿景的体现,是产品成功的关键要素之一。
919
+
920
+ **使用总结**
921
+
922
+ 在使用本指南时,请记住以下关键原则:
923
+
924
+ 1. **主动读取模板**:不要仅依赖本指南的概述,要根据具体任务主动读取相关的模板文档
925
+ 2. **理解模板结构**:在开始撰写前,先理解模板的完整结构和内容要求
926
+ 3. **遵循格式规范**:严格按照模板中的格式要求进行文档撰写
927
+ 4. **参考最佳实践**:结合模板中的示例和说明,确保文档质量
928
+ 5. **持续学习**:通过阅读多个相关模板,建立对需求文档撰写的全面理解
929
+
930
+ 本指南中的所有模板链接都是可访问的,请充分利用这些资源来提升需求文档的质量和准确性。