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:
@@ -7,29 +7,24 @@
|
||||
- 交互效果规范(导航跳转、Tab切换、交互注释标注)
|
||||
- 命名规范(小写短横线文件名、BEM 类名)
|
||||
- 墨刀导入兼容约束(禁止外部引用、简洁DOM、内联SVG)
|
||||
- 模块文档规范(CHANGELOG、PRD、截图,详见 `项目背景.md` 第七部分)
|
||||
|
||||
每次生成或修改 HTML 原型文件前,必须先确认符合上述约束。
|
||||
|
||||
# 模块文档规范
|
||||
# Agent 行为约束(补充项目背景.md 中未涉及的 Agent 专属规则)
|
||||
|
||||
每个一级功能模块目录下必须创建 `doc/` 子目录,维护以下两个文档:
|
||||
## PRD 文档更新时机
|
||||
|
||||
## doc/CHANGELOG.md(变更记录)
|
||||
- **禁止自动更新**:修改原型页面时不得自动同步更新 PRD 文档
|
||||
- **仅在用户明确要求时**才编写、更新 PRD 或重新截取页面截图
|
||||
- PRD 的具体编写规范和截图规范见 `项目背景.md` 第 7.3 和 7.4 节
|
||||
|
||||
- 记录该模块原型的所有变更,按时间倒序排列
|
||||
- 每条记录包含:变更日期、变更类型(init/feat/fix/refactor)、涉及文件列表及具体变更说明
|
||||
- **每次提交代码前,必须自动整理本次变更内容并追加到对应模块的 `doc/CHANGELOG.md` 中**
|
||||
## CHANGELOG 更新时机
|
||||
|
||||
## doc/PRD.md(产品需求文档)
|
||||
- 每次提交代码前,自动整理本次变更内容并追加到对应模块的 `doc/CHANGELOG.md` 中
|
||||
- 格式规范见 `项目背景.md` 第 7.2 节
|
||||
|
||||
- 作为该模块的产品需求说明,面向研发人员,简洁为主
|
||||
- 每次新增或修改原型页面后,必须同步更新 `doc/PRD.md` 中对应的内容
|
||||
- 文档结构要求:
|
||||
- **模块概述**:简述模块功能,附页面导航结构树 + 状态流转图(Mermaid)
|
||||
- **页面清单**:列出所有页面和弹窗
|
||||
- **逐页说明**:每个页面/弹窗从几个维度描述:
|
||||
- 功能说明:页面用途和核心元素
|
||||
- 业务规则:数据逻辑、状态流转、约束条件
|
||||
- 交互说明:以文字列表形式描述各元素的交互行为和跳转目标,跳转目标使用中文页面名称(如"跳转到专家主页"),不使用文件名
|
||||
- 表单字段表:如若存在表单提交的页面以表格列出字段名、类型、必填、规则
|
||||
- 各个模块PRD文档生成后需要在导航页所对应的一级菜单卡片左下角加上PRD文档的跳转逻辑
|
||||
## 导航页同步
|
||||
|
||||
- 新增原型页面时,必须同步在 `index.html` 的 `SITE_MAP` 中添加对应条目
|
||||
- PRD 文档生成后需要在导航页对应的一级菜单卡片左下角加上 PRD 文档的跳转逻辑
|
||||
|
||||
Reference in New Issue
Block a user