软件开发文档 -清单

背景
  软件开发, 文档必不可少
  必备的文档有哪些呢?
  ps: 或有缺漏, 渐进补全

文档可以按照两个维度分类:

1. 软件生命周期
      问题定义/规划 -> 需求分析/评审 -> 软件设计 -> 编码 -> 测试 -> 上线/维护
2. 文档类别
      开发类; 产品类; 用户类

1. 必备文档不可少，多余文档不可有
2. 文档应该和项目，产品一样不停的成长

---

一. 开发文档

需求类

1. 《需求说明文档》
2. 《需求评审记录》

设计类

3. 《项目规划》
4. 《概要设计》
5. 《详细设计》
6. 《数据库设计》

开发类

7. 《编程规范》
8. 《接口文档》

测试类

9. 《测试用例》
10. 《测试报告》

维护类

10. 《质量管理手册》
11. 《名词清单》
12. 其他 【开源漏洞清单，模块清单，】

二. 产品文档

1. 《产品规划文档》
2. 《产品设计文档》

三. 用户手册

1. 《安装手册》
2. 《使用手册》
3. 《软件升级手册》 【可选】

四. 其他文档

有些文档的存在，即说明产品有问题

比如:

1. 常见问题定位/排查记录文档

"常见问题记录"，说明产品有些地方存在缺陷，不能通过产品自身解决，才需要文档维护。

To Be Continued