软件文档在软件开发中的作用(软件开发文档的重要性)

软件开发文档干什么的？

在软件的生产过程中，总是伴随着大量的信息要记录、要使用。因此，软件文档在产品的开发生产过程中起着重要的作用。

1)提高软件开发过程的能见度。把开发过程中发生的事件以某种可阅读的形式记录在文档中。管理人员可把这些记载下来的材料作为检查软件开发进度和开发质量的依据，实现对软件开发的工程管理。

2)提高开发效率。软件文档的编制，使得开发人员对各个阶段的工作都进行周密思考、全盘权衡、从而减少返工。并且可在开发早期发现错误和不一致性，便于及时加以纠正。

3)作为开发人员在一定阶段的工作成果和结束标志。

4)记录开发过程中的有关信息，便于协调以后的软件、开发、使用和维护。

5)提供对软件的运行、维护和培训的有关信息，便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解。使软件开发活动更科学、更有成效。

6)便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需要的软件提供依据。

文档在各类人员、计算机之间的多种桥梁作用中看出：

既然软件已经从手工艺人的开发方式发展到工业化的生产方式，文档在开发过程中就起到关键作用。从某种意义上来说，文档是软件开发

规范的体现和指南。按规范要求生成一整套文档的过程，就是按照软件开发规范完成一个软件开发的过程。所以，在使用工程化的原理和方法来指导软件的开发和维护时，应当充分注意软件文档的编制和管理。

PS：软件开发文档包括：

操作手册

维护修改建议

软件需求（规格）说明书

开发文档软件需求（规格）说明书

数据要求说明书

概要设计说明书

详细设计说明书

可行性研究报告

项目开发计划

管理文档项目开发计划

测试计划

测试报告

开发进度月报

开发总结报告

文档的作用是什么

文档的作用和分类

软件文档(document)也称文件,通常指的是一些记录的数据和数据媒体,它具有固定不变的形式,可被人和计算机阅读.它和计算机程序共同构成了能完成特定功能的计算机软件(有人把源程序也当作文档的一部分).我们知道,硬件产品和产品资料在整个生产过程中都是有形可见的,软件生产则有很大不同,文档本身就是软件产品.没有文档的软件,不成其为软件,更谈不到软件产品.软件文档的编制(documentation)在软件开发工作中占有突出的地位和相当的工作量.高效率,高质量地开发,分发,管理和维护文档对于转让,变更,修正,扩充和使用文档,对于充分发挥软件产品的效益有着重要意义. 然而,在实际工作中,文档在编制和使用中存在着许多问题,有待于解决.软件开发人员中较普遍地存在着对编制文档不感兴趣的现象.从用户方面看,他们又常常抱怨:文档售价太高,文档不够完整,文档编写得不好,文档已经陈旧或是文档太多,难于使用等等.究竟应该怎样要求它,文档应该写哪些,说明什么问题,起什么作用这里将给出简要的介绍.

图文档桥梁作用

文档在软件开发人员,软件管理人员,维护人员,用户以及计算机之间的多种桥梁作用可从图中看出.软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据,这个作用是显而易见的.软件开发过程中软件开发人员需制定一些工作计划或工作报告,这些计划和报告都要提供给管理人员, 并得到必要的支持.管理人员则可通过这些文档了解软件开发项目安排,进度,资源使用和成果等.软件开发人员需为用户了解软件的使用,操作和维护提供详细的资料,我们称此为用户文档.

以上三种文档构成了软件文档的主要部分.我们把这三种文档所包括的内容列在图6中.其中列举了十三个文档,这里对它们作一些简要说明:

· 可行性研究报告:说明该软件开发项目的实现在技术上,经济上和社会因素上的可行性,评述为了合理地达到开发目标可供选择的各种可能实施的方案,说明并论证所选定实施方案的理由.

· 项目开发计划:为软件项目实施方案制定出具体计划,应该包括各部分工作的负责人员,开发的进度,开发经费的预算,所需的硬件及软件资源等.项目开发计划应提供给管理部门,并作为开发阶段评审的参考.

· 软件需求说明书:也称软件规格说明书,其中对所开发软件的功能,性能,用户界面及运行环境等作出详细的说明.它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议, 也是实施开发工作的基础.

· 数据要求说明书:该说明书应给出数据逻辑描述和数据采集的各项要求,为生成和维护系统数据文卷作好准备.

· 概要设计说明书:该说明书是概要设计阶段的工作成果,它应说明功能分配,模块划分,程序的总体结构,输入输出以及接口设计,运行设计,数据结构设计和出错处理设计等,为详细设计奠定基础.

· 详细设计说明书:着重描述每一模块是怎样实现的, 包括实现算法,逻辑流程等.

·用户手册:本手册详细描述软件的功能,性能和用户界面,使用户了解如何使用该软件.

图三种文档

· 操作手册:本手册为操作人员提供该软件各种运行情况的有关知识,特别是操作方法的具体细节.

· 测试计划:为做好组装测试和确认测试,需为如何组织测试制定实施计划.计划应包括测试的内容,进度,条件,人员,测试用例的选取原则,测试结果允许的偏差范围等.

· 测试分析报告:测试工作完成以后,应提交测试计划执行情况的说明.对测试结果加以分析,并提出测试的结论意见.

· 开发进度月报:该月报系软件人员按月向管理部门提交的项目进展情况报告.报告应包括进度计划与实际执行情况的比较, 阶段成果,遇到的问题和解决的办法以及下个月的打算等.

· 项目开发总结报告:软件项目开发完成以后,应与项目实施计划对照,总结实际执行的情况,如进度,成果,资源利用,成本和投入的人力.此外还需对开发工作作出评价,总结出经验和教训.

· 哪些需求要被满足,即回答”做什么 ”

· 所开发的软件在什么环境中实现以及所需信息从哪里来, 即回答”从何处 ”

· 某些开发工作的时间如何安排,即回答”何时干 ”

· 某些开发(或维护)工作打算由”谁来干 ” · 某些需求是怎么实现的

· 为什么要进行那些软件开发或维护修改工作上述十三个文档都在一定程度上回答了这六个方面的问题.这可从表中看到.

表文档所回答的问题

至此,我们对文档的作用有了进一步的理解.每一个文档的任务也是明确的,任何一个文档都此是多余的.

文档是用来干什么的

文档是软件开发使用和维护中的必备资料. 软件文档或者源代码文档是指与软件系统及其软件工程过程有关联的文本实体.文档的类型包括软件需求文档,设计文档,测试文档,用户手册等.其中的需求文档,设计文档和测试文档一般是在软件开发过程中由开发者写就的,而用户手册等非过程类文档是由专门的非技术类写作人员写就的. 文档能提高软件开发的效率,保证软件的质量,而且在软件的使用过程中有指导、帮助、解惑的作用,尤其在维护工作中,文档是不可或缺的资料.

最近文档的作用是什么呢?

电脑管家里的“最近文档”主要有两个核心作用:1、在电脑上:你可以在最近文档格子中,快速找到并打开你最近30天内新建的、本地已有的、沟通软件接收的、浏览器下载的所有磁盘路径下的文档.2、在手机上:你可以通过绑定微信小程序,将电脑中的最近文档完全一致的传输到手机微信小程序中,方便你随时随附查看、分享、使用你的文档.