软件文档写作03-文档类型.ppt

* 3.1 软件文档类型 软件文档可以用自然语言、形式语言、介于两者之间的半形式语言、各类图形表格等方式编制。文档可以书写编制，也可以用计算机辅助编制。 基于软件生存期方法，可以从形式上将软件文档大致分成两类：软件开发过程中需要填写的各种图表，及应编制的各种技术文件或管理资料。 软件文档根据其产生和使用的范围，主要划分为3大类：开发文档、用户文档和管理文档。 软件文档 开发文档 用户文档 管理文档 可行性研究报告 项目开发计划 软件需求说明书 数据库设计说明书 概要设计说明书 详细设计说明书 用户手册 操作手册 软件需求说明书 数据要求说明书 项目开发计划 模块开发卷宗 开发进度月报 测试计划 测试分析报告 项目开发总结报告 第三章 软件文档类型和风格 1. 开发文档 开发文档主要负责对软件开发过程进行描述和规范。开发文档除了前面列表的内容，还包括软件的详细技术描述，如程序逻辑、程序间相互关系、数据格式、存储等。 开发文档主要可以发挥以下几个方面的作用： (1) 作为软件生存期个阶段之间的通信工具，记录生成软件需求、设计、编码、测试等的详细规定和说明； (2) 描述开发小组的工作职责。通过规定软件规划设计、主题脚本编制、文档编制、质量保证等人员的角色，来定义“如何做”和“何时做”； (3) 用作检验点，而允许管理者评估开发进度。如果开发文档缺失或过时，管理者将失去跟踪和控制软件项目的重要工具； (4) 形成系统维护人员所要求的基本的软件支持文档，并构成产品文档 的一部分； (5) 记录软件开发的历史。 2. 用户文档 用户文档主要负责对软件产品的安装、配置、使用、维护等信息进行描述。包括系统安装配置手册、用户操作手册、软件需求说明书、数据要求说明书等。用户文档主要发挥以下作用： (1) 为使用和运行软件产品的用户提供培训和运行参考信息； (2) 为产品维护工程师提供必要的信息； (3) 促进和方便软件产品的市场推广。 用户文档的提供通常可以包括以下形式：产品的市场宣传资料、适合管理者的产品指南和相关资料、提供给潜在用户的较深入的产品技术资料、产品使用所需的完整的操作和技术资料等。 用户文档的涉众通常包括以下人员：一般潜在用户、具有决策权的潜在用户、最终用户、产品维护人员等。 最基本的用户文档通常包括以下几类：产品培训手册、产品操作手册、产品安装配置手册、产品支持手册、产品信息广告等。 用户文档的分发按照涉众的类型j进行。不同类型的涉众可以获得不同的用户文档。用户文档在分发前应该制定合适的分发策略和计划。 3. 管理文档 管理文档主要是对软件开发过程的管理信息进行描述。管理文档除了前面列表内容，还应该包括被管理者的反馈信息，如各色表格、工作总结、开发体会、产品建议等。 管理文档主要有以下主要： (1) 软件初期定义、规划、商务等与客户互动结果的记录； (2) 开发过程每个阶段的进度和进度变更的记录； (3) 软件开发人员的组织、管理和变更的记录； (4) 软件需求、规划、设计等的变更控制的记录； (5) 开发过程发生的各种审查、审核、评估等情况的记录； (6) 验收、培训、移交、安装等相关工作的实施记录； (7) 维护需求的提出、认定、计划、实施等工作的记录。 3.2 软件文档风格的概念 从软件工程学中我们可以获知，软件的体系结构具有几种相对稳定的基本构架类型，因此，软件系统分析师通常必须同时以3种方式对自己的软件进行考虑： 1. 作为一个实现单元集，它是如何构造的； 2. 作为一个具有运行时行为和交互作用的元素集，它是如何构造的； 3. 它是如何在自己所处的环境内与非软件结构产生联系的。 因此，作为软件文档的编制者，应该了解软件的这些基本构架类型会对软件文档的编制产生什么影响？ 这些因软件某一构架类型而影响软件文档的编制表达，称为软件文档风格。 软件文档风格允许我们将专门的设计知识应用于特定类型的软件系统，也允许我们利用特定风格的工具、分析方法和实现方案支持这类系统的设计。 事实上，软件的文档风格可以和软件的结构元素形成互动。即不同的软件结构能够导致不同的文档风格，而文档风格也可能影响到软件的结构。接下去，我们就可以采用与软件结构密切相关的视图及其类型一起讨论相关的软件文档编制。 对软件文档风格的研究，既可以促进软件文档编制工作的标准化，提高软件文档编制的效率和质量，又可以改进软件分析、构造和设计的过程，同时还为软件文档编制和软件构架过程的同步、自动化提供了可能。 3.3 软件视图 具体的，什么是软件视图？回答这个问题主要取决于你的目标！ 我们已