软件文档国家标准与写作要求.pptVIP

主要内容 软件文档国家标准 软件产品开发文件编制指南 软件产品开发文件编制指南 软件需求说明编制指南 软件需求说明编制指南 软件需求说明编制指南 软件需求说明编制指南 软件需求文档的编制目标 软件需求文档的基本要求 软件需求标准适用范围 软件测试文档编制规范 软件测试文档内容 测试计划 测试说明 测试报告 测试文档的结构 1、测试计划 2、测试设计说明 4、测试规程说明 8、测试总结报告 测试文档的编制 测试文档的编制 测试文档的编制 软件文档管理指南 主要内容 软件文档的编写原则 软件文档的编写原则 软件文档的编写原则 软件文档的编写原则 软件文档的编写原则 制定文档的编写策略 制定文档的编写策略 软件文档的质量等级 软件文档的质量等级 软件文档的质量等级 制定文档的编制计划 文档计划检查表 建立文档的编制规程 建立文档的编制规程 建立文档的编制规程 软件文档的质量要求 软件文档的编写技巧 确定软件文档类型的种类 确定软件文档类型的种类 确定软件文档类型的种类 确定软件文档类型的种类 软件文档的编写原则 制定文档的编写策略 软件文档的质量等级 制定文档的编制计划 建立文档的编制规程 软件文档的质量要求 软件文档的编写技巧 确定软件文档类型的种类 1、软件文档的编写原则 文档编制的原则 文档编写应适应文档的读者 文档编写应有必要的重复性 文档编写应具有一定灵活性 文档种类 文档详细程度 文档的扩展 章 节的扩张与缩并 程序设计的表现形式 文档的表现形式 文档其他种类 文档编制的原则 文档编写应适应文档的读者 文档编写应有必要的重复性 文档编写应具有一定灵活性 文档种类 文档详细程度 文档的扩展 章 节的扩张与缩并 程序设计的表现形式 文档的表现形式 文档其他种类 根据一个项目的规模、复杂性和成败风险，决定应编制的文档种类及其详细 当被开发的项目规模非常大时，可以将一个文档拆分成多个卷进行编制。 项目开发计划可能包括： 质量保证计划； 配置管理计划； 用户培训计划； 安装实施计划。 系统设计说明书可分写成： 系统设计说明书； 子系统设计说明书。 程序设计说明书可分写成： 程序设计说明书； 接口设计说明书； 版本说明。 所有的章节都可以进一步细分或缩并，以适应实际需要。 程序的设计表现形式可以使用多种形式，如流程图、判定表、等其他表现形式。 按规定：重量不超过30公斤的行李可免费托运。重量超过30公斤时，对超运部分，头等舱国内乘客收4元/公斤；其它舱位国内乘客收6元/公斤；外国乘客收费为国内乘客的2倍；残疾乘客的收费为正常乘客的1/2。 2、制定文档的编写策略 文档策略是由上级（资深）管理者提出并支持的，对下级开发单位或开发人员提供指导。策略规定主要的方向，而不是规定做什么或如何做。 文档需要覆盖整个软件生存期 文档应是可管理的 文档应适合于它的读者 文档效应应贯穿到软件的整个开发过程中 文档标准应被标识和使用 应规定支持工具 文档策略 评估现有策略条款的有效性和完整性的文档检查表 ——适当的文档的决策作出了吗？ ——涉及文档的策略声明发布了吗？ ——负责开发文档和产品文档编写工作的人员或部门落实了吗？ ——用于文档编制的资源落实了吗？ ——负责文档质量的人员或部门落实了吗？ ——各管理层次和组织各分支之间的各种关系确定了吗？ ——对于文档的编制、分发和维护等方面是否确定了职责、所需活动和联系途径？ ——所有的文档要求已列入整个项目开发计划表中了吗？ ——适用的文档标准已确定了吗？ ——是否已考虑采用支持工具和自动化的文档编制？ 3、软件文档的质量等级 是不是每个人编写的文档质量都一样？如何确定文档的质量？如何保证？ 评价文档的质量主要从两个方面： 文档的结构：其质量从各个组成部分的顺序和总体安排的简单性来测定。 文档的内容：从文档内容的正确性、完整性和明确性来判断。 文档的质量可以按文档的形式和要求划分为四级： （1）最低限度文档（1级文档）：1级文档适合开发工作量低于一个人月的软件。该文档应包含程序清单、开发记录、测试数据和程序简介。 （2）内部文档（2级文档）：2级文档可用于在精心研究后被认为没有与其他用户共享资源的专用程序。除1级文档提供的信息外，2级文档还包括程序清单内足够的注释以帮助用户安装和使用程序。 （3）工作文档（3级文档）：3级文档适合于由同一单位内若干人联合开发的程序，或可被其他单位使用的程序。 （4）正式文档（4