设计文档模板

任何一个项目,项目文档是必不可少的,尤其IT项目,如果仅仅只有代码,不能称之为项目,仅仅是程序或代码片段。不同的标准和要求,对项目文档的数量、内容和规范等要求也不一样,比如CMMI,有5级标准。结合当前实际和需求,现拟定项目文档参考如下:

  1. 引言
    1. 背景
    2. 目标
    3. 术语
    4. 参考资料
  2. 功能说明

    业务架构

    用例图

  3. 业务流程

    流程图

  4. 系统模块

    应用架构

  5. 数据流程

    时序图

    状态图

  6. 数据架构

    ER图

    数据库设计

  7. 系统接口

    1. 对外开放接口
    2. 依赖外部接口
  8. 技术架构

  9. 部署架构
    1. 网络部署
    2. 环境资源
      1. 集成开发环境
      2. UAT环境
      3. 测试环境
      4. 生产环境
    3. 外部资源
  10. 业务运营

    1. 操作使用说明
  11. 系统运维
    1. 变更上线操作手册
    2. 应急预案
    3. FAQ