@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.
- package/README.md +107 -0
- package/bin/setup.js +89 -0
- package/package.json +24 -0
- package/skills/aipk_design/GURU_AI.md +10 -0
- package/skills/aipk_design/SKILL.md +33 -0
- package/skills/aipk_design/auto_panel_splitter/SKILL.md +360 -0
- package/skills/aipk_design/auto_panel_splitter/scripts/auto_panel_splitter.js +399 -0
- package/skills/aipk_design/auto_panel_splitter/scripts/panel_asset_mapper.js +445 -0
- package/skills/aipk_development/GURU_AI.md +8 -0
- package/skills/aipk_development/SKILL.md +20 -0
- 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
- package/skills/aipk_init_project/SKILL.md +188 -0
- package/skills/aipk_init_project/scripts/check_agents.sh +55 -0
- package/skills/aipk_init_project/template/AGENTS_TEMPLATE.md +138 -0
- package/skills/aipk_operations/GURU_AI.md +10 -0
- package/skills/aipk_operations/SKILL.md +37 -0
- package/skills/aipk_operations/aso_new_release/SKILL.md +84 -0
- package/skills/aipk_operations/aso_new_release/references/aso-update-notes-prompt.md +196 -0
- package/skills/aipk_operations/aso_new_release/references/aso-update-notes-template.md +162 -0
- package/skills/aipk_requirements/GURU_AI.md +39 -0
- package/skills/aipk_requirements/SKILL.md +243 -0
- package/skills/aipk_requirements/changes/SKILL.md +196 -0
- package/skills/aipk_requirements/changes/template/index.md +30 -0
- 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
- 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
- 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
- package/skills/aipk_requirements/documentation/SKILL.md +930 -0
- 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
- package/skills/aipk_requirements/documentation/template/2_/345/212/237/350/203/275/351/234/200/346/261/202.md +67 -0
- 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
- 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
- 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
- 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
- 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
- package/skills/aipk_requirements/documentation/template/index.md +83 -0
- 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
- 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
- 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
- package/skills/aipk_requirements/initiative_planning/SKILL.md +407 -0
- package/skills/aipk_requirements/initiative_planning/template/SWOT/345/210/206/346/236/220/346/250/241/346/235/277.md +381 -0
- 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
- 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
- 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
- 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
- package/skills/aipk_requirements/intake/SKILL.md +260 -0
- 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
- 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
- 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
- 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
- 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
- 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
- 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
- package/skills/aipk_requirements/review/SKILL.md +218 -0
- package/skills/aipk_skill_generate/GURU_AI.md +8 -0
- package/skills/aipk_skill_generate/SKILL.md +259 -0
- package/skills/aipk_skill_generate/agent_skills_spec.md +79 -0
- 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
- package/skills/aipk_tool_prompts/GURU_AI.md +13 -0
- package/skills/aipk_tool_prompts/Prompt/347/224/237/346/210/220.md +20 -0
- package/skills/aipk_tool_prompts/SKILL.md +55 -0
- package/skills/aipk_tool_prompts/images/20250710200701.png +0 -0
- package/skills/aipk_tool_prompts/images/20250710200802.png +0 -0
- 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
- package/skills/aipk_tool_prompts//347/224/237/346/210/220DrawIO/346/226/207/346/241/243.md +45 -0
|
@@ -0,0 +1,243 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: requirements
|
|
3
|
+
description: Central repository for requirement discovery, documentation, review, and change management assets.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# 需求阶段资料库
|
|
7
|
+
|
|
8
|
+
## 1. 概述
|
|
9
|
+
|
|
10
|
+
本文档库是产品需求收集与管理的核心枢纽,旨在为产品团队提供一套完整、标准化的需求工作流程。这里汇集了从市场研究、用户洞察到需求文档撰写及评审的全流程指南、工具和模板。
|
|
11
|
+
|
|
12
|
+
通过遵循本库定义的规范,团队可以:
|
|
13
|
+
|
|
14
|
+
- **提升效率**:利用先进的工具和标准化的模板,快速进行需求收集与分析。
|
|
15
|
+
- **保证质量**:通过统一的文档规范和评审流程,确保需求文档的清晰、完整和一致。
|
|
16
|
+
- **促进协作**:为产品、研发、设计等团队提供共同的语言和协作基础。
|
|
17
|
+
|
|
18
|
+
## 2. 文档结构
|
|
19
|
+
|
|
20
|
+
本目录包含以下核心部分,请根据您的需要查阅:
|
|
21
|
+
|
|
22
|
+
### 2.1 [需求收集](./intake/)
|
|
23
|
+
|
|
24
|
+
本部分提供了进行高效需求研究所需的工具、方法论和模板。内容涵盖市场分析、竞品追踪、用户洞察等。
|
|
25
|
+
|
|
26
|
+
- **核心文档**: `[需求收集](./intake/SKILL.md)` - 详细介绍了如何结合使用 Gemini DeepResearch 和各类数据平台进行深度研究。
|
|
27
|
+
|
|
28
|
+
### 2.2 [立项规划](./initiative_planning/)
|
|
29
|
+
|
|
30
|
+
本部分提供了产品立项阶段的规划方法和工具,帮助团队在项目启动前进行全面的分析和规划。
|
|
31
|
+
|
|
32
|
+
- **核心文档**: `[立项规划](./initiative_planning/SKILL.md)` - 详细介绍了如何进行产品立项规划。
|
|
33
|
+
|
|
34
|
+
### 2.3 [需求文档与迭代](./documentation/)
|
|
35
|
+
|
|
36
|
+
> ⚠️ 重要:在开始任何需求文档撰写前,请先查看模板选择指南
|
|
37
|
+
|
|
38
|
+
本部分提供了需求文档模板和需求迭代模板的统一指南,帮助正确选择适合的模板类型。
|
|
39
|
+
|
|
40
|
+
- **核心文档**: `[需求文档与迭代模板指南](./documentation/SKILL.md)` - 包含模板选择决策树、确认流程和两个模板的执行流程。
|
|
41
|
+
- **适用场景**:
|
|
42
|
+
- 需求文档模板:新产品开发(从0到1)、重大功能模块开发、需要完整产品规划的场景
|
|
43
|
+
- 需求迭代模板:现有功能优化迭代、小功能新增或修改、基于现有产品的功能改进
|
|
44
|
+
|
|
45
|
+
### 2.4 [需求评审](./review/)
|
|
46
|
+
|
|
47
|
+
本部分详细说明了需求评审的流程、标准和最佳实践,以确保需求的有效性、可行性和商业价值。
|
|
48
|
+
|
|
49
|
+
- **核心文档**: `[需求评审](./review/SKILL.md)` - 指导团队如何进行高效的需求评审会议。
|
|
50
|
+
|
|
51
|
+
## 3. 工作流程建议
|
|
52
|
+
|
|
53
|
+
一个标准的需求处理流程如下:
|
|
54
|
+
|
|
55
|
+
1. **立项规划**: 遵循 `[立项规划](./initiative_planning/)` 的方法进行产品立项前的全面分析和规划。
|
|
56
|
+
|
|
57
|
+
**Prompt 模板示例:**
|
|
58
|
+
|
|
59
|
+
```md
|
|
60
|
+
你是一位资深的产品战略专家,需要基于项目背景进行全面的立项规划分析。
|
|
61
|
+
|
|
62
|
+
**项目背景**: {项目的基本背景和目标}
|
|
63
|
+
**产品定位**: {产品的初步定位}
|
|
64
|
+
**目标市场**: {目标市场描述}
|
|
65
|
+
|
|
66
|
+
请参考以下指南和模板进行立项规划:
|
|
67
|
+
- 立项指南: ./initiative_planning/SKILL.md
|
|
68
|
+
- SWOT分析模板: ./initiative_planning/template/SWOT分析模板.md
|
|
69
|
+
- 产品规划模板: ./initiative_planning/template/产品规划模板.md
|
|
70
|
+
- 技术规划模板: ./initiative_planning/template/技术规划模板.md
|
|
71
|
+
- 商业化规划模板: ./initiative_planning/template/商业化规划模板.md
|
|
72
|
+
|
|
73
|
+
**输出要求**:
|
|
74
|
+
1. 进行SWOT分析,识别项目的优势、劣势、机会和威胁
|
|
75
|
+
2. 制定详细的产品规划和技术规划
|
|
76
|
+
3. 设计商业化策略和盈利模式
|
|
77
|
+
4. 评估项目可行性和风险
|
|
78
|
+
5. 输出完整的立项规划文档
|
|
79
|
+
|
|
80
|
+
请开始你的立项规划分析。
|
|
81
|
+
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
2. **研究与发现**: 遵循 `[需求收集](./intake/)` 的方法进行市场和用户研究,发现机会点。
|
|
85
|
+
|
|
86
|
+
**Prompt 模板示例:**
|
|
87
|
+
|
|
88
|
+
```md
|
|
89
|
+
你是一位资深的产品经理和市场研究专家。请基于以下信息进行深度的产品需求发现与验证:
|
|
90
|
+
|
|
91
|
+
**研究目标**: {具体的研究目标,如"分析K12在线教育市场的用户痛点"}
|
|
92
|
+
**目标用户**: {目标用户群体描述}
|
|
93
|
+
**产品领域**: {产品所属领域}
|
|
94
|
+
**基本假设**: {初步的产品假设或需求}
|
|
95
|
+
|
|
96
|
+
请参考以下指南和模板进行研究:
|
|
97
|
+
- 需求收集指南: ./intake/SKILL.md
|
|
98
|
+
- 产品需求发现与验证模板: ./intake/template/产品需求发现与验证模板.md
|
|
99
|
+
- 市场机会评估与竞争分析模板: ./intake/template/市场机会评估与竞争分析模板.md
|
|
100
|
+
- 深度用户行为与需求洞察模板: ./intake/template/深度用户行为与需求洞察模板.md
|
|
101
|
+
|
|
102
|
+
**输出要求**:
|
|
103
|
+
1. 使用 Gemini DeepResearch 等工具进行深度市场调研
|
|
104
|
+
2. 分析竞品情况和市场机会
|
|
105
|
+
3. 识别用户痛点和需求缺口
|
|
106
|
+
4. 提供数据支撑的洞察结论
|
|
107
|
+
5. 输出结构化的研究报告
|
|
108
|
+
|
|
109
|
+
请开始你的研究分析。
|
|
110
|
+
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
3. **撰写与定义**: 遵循 `[需求文档](./documentation/)` 的规范,将需求撰写成结构化的文档。
|
|
114
|
+
|
|
115
|
+
**Prompt 模板示例:**
|
|
116
|
+
|
|
117
|
+
```md
|
|
118
|
+
你是一位经验丰富的产品经理,需要基于第2步"研究与发现"的产出结果,将研究发现转化为标准化的产品需求文档。
|
|
119
|
+
|
|
120
|
+
**前期研究成果**(来自第2步产出):
|
|
121
|
+
{研究报告内容} - 请在此处引用第2步"研究与发现"环节产出的完整研究报告内容,包括市场分析、竞品分析、用户洞察、痛点识别等关键发现
|
|
122
|
+
|
|
123
|
+
**基础信息**:
|
|
124
|
+
- 产品名称: {产品名称}
|
|
125
|
+
- 目标用户: {目标用户群体}
|
|
126
|
+
- 核心功能: {核心功能描述}
|
|
127
|
+
|
|
128
|
+
请严格按照以下指南和模板,基于上述研究成果撰写需求文档:
|
|
129
|
+
- 撰写指南: ./documentation/SKILL.md
|
|
130
|
+
- 需求文档模板: ./documentation/template/index.md
|
|
131
|
+
- 产品定位模板: ./documentation/template/1_产品定位与分析.md
|
|
132
|
+
- 功能需求模板: ./documentation/template/2_功能需求.md
|
|
133
|
+
- 用户界面模板: ./documentation/template/4_用户界面与体验.md
|
|
134
|
+
- 技术架构模板: ./documentation/template/5_技术架构与实施计划.md
|
|
135
|
+
- 运营计划模板: ./documentation/template/6_运营计划.md
|
|
136
|
+
- 风险评估模板: ./documentation/template/7_风险评估与成功指标.md
|
|
137
|
+
|
|
138
|
+
**埋点需求规范**(如需求中包含埋点设计):
|
|
139
|
+
- 埋点规范文档: ./documentation/template/埋点规范文档.md - **必读**:优先复用已有事件和参数名
|
|
140
|
+
|
|
141
|
+
**输出要求**:
|
|
142
|
+
请严格按照以下指南和模板撰写需求文档:
|
|
143
|
+
|
|
144
|
+
1. **基于研究报告的产品定位与市场分析**
|
|
145
|
+
2. **针对发现痛点的详细功能需求规格说明**
|
|
146
|
+
3. **符合用户洞察的界面与体验设计要求**
|
|
147
|
+
4. **可执行的技术架构与实施计划**
|
|
148
|
+
5. **完整的运营计划与推广策略**
|
|
149
|
+
6. **全面的风险评估与成功指标**
|
|
150
|
+
7. **符合团队协作标准的文档格式**
|
|
151
|
+
|
|
152
|
+
确保需求文档与前期研究发现保持一致,并基于提供的模板结构撰写完整的产品需求文档。
|
|
153
|
+
|
|
154
|
+
**注意:具体的文档输出规范请参考 ./documentation/SKILL.md 中的"文档输出规范"部分。**
|
|
155
|
+
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
4. **评审与确认**: 遵循 `[需求评审](./review/)` 的流程,对需求文档进行评审,达成共识。
|
|
159
|
+
|
|
160
|
+
**Prompt 模板示例:**
|
|
161
|
+
|
|
162
|
+
```md
|
|
163
|
+
你是一位资深的产品评审专家,需要基于第3步"撰写与定义"的产出结果,对已完成的产品需求文档进行全面的评审和确认。
|
|
164
|
+
|
|
165
|
+
**待评审的需求文档**(来自第3步产出):
|
|
166
|
+
{需求文档内容} - 请在此处引用第3步"撰写与定义"环节产出的完整需求文档内容,包括产品定位、功能需求、用户体验设计、实施计划等所有章节
|
|
167
|
+
|
|
168
|
+
**评审范围**: {评审的具体范围,如功能完整性、技术可行性等}
|
|
169
|
+
**参与角色**: {评审参与的角色,如产品、技术、设计、运营等}
|
|
170
|
+
|
|
171
|
+
请参考以下评审指南,基于上述需求文档进行系统性评审:
|
|
172
|
+
- 评审指南: ./review/SKILL.md
|
|
173
|
+
|
|
174
|
+
**评审维度**:
|
|
175
|
+
1. **需求完整性**: 检查需求描述是否完整、清晰、无歧义
|
|
176
|
+
2. **商业价值**: 评估需求的商业价值和优先级合理性
|
|
177
|
+
3. **技术可行性**: 分析技术实现的可行性和复杂度
|
|
178
|
+
4. **用户体验**: 评估用户体验设计的合理性
|
|
179
|
+
5. **资源评估**: 确认开发资源和时间安排的合理性
|
|
180
|
+
6. **风险识别**: 识别潜在风险和应对措施
|
|
181
|
+
7. **一致性检查**: 确认需求文档与前期研究发现的一致性
|
|
182
|
+
|
|
183
|
+
**输出要求**:
|
|
184
|
+
1. 基于具体需求文档内容的结构化评审意见和建议
|
|
185
|
+
2. 需求优先级的确认或调整建议
|
|
186
|
+
3. 技术实现方案的确认
|
|
187
|
+
4. 明确的后续行动计划
|
|
188
|
+
5. 各方达成的共识记录
|
|
189
|
+
|
|
190
|
+
请基于提供的需求文档内容进行详细评审,并提供具体的评审报告。
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
5. **迭代管理**: 参见 2.3 需求文档与迭代,迭代为文档流程的一部分。根据适用场景选择模板:
|
|
194
|
+
- **需求文档模板**:适用于新产品开发(从0到1)、重大功能模块开发、需要完整产品规划的场景
|
|
195
|
+
- **需求迭代模板**:适用于现有功能优化迭代、小功能新增或修改、基于现有产品的功能改进
|
|
196
|
+
|
|
197
|
+
**Prompt 模板示例:**
|
|
198
|
+
|
|
199
|
+
```md
|
|
200
|
+
你是一位资深的产品经理,需要基于前期研究和现有产品状态,撰写需求迭代文档。请根据场景选择合适模板:
|
|
201
|
+
- 如果是新产品或重大功能模块:使用需求文档模板
|
|
202
|
+
- 如果是现有功能优化或小功能改进:使用需求迭代模板
|
|
203
|
+
|
|
204
|
+
**迭代背景**: {迭代的具体背景和原因}
|
|
205
|
+
**目标功能**: {需要迭代的功能模块}
|
|
206
|
+
**用户反馈或研究数据**: {用户反馈、数据分析结果或前期研究产出}
|
|
207
|
+
|
|
208
|
+
请参考以下指南和模板进行迭代规划:
|
|
209
|
+
- 需求文档与迭代指南: ./documentation/SKILL.md
|
|
210
|
+
- 需求文档模板: ./documentation/template/index.md(适用于新产品/重大功能)
|
|
211
|
+
- 需求迭代模板: ./documentation/template/需求迭代模板.md(适用于功能优化/小功能改进)
|
|
212
|
+
|
|
213
|
+
**埋点需求规范**(如需求中包含埋点设计,如需求迭代模板的3.6节):
|
|
214
|
+
- 埋点规范文档: ./documentation/template/埋点规范文档.md - **必读**:优先复用已有事件和参数名
|
|
215
|
+
|
|
216
|
+
**输出要求**:
|
|
217
|
+
1. 分析当前功能的问题和优化机会(或新功能需求)
|
|
218
|
+
2. 制定具体的迭代方案和实施计划
|
|
219
|
+
3. 评估迭代的预期效果和风险
|
|
220
|
+
4. 输出结构化的迭代文档
|
|
221
|
+
|
|
222
|
+
请开始你的迭代规划分析。
|
|
223
|
+
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
---
|
|
227
|
+
|
|
228
|
+
## 4. 埋点需求规范
|
|
229
|
+
|
|
230
|
+
当需求文档中包含埋点设计(如需求迭代模板的3.6节)时,**必须参考埋点规范文档**:
|
|
231
|
+
|
|
232
|
+
- **埋点规范文档**: [`./documentation/template/埋点规范文档.md`](./documentation/template/埋点规范文档.md) - **必读**:包含已定义事件库和参数库,确保复用已有事件和参数名
|
|
233
|
+
|
|
234
|
+
**重要原则**:
|
|
235
|
+
|
|
236
|
+
1. 优先复用规范文档中的已有事件名和参数名
|
|
237
|
+
2. 新增事件或参数时,必须严格遵循命名规范
|
|
238
|
+
3. 确保埋点方案的一致性和可复用性
|
|
239
|
+
|
|
240
|
+
---
|
|
241
|
+
**相关资源**:
|
|
242
|
+
|
|
243
|
+
- [指南文档总规范](../../docs/guide_writing_standard/SKILL.md)
|
|
@@ -0,0 +1,196 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: requirements-changes
|
|
3
|
+
description: Templates, prompts, and procedures for documenting and reviewing requirement changes.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# 需求变动说明生成工具包
|
|
7
|
+
|
|
8
|
+
## 执行指南
|
|
9
|
+
|
|
10
|
+
**重要提示**: 本指南专为自动化文档生成设计,请严格按照以下规则执行:
|
|
11
|
+
|
|
12
|
+
### 执行原则
|
|
13
|
+
|
|
14
|
+
1. **严格遵循模板结构**: 使用模板时,必须完全按照模板的章节结构和内容格式,不得添加模板中未定义的章节
|
|
15
|
+
2. **内容完整性**: 模板中的所有章节都必须填写,不得跳过任何部分
|
|
16
|
+
3. **格式一致性**: 保持与模板相同的标题层级、编号格式和内容组织方式
|
|
17
|
+
4. **无额外内容**: 禁止在模板基础上添加任何额外的章节、说明或注释
|
|
18
|
+
|
|
19
|
+
### 模板使用流程
|
|
20
|
+
|
|
21
|
+
1. **结构遵循**: 严格按照模板的章节结构填写,不得添加或删除章节
|
|
22
|
+
2. **内容填写**: 逐章节填写实质性内容,确保每个章节都有明确的信息
|
|
23
|
+
3. **格式保持**: 保持与模板相同的标题层级、编号格式和内容组织方式
|
|
24
|
+
4. **质量检查**: 完成所有章节后,检查是否遗漏任何模板定义的章节
|
|
25
|
+
|
|
26
|
+
### 模板使用要求
|
|
27
|
+
|
|
28
|
+
- 必须填写所有主要章节(变动概述、Commit历史、文档级变动详情、功能维度变动分析、产品策略分析、附录)
|
|
29
|
+
- 根据变动特点选择适用的子章节,不适用的章节使用 `*略*` 标记
|
|
30
|
+
- 每个子部分都要有详细的变动说明
|
|
31
|
+
- 保持文档简洁,专注于核心内容
|
|
32
|
+
|
|
33
|
+
### 模板内容处理规则
|
|
34
|
+
|
|
35
|
+
1. **标题处理**: 将模板标题中的 `[版本号]` 替换为具体的版本信息
|
|
36
|
+
2. **占位符处理**: 将模板中的 `[内容]` 替换为实际内容,替换后不要保留中括号
|
|
37
|
+
3. **条件内容**: 根据变动特点选择适用的子章节,不适用的章节使用 `*略*` 标记
|
|
38
|
+
4. **可选内容**: 模板中标注为"可选"的内容,根据项目实际情况决定是否填写
|
|
39
|
+
5. **示例内容**: 模板中的示例内容应替换为实际项目相关内容
|
|
40
|
+
|
|
41
|
+
### 质量检查清单
|
|
42
|
+
|
|
43
|
+
- [ ] 文档标题已替换为具体的版本信息
|
|
44
|
+
- [ ] 所有模板章节都已填写
|
|
45
|
+
- [ ] 没有添加模板外的章节
|
|
46
|
+
- [ ] 标题层级与模板一致
|
|
47
|
+
- [ ] 内容格式与模板保持一致
|
|
48
|
+
- [ ] 没有多余的说明或注释
|
|
49
|
+
- [ ] 所有占位符已替换为实际内容
|
|
50
|
+
- [ ] 不适用的章节已使用 `*略*` 标记
|
|
51
|
+
- [ ] 条件内容已根据实际情况处理
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## 工具包说明
|
|
56
|
+
|
|
57
|
+
本文件夹包含统一的需求变动说明生成工具包,适用于所有场景的需求文档变更管理。
|
|
58
|
+
|
|
59
|
+
## 工具包使用
|
|
60
|
+
|
|
61
|
+
### [需求变动说明文档模板](./template/需求变动说明文档模板.md)
|
|
62
|
+
|
|
63
|
+
**适用场景**:
|
|
64
|
+
|
|
65
|
+
- 所有需求文档变更(重大功能、小功能、快速修复等)
|
|
66
|
+
- 跨团队协作项目
|
|
67
|
+
- 需要详细文档记录的项目
|
|
68
|
+
- 正式的产品迭代
|
|
69
|
+
|
|
70
|
+
**特点**:
|
|
71
|
+
|
|
72
|
+
- 结构完整,涵盖变动概述、Commit历史、文档级变动详情等各个方面
|
|
73
|
+
- 包含详细的功能维度变动分析、产品策略分析说明
|
|
74
|
+
- 提供完整的统计汇总和附录信息
|
|
75
|
+
- 适合长期项目管理和文档归档
|
|
76
|
+
- **文档标题**: 使用 `[版本号] 需求文档变动说明` 格式,应用时替换为具体的版本信息
|
|
77
|
+
|
|
78
|
+
### [需求变动说明生成指南](./template/需求变动说明生成指南.md)
|
|
79
|
+
|
|
80
|
+
**用途**:完整的生成指南文档,包含方法论和最佳实践
|
|
81
|
+
|
|
82
|
+
**包含内容**:
|
|
83
|
+
|
|
84
|
+
- 生成目标和准备工作
|
|
85
|
+
- 详细的分步骤生成指导
|
|
86
|
+
- 链接格式、图标使用等规范
|
|
87
|
+
- 质量检查清单
|
|
88
|
+
- 常见问题解答
|
|
89
|
+
- 工具和技巧
|
|
90
|
+
- 示例参考
|
|
91
|
+
|
|
92
|
+
**适用场景**:
|
|
93
|
+
|
|
94
|
+
- 第一次生成变动说明时阅读
|
|
95
|
+
- 需要了解完整流程和规范
|
|
96
|
+
- 遇到问题时查找解决方案
|
|
97
|
+
|
|
98
|
+
### [需求变动说明生成Prompt](./template/需求变动说明生成Prompt.md)
|
|
99
|
+
|
|
100
|
+
**用途**:AI辅助生成的Prompt集合
|
|
101
|
+
|
|
102
|
+
**包含内容**:
|
|
103
|
+
|
|
104
|
+
- 基础Prompt(快速生成)
|
|
105
|
+
- 增强Prompt(详细要求)
|
|
106
|
+
- 分步执行Prompt(复杂场景)
|
|
107
|
+
- 质量检查Prompt
|
|
108
|
+
- 使用示例
|
|
109
|
+
|
|
110
|
+
**适用场景**:
|
|
111
|
+
|
|
112
|
+
- 使用AI辅助生成文档
|
|
113
|
+
- 自动化生成基础内容
|
|
114
|
+
- 提高生成效率
|
|
115
|
+
|
|
116
|
+
## 文件命名规范
|
|
117
|
+
|
|
118
|
+
### 文档文件命名
|
|
119
|
+
|
|
120
|
+
**格式**: `YYYYMMDD_需求文档变动说明_旧commit至新commit.md`
|
|
121
|
+
|
|
122
|
+
**示例**:
|
|
123
|
+
|
|
124
|
+
- `20251017_需求文档变动说明_90cad63至fa5a716.md`
|
|
125
|
+
- `20251018_需求文档变动说明_v2.0.0至v2.1.0.md`
|
|
126
|
+
- `20251019_需求文档变动说明_HEAD至main.md`
|
|
127
|
+
|
|
128
|
+
**命名规则**:
|
|
129
|
+
|
|
130
|
+
- **日期**: 使用8位数字格式(YYYYMMDD),表示变动说明创建日期
|
|
131
|
+
- **功能模块**: 固定为"需求文档变动说明"
|
|
132
|
+
- **变动描述**: 简洁描述本次变动的版本范围,使用commit hash或版本号
|
|
133
|
+
|
|
134
|
+
### 文档标题格式
|
|
135
|
+
|
|
136
|
+
**格式**: `[版本号] 需求文档变动说明`
|
|
137
|
+
|
|
138
|
+
**示例**:
|
|
139
|
+
|
|
140
|
+
- `v2.1.0 需求文档变动说明`
|
|
141
|
+
- `v2.0.0至v2.1.0 需求文档变动说明`
|
|
142
|
+
- `90cad63至fa5a716 需求文档变动说明`
|
|
143
|
+
|
|
144
|
+
## 使用建议
|
|
145
|
+
|
|
146
|
+
### 模板使用原则
|
|
147
|
+
|
|
148
|
+
1. **统一标准**: 所有需求变动说明都使用统一模板,确保文档格式一致性
|
|
149
|
+
2. **灵活应用**: 根据变动特点选择适用的子章节,不适用的章节使用 `*略*` 标记
|
|
150
|
+
3. **内容完整**: 确保所有必填章节都有实质性内容
|
|
151
|
+
4. **格式规范**: 严格按照模板的格式要求填写内容
|
|
152
|
+
|
|
153
|
+
### 模板定制
|
|
154
|
+
|
|
155
|
+
- 可根据项目特点调整模板结构
|
|
156
|
+
- 可添加项目特定的字段和检查项
|
|
157
|
+
- 可结合团队工作流程优化模板
|
|
158
|
+
|
|
159
|
+
## 版本管理
|
|
160
|
+
|
|
161
|
+
- 模板版本号格式: v主版本.次版本
|
|
162
|
+
- 重大变更升级主版本号
|
|
163
|
+
- 小幅调整升级次版本号
|
|
164
|
+
- 保持向后兼容性
|
|
165
|
+
|
|
166
|
+
## 反馈建议
|
|
167
|
+
|
|
168
|
+
如有模板改进建议,请通过以下方式反馈:
|
|
169
|
+
|
|
170
|
+
- 提交Issue到项目仓库
|
|
171
|
+
- 发送邮件给文档维护者
|
|
172
|
+
- 在团队会议中讨论
|
|
173
|
+
|
|
174
|
+
---
|
|
175
|
+
|
|
176
|
+
## AI Agent 执行总结
|
|
177
|
+
|
|
178
|
+
**核心原则**: 严格按照模板结构执行,不添加、不删除、不修改模板定义的章节结构。
|
|
179
|
+
|
|
180
|
+
**执行步骤**:
|
|
181
|
+
|
|
182
|
+
1. 逐章节填写内容,替换所有占位符
|
|
183
|
+
2. 根据变动特点选择适用的子章节,不适用的使用 `*略*` 标记
|
|
184
|
+
3. 处理条件内容和可选内容
|
|
185
|
+
4. 进行质量检查,确保符合所有要求
|
|
186
|
+
|
|
187
|
+
**关键提醒**:
|
|
188
|
+
|
|
189
|
+
- 模板是标准化的文档结构,任何偏离都会影响文档的一致性和可读性
|
|
190
|
+
- 专注于内容质量,而非结构创新
|
|
191
|
+
- 如有疑问,优先遵循模板而非添加额外说明
|
|
192
|
+
|
|
193
|
+
---
|
|
194
|
+
|
|
195
|
+
**最后更新**: 2025-10-17
|
|
196
|
+
**维护者**: 需求文档管理团队
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# 需求变动说明索引(模板)
|
|
2
|
+
|
|
3
|
+
## 基本信息
|
|
4
|
+
|
|
5
|
+
| 项目 | 内容 |
|
|
6
|
+
|------|------|
|
|
7
|
+
| 版本号 | {{版本号}} |
|
|
8
|
+
| 状态 | {{状态: 草稿/审核中/已批准}} |
|
|
9
|
+
| 负责人 | {{负责人}} |
|
|
10
|
+
| 里程碑 | {{里程碑}} |
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## 需求变动说明
|
|
15
|
+
|
|
16
|
+
| 变动说明名称 | 文件路径 | 版本范围 | 状态 |
|
|
17
|
+
|-------------|----------|----------|------|
|
|
18
|
+
| {{变动说明名称}} | ./{{YYYYMMDD}}_需求文档变动说明_{{旧commit}}至{{新commit}}.md | {{版本范围}} | {{状态}} |
|
|
19
|
+
| {{变动说明名称}} | ./{{YYYYMMDD}}_需求文档变动说明_{{旧commit}}至{{新commit}}.md | {{版本范围}} | {{状态}} |
|
|
20
|
+
| {{变动说明名称}} | ./{{YYYYMMDD}}_需求文档变动说明_{{旧commit}}至{{新commit}}.md | {{版本范围}} | {{状态}} |
|
|
21
|
+
|
|
22
|
+
> 提示:对应文档应基于 `./需求变动说明文档模板.md` 生成,文档标题使用 `[版本号] 需求文档变动说明` 格式。
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## 备注
|
|
27
|
+
|
|
28
|
+
- 文件命名:`YYYYMMDD_需求文档变动说明_旧commit至新commit.md`
|
|
29
|
+
- 文档标题:使用 `[版本号] 需求文档变动说明` 格式,落地时替换为具体的版本信息
|
|
30
|
+
- 表格可按需增删行;未涉及的条目可留空或删除
|