2.系统开发基础-软件文档（7）

软件文档

软件文档是开发过程中重要组成部分也是软件产品重要组成部分。软件文档分为：开发文档、产品文档、管理文档。这三个文档中又可以进行细化。

开发文档

开发文档是软件开发使用和维护各种必备的资料。它能够提高软件开发的效率和保证软件的质量，而且在软件使用过程中，具有指导、帮助、解惑的作用。因为我们使用软件会遇到各种各样的问题，它可以作为解决问题参考资料，尤其在软件维护过程中文档是不可或缺的资料。如果没有文档，软件维护起来相当麻烦棘手，因为软件开发和维护不是同层次的技术人员，就算是同层次的技术人员时间久了可能就会遗忘，这时没有文档作为参考依据，想要读懂软件是很困难的。

开发文档有：《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《QA文档》、《项目总结》。

• 《功能要求》：源于产品功能要求和市场的调查，是软件文档中最早期的环节也是编写《需求分析》的基础。
• 《投标方案》：公司为了投标某个项目而根据用户的功能要求经过与招标方沟通和确认，再由相关人员编写的方案书。
• 《需求分析》：它包括产品的概述、主要概念、操作流程、功能列表、系统环境、客户需求和注意事项等。它是以《功能要求》基础进行编写，详细的列出《需求分析》包括的内容并将内容具体化。
• 《技术分析》：它包括技术选型、技术比较、开发人员、关键技术问题的解决、技术的风险、技术升级的方向、技术方案评价、竞争对手的技术分析等。它是以《需求分析》为基础进行编写，详细的列出《技术分析》包括的内容并将内容具体化。
• 《系统分析》：它包括模块组成、功能实现、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。它也是以《需求分析》为基础编写，详细列出《系统分析》包括的内容并将内容具体化。
• 《数据库文档》：它包括数据库的名字、数据库中的表名、字段名、字段类型、字段说明等。它是以《系统分析》为基础进行编写，详细列出《数据库文档》包括的内容并将内容具体化。
• 《功能函数文档》：它包括变量名、变量初植、功能、函数名、参数、如何调用、备注、注意事项等。它也是以《系统分析》为基础进行编写,详细列出《功能函数文档》包括的内容并将内容具体化。
• 《界面文档》：它包括软件的外观、界面的素材、文件名、菜单、按钮和其他的界面部件等。
• 《编译手册》：它包括服务器的编译环境、操作系统、编译工具、目录说明、程序生成、原程序文件列表等。
• 《QA文档》：它包括产品简介、产品原理、产品功能列表、功能描述、功能流程、执行结果、数据库结构、测试要求等。主要提供给软件测试人员使用的。
• 《项目总结》：它包括项目的简介、项目的参与人员、项目风险管理过程、项目功能列表、技术特点和开发时间、项目升级建议、人员素质情况等。

产品文档

产品文档有：《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、《技术白皮书》、《评测报告》。

• 《产品简介》：它包括公司背景、产品的概念、适用范围、产品功能、功能特点、运行要求和公司联系方式。
• 《产品演示》：包括公司简介、产品背景、产品描述、产品特点、产品作用、适用范围、功能模块、解决的问题、成功的案例和合作的伙伴等。
• 《疑问解答》：它列出的是用户的关系问题和处理的方法，用于解答软件的操作功能和解决用户的疑难问题。
• 《功能介绍》：它包括软件介绍、软件的结构、功能描述、功能的列表等。它是以《需求分析》为基础编写，详细列出《功能介绍》包括的内容并将内容具体化。
• 《技术白皮书》：它包括功能实现、技术选型、关键技术问题的解决、技术方案特点、技术升级方向等。它是以《技术分析》为基础编写，详细列出《技术白皮书》包括的内容并将内容具体化。
• 《评测报告》：它是第三方权威评测报告，它包括评测的目的、评测的范围、评测的环境、评测的内容、结果分析和评测总结等。

管理文档

管理文档有：《安装手册》、《使用手册》、《维护手册》、《用户报告》、《销售培训》。

• 《安装手册》：它包括系统环境、运行平台、产品安装过程、初始环境设置、安装记录等。
• 《使用手册》：它包括产品简介、功能描述、功能列表、相关注解、功能操作、客户服务和联系方式等。
• 《维护手册》：它包括产品简介、系统出支、初始环境设置、数据管理、备份、技术问题解答和联系方式等。
• 《用户报告》：它包括产品简介、购买时间、使用目的、使用时间、使用地点、实施过程、出现和解决产品问题总结和建议等。
• 《销售培训》：它包括项目简介、产品功能、产品特点、商业优势、系统运行环境、适用范围、目标客户等。

软件文档总结图