1.项目开发计划
项目开发计划内容覆盖项目整个开发周期内的人员调度,所属阶段(需求、设计、编码、测试、实施)、模块划分,开始和结束时间(计划、实际)。
2.需求规格说明书
需求规格说明书是对客户需求的理解形成的文档,为了确定与客户需求一致,在此基础上开展项目的后续工作。
3.概要设计说明书
概要设计说明书应从项目的架构(技术选型、系统架构)、总体设计(功能结构、数据结构、展现设计)和功能设计方面作简要描述,以及其他的一些非功能设计。
4.详细设计说明书
细化到项目的每个模块,每个功能的说明文档。
5.数据库设计说明书
数据库的表的详细信息(字段,类型,长度,解释)。
6.接口说明书
接口说明书一般主要阐述所有service层的方法及使用(功能描述,参数说明,返回类型),有的还包括实现过程、所涉及的sql脚本和错误处理。
7.系统部署文档
一般由研发人员提供项目包、系统部署文档和所需软件给现场,交由现场运维人员进行部署与维护,如果是较为复杂的项目,一份逻辑清晰,言简意赅的部署文档就显得尤为重要,部署文档一般包括所有部署项目中的操作步骤:
- 环境要求(tomcat、jdk版本、数据库、服务器、redis等等);
- 准备工作(数据库初始化、项目包配置文件修改);
- 正式启动(若包含多个包,有顺序要求的也应标注出来)。
如果有需要修改的部分,建议使用文字描述和截图的方式解释清楚;如果需要在linux执行某些命令,建议将这些命令也编辑在文档中,方便运维人员直接复制。
8.用户操作手册
用户操作手册应清楚的描述每一个功能的使用,及页面出现的所有输入框、状态、按钮的解释。
9.系统管理员手册
系统管理员手册是为了现场交付日常维护时,处理某些问题时可以参考的文档。一般项目都有供交付人员使用的后台系统,手册中应清晰的描述后台每一个功能的使用及其常见问题的解决方案。