介绍

编辑

软件文档可以分为两类：开发文档和产品文档。

开发文档包括：“功能需求”，“投标计划”，“需求分析”，“技术分析”，“系统分析”，“数据库文档”，“功能函数文档”，“接口文档”，“汇编手册”，“ QA文档”，“ QA文档”，“项目摘要”，“项目摘要”，等等。

产品文档包括：“产品简介”，“产品演示”，“问题和答案”，“功能简介”，“技术白皮书”和“评估报告”。

用户文档“安装手册”，“用户手册”，“维护手册”，“用户报告”，“销售培训”，等等。

分类广播

编辑

开发文档

1。“功能需求” - 它来自客户需求和市场研究，是软件开发中最早的链接。客户提出了一个模糊的功能概念，或要求解决实际问题，或者是指类似软件的函数。具有软件经验的客户还将提供更详细的技术规格，在文档中写下所有要求，并在必要时使用图表说明。该文档是需求分析的基础。

2。“竞标计划” - 根据用户的功能要求，在与竞标者进行沟通和确认后，技术人员开始编写“竞标计划”。该计划通常包括以下重要章节：序言 - 项目背景，公司背景和业务，技术人员结构，公司成功故事介绍等。需求分析 - 项目需求，软件结构，功能清单，功能描述，预防措施等。技术解决方案 - 技术需求和指导意识形态和指导技术解决方案，技术解决方案，技术开发，软件开发平台，网络结构系统，网络开发和项目管理项目，项目和项目的发展范围，项目和项目的发展，项目和项目的质量，质量，组织范围，质量部门，质量，组织范围，质量部门，质量，组织范围，质量，组织，质量，组织范围，质量，组织范围，质量，组织范围，质量，组织范围，质量，组织范围，构图 , , etc. - the 's and , and , and time, area, , user , etc. -list of and , , , etc. -The of the time for the of , , , , , test and , , user , user培训和其他步骤。

3。“需求分析” - 包括产品概述，主要概念，操作程序，功能列表和说明，预防措施，系统环境等。基于“功能要求”，进行详细的详细功能分析（包括客户提出的要求以及根据开发经验提出的功能以及建议的功能），列出了哪些功能，哪些功能是什么功能，列出了什么功能，哪些功能是什么，该功能是什么，该功能是什么，该功能是什么，该功能是什么，该功能是什么，该功能是什么，该功能是什么，该功能是什么，该功能是什么，该功能是什么，该功能是什么，在实施它时，客户可以使用哪些要求，以及系统操作环境的要求等。此处的功能描述与将来的用户手册一致。

4。“技术分析” - 包括技术选择，技术比较，开发人员，解决关键技术问题的解决方案，技术升级方向，技术计划评估，竞争对手的技术分析等。进行详细的技术分析（产品性能和实施方法）正在进行哪些技术需要在此项目中使用哪些技术，在这些问题上需要进行哪些困难，解决方案的列表，这些解决方案应涉及哪些技术，这些问题在何时求解，涉及什么困难，涉及求解的问题，这些问题是解决问题的，这些问题是求解的，这些解决方案是解决方案的，这些问题是解决方案的，这些问题是解决方案的，这些问题是解决方案的，这些问题是解决方案的，涉及技术的范围。将来的解决方案，以及对该项目技术的评估。

5。“系统分析” - 包括功能实现，模块组成，功能流程图，功能界面，数据字典，在软件开发中需要考虑的各种问题等。基于“需求分析”，进行了详细的系统分析（产品开发和实施方法），并且估计了开发期间需要解释的问题。程序员根据“系统分析”开始在项目经理的领导下进行编码。

6。“数据库文档” - 包括数据库名称，表名称，字段名称，字段类型，字段描述，注释，字段数值计算公式等。基于“系统分析”，进行了详细的数据库设计。您可以在必要时使用图表来解释，尤其是关系数据库。

7。“函数函数文档” - 包括变量名称，可变初始值，函数，函数名称，参数，如何调用，注释，预防措施等。基于“系统分析”，将进行详细的描述，列出哪些函数涉及许多函数，以便程序员可以在将来修改，接管和扩展。

8。“接口文档” - 包括软件外观，接口材料，编辑工具，文件名，菜单，按钮和其他接口组件的要求，这与软件完成后的运行接口一致。

9。“编译手册” - 包括服务器编译环境，操作系统，编译工具，GNU的C ++编译器版本信息，目录说明，程序生成，源程序文件列表，配置和相关程序的相应列表。客户端的编译过程，汇编结果，汇编示例，编译环境，操作系统，编译工具，源文件列表和创建安装程序的过程。

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

11。“项目摘要” - 包括项目介绍，项目参与者和开发时间，项目风险管理流程，项目功能列表，项目结构特征，技术特征，项目升级建议，未来项目的建议，人事质量，等等。

产品文档

1。“产品简介” - 包括公司背景，产品概念，应用程序范围，产品功能，功能特征，操作要求和公司联系地址。

2。“产品演示” - 包括公司概况，产品背景，产品描述，产品功能，产品功能，应用程序范围，使用分析，功能模块，解决问题，合作伙伴，成功案例等。通常使用VCD记录软件实现。

3。“问答” - 列出用户关心的问题和解决方案。用于回答软件的操作功能并解决用户的困难问题。

4。“功能简介” - 基于“需求分析”，它包括软件简介，软件结构，功能列表，功能描述和公司联系地址。

5。“技术白皮书” - 基于“技术分析”，包括功能实施，技术选择，关键技术问题的解决方案，技术解决方案特征和技术升级方向。

6。“评估报告” - 第三方权威评估报告。包括评估目的，评估范围，评估环境，评估内容，实际测量数据，绩效绩效，结果分析和评估摘要等。

7。“安装手册” - 包括系统环境，操作平台，产品安装过程，初始环境设置，安装记录等。