docs-04-skeleton-template.md
5.68 KB
一、后端规范
1.1 规则
- 【人工填写：一条后端通用约定，按需复制本行新增更多；无则填「无」】
1.2 分层结构
1.3 命名约定
1.4 统一响应格式
1.5 异常处理
1.6 事务
1.7 认证
二、前端规范
2.1 目录约定
2.2 状态管理
2.3 请求封装
2.4 错误处理
2.5 样式与主题
三、共同约定
3.1 Git 提交
<type>(<scope>): <subject> REQ-XXX-NNN
3.2 分页查询
3.3 日期与金额
3.4 数据访问规约
3.5 配置与安全
四、前端 Design Tokens / 交互约定
所有色值统一以 CSS 变量定义于 src/styles/tokens.css；命名规范见 § 2.5。 本项目所有页面布局以项目根
prototype/目录下的静态 HTML mockup 为权威。 前端阶段实现时直接以 prototype/ HTML 推导组件树与样式。本节仅承载跨页面通用规则与 Design Tokens。
4.1 通用交互规则
4.1.1 操作反馈
4.1.2 数据展示
4.1.3 权限控制（前端）
4.2 全局调色板
4.3 组件级状态色
4.4 引用约定
五、环境配置
5.1 依赖清单
5.2 端口约定
5.3 环境变量
运行时凭据（数据库连接、JWT 密钥等）全部放在仓库根的 .env.local，不入 git。
字段清单与占位符见该文件，真实值由开发者本地填写。