软件工程标化与文档.ppt

软件工程标准化与文档 授课教师：李梁 联络电话电子邮件：iliang@ 软件工程标准化与文档 软件工程标准 ISO 9000-3标准及软件质量认证 软件文档的作用与分类 文档编制质量要求 软件生存期各阶段与各种文档编制的关系 文档要回答的问题 作业： §4 文档编制的质量要求 如果不重视文档编写工作，或是对文档编写工作的安排不当，就不可能得到高质量的文档。 1、质量差的文档 使读者难于理解，给使用者造成许多不便 会削弱对软件的管理（难以确认和评价开发工作的进展情况)，提高软件成本(一些工作可能被迫返工) 造成误操作 2、高质量文档质量要求 (1) 针对性 文档编制以前应分清读者对象。按不同的类型、不同层次的读者，决定怎样适应他们的需要。 管理文档面向管理人员，用户文档主要面向用户 这两类文档尽量少使用专用术语。 (2) 精确性 ：文档的行文应当十分确切，不能出现多义性的描述。同一课题几个文档的内容应当是协调一致，没有矛盾的。 (3) 清晰性：文档编写应力求简明，如有可能，配以适当的图表，以增强其清晰性。 (4) 完整性：任何一个文档都应当是完整的、独立的，它应自成体系。 例如，前言部分应做一般性介绍，正文给出中心内容，必要时还有附录，列出参考资料等。 同一课题的几个文档之间可能有些部分内容相同，这种重复是必要的。 不要在文档中出现转引其它文档内容的情况。如，一些段落没有具体描述，用“见××文档××节” (5) 灵活性：各个不同软件项目，其规模和复杂程度有着许多实际差别，不能一律看待。应根据具体的软件开发项目，决定编制的文档种类。 软件开发的管理部门应该根据本单位承担的应用软件的专业领域和本单位的管理能力，制定一个对文档编制要求的实施规定。 对于一个具体的应用软件项目，项目负责人应根据上述实施规定，确定一个文档编制计划。包括： 编制哪几种文档，详细程度如何 各文档的编制负责人和进度要求 审查/批准负责人和时间进度安排 在开发时期内各文档的维护、修改和管理的负责人，以及批准手续 有关的开发人员必须严格执行这个文档编制计划。 (6)当所开发的软件系统非常大时，一种文档可以分成几卷编写。例如， 项目开发计划可分写为：质量保证计划、配置管理计划、用户培训计划、安装实施计划等。 系统设计说明书可分写为：系统设计说明书、子系统设计说明书。 程序设计说明书可分写为：程序设计说明书、接口设计说明书、版本说明。 操作手册可分写为：操作手册、安装实施过程。 测试计划可分写为：测试计划、测试设计说明、测试规程、测试用例。 测试分析报告可分写为：综合测试报告、验收测试报告。 项目开发总结报告也可分写成：项目开发总结报告、资源环境统计。 * §1 软件工程标准 软件危机的出路在于软件开发的工程化和标准化。 程序设计语言的标准化：为某一程序设计语言规定若干个标准子集，对于语言的实现者和用户都带来了很大方便。 软件过程的标准化：软件生存期各个阶段的工作建立标准或规范。 1、软件工程标准的类型 国家标准GB／T 15538－1995《软件工程标准分类法》给出软件工程标准的分类。 涉及过程管理、产品管理、资源管理，以及确认与验证。 过程标准：方法、技术、度量 产品标准：需求、设计、部件、描述、计划、报告 专业标准：职别、道德准则、认证、特许、课程 记法标准：术语、表示法、语言 2、软件工程标准化的作用 可提高软件的可靠性、可维护性和可移植性； 可提高软件人员的技术水平，减少差错和误解； 可提高软件人员之间的通信效率，提高软件的生产率； 有利于软件管理；有利于降低软件产品的成本和运行维护成本； 有利于缩短软件开发周期。 3、软件工程标准的层次 (1) 国际标准：由国际联合机构制定和公布，提供各国参考的标准。 国际标准化组织 ISO (International Standards Organization)这一国际机构有着广泛的代表性和权威性，它所公布的标准也有较大的影响。 ISO建立了“计算机与信息处理技术委员会”, 简称ISO／TC97，专门负责与计算机有关的标准化工作。 这一标准通常冠有ISO字样，如 ISO 8631－86 Information processing_program constructs and conventions for their representation《信息处理──程序构造及其表示法的约定》。该标准现已由中国收入国家标准。 (2) 国家标准：由政府或国家级的机构制定或批准，适用于全国范围的标准，如： GB：中华人民共和国国家技术监督局公布实施的标准，简称“国标”。现已批准了若干软件工程标准。 ANSI (American