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