任何一个项目,项目文档是必不可少的,尤其IT项目,如果仅仅只有代码,不能称之为项目,仅仅是程序或代码片段。不同的标准和要求,对项目文档的数量、内容和规范等要求也不一样,比如CMMI,有5级标准。结合当前实际和需求,现拟定项目文档参考如下:
- 引言
- 背景
- 目标
- 术语
- 参考资料
-
功能说明
业务架构
用例图
-
业务流程
流程图
-
系统模块
应用架构
-
数据流程
时序图
状态图
-
数据架构
ER图
数据库设计
-
系统接口
- 对外开放接口
- 依赖外部接口
-
技术架构
- 部署架构
- 网络部署
- 环境资源
- 集成开发环境
- UAT环境
- 测试环境
- 生产环境
- 外部资源
-
业务运营
- 操作使用说明
- 系统运维
- 变更上线操作手册
- 应急预案
- FAQ