File tree Expand file tree Collapse file tree 1 file changed +74
-1
lines changed Expand file tree Collapse file tree 1 file changed +74
-1
lines changed Original file line number Diff line number Diff line change 144
144
145
145
## 实际应用示例
146
146
147
- 以下是在跨境物流平台开发中,如何使用规范生成不同类型的产品文档:
147
+ 在使用规范生成文档之前,建议先设置以下通用提示词参数:
148
+
149
+ ``` markdown
150
+ ## 通用参数设置
151
+ 文档管理:
152
+ - 存储位置:docs/{项目名称}/{文档类型}/{YYYY-MM-DD}-{文档名称}.md
153
+ - 文档类型分类:
154
+ - 需求文档:requirements/
155
+ - 设计文档:design/
156
+ - 规划文档:planning/
157
+ - 分析报告:analysis/
158
+ - 评审文档:review/
159
+ - 版本控制:
160
+ - 使用语义化版本号:v主版本.次版本.修订号
161
+ - 变更日志:CHANGELOG.md
162
+ - 文档模板:templates/
163
+ - 资源文件:assets/
164
+ - 图片:images/
165
+ - 原型图:prototypes/
166
+ - 流程图:flowcharts/
167
+
168
+ 命名规范:
169
+ - 文件名:小写字母、数字、连字符
170
+ - 图片名:{功能模块}-{用途}-{序号}
171
+ - 版本号:v1.0.0
172
+
173
+ 文档关联:
174
+ - 相关文档:在文档开头列出关联文档的相对路径
175
+ - 依赖关系:说明本文档依赖的其他文档
176
+ - 子文档:列出所有子文档的链接
177
+ ```
178
+
179
+ 以下是在跨境物流平台开发中的具体应用示例:
148
180
149
181
### 1. 功能需求文档生成
150
182
151
183
** 输入提示词** :
152
184
```
153
185
角色:跨境物流平台产品经理
154
186
任务:设计实时货物追踪功能的产品需求文档
187
+
188
+ 文档信息:
189
+ - 存储路径:docs/logistics-tracking/requirements/2024-03-20-realtime-tracking-spec.md
190
+ - 文档类型:需求文档
191
+ - 版本号:v1.0.0
192
+ - 关联文档:
193
+ - ../design/2024-03-15-tracking-system-architecture.md
194
+ - ../analysis/2024-03-10-market-research.md
195
+
196
+ 资源位置:
197
+ - 原型图:assets/prototypes/tracking-system/
198
+ - 流程图:assets/flowcharts/tracking-process/
199
+ - 时序图:assets/sequence/tracking-flow/
200
+
155
201
要求:
156
202
- 考虑不同运输方式(海运、空运、铁路)的追踪需求
157
203
- 包含各物流节点的状态定义
158
204
- 重点关注异常情况处理流程
159
205
- 提供清晰的数据指标
160
206
- 考虑多语言支持需求
161
207
- 整合各方物流数据
208
+
162
209
补充信息:
163
210
- 主要用户是货代公司和外贸企业
164
211
- 需要支持集装箱和散货追踪
165
212
- 系统需要对接主要船公司和航空公司的API
213
+
214
+ 文档格式:
215
+ - 使用标准Markdown格式
216
+ - 包含目录导航
217
+ - 图表使用Mermaid语法
218
+ - 代码示例使用代码块
166
219
```
167
220
168
221
### 2. 用户体验优化方案
171
224
```
172
225
角色:跨境物流平台产品经理
173
226
任务:优化货物追踪功能的用户体验
227
+
228
+ 文档信息:
229
+ - 存储路径:docs/logistics-tracking/design/2024-03-21-tracking-ux-optimization.md
230
+ - 文档类型:设计文档
231
+ - 版本号:v1.0.0
232
+ - 关联文档:
233
+ - ../requirements/2024-03-20-realtime-tracking-spec.md
234
+ - ../analysis/2024-03-18-user-feedback-analysis.md
235
+
236
+ 资源位置:
237
+ - 原型图:assets/prototypes/tracking-ux/
238
+ - 用户旅程:assets/flowcharts/user-journey/
239
+ - 交互设计:assets/interaction/tracking-ui/
240
+
174
241
关注点:
175
242
- 用户痛点分析
176
243
- 界面交互优化
177
244
- 信息展示层级
178
245
- 操作流程简化
179
246
- 多端适配方案
247
+
180
248
用户场景:
181
249
- 货代每天需要查看100+票货物状态
182
250
- 客户经常需要分享追踪信息给下游客户
183
251
- 用户需要实时获取异常预警
184
252
- 经常需要导出追踪报告
253
+
254
+ 设计规范:
255
+ - 遵循公司UI设计规范
256
+ - 使用统一的组件库
257
+ - 保持交互一致性
185
258
```
186
259
187
260
### 3. 数据分析需求
You can’t perform that action at this time.
0 commit comments