当前位置: 首页 > 新闻中心 > 软件开发文档标准(八)#软件开发#软件文档

软件开发文档标准(八)#软件开发#软件文档


  1. 软件开发文档干什么的?
  2. 软件文档在软件开发中的作用
  3. 软件开发文档的用途有哪些(软件工程文档的作用)

一、软件开发文档干什么的?

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

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

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

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

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

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

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

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

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

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

ps:软件开发文档包括:

操作手册

维护修改建议

软件需求(规格)说明书

开发文档 软件需求(规格)说明书

数据要求说明书

概要设计说明书

详细设计说明书

可行性研究报告

项目开发计划

管理文档 项目开发计划

测试计划

测试报告

开发进度月报

开发总结报告

二、软件文档在软件开发中的作用

软件文档在软件开发中的作用是提高软件开发过程的能见度。

在软件的生产过程中,总是伴随着大量的信息要记录、使用。因此,软件文档在产品的开发过程中起着重要的作用。软件文档在软件开发中的主要作用是提高软件开发过程的能见度。还可以记录开发过程的相关信息;提高开发效率;作为开发人员在一定阶段的工作成果和结束标志;便于潜在用户了解软件的功能、性能等各项指标。

软件文档在软件开发中起到很重要作用,如果没有软件文档,后前的工作就难以展开,维护很难。软件文档其实可以看做是一个规范、标准,特别是前期的需求分析,利用软件文档可以很好的去了解业务逻辑等。

软件文档的管理标准

1、软件开发小组应当设立一位文档管理员,管理所有文档。

2、软件开发小组成员可根据工作需要在自己手中保存一些个人文档。

3、开发人员只保存着主文档中与它工作有关的部分文档。

4、在新文档取代旧文档时,管理人员应随时修订主文本,使其及时反应更新了的类容。

5、项目开发结束时,文档管理人员应收回开发人员的个人文档,与主文档对比差异,着手解决有差异的地方。

6、在开发过程中,严格控制修改已经完成的文档。

以上内容参考百度百科-软件文档

三、软件开发文档的用途有哪些(软件工程文档的作用)

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

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

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

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

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

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

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

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

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

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

ps:软件开发文档包括:

操作手册

维护修改建议

软件需求(规格)说明书

开发文档软件需求(规格)说明书

数据要求说明书

概要设计说明书

详细设计说明书

可行性研究报告

项目开发计划

管理文档项目开发计划

测试计划

测试报告

开发进度月报

开发总结报告

......