feat: 新增模块文档规范体系及导航页PRD文档入口
- 新增 doc/CHANGELOG.md 和 doc/PRD.md 模块文档规范,更新项目背景和CLAUDE.md约束 - 导航页新增"产品需求文档"Tab,展示各模块PRD编写状态 - 模块卡片左下角新增PRD文档快捷链接 - 新增 md-viewer.html 用于Markdown文件预览,支持HTML混合内容iframe隔离渲染 - 健康咨询模块完成首份PRD文档和变更记录 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
@@ -356,3 +356,35 @@ window.location.href = '../health-consult/consult-list.html';
|
||||
| 应急就医 | 应急申请、资源调度、进度跟踪的全流程管理 | 员工端 APP / 健康应急 APP / Web 管理端 |
|
||||
| 一线医疗 | 一线医疗点服务与管理 | 员工端 APP / Web 管理端 |
|
||||
| AI | 智能健康助手,AI问答与健康建议 | 员工端 APP |
|
||||
|
||||
---
|
||||
|
||||
## 七、模块文档规范
|
||||
|
||||
### 7.1 文档要求
|
||||
|
||||
每个一级功能模块目录下必须创建 `doc/` 子目录,维护以下两个文档:
|
||||
|
||||
| 文件 | 用途 | 更新时机 |
|
||||
|------|------|----------|
|
||||
| `doc/CHANGELOG.md` | 变更记录 | 每次提交代码前自动整理并追加 |
|
||||
| `doc/PRD.md` | 产品需求文档 | 每次新增/修改原型页面后同步更新 |
|
||||
|
||||
### 7.2 CHANGELOG.md 格式规范
|
||||
|
||||
- 按时间倒序排列,最新变更在最前
|
||||
- 每条记录格式:`## [YYYY-MM-DD] type: 变更摘要`
|
||||
- type 取值:`init`(初始化)、`feat`(新增)、`fix`(修复)、`refactor`(重构)
|
||||
- 列出涉及的文件及具体变更说明
|
||||
|
||||
### 7.3 PRD.md 编写规范
|
||||
|
||||
面向研发人员的产品需求文档,要求简洁、条理清晰,包含以下结构:
|
||||
|
||||
1. **模块概述**:一句话说明模块功能 + 页面导航结构树 + 状态流转图(Mermaid)
|
||||
2. **页面清单**:表格列出所有页面和弹窗
|
||||
3. **逐页说明**:每个页面/弹窗包含三个维度
|
||||
- **功能说明**:页面用途和核心 UI 元素
|
||||
- **业务规则**:数据逻辑、状态约束、边界条件
|
||||
- **交互说明**:以文字列表形式描述各元素的交互行为和跳转目标,跳转目标使用中文页面名称(如"跳转到专家主页"),不使用文件名
|
||||
4. **表单字段表**:含表单提交的页面,以表格列出字段名、类型、是否必填、校验规则
|
||||
|
||||
Reference in New Issue
Block a user