软件文档写作要求xcz .pptVIP

第四章 软件文档写作要求 主要内容 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????????版本说明。 操作手册可分成以下内容： 操作手册； 安装实施过程； 测试计划可分成以下内容： 测试计划 测试设计说明 测试规程 测试用例 测试分析报告可分成以下内容： 综合测试报告 验收测试报告。 项目开发总结报告也可分成项目开发总结报告和资源环境统计。 4.2 软件文档的编写原则 4.2 软件文档的编写原则 例：P.86 航空行李托运费的算法 按规定：重量不超过30公斤的行李可免费托运。重量超过30公斤时，对超运部分，头等舱国内乘客收4元/公斤；其它舱位国内乘客收6元/公斤；外国乘客收费为国内乘客的2倍；残疾乘客的收费为正常乘客的1/2。 4.2 软件文档的编写原则 4.2 软件文档的编写原则 主要内容 4.1 软件文档管理指南 4.2 软件文档的编写原则 4.3 制定文档的编写策略 4.4建立文档的企业标准 4.5 制定文档的编制计划 4.6 建立文档的编制规程 4.7 软件文档的质量要求 4.8 软件文档的编写技巧 4.9 确定软件文档类型的种类 4.3 制定文档的编写策略 文档策略是由上级（资深）管理者提出并支持的，对下级开发单位或开发人员提供指导。策略规定主要的方向，而不是规定做什么或如何做。 评估现有策略条款的有效性和完整性的文档检查表 ——适当的文档的决策作出了吗？ ——涉及文档的策略声明发布了吗？ ——负责开发文档和产品文档编写工作的人员或部门落实了吗？ ——用于文档编制的资源落实了吗？ ——负责文档质量的人员或部门落实了吗？ ——各管理层次和组织各分支之间的各种关系确定了吗？ ——对于文档的编制、分发和维护等方面是否确定了职责、所需活动和联系途径？ ——所有的文档要求已列入整个项目开发计划表中了吗？ ——适用的文档标准已确定了吗？ ——是否已考虑采用支持工具和自动化的文档编制？ 主要内容 4.1 软件文档管理指南 4.2 软件文档的编写原则 4.3 制定文档的编写策略 4.4建立文档的企业标准 4.5 制定文档的编制计划 4.6 建立文档的编制规程 4.7 软件文档的质量要求 4.8 软件文档的编写技巧 4.9 确定软件文档类型的种类 4.4建立文档的企业标准 是不是每个人编写的文档质量都一样？如何确定文档的质量？如何保证？ 评价文档的质量主要从两个方面： 文档的结构：其质量从各个组成部分的顺序和总体安排的简单性来测定。 文档的内容：从文档内容的正确性、完整性和明确性来判断。 4.4建立文档的企业标准 在一个机构内部应采用一些标准和指南: 软件生存期模型 文档类型和相互关系 文档质量 标准和指南作用： （1）决定如何实现文档任务 （2）提供一些准则以评价该机构内所产生的软件文档的完整性、可用性和适合性。 尽可能地采用现行的国家和国际标准，若现行的标准不适用，机构应制订自己的标准 4.4建立文档的企业标准 1.选择软件生存期模型 2.规定文档类型和内容 3.确定文档的质量等级 1.选择软件生存期模型 软件生存周期模型无关紧要, 但阶段和相应的文档必须清晰定义、计划、并且适用具体的软件项目。 管理者应选择一个软件生存期模型并保证该模型在他们机构内是适用的 生存周期选择对管理者作用： （1）软件周期中相应的阶段划分与各阶段定义将有助于监控软件项目的进展， （2）相应于特定阶段生成的文档可用作该阶段的评审通过和完成的检验点 2规定文档类型和内容 软件文档归入如下三种类别： 开发文档——描述开发过程本身 产品文档——描述开发过程的产物 管理文档——记录项目管理的信息 以上内容已在P18软件文档的分类中讲过。 3. 文档的质量等级 文档的