软工文档简介

软工文档简介

一、   软工文档的概念

          文档是指：是指某种数据媒体和其中所记录的数据。

          软件工程文档就是表示对活动、需求、过程或结果进行描述、定义、规定、报告或认证的任何书面或图示的信息。

二、   软工文档的作用

          软件开发文档是软件开发使用和维护过程中的必备资料。它能提高软件开发的效率，保证软件的质量，而且在软件的使用过程中有指导，帮助，解惑的作用，尤其在维护工作中，文档是不可或缺的资料。

三、   软工文档的分类

          按照文档产生和使用的范围，软件文档大致可以分为三类，开发文档、用户文档，管理文档。

四、   软工文档开发的质量要求

          软件工程文档在开发的过程中的要求，包括了五个主要的方面，针对性，精确性，清晰性，完整性，灵活性。

          针对性：文档编制以前应分清读者对象。按不同的类型、不同层次的读者，决定怎样适应他们的需要。

          精确性：文档的行文应当十分确切，不能出现多义性的描述，同一课题几个文档的内容应当是协调一致，没有矛盾的。

          清晰性：文档编写应力求简明，如有可能，配以适当的图表，以增强其清晰性。

          完整性：任何一个文档都应当是完整的、独立的，它应自成体系，不要在文档中出现转引其它文档内容的情况。

          灵活性：各个不同软件项目，其规模和复杂程度有着许多实际差别，不能一律看待，应根据具体的软件开发项目，决定编制的文档种类。