13.2.1 软件文档的作用
(1)文档的概念。文档是指某种数据媒体和其中记录的数据。它具有永久性,并可以由人或机器阅读。在软件工程中,文档常常用来表示对活动、需求、过程或结果进行描述、定义、规定、报告或认证的任何书面或图示的信息。它们描述和规定了软件设计和实现的细节,说明使用软件的操作命令。文档也是软件产品的一部分,没有文档的软件就不称其为软件。软件文档的编址在软件开发工作中占有突出的地位和相当大的工作量。高质量、高效率地开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档,对于充分发挥软件产品的效益有着重要的意义。
(2)文档的作用。软件文档在产品的开发生产过程中起着重要的作用,具体如下。
①提高软件开发过程的能见度。把开发过程中发生的事件以某种可阅读的形式记录在文档中。管理人员可把这些记载下来的材料作为检查软件开发进度和开发质量的依据,实现对软件开发的工程管理。
②提高开发效率。软件文档的编制使得开发人员对各阶段的工作都进行周密思考、全盘权衡,从而减少返工。并且可在开发早期发现错误和不一致性,便于及时加以纠正。
③作为开发人员在一定阶段的工作成果和结束标志。(https://www.daowen.com)
④记录开发过程中的有关信息,便于协调以后的软件开发、使用和维护。
⑤提供对软件的运行、维护和培训的有关信息,便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解。使软件开发活动更科学、更有成效。
⑥便于潜在用户了解软件的功能、性能等各项指标,为他们选购符合自己需要的软件提供依据。
既然软件已经从手工艺人的开发方式发展到工业化的生产方式,文档在开发过程中就能起到关键作用。从某种意义上来说,文档是软件开发规范的体现和指南。按规范要求生成一整套文档的过程,就是按照软件开发规范完整一个软件开发的过程。所以,在使用工程化的原理和方法来指导软件的开发和维护时,应当充分注意软件文档的编制和管理。