南华大学计算机科学与技术学院软件文档写作 第3讲.pdfVIP

第三章 软件文档类型和风格 } 3.1 软件文档类型 } 3.2 软件文档风格 } 3.3 软件视图 } 3.4 风格指导 } 3.5 模块视图及文档风格 } （1）分解风格、 } （2）使用风格、 } （3）泛化风格 1 3.1软件文档类型 可行性研究报告 项目开发计划 软件文档可以用自然语言、 软件需求说明书 形式语言、介于两者之间 开发文档 的半形式语言、各类图形 数据库设计说明书 表格等方式编制。文档可 概要设计说明书 以书写编制，也可以用计 算机辅助编制。 详细设计说明书 基于软件生存期方法， 用户手册 可以从形式上将软件文档 软件文档 用户文档 操作手册 大致分成两类：软件开发 软件需求说明书 过程中需要填写的各种图 数据要求说明书 表，及应编制的各种技术 文件或管理资料。 项目开发计划 软件文档根据其产生 模块开发卷宗 和使用的范围，主要划分 为3大类：开发文档、用 管理文档 开发进度月报 户文档和管理文档。 测试计划 测试分析报告 项目开发总结报告 2 1. 开发文档 开发文档主要负责对软件开发过程进行描述和规范。开发文档除 了前面列表的内容，还包括软件的详细技术描述，如程序逻辑、程序 间相互关系、数据格式、存储等。 开发文档主要可以发挥以下几个方面的作用： (1)作为软件生存期个阶段之间的通信工具，记录生成软件需求、设 计、编码、测试等的详细规定和说明； (2)描述开发小组的工作职责。通过规定软件规划设计、主题脚本编 制、文档编制、质量保证等人员的角色，来定义“如何做”和“何时 做”； (3)用作检验点，而允许管理者评估开发进度。如果开发文档缺失或 过时，管理者将失去跟踪和控制软件项目的重要工具； (4)形成系统维护人员所要求的基本的软件支持文档，并构成产品文 档 的一部分； (5)记录软件开发的历史。 3 2. 用户文档 用户文档主要负责对软件产品的安装、配置、使用、维护等信息进行描 述。包括系统安装配置手册、用户操作手册、软件需求说明书、数据要求说 明