1.9 KiB
1.9 KiB
项目约束
本项目所有工作必须严格遵守 项目背景.md 中定义的全部规范，包括：
- 项目结构规范（三端目录划分、模块分目录）
- HTML 原型编写规范（独立文件粒度、自包含、视觉尺寸、设计令牌）
- 交互效果规范（导航跳转、Tab切换、交互注释标注）
- 命名规范（小写短横线文件名、BEM 类名）
- 墨刀导入兼容约束（禁止外部引用、简洁DOM、内联SVG）
每次生成或修改 HTML 原型文件前，必须先确认符合上述约束。
模块文档规范
每个一级功能模块目录下必须创建 doc/ 子目录，维护以下两个文档：
doc/CHANGELOG.md（变更记录）
- 记录该模块原型的所有变更，按时间倒序排列
- 每条记录包含：变更日期、变更类型（init/feat/fix/refactor）、涉及文件列表及具体变更说明
- 每次提交代码前，必须自动整理本次变更内容并追加到对应模块的
doc/CHANGELOG.md中
doc/PRD.md（产品需求文档）
- 作为该模块的产品需求说明，面向研发人员，简洁为主
- 每次新增或修改原型页面后，必须同步更新
doc/PRD.md中对应的内容 - 文档结构要求：
- 模块概述：简述模块功能，附页面导航结构树 + 状态流转图（Mermaid）
- 页面清单：列出所有页面和弹窗
- 逐页说明：每个页面/弹窗从几个维度描述：
- 功能说明：页面用途和核心元素
- 业务规则：数据逻辑、状态流转、约束条件
- 交互说明：以文字列表形式描述各元素的交互行为和跳转目标，跳转目标使用中文页面名称（如"跳转到专家主页"），不使用文件名
- 表单字段表：如若存在表单提交的页面以表格列出字段名、类型、必填、规则
- 各个模块PRD文档生成后需要在导航页所对应的一级菜单卡片左下角加上PRD文档的跳转逻辑