文档介绍：文档分类:条例文档编号:WDGF001版本:-7-,有助于程序员编制程序,有助于管理人员监督和管理软件开发,有助于用户了解软件的工作和应做的操作,有助于维护人员进行有效的修改和扩充,文档的编制必须保证一定的质量。质量差的软件文档不仅使读者难于理解,给使用者造成许多不便,而且会削弱对软件的管理,增高软件的成本,甚至造成更加有害的后果。造成软件文档质量不高的原因可能是:,缺乏评价文档质量的标准。。高质量的文档应当体现在以下方面:①针对性;文档编制以前应分清读者对象,按不同的类型、不同层次的读者,决定怎样适应他们的需要。例如,管理文档主要是面向管理人员的,用户文档主要是面向用户的,这两类文档不应像开发文档(面向软件开发人员)那样过多地使用软件的专业术语。②精确性:文档的行文应当十分确切,不能出现多义性的描述。同一课题若干文档内容应该协调一致,应是没矛盾的。③清晰性:文档编写应力求简明,如有可能,配以适当的表,以增强其清晰性。④完整性:任何一个文档都应当是完整的、独立的,它应自成体系。例如,前言部分应作一般性介绍,正文给出中心内容,必要时还有附录,列出参考资料等。同一课题的几个文档之间可能有些部分相同,这些重复是必要的。⑤灵活性:各个不同的软件项目,其规模和复杂程度有着许多实际差别,不能一律看待。对于较小的或比较简单的项目,可做适当调整或合并。比如,可将用户手册和操作手册合并成用户操作手册;软件需求说明书可包括对数据的要求,从而去掉数据要求说明书;概要设计说明书与详细设计说明书合并成软件设计说明书等。⑥可追溯性;由于各开发阶段编制的文档与各阶段完成的工作有着紧密的关系,前后两个阶段生成的文档,随着开发工作的逐步扩展,具有一定的继承关系。在一个项目各开发阶段之间提供的文档必定存在着可追溯的关系。例如,某一项软件需求,必定在设计说明书,测试计划以至用户手册中有所体现。,针对文档的要求必须系统化,规范化。软件项目中产生文档:可行性分析报告、项目开发计划、需求规格说明书、数据要求说明书、测试计划、概要设计说明书、详细设计说明书、模块开发卷宗、数据库设计说明书、用户手册、操作手册、测试分析报告、开发进度月报、项目开发总结、程序维护手册。其中,选择需求规格说明书、数据库设计说明书做为此报告分析重点。,必须进行需求验证。一般说来,一个有效地需求规格说明书应具有如下特征:正确性、无歧义性、完整性、一致性、可验证性、可理解性、可修改性、可追总行和注释等。需求规格说明书决定软件所需完成的功能和整个项目的要求,所以必须有规范的书写格式。参考格式:文档介绍其中包含有文档目的,文档范围,术语及缩写引言阐述编写目的、背景,列出有关参考资料等。类似于《可行性研究报告》。、功能、编程语言、用户特点、一般性约束等。、图表或数学公式详细描述被开发软件的输入、处理、输出、以及、在上述过程中发生的基本操作等