目录
设计文档编写规范
- 设计文档面对的是开发团队内部的同事以及客户（甲方）；
- 设计文档包括设计方案、业务层次架构（路由）；
- 前端设计文档以页面为单位进行编写；
- 前端设计文档中必须包括每个元素的构成状态、显示值数据类型、默认值、限制；
- 前端设计文档中必须包括每个元素的事件状态，由事件引发的操作、检查规则、错误提示；
- 前端设计文档中必须描述每个元素的权限状态，在什么时候可以被谁所浏览；
- 后端设计文档分为两层：概要设计和详细设计；
- 概要设计以模块为单位进行编写，主要描述每个模块所对应的功能、都有哪些逻辑点、分支路线；
- 详细设计以类（或者文件）为单位进行编写，主要描述功能点的实现方式、逻辑点的关联；