4软件文档写作要求xcz.ppt

第四章 软件文档写作要求 主要内容 4.1 软件文档管理指南 4.2 软件文档的编写原则 4.3 制定文档的编写策略 4.4建立文档的企业标准 4.5 制定文档的编制计划 4.6 建立文档的编制规程 4.7 软件文档的质量要求 4.8 软件文档的编写技巧 4.9 确定软件文档类型的种类 4.1 软件文档管理指南 软件文档管理指南（GB16680－1996）制定的目的在于协助管理者在他们的机构中产生有效的文档。其主要内容主要涉及文档编制的策略、标准、规程、资源和计划 4.2 软件文档的编写原则 4.2 软件文档的编写原则 项目开发计划可能包括： l???????? 质量保证计划； l???????? 配置管理计划； l???????? 用户培训计划； l???????? 安装实施计划。 系统设计说明书可分写成： l???????? 系统设计说明书； l???????? 子系统设计说明书。 程序设计说明书可分写成： l???????? 程序设计说明书； l???????? 接口设计说明书； l????????版本说明。 操作手册可分成以下内容： 操作手册； 安装实施过程； 测试计划可分成以下内容： 测试计划 测试设计说明 测试规程 测试用例 测试分析报告可分成以下内容： 综合测试报告 验收测试报告。 项目开发总结报告也可分成项目开发总结报告和资源环