软件项目管理-如何写好项目文档1.1.pptxVIP

01 正确理解文档 02 文档编写的三个步骤 03 文档编排管理 软件（英文：Software）是一系列按照特定顺序组织的计算机数据和指令的集合。一般来讲软件被划分为系统软件、应用软件和介于这两者之间的中间件。软件并不只是包括可以在计算机（这里的计算机是指广义的计算机）上运行的电脑程序，与这些电脑程序相关的文档一般也被认为是软件的一部分。简单的说软件就是程序加文档的集合体。另也泛指社会结构中的管理系统、思想意识形态、思想政治觉悟、法律法规等等。。 1.1.1 什么是软件？ 第一节 软件文档概念 1.1.2 为什么需要软件文档？ 第一节 软件文档概念 项目管理的依据：文档将通常“不可见的”软件开发进程转换成“可见的”文字资料，有利于项目的管理。。 技术交流的语言：项目小组内部、项目平行开发的各小组之间进行的交流和联系，通常都是通过文档来实现的。 项目质量保证：文档是进行项目质量审查和评价的重要依据，有效文档的提供，可以满足项目质量保证人员和审查人员的工作需要。 支持培训与维护：合格的软件文档通常都提供有关软件运行、维护和培训的必要信息，支持软件产品的应用。 支持软件维护：软件文档提供系统开发的全部必要技术资料，有利于维护人员熟悉系统，开展维护工作；软件维护文档记载了软件维护过程中软件及其环境变化的全部信息。 记载软件历史： 软件文档作为“记载软件历史的语言”，可用作未来项目的一种资源，向潜在用户报道软件的各种有利信息，便于他们判断自己是否需要该软件提供的服务。 第一节 软件文档概念 1.1.3 文档的作用 第二节 软件文档分类 1.2.1 根据产生和使用范围分 软件文档 开发文档 用户文档 管理文档 ? 可行性研究报告 ? 项目开发计划 ? 软件需求说明书 ? 数据库设计说明书 ? 概要设计说明书 ? 详细设计说明书 ? 用户手册 ? 操作手册 ? 软件需求说明书 ? 数据要求说明书 ? 项目开发计划 ? 开发进度月报 ? 测试计划 ? 测试分析报告 ? 项目开发总结报告 1.2.2 开发文档 开发文档主要可以发挥以下几个方面的作用： 作为软件生存期整个阶段之间的通信工具，记录生成软件需求、设计、编码、测试等的详细规定和说明； 描述开发小组的工作职责。通过规定软件规划设计、主题事项、文档编制、质量保证等人员的角色，来定义“如何做”和“何时做”； 用作检验点，而允许管理者评估开发进度。如果开发文档缺失或过时，管理者将失去跟踪和控制软件项目的重要工具； 形成系统维护人员所要求的基本的软件支持文档，并构成产品文档 的一部分； 记录软件开发的历史。 开发文档主要负责对软件开发过程进行描述和规范。开发文档除了前面列表的内容，还包括软件的详细技术描述，如程序逻辑、程序间相互关系、数据格式、存储等。 第二节 软件文档分类 1.2.3 用户文档 用户文档主要发挥以下作用： 为使用和运行软件产品的用户提供培训和运行参考信息； 为产品维护工程师提供必要的信息； 促进和方便软件产品的市场推广。 用户文档主要负责对软件产品的安装、配置、使用、维护等信息进行描述。包括系统安装配置手册、用户操作手册、软件需求说明书、数据要求说明书等。 第二节 软件文档分类 1.2.4 管理文档 管理文档主要有以下作用： 软件初期定义、规划、商务等与客户互动结果的记录； 开发过程每个阶段的进度和进度变更的记录； 软件开发人员的组织、管理和变更的记录； 软件需求、规划、设计等的变更控制的记录； 开发过程发生的各种审查、审核、评估等情况的记录； 验收、培训、移交、安装等相关工作的实施记录； 维护需求的提出、认定、计划、实施等工作的记录。 管理文档主要是对软件开发过程的管理信息进行描述。管理文档除了前面列表内容，还应该包括被管理者的反馈信息，如各色表格、工作总结、开发体会、产品建议等。 第二节 软件文档分类 软件文档最终需要回答读者关心的下列问题： 第三节 软件文档最终需要回答的问题 01 正确理解文档 02 文档编写的三个步骤 03 文档编排管理 那么，软件文档如何表达？。 第一节 引言 2.1.1 诗歌与编码 第一节 引言 2.1.2 知其然 通常版本的故事是这样的…… 第一节 引言 2.1.3 知其所以然 高手的故事是这样的…… 步骤分解说明 文档编制者在编写文档时，通常会采用两种形式：意识流或执行流。 意识流：按思维在编写者头脑中出现的顺序捕捉思维，并加以记录。通常缺乏可读的组织结构。 执行流：按软件执行时的思维顺序捕捉思维，并加以记录。缺乏重点内容的突出展现。 写给谁看？ 写什么？ 需要达到什么效果？ … 用什么顺序？ 是否需要拆分文档？ 能否说明问题？ … 是否抓住重点？ 是否有重复？ 是否有歧义？ … 第二节 文档