@deppon/deppon-skills 2.4.16 → 2.4.20
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/dist/deppon-npm-skills/SKILL.md +7 -5
- package/dist/deppon-prd-generator/SKILL.md +273 -0
- package/dist/deppon-prd-generator/examples/README.md +17 -0
- package/dist/deppon-prd-generator/examples/app-shell-navigation/layout-spec.md +54 -0
- package/dist/deppon-prd-generator/examples/app-shell-navigation/pages/demo-form.html +57 -0
- package/dist/deppon-prd-generator/examples/app-shell-navigation/pages/demo-home.html +92 -0
- package/dist/deppon-prd-generator/examples/app-shell-navigation/pages/demo-list.html +47 -0
- package/dist/deppon-prd-generator/examples/app-shell-navigation/prd.md +164 -0
- package/dist/deppon-prd-generator/examples/app-shell-navigation/prototype.html +794 -0
- package/dist/deppon-prd-generator/examples/backend-list/prd.md +91 -0
- package/dist/deppon-prd-generator/examples/backend-list/prototype.html +369 -0
- package/dist/deppon-prd-generator/examples/data-dashboard/prd.md +127 -0
- package/dist/deppon-prd-generator/examples/data-dashboard/prototype.html +281 -0
- package/dist/deppon-prd-generator/examples/form-edit/prd.md +108 -0
- package/dist/deppon-prd-generator/examples/form-edit/prototype.html +280 -0
- package/dist/deppon-prd-generator/examples/form-preview/prd.md +106 -0
- package/dist/deppon-prd-generator/examples/form-preview/prototype.html +240 -0
- package/dist/deppon-prd-generator/examples/list-crud/prd.md +151 -0
- package/dist/deppon-prd-generator/examples/list-crud/prototype.html +1339 -0
- package/dist/deppon-prd-generator/examples/user-frontend/prd.md +86 -0
- package/dist/deppon-prd-generator/examples/user-frontend/prototype.html +223 -0
- package/dist/deppon-prd-generator/quick-reference.md +170 -0
- package/dist/deppon-prd-generator/template/app-shell-navigation-prd-template.md +180 -0
- package/dist/deppon-prd-generator/template/backend-form-edit-prd-template.md +116 -0
- package/dist/deppon-prd-generator/template/backend-form-preview-prd-template.md +112 -0
- package/dist/deppon-prd-generator/template/backend-list-prd-template.md +110 -0
- package/dist/deppon-prd-generator/template/data-prd-template.md +194 -0
- package/dist/deppon-prd-generator/template/user-frontend-prd-template.md +59 -0
- package/dist/deppon-prd-generator/workflow.md +269 -0
- package/dist/deppon-pro-form/SKILL.md +1 -1
- package/dist/deppon-pro-page-insert-detail-workflow/SKILL.md +94 -0
- package/dist/{deppon-pro-page-crud → deppon-pro-page-query-table-form}/SKILL.md +20 -7
- package/dist/deppon-pro-table/SKILL.md +5 -0
- package/package.json +1 -1
- package/dist/deppon-npm-prd/SKILL.md +0 -70
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
# [页面名称] PRD (产品需求文档)
|
|
2
|
+
|
|
3
|
+
> **生成时对照**:整页表单编辑类 PRD 生成前阅读本技能目录 `examples/form-edit/prd.md`(及将交付原型时的 `prototype.html`)。
|
|
4
|
+
|
|
5
|
+
> **交互原型链接(有 `prototype.html` 时必填)**:文首加入 `- **交互原型**:[打开 prototype.html](./prototype.html)`;仅无原型时删除。见 `SKILL.md`「PRD 与原型互链」。
|
|
6
|
+
|
|
7
|
+
## 1. 引言
|
|
8
|
+
|
|
9
|
+
### 1.1 背景
|
|
10
|
+
|
|
11
|
+
> 简要说明该元素/页面的核心定位、解决的问题、用户价值(控制在50字左右)。
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
[需求背景内容]
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
### 1.2 功能清单
|
|
18
|
+
|
|
19
|
+
> 以表格形式梳理出所有模块、功能点及功能描述。
|
|
20
|
+
>
|
|
21
|
+
> 功能清单不包含:页面顶栏、左侧菜单栏的样式、交互需求内容!
|
|
22
|
+
|
|
23
|
+
| 模块 | 功能点 | 功能描述 |
|
|
24
|
+
| ---------------- | -------------- | -------------- |
|
|
25
|
+
| `[功能模块标题]` | `[功能点标题]` | `[功能点描述]` |
|
|
26
|
+
|
|
27
|
+
## 2. 页面菜单与权限规划
|
|
28
|
+
|
|
29
|
+
### 2.1 页面菜单
|
|
30
|
+
|
|
31
|
+
> 参考菜单栏,描述页面菜单路径。仅描述菜单路径即可!不要做其他内容说明。
|
|
32
|
+
|
|
33
|
+
**菜单路径**:[一级菜单名称] / [二级菜单名称]
|
|
34
|
+
|
|
35
|
+
### 2.2 权限规划
|
|
36
|
+
|
|
37
|
+
> 表格呈现权限点规划,仅定义权限点、可执行操作范围、数据范围(如:个人数据/全量数据),不定义具体角色;
|
|
38
|
+
>
|
|
39
|
+
> **权限点规划的基本原则:**查看类操作归集在【查看】一个权限点;编辑类操作归集在【编辑】一个权限点;导出类操作归集在【导出】一个权限点。
|
|
40
|
+
|
|
41
|
+
| 权限点 | 操作范围 | 数据范围 |
|
|
42
|
+
| -------------- | ------------------ | ------------- |
|
|
43
|
+
| `[权限点名称]` | `[支持的操作名称]` | `[个人/全量]` |
|
|
44
|
+
|
|
45
|
+
## 3. [模块名称]需求说明
|
|
46
|
+
|
|
47
|
+
### 3.1 表单字段说明
|
|
48
|
+
|
|
49
|
+
> 按表单字段逐一描述,包含字段名称、类型、必填性、校验规则、默认值、说明等
|
|
50
|
+
|
|
51
|
+
| 字段名称 | 字段类型 | 必填 | 默认值 | 校验规则 | 说明 |
|
|
52
|
+
|---------|---------|------|--------|---------|------|
|
|
53
|
+
| `[字段名]` | `[文本/下拉/日期/数字等]` | 是/否 | `[默认值]` | `[校验规则,如:长度1-50,手机号格式等]` | `[字段说明]` |
|
|
54
|
+
|
|
55
|
+
### 3.2 字段详细说明
|
|
56
|
+
|
|
57
|
+
> 对每个字段进行更详细的说明,特别是有特殊逻辑的字段
|
|
58
|
+
|
|
59
|
+
#### 3.2.1 [字段名称]
|
|
60
|
+
|
|
61
|
+
- **字段说明**:[详细说明]
|
|
62
|
+
- **输入限制**:[具体限制]
|
|
63
|
+
- **校验规则**:
|
|
64
|
+
- 规则1:[描述]
|
|
65
|
+
- 规则2:[描述]
|
|
66
|
+
- **错误提示**:[校验失败时的提示信息]
|
|
67
|
+
|
|
68
|
+
### 3.3 字段联动逻辑
|
|
69
|
+
|
|
70
|
+
> 描述字段之间的联动关系,如:选择A后,B字段显示/隐藏、变为必填等
|
|
71
|
+
|
|
72
|
+
| 触发字段 | 触发条件 | 影响字段 | 影响效果 |
|
|
73
|
+
|---------|---------|---------|---------|
|
|
74
|
+
| `[字段A]` | `[选择某个值]` | `[字段B]` | `[显示/隐藏/必填/可选等]` |
|
|
75
|
+
|
|
76
|
+
### 3.4 操作按钮
|
|
77
|
+
|
|
78
|
+
#### 3.4.1 保存/提交
|
|
79
|
+
|
|
80
|
+
- **按钮位置**:表单底部
|
|
81
|
+
- **点击逻辑**:
|
|
82
|
+
1. 前端校验所有必填字段和格式校验
|
|
83
|
+
2. 校验失败:显示错误提示,光标定位到第一个错误字段
|
|
84
|
+
3. 校验通过:调用后端接口提交数据
|
|
85
|
+
4. 提交成功:显示成功提示,跳转至列表页
|
|
86
|
+
5. 提交失败:显示失败提示,保留表单数据
|
|
87
|
+
|
|
88
|
+
#### 3.4.2 取消
|
|
89
|
+
|
|
90
|
+
- **按钮位置**:保存按钮旁边
|
|
91
|
+
- **点击逻辑**:
|
|
92
|
+
1. 若表单有修改,弹出二次确认:"您有未保存的修改,确定要离开吗?"
|
|
93
|
+
2. 确认:跳转至列表页
|
|
94
|
+
3. 取消:停留在当前页面
|
|
95
|
+
|
|
96
|
+
#### 3.4.3 重置
|
|
97
|
+
|
|
98
|
+
- **按钮位置**:表单底部(可选)
|
|
99
|
+
- **点击逻辑**:
|
|
100
|
+
1. 弹出二次确认:"确定要重置表单吗?"
|
|
101
|
+
2. 确认:恢复所有字段为默认值
|
|
102
|
+
3. 取消:不做操作
|
|
103
|
+
|
|
104
|
+
## 4. 交互设计
|
|
105
|
+
|
|
106
|
+
### 4.1 全局交互
|
|
107
|
+
|
|
108
|
+
- **加载状态**:数据请求过程中需展示 Loading 状态。
|
|
109
|
+
- **空状态**:无数据时需展示统一的 Empty 状态图。
|
|
110
|
+
- **响应式**:页面需适配不同分辨率屏幕,保证内容不遮挡、不错位。
|
|
111
|
+
|
|
112
|
+
### 4.2 表单交互
|
|
113
|
+
|
|
114
|
+
- **实时校验**:字段失焦时进行校验,即时显示错误提示
|
|
115
|
+
- **必填标识**:必填字段前显示红色星号(*)
|
|
116
|
+
- **Tab键导航**:支持Tab键在字段间顺序切换
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
# [页面名称] PRD (产品需求文档)
|
|
2
|
+
|
|
3
|
+
> **生成时对照**:只读详情/预览类 PRD 生成前阅读本技能目录 `examples/form-preview/prd.md`(及将交付原型时的 `prototype.html`)。
|
|
4
|
+
|
|
5
|
+
> **交互原型链接(有 `prototype.html` 时必填)**:文首加入 `- **交互原型**:[打开 prototype.html](./prototype.html)`;仅无原型时删除。见 `SKILL.md`「PRD 与原型互链」。
|
|
6
|
+
|
|
7
|
+
## 1. 引言
|
|
8
|
+
|
|
9
|
+
### 1.1 背景
|
|
10
|
+
|
|
11
|
+
> 简要说明该元素/页面的核心定位、解决的问题、用户价值(控制在50字左右)。
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
[需求背景内容]
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
### 1.2 功能清单
|
|
18
|
+
|
|
19
|
+
> 以表格形式梳理出所有模块、功能点及功能描述。
|
|
20
|
+
>
|
|
21
|
+
> 功能清单不包含:页面顶栏、左侧菜单栏的样式、交互需求内容!
|
|
22
|
+
|
|
23
|
+
| 模块 | 功能点 | 功能描述 |
|
|
24
|
+
| ---------------- | -------------- | -------------- |
|
|
25
|
+
| `[功能模块标题]` | `[功能点标题]` | `[功能点描述]` |
|
|
26
|
+
|
|
27
|
+
## 2. 页面菜单与权限规划
|
|
28
|
+
|
|
29
|
+
### 2.1 页面菜单
|
|
30
|
+
|
|
31
|
+
> 参考菜单栏,描述页面菜单路径。仅描述菜单路径即可!不要做其他内容说明。
|
|
32
|
+
|
|
33
|
+
**菜单路径**:[一级菜单名称] / [二级菜单名称]
|
|
34
|
+
|
|
35
|
+
### 2.2 权限规划
|
|
36
|
+
|
|
37
|
+
> 表格呈现权限点规划,仅定义权限点、可执行操作范围、数据范围(如:个人数据/全量数据),不定义具体角色;
|
|
38
|
+
>
|
|
39
|
+
> **权限点规划的基本原则:**查看类操作归集在【查看】一个权限点;编辑类操作归集在【编辑】一个权限点;导出类操作归集在【导出】一个权限点。
|
|
40
|
+
|
|
41
|
+
| 权限点 | 操作范围 | 数据范围 |
|
|
42
|
+
| -------------- | ------------------ | ------------- |
|
|
43
|
+
| `[权限点名称]` | `[支持的操作名称]` | `[个人/全量]` |
|
|
44
|
+
|
|
45
|
+
## 3. [模块名称]需求说明
|
|
46
|
+
|
|
47
|
+
### 3.1 信息展示区域
|
|
48
|
+
|
|
49
|
+
> 描述页面展示的所有信息字段
|
|
50
|
+
|
|
51
|
+
| 字段名称 | 展示格式 | 说明 |
|
|
52
|
+
|---------|---------|------|
|
|
53
|
+
| `[字段名]` | `[文本/日期/金额/状态标签等]` | `[字段说明]` |
|
|
54
|
+
|
|
55
|
+
### 3.2 字段详细说明
|
|
56
|
+
|
|
57
|
+
> 对重要字段进行详细说明
|
|
58
|
+
|
|
59
|
+
#### 3.2.1 [字段名称]
|
|
60
|
+
|
|
61
|
+
- **字段说明**:[详细说明]
|
|
62
|
+
- **展示格式**:[具体格式,如:YYYY-MM-DD、¥#,##0.00等]
|
|
63
|
+
- **空值展示**:[空值时显示的内容,如:-、暂无等]
|
|
64
|
+
- **特殊规则**:[特殊展示规则,如:状态颜色、超长省略等]
|
|
65
|
+
|
|
66
|
+
### 3.3 操作按钮
|
|
67
|
+
|
|
68
|
+
> 描述页面上的操作按钮
|
|
69
|
+
|
|
70
|
+
| 按钮名称 | 按钮位置 | 点击逻辑 | 权限要求 |
|
|
71
|
+
|---------|---------|---------|---------|
|
|
72
|
+
| `[编辑]` | `[页面右上角/底部等]` | `[跳转至编辑页面]` | `[需要编辑权限]` |
|
|
73
|
+
| `[删除]` | `[页面右上角/底部等]` | `[弹出二次确认,确认后删除]` | `[需要删除权限]` |
|
|
74
|
+
| `[返回]` | `[页面左上角/底部等]` | `[返回上一页/列表页]` | `[无权限要求]` |
|
|
75
|
+
|
|
76
|
+
#### 3.3.1 编辑按钮
|
|
77
|
+
|
|
78
|
+
- **按钮样式**:主按钮样式
|
|
79
|
+
- **点击逻辑**:
|
|
80
|
+
1. 校验编辑权限
|
|
81
|
+
2. 有权限:跳转至编辑页面,携带当前记录ID
|
|
82
|
+
3. 无权限:显示无权限提示
|
|
83
|
+
|
|
84
|
+
#### 3.3.2 删除按钮
|
|
85
|
+
|
|
86
|
+
- **按钮样式**:危险按钮样式
|
|
87
|
+
- **点击逻辑**:
|
|
88
|
+
1. 校验删除权限
|
|
89
|
+
2. 弹出二次确认:"确定要删除该记录吗?删除后不可恢复。"
|
|
90
|
+
3. 确认:调用删除接口
|
|
91
|
+
4. 删除成功:显示成功提示,跳转至列表页
|
|
92
|
+
5. 删除失败:显示失败提示
|
|
93
|
+
|
|
94
|
+
#### 3.3.3 返回按钮
|
|
95
|
+
|
|
96
|
+
- **按钮样式**:次要按钮样式
|
|
97
|
+
- **点击逻辑**:
|
|
98
|
+
1. 跳转至上一页或列表页
|
|
99
|
+
|
|
100
|
+
## 4. 交互设计
|
|
101
|
+
|
|
102
|
+
### 4.1 全局交互
|
|
103
|
+
|
|
104
|
+
- **加载状态**:数据请求过程中需展示 Loading 状态。
|
|
105
|
+
- **空状态**:无数据时需展示统一的 Empty 状态图。
|
|
106
|
+
- **响应式**:页面需适配不同分辨率屏幕,保证内容不遮挡、不错位。
|
|
107
|
+
|
|
108
|
+
### 4.2 页面交互
|
|
109
|
+
|
|
110
|
+
- **数据加载**:进入页面时,根据ID加载详情数据
|
|
111
|
+
- **权限控制**:根据用户权限控制操作按钮的显示/隐藏
|
|
112
|
+
- **复制功能**:(可选)支持一键复制某些字段内容
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
# [页面名称] PRD (产品需求文档)
|
|
2
|
+
|
|
3
|
+
> **生成时对照**:若本页含典型 **列表 + 筛选 + CRUD(详情/新增编辑/删除)**,生成前阅读本技能目录 `examples/list-crud/prd.md`,对齐章节拆分、表格字段密度与「原型与 PRD 对应关系」小节(交付 `prototype.html` 时)。若仅为**筛选 + 列表 + 分页**(无弹层 CRUD),阅读 `examples/backend-list/prd.md`。
|
|
4
|
+
|
|
5
|
+
> **交互原型链接(有 `prototype.html` 时必填)**:在文首「文档说明」或标题下第一段加入 Markdown 相对链接,例如 `- **交互原型**:[打开 prototype.html](./prototype.html)`(文件名随实际交付调整);仅无原型时删除本行链接。见本技能 `SKILL.md`「PRD 与原型互链」。
|
|
6
|
+
|
|
7
|
+
## 1. 引言
|
|
8
|
+
|
|
9
|
+
### 1.1 背景
|
|
10
|
+
|
|
11
|
+
> 简要说明该元素/页面的核心定位、解决的问题、用户价值(控制在50字左右)。
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
[需求背景内容]
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
### 1.2 功能清单
|
|
18
|
+
|
|
19
|
+
> 以表格形式梳理出所有模块、功能点及功能描述。
|
|
20
|
+
>
|
|
21
|
+
> 功能清单不包含:页面顶栏、左侧菜单栏的样式、交互需求内容!
|
|
22
|
+
|
|
23
|
+
| 模块 | 功能点 | 功能描述 |
|
|
24
|
+
| ---------------- | -------------- | -------------- |
|
|
25
|
+
| `[功能模块标题]` | `[功能点标题]` | `[功能点描述]` |
|
|
26
|
+
|
|
27
|
+
## 2. 页面菜单与权限规划
|
|
28
|
+
|
|
29
|
+
### 2.1 页面菜单
|
|
30
|
+
|
|
31
|
+
> 参考菜单栏,描述页面菜单路径。仅描述菜单路径即可!不要做其他内容说明。
|
|
32
|
+
|
|
33
|
+
**菜单路径**:[一级菜单名称] / [二级菜单名称]
|
|
34
|
+
|
|
35
|
+
### 2.2 权限规划
|
|
36
|
+
|
|
37
|
+
> 表格呈现权限点规划,仅定义权限点、可执行操作范围、数据范围(如:个人数据/全量数据),不定义具体角色;
|
|
38
|
+
>
|
|
39
|
+
> **权限点规划的基本原则:**查看类操作归集在【查看】一个权限点;编辑类操作归集在【编辑】一个权限点;导出类操作归集在【导出】一个权限点。
|
|
40
|
+
|
|
41
|
+
| 权限点 | 操作范围 | 数据范围 |
|
|
42
|
+
| -------------- | ------------------ | ------------- |
|
|
43
|
+
| `[权限点名称]` | `[支持的操作名称]` | `[个人/全量]` |
|
|
44
|
+
|
|
45
|
+
## 3. [模块名称]需求说明
|
|
46
|
+
|
|
47
|
+
### 3.1 筛选查询区
|
|
48
|
+
|
|
49
|
+
> 用表格呈现筛选字段、控件类型(如:文本输入/下拉选择/下拉多选/日期范围选择器等)、输入限制(明确长度/枚举值/默认值/必填性/其他条件依赖)、匹配规则(精准/模糊/范围)。
|
|
50
|
+
|
|
51
|
+
支持多维度组合筛选,筛选条件变更后需点击"查询"按钮生效。
|
|
52
|
+
|
|
53
|
+
| 筛选字段 | 类型 | 输入限制 | 匹配规则 |
|
|
54
|
+
| :--------------- | :----------- | :--------------- | :----------- |
|
|
55
|
+
| `[筛选字段名称]` | `[控件类型]` | `[输入限制内容]` | `[匹配规则]` |
|
|
56
|
+
|
|
57
|
+
- **操作按钮**:
|
|
58
|
+
|
|
59
|
+
- **查询**:根据当前筛选条件刷新页面数据。
|
|
60
|
+
|
|
61
|
+
- **重置**:恢复所有筛选条件为默认值。
|
|
62
|
+
|
|
63
|
+
### 3.2 数据列表
|
|
64
|
+
|
|
65
|
+
> 按页面里列表形式的子模块循环撰写
|
|
66
|
+
|
|
67
|
+
以列表形式,按需展示详细的数据表格。
|
|
68
|
+
|
|
69
|
+
- **列表字段**:
|
|
70
|
+
|
|
71
|
+
| 列表字段 | 字段说明 | 排序 |
|
|
72
|
+
| :----------- | :--------------- | :--- |
|
|
73
|
+
| `[字段名称]` | `[字段定义描述]` | 是/否 |
|
|
74
|
+
|
|
75
|
+
- **分页规则**:
|
|
76
|
+
- 每页默认显示:[X]条
|
|
77
|
+
- 可切换显示:[X/X/X]条
|
|
78
|
+
- 分页控件位置:列表底部
|
|
79
|
+
|
|
80
|
+
- **批量操作**:
|
|
81
|
+
> 描述支持的批量操作,如批量删除、批量导出等
|
|
82
|
+
|
|
83
|
+
- **批量删除**:选中多条记录后点击删除,弹出二次确认
|
|
84
|
+
|
|
85
|
+
- **行操作**:
|
|
86
|
+
> 描述每行支持的操作,如编辑、删除、查看详情等
|
|
87
|
+
|
|
88
|
+
- **编辑**:点击编辑按钮,跳转至编辑页面
|
|
89
|
+
- **删除**:点击删除按钮,弹出二次确认
|
|
90
|
+
|
|
91
|
+
- **交互说明**:
|
|
92
|
+
> 简述数据列表的操作说明,包括导出/排序/行操作说明
|
|
93
|
+
|
|
94
|
+
- **排序**:点击表头排序图标,支持升序/降序切换
|
|
95
|
+
- **导出**:点击导出按钮,导出当前筛选条件下的全部数据(CSV格式)
|
|
96
|
+
|
|
97
|
+
## 4. 交互设计
|
|
98
|
+
|
|
99
|
+
### 4.1 全局交互
|
|
100
|
+
|
|
101
|
+
- **加载状态**:数据请求过程中需展示 Loading 状态。
|
|
102
|
+
- **空状态**:无数据时需展示统一的 Empty 状态图。
|
|
103
|
+
- **响应式**:页面需适配不同分辨率屏幕,保证内容不遮挡、不错位。
|
|
104
|
+
|
|
105
|
+
### 4.2 特殊交互
|
|
106
|
+
|
|
107
|
+
> 描述页面中特殊的交互逻辑,如:
|
|
108
|
+
> - 筛选条件联动
|
|
109
|
+
> - 数据刷新机制
|
|
110
|
+
> - 弹窗交互等
|
|
@@ -0,0 +1,194 @@
|
|
|
1
|
+
# [页面名称] PRD (产品需求文档)
|
|
2
|
+
|
|
3
|
+
> **生成时对照**:数据看板类 PRD 生成前阅读本技能目录 `examples/data-dashboard/prd.md`(含 §3 子模块、§4 指标总览、§5 交互;交付原型时对照同目录 `prototype.html`)。
|
|
4
|
+
|
|
5
|
+
> **交互原型链接(有 `prototype.html` 时必填)**:文首加入 `- **交互原型**:[打开 prototype.html](./prototype.html)` 等相对链接;仅无原型时删除。见 `SKILL.md`「PRD 与原型互链」。
|
|
6
|
+
|
|
7
|
+
## 1. 引言
|
|
8
|
+
|
|
9
|
+
### 1.1 背景
|
|
10
|
+
|
|
11
|
+
> 简要说明该元素/页面的核心定位、解决的问题、用户价值(控制在50字左右)。
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
[需求背景内容]
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
### 1.2 功能清单
|
|
20
|
+
|
|
21
|
+
> 以表格形式梳理出所有模块、功能点及功能描述。
|
|
22
|
+
>
|
|
23
|
+
> 功能清单不包含:页面顶栏、左侧菜单栏的样式、交互需求内容!
|
|
24
|
+
|
|
25
|
+
| 模块 | 功能点 | 功能描述 |
|
|
26
|
+
| ---------------- | -------------- | -------------- |
|
|
27
|
+
| `[功能模块标题]` | `[功能点标题]` | `[功能点描述]` |
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
## 2. 页面菜单与权限规划
|
|
32
|
+
|
|
33
|
+
### 2.1 页面菜单
|
|
34
|
+
|
|
35
|
+
> 参考菜单栏,描述页面菜单路径。仅描述菜单路径即可!不要做其他内容说明。
|
|
36
|
+
|
|
37
|
+
**菜单路径**:[一级菜单名称] / [二级菜单名称]
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
### 2.2 权限规划
|
|
42
|
+
|
|
43
|
+
> 表格呈现权限点规划,仅定义权限点、可执行操作范围、数据范围(如:个人数据/全量数据),不定义具体角色;
|
|
44
|
+
>
|
|
45
|
+
> **权限点规划的基本原则:**查看类操作归集在【查看】一个权限点;编辑类操作归集在【编辑】一个权限点;导出类操作归集在【导出】一个权限点。
|
|
46
|
+
|
|
47
|
+
| 权限点 | 操作范围 | 数据范围 |
|
|
48
|
+
| -------------- | ------------------ | ------------- |
|
|
49
|
+
| `[权限点名称]` | `[支持的操作名称]` | `[个人/全量]` |
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
## 3. [模块名称]需求说明
|
|
54
|
+
|
|
55
|
+
> 按模块循环撰写
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
### 3.1 筛选查询区
|
|
60
|
+
|
|
61
|
+
> 用表格呈现筛选字段、控件类型(如:文本输入/下拉选择/下拉多选/日期范围选择器等)、输入限制(明确长度/枚举值/默认值/必填性/其他条件依赖)、匹配规则(精准/模糊/范围)。
|
|
62
|
+
|
|
63
|
+
支持多维度组合筛选,筛选条件变更后需点击“查询”按钮生效。
|
|
64
|
+
|
|
65
|
+
| 筛选字段 | 类型 | 输入限制 | 匹配规则 |
|
|
66
|
+
| :--------------- | :----------- | :--------------- | :----------- |
|
|
67
|
+
| `[筛选字段名称]` | `[控件类型]` | `[输入限制内容]` | `[匹配规则]` |
|
|
68
|
+
|
|
69
|
+
- **操作按钮**:
|
|
70
|
+
|
|
71
|
+
- **查询**:根据当前筛选条件刷新页面数据。
|
|
72
|
+
|
|
73
|
+
- **重置**:恢复所有筛选条件为默认值。
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
### 3.2 [子模块标题]卡片说明
|
|
78
|
+
|
|
79
|
+
> 按页面里卡片形式**的子模块循环撰写,请严格按照一个子模块一个说明的要求进行撰写,严禁对同类型模块进行合并描述!!!
|
|
80
|
+
|
|
81
|
+
- **指标列表**:
|
|
82
|
+
|
|
83
|
+
> 用表格呈现卡片里展示业务指标的业务价值、指标定义
|
|
84
|
+
|
|
85
|
+
| 指标名称 | 业务价值 | 指标定义 |
|
|
86
|
+
| :----------- | :--------------- | :---------------------------------- |
|
|
87
|
+
| `[指标名称]` | `[指标业务价值]` | `[指标具体的定义(取数逻辑/范围)]` |
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
- **交互说明**:
|
|
92
|
+
|
|
93
|
+
> 简述指标卡片模块的交互说明
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
### 3.3 [子模块名称]图表说明
|
|
98
|
+
|
|
99
|
+
> 按页面里**图表形式**的每个子模块独立循环撰写,请严格按照一个子模块一个说明的要求进行撰写,不要对同类型模块进行合并描述!!!
|
|
100
|
+
>
|
|
101
|
+
> 请识别模块是否包含多个部分,如:即包含图表部分、又包含指标卡片部分,须对每个部分分别进行描述!!!不可遗漏某个部分。
|
|
102
|
+
|
|
103
|
+
- **[图表名称]说明**:
|
|
104
|
+
|
|
105
|
+
> 描述图表模型的图表内容
|
|
106
|
+
|
|
107
|
+
- **图表描述**:以`[图标形式]`展示`[图片内容描述]`
|
|
108
|
+
|
|
109
|
+
- **图表指标列表**:
|
|
110
|
+
|
|
111
|
+
> 用表格呈现图表里展示所有业务指标的业务价值、指标定义,不要用概括性的语言。
|
|
112
|
+
|
|
113
|
+
| 指标名称 | 业务价值 | 指标定义 |
|
|
114
|
+
| :----------- | :--------------- | :---------------------------------- |
|
|
115
|
+
| `[指标名称]` | `[指标业务价值]` | `[指标具体的定义(取数逻辑/范围)]` |
|
|
116
|
+
|
|
117
|
+
- **交互说明:**
|
|
118
|
+
|
|
119
|
+
> 简述数据列表的操作说明,包括导出/排序/行操作说明
|
|
120
|
+
|
|
121
|
+
- **[指标卡片名称]说明**:
|
|
122
|
+
|
|
123
|
+
> 描述图表模块的指标卡片内容,梳理出所有指标清单,不要进行概括性总结,不要对指标有遗漏!!
|
|
124
|
+
|
|
125
|
+
- **卡片指标列表**:
|
|
126
|
+
|
|
127
|
+
| 指标名称 | 业务价值 | 指标定义 |
|
|
128
|
+
| :----------- | :--------------- | :---------------------------------- |
|
|
129
|
+
| `[指标名称]` | `[指标业务价值]` | `[指标具体的定义(取数逻辑/范围)]` |
|
|
130
|
+
|
|
131
|
+
- **交互说明**:
|
|
132
|
+
|
|
133
|
+
> 简述数据列表的操作说明,包括导出/排序/行操作说明
|
|
134
|
+
|
|
135
|
+
- **[数据列表名称]说明**:
|
|
136
|
+
|
|
137
|
+
> 描述图表模块的数据列表内容,梳理出所有列表字段清单,不要进行概括性总结,不要对字段有遗漏!!
|
|
138
|
+
|
|
139
|
+
- **列表字段**:
|
|
140
|
+
|
|
141
|
+
| 列表字段 | 字段说明 |
|
|
142
|
+
| :----------- | :--------------- |
|
|
143
|
+
| `[字段名称]` | `[字段定义描述]` |
|
|
144
|
+
|
|
145
|
+
- **交互说明**:
|
|
146
|
+
|
|
147
|
+
> 简述数据列表的操作说明,包括导出/排序/行操作说明
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
### 3.4 [子模块名称]数据列表
|
|
152
|
+
|
|
153
|
+
> 按页面里列表形式**的子模块循环撰写
|
|
154
|
+
|
|
155
|
+
以列表形式,按需展示详细的数据表格。
|
|
156
|
+
|
|
157
|
+
- **列表字段**:
|
|
158
|
+
|
|
159
|
+
| 列表字段 | 字段说明 |
|
|
160
|
+
| :----------- | :--------------- |
|
|
161
|
+
| `[字段名称]` | `[字段定义描述]` |
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
- **交互说明**:
|
|
166
|
+
|
|
167
|
+
> 简述数据列表的操作说明,包括导出/排序/行操作
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
## 4. 指标总览
|
|
172
|
+
|
|
173
|
+
> 以表格的形式,梳理出整个数据看板的全量指标清单(**包含所有子模块的所有指标, 包括卡片、图表、数据列表**),描述指标名称、指标筛选维度(日期/场景/终端/用户身份/等)、数据来源(埋点/业务数据)、指标定义(取数逻辑/范围)。
|
|
174
|
+
>
|
|
175
|
+
> **重点**:一定要全面梳理完整整个数据看板,数据研发需要加工的所有指标内容,该部分内容将作为数据研发的需求清单。整理出来的指标总览需要满足数据看板的全部需求!不可以有遗漏!不可以有遗漏!不可以有遗漏!重点关注:
|
|
176
|
+
>
|
|
177
|
+
> - 提取每个页面的每个子模块中的指标;
|
|
178
|
+
> - 提取指标的范围包含:指标卡片、图表(饼图/折线图/漏斗/等)、数据列表的等
|
|
179
|
+
>
|
|
180
|
+
> 完成梳理后务必对比所有数据看板模块,仔细检查每个指标是否都已经囊括?如果没有囊括,请进行补充!!!确保没有遗漏!!!
|
|
181
|
+
|
|
182
|
+
| 指标名称 | 筛选维度 | 数据来源 | 指标定义 |
|
|
183
|
+
| ------------ | ---------------------------- | ---------------- | ------------------ |
|
|
184
|
+
| `[指标名称]` | `[筛选维度,用无序列表展示]` | `[指标数据来源]` | `[指标的具体定义]` |
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
## 5. 交互设计
|
|
189
|
+
|
|
190
|
+
### 5.1 全局交互
|
|
191
|
+
|
|
192
|
+
- **加载状态**:数据请求过程中需展示 Loading 状态。
|
|
193
|
+
- **空状态**:无数据时需展示统一的 Empty 状态图。
|
|
194
|
+
- **响应式**:页面需适配不同分辨率屏幕,保证内容不遮挡、不错位。
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# [页面名称] PRD (产品需求文档)
|
|
2
|
+
|
|
3
|
+
> **生成时对照**:用户前台 / C 端活动类 PRD 生成前阅读本技能目录 `examples/user-frontend/prd.md`(及将交付原型时的 `prototype.html`)。
|
|
4
|
+
|
|
5
|
+
> **交互原型链接(有 `prototype.html` 时必填)**:文首加入 `- **交互原型**:[打开 prototype.html](./prototype.html)`;仅无原型时删除。见 `SKILL.md`「PRD 与原型互链」。
|
|
6
|
+
|
|
7
|
+
## 1. 引言
|
|
8
|
+
|
|
9
|
+
### 1.1 背景
|
|
10
|
+
|
|
11
|
+
> 简要说明该元素/页面的核心定位、解决的问题、用户价值(控制在50字左右)。
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
[需求背景内容]
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
### 1.2 用户角色
|
|
18
|
+
|
|
19
|
+
> 简要说明不同类型的用户角色,包括但不限于:游客、个人用户、供方普通企业用户、供方会员企业用户、采方企业用户。
|
|
20
|
+
|
|
21
|
+
| 用户角色 | 描述 | 使用场景 |
|
|
22
|
+
|---------|------|---------|
|
|
23
|
+
| `[角色1]` | `[角色描述]` | `[使用场景]` |
|
|
24
|
+
| `[角色2]` | `[角色描述]` | `[使用场景]` |
|
|
25
|
+
|
|
26
|
+
### 1.3 功能清单
|
|
27
|
+
|
|
28
|
+
> 以表格形式梳理出所有模块、功能点及功能描述。
|
|
29
|
+
|
|
30
|
+
| 模块 | 功能点 | 功能描述 |
|
|
31
|
+
| ---------------- | -------------- | -------------- |
|
|
32
|
+
| `[功能模块标题]` | `[功能点标题]` | `[功能点描述]` |
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
## 2. [功能名称]需求说明
|
|
36
|
+
|
|
37
|
+
> 按功能模块循环撰写
|
|
38
|
+
|
|
39
|
+
### 2.1 [子模块名称]
|
|
40
|
+
|
|
41
|
+
#### 2.1.1 功能描述
|
|
42
|
+
|
|
43
|
+
> 详细描述该子模块的功能
|
|
44
|
+
|
|
45
|
+
#### 2.1.2 交互流程
|
|
46
|
+
|
|
47
|
+
> 描述用户操作流程,包括触发条件、操作步骤、反馈等
|
|
48
|
+
|
|
49
|
+
1. **触发条件**:[用户操作,如点击按钮、进入页面等]
|
|
50
|
+
2. **操作步骤**:
|
|
51
|
+
- 步骤1:[描述]
|
|
52
|
+
- 步骤2:[描述]
|
|
53
|
+
3. **操作反馈**:
|
|
54
|
+
- 成功:[成功反馈,如弹窗提示、页面跳转等]
|
|
55
|
+
- 失败:[失败反馈,如错误提示等]
|
|
56
|
+
|
|
57
|
+
### 2.2 [子模块名称]
|
|
58
|
+
|
|
59
|
+
> 按同样格式描述其他子模块
|