软件开发文档应包括哪些内容？

开发文档

1. 《功能要求》 -- 来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。这份文档是需求分析的基础。

2. 《投标方案》 -- 根据用户的功能要求，经过与招标方沟通和确认，技术人员开始书写《投标方案》，方案书一般包括以下几个重要的章节： 前言 -- 项目背景、公司背景和业务、技术人员结构、公司的成功案例介绍等。 需求分析 -- 项目要求、软件结构、功能列表、功能描述、注意事项等。 技术方案 -- 总体要求和指导思想、技术解决方案、软件开发平台、网络结构体系等。 项目管理 -- 描述公司的软件开发流程、工程实施服务、组织和人员分工、开发进度控制、软件质量保证、项目验收和人员培训、软件资料文档等。 技术支持 -- 公司的技术支持和服务介绍、服务宗旨和目标、服务级别和响应时间、技术服务区域、技术服务期限、授权用户联系人等。 系统报价 -- 软、硬件平台报价列表、软件开发费用、系统维护费用等。 项目进度 -- 整个项目的进度计划，包括签署合同、项目启动、需求分析、系统分析、程序开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规划。

3. 《需求分析》 -- 包括产品概述、主要概念、 *** 作流程、功能列表和解说、注意事项、系统环境等。以《功能要求》为基础，进行详细的功能分析 ( 包括客户提出的要求和根据开发经验建议的功能 ) ，列出本产品是什么，有什么特殊的概念，包括哪些功能分类，需要具备什么功能，该功能的 *** 作如何，实现的时候该注意什么细节，客户有什么要求，系统运行环境的要求等。这里的功能描述跟以后的使用手册是一致的。

4. 《技术分析》 -- 包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。以《需求分析》为基础，进行详细的技术分析 ( 产品的性能和实现方法 ) ，列出本项目需要使用什么技术方案，为什么，有哪些技术问题要解决 ，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什么评价等。

5. 《系统分析》 -- 包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以《需求分析》为基础，进行详细的系统分析 ( 产品的开发和实现方法 ) ，估计开发期间需要把什么问题说明白，程序员根据《系统分析》，开始在项目主管的带领下进行编码。

6. 《数据库文档》 -- 包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。以《系统分析》为基础，进行详细的数据库设计。必要时可以用图表解说，特别是关系数据库。

7. 《功能函数文档》 -- 包括变量名、变量初植、功能，函数名，参数，如何调用、备注、注意事项等。以《系统分析》为基础，进行详细的说明，列出哪个功能涉及多少个函数，以便以后程序员修改、接手和扩展。

8. 《界面文档》 -- 包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的要求，这里与软件完成后的运行界面是一致的。

9. 《编译手册》 -- 包括服务器编译环境、 *** 作系统、编译工具、 GNU 的 C++ 编译器版本信息、目录说明、程序生成、源程序文件列表、 Makefile 配置及其相关程序的对应关系列表。客户端的编译过程、编译结果、编译示例、编译环境、 *** 作系统、编译工具、源文件列表和制作安装程序的过程。

10. 《 QA 文档》 -- 包括产品简介、产品原理、产品功能列表、功能描述、功能流程、执行结果、数据库结构、测试要求等，提供给软件测试人员使用。

11. 《项目总结》 -- 包括项目简介、项目参与人员和开发时间、项目风险管理过程、项目功能列表、项目结构特点、技术特点、对项目的升级建议、对以后的项目的建议、人员素质情况等。

我很少写文档，懒得写，除非项目有要求

对于文档这个东西简单谈一下

做项目之前就有文档

这个是可遇不可求的，现在做的项目很多都是临时突然说要做的，什么需求都没有，只能靠程序员自己去发现，项目经理的要求，客户的临时需求（这个比较痛苦，他们有时候根本就不知道要什么，所以必须写好文档，跟客户谈好，不然又要变的时候，你就痛苦了）

如果项目一开始就有文档，当然也可能是你自己写的，也可能是其他人写好的，有些公司有人专门负责写，需求分档，项目分析文档，项目结构文档，数据库文档等等，不过之后可能需要你写测试文档，这个就没有听说过谁帮你做了，但是更多的情况也是不用写，就几个功能，自己和测试人员测测就算了，也有可能需要写使用文档，这个看情况了

做项目之前没有文档

如果项目紧张，根本就不会写任何文档，但是当项目结束的时候，你又没有项目做，项目精灵可能就让你写写文档打发打发时间，

文档对于公司来说是很重要的，但是对于个人的话，就要看情况，如果你做了很多项目，其实什么文档也不需要，你大体上都知道这个项目就做什么用的，怎么架构的，那些代码是什么意思(你的编程习惯很好的情况下)，所以很多公司都会要求程序员写文档，不然你走的时候，别的人怎么接受，让别人理解你的思想是很痛苦的，每个人的思想都是不一样的

GitHubPages。

现在大多程序员都会使用通用代码库Github，所以对于希望保存文档的程序员来说，Github是一个不错的选择，尽管很多人只是利用代码库中的readme功能来为项目提供简单的 *** 作指南，但这并非是最好的办法。

ReadtheDocs。

顾名思义，ReadtheDocs为开发人员提供了一个集中的平台来保存文档，这样用户就可以直接阅读文档了。它的工作原理有点类似GitHubpages，因为开发人员可以从他们喜欢的版本控制系统（包括Git、Bazaar、Mercurial等）中推送文档更新。

---