前言:
慢慢地,很多fe也会接触到一些比较大中型的项目,就需要编写一些类似的设计文档,本文简单地探究一些这方面的规范。
正文:
- 项目要求?
一般我们对大中型项目进行设计文档的编写。
- 文档存放的位置?
- 如果只是需要一个文档就能完整描述,存放在项目根目录下面就可以
- 如果需要多份文档,建议新建文件夹目录进行分开存放
- 设计文档一般需要编写的内容?
当然这部分应项目而已,主体要求还是加强对项目的控制以及后续的升级维护,形成文档化的东西,同时也让开发人员也加速对项目的理解,关注设计。
- 项目本身的背景和完成时候的预期相关的介绍
- 功能的梳理
- 具体功能实现的技术方案(调研评估)
- 主体流程的设计(流程图)
- 相关接口列表整理(带有时间标记)
- 一些风险和异常处理相关
- 其他。。。
推荐模版:
- 项目背景
- 名词术语解释
- 功能点描述
- 设计的目标
- 浏览器支持列表
- 部分重要页面(首页,首屏)性能指标(请求数,响应时间等)
- 。。。。
- 总体设计
最好有一个总体流程图
- 相关模块的详细设计
- 数据接口整理
- 前端自身互相依赖的
- 与后端协商的数据接口(接口名称,参数,请求方式,返回值的数据格式,部分异常处理等)
- 风险和异常评估及处理方案