docs: 更新健康咨询三端PRD文档,新增截图规范与md-viewer图片支持
- 重写员工端PRD,按业务流程重新组织,页面与弹窗穿插介绍 - 补充应急APP专家端/小助手端PRD缺失页面和共享模块说明 - 更新管理后台PRD咨询须知双Tab设计描述 - 员工端PRD新增25张页面截图(Playwright自动截取) - md-viewer.html支持图片相对路径自动补全和尺寸限制 - 项目背景.md新增PRD截图规范(7.4节),PRD更新时机改为用户主动触发 - CLAUDE.md精简去重,文档规范统一指向项目背景.md Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
@@ -368,7 +368,7 @@ window.location.href = '../health-consult/consult-list.html';
|
||||
| 文件 | 用途 | 更新时机 |
|
||||
|------|------|----------|
|
||||
| `doc/CHANGELOG.md` | 变更记录 | 每次提交代码前自动整理并追加 |
|
||||
| `doc/PRD.md` | 产品需求文档 | 每次新增/修改原型页面后同步更新 |
|
||||
| `doc/PRD.md` | 产品需求文档 | **用户明确要求时**才编写或更新,不随原型修改自动同步 |
|
||||
|
||||
### 7.2 CHANGELOG.md 格式规范
|
||||
|
||||
@@ -383,8 +383,31 @@ window.location.href = '../health-consult/consult-list.html';
|
||||
|
||||
1. **模块概述**:一句话说明模块功能 + 页面导航结构树 + 状态流转图(Mermaid)
|
||||
2. **页面清单**:表格列出所有页面和弹窗
|
||||
3. **逐页说明**:每个页面/弹窗包含三个维度
|
||||
3. **逐页说明**:按业务流程顺序组织,页面与弹窗按流程穿插介绍(不分开罗列),每个页面/弹窗包含以下维度:
|
||||
- **页面截图**:在标题下方紧跟截图引用(格式见 7.4)
|
||||
- **功能说明**:页面用途和核心 UI 元素
|
||||
- **业务规则**:数据逻辑、状态约束、边界条件
|
||||
- **交互说明**:以文字列表形式描述各元素的交互行为和跳转目标,跳转目标使用中文页面名称(如"跳转到专家主页"),不使用文件名
|
||||
4. **表单字段表**:含表单提交的页面,以表格列出字段名、类型、是否必填、校验规则
|
||||
|
||||
### 7.4 PRD 页面截图规范
|
||||
|
||||
为提升文档可读性,PRD 中每个页面说明需附带页面截图。
|
||||
|
||||
**截图生成方式:**
|
||||
- 使用 Playwright 对 HTML 原型文件进行无头浏览器截图
|
||||
- APP 端截取 `.phone-shell` 元素,视口 460×920,设备缩放 2x
|
||||
- Web 端截取完整页面,视口 1440×900,设备缩放 1x
|
||||
- 输出格式:PNG
|
||||
|
||||
**截图存放:**
|
||||
- 统一存放在模块的 `doc/screenshots/` 目录下
|
||||
- 文件名与原型 HTML 文件名一致(去掉 `.html` 后缀),如 `find-expert.png`
|
||||
- 内嵌于其他页面的弹窗无需单独截图,在页面清单中标注即可
|
||||
|
||||
**PRD 中引用方式:**
|
||||
- 在每个页面/弹窗的三级标题下方紧跟插入:``
|
||||
- 使用相对路径(基于 `doc/` 目录),md-viewer.html 会自动补全为完整路径
|
||||
|
||||
**截图更新时机:**
|
||||
- 与 PRD 文档同步,仅在用户明确要求更新 PRD 时重新截取
|
||||
|
||||
Reference in New Issue
Block a user