[模块名] · 详细设计文档

文档版本：0.01 ｜ 最近核对日期：[日期]

文档控制

项目	内容
模块名称
关联需求分析	[链接]
关联概要设计	[链接]
关联数据库设计	[链接]
关联代码版本	分支、提交或发布版本
编写/核对人
待确认事项

1. 页面、路由与交互

页面/组件	路由	进入条件	可见角色	主要操作	状态/异常反馈

说明关键表单校验、列表筛选、分页、上传下载、确认弹窗、空态、加载态和失败提示。标准交互引用项目 UI 规范，不重复复制通用规则。

2. 接口契约

接口	方法	调用方	权限	请求对象	响应对象	事务及特殊处理

对每个接口补充：参数校验、必填/可空、枚举、分页、错误码、数据范围、审计字段和兼容约束。已存在接口必须记录是否兼容旧调用方。

3. 状态与业务动作

当前状态	动作	允许角色	前置校验	数据变化	下一状态	失败处理

需要回写到需求分析的业务规则使用规则编号关联，不在此处另造一套口径。

4. 权限与数据范围

资源/动作	菜单权限	按钮权限	接口权限	数据范围	越权结果

说明页面可见性与服务端授权的关系；不能以隐藏按钮代替接口鉴权。

5. 异常与事务

场景	检测位置	用户提示	回滚/补偿	日志与告警	测试用例

按实际业务场景记录异常和事务边界；并发、重复提交、重试及幂等处理仅在用户明确要求、已有实际故障或已确认业务流程依赖时纳入。

6. 实现映射与验证

责任	代码位置	需要验证的行为

只记录已核对的实现位置；未实现或未核对内容标记为“待核对”。实际验证结果与证据记录在测试与验收文档。