软件工程文档的作用: 硬件产品和产品资料在整个生产过程中都是有形可见的,软件生产则有很大不同,文档本身就是软件产品。没有文档的软件,不成为软件,更谈不到软件产品。软件文档的编制在软件开发工作中占有突出的地位和相当的工作量。高效率、高质量地开发、分发、管理和维护文档,对于转让、变更、修正、扩充和使用文档,对于充分发挥软件产品的效益有着重要意义。
然而,在实际工作中,文档的编制和使用都存在着许多问题,很多不规范的地方有待于解决。软件开发人员中较普遍地存在着对编制文档不感兴趣的现象。从用户方面看,他们又常常抱怨:文档售价太高、文档不够完整、文档编写得不好、文档已经陈旧或是文档太多、难于使用等。究竟应该怎样要求它,文档应该写哪些,说明什么问题,起什么作用?
软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据,这个作用是显而易见的。软件开发过程中软件开发人员需制定一些工作计划或工作报告,这些计划和报告都要提供给管理人员,并得到必要的支持。管理人员则可通过这些文档了解软件开发项目安排、进度、资源使用和成果等。软件开发人员需为用户了解软件的使用、操作和维护提供详细的资料,称之为用户文档。可见,文档在开发过程中就起到关键作用。
从某种意义上来说,文档是软件开发规范的体现和指南。按规范要求生成一整套文档的过程,就是按照软件开发规范完成一个软件开发的过程。所以,在使用工程化的原理和方法来指导软件的开发和维护时,应当充分注意软件文档的编制和管理。
在软件开发的过程中,文档的作用不可小视。它们不仅能帮助开发人员了解自己的工作进度,方便自己和他人阅读和改进代码,还能够帮助项目的管理人员管理软件开发进程、提高软件开发的效率和质量、改进软件开发过程。