本文共 1565 字，大约阅读时间需要 5 分钟。

前言

刚开始接触文档，真的很头大，这么多文档，到底要怎么写啊？不要着急，一开始谁都不会写，要想真的得心应手是需要一个过程的。我认为我们只要弄清楚以下几个问题就可以了：各个开发阶段都需要写什么文档？由谁写？给谁看？各个文档的内容和作用是什么？为什么要写文档？

大家都知道软件包括：程序、数据结构、文档，如果没有文档，那么就不是一个完整的软件，所以写好文档还是有必要的，具体原因接下来让我们分析一下。

每个阶段产生的文档

各个文档的作者和读者

本来想弄个表格的，但是感觉那样看着比较麻烦。而且我认为图比文字更有吸引力，所以就想画个图，结果没想到画出来是介个样子的，看着比较乱，就这么将就着看吧。

各个文档的内容和作用

1.可行性研究报告：说明该软件项目在各种综合因素下的可行性，包括经济、社会、技术、法律等因素。

2.项目开发计划：把在开发过程中各项工作的负责人员、开发进度、所需经费预算、所需软硬件条件等问题记载下来，以便根据本计划开展和检查本项目的开发工作。

3.软件需求说明书：使用户和软件开发者双方对软件的初始规定有一个共同的理解，是整个开发工作的基础，包括对软件功能、性能的规定等，是文档中的重中之重。

4.数据要求说明书：向整个开发时期提供被处理数据的描述和数据采集的要求，明确软件实现所需要的数据。

5.数据库设计说明书：对数据库的所有标识、逻辑结构和物理结构做出具体的设计规定。

6.概要设计说明书：说明对程序的设计考虑，包括基本处理流程、组织结构、模块划分、功能分配、接口设计、数据结构设计和出错处理设计等，为详细设计提供基础。

7.详细设计说明书：说明一个软件系统各层次中的每一个程序的设计考虑，包括算法设计、数据结构设计等具体实现方法。

8.测试计划：提供一个软件的测试计划，包括测试内容、进度安排、测试方法以及评价准则等。

9.测试分析报告：对测试结果加以记录和分析总结。

10.用户手册：描述该系统所具有的的功能及基本的使用方法，使用户了解软件的用途，并在什么情况下如何使用它。

11.操作手册：向操作人员提供软件每一个运行的具体过程，包括操作方法等。

12.项目开发总结报告：总结本项目开发工作的经验，说明实际取得的开发结果，对开发工作的各个方面进行评价，为以后的项目开发积累经验和教训。

13.开发进度月报：向有关管理部门汇报项目开发的进展情况，及时发现并处理过程中出现的问题，给出建议和下月计划等。

为什么要写文档

1.方便各个开发人员之间的交流，节省时间

用户手册和操作手册的区别

说实话，一开始我也弄不清楚这两个手册的区别，但是网络的力量是无穷的，站在巨人的肩膀上总是没错的。现在来说一说我个人的理解：

  用户手册：用户手册较于操作手册来说，更加的完整，更加的详细以及规程化。它从整个软件的规格、组成，推荐和标准配置，到软件的安装与使用，功能和性能，还包括使用过程中的维护，以及最后的商家联系方式等。假如我们在使用过程中出现故障，还可以自己按着说明书解决或者联系维修人员。

  操作手册：而操作手册是用户手册的一部分，它主要讲述如何操作该软件。

后语

我感觉人一旦钻了牛角尖就特别不好，我总是感觉自己学的这些理论知识太“虚无缥缈”，掌握不好学习的“度”，但是我也明白了，这些东西不是光学理论知识就可以的，等我们真正参加工作或者接触项目才会有更深的体会，在学习的过程中不必太纠结于此。

总结的不是很全面，若发现有纰漏之处，还请指正。学习是一个循序渐进的过程，如果以后我发现有些不对的地方，还会回来改正的。

转载地址：https://blog.csdn.net/zwj_jyzl/article/details/79858307 如侵犯您的版权，请留言回复原文章的地址，我们会给您删除此文章，给您带来不便请您谅解！