软件文档及其组成.ppt

软件文档与标准,第2章 软件文档及其组成,关于软件文档要说的话,文档对于工程的意义软件工程是针对大型系统开发的，是多人开发和团队合作，因此文档是相互交流的重要且必须的媒介。文档的媒介形式可以多种多样文档的重要性文档编写工作与代码编写工作同等重要。技术人员对文档人员的偏见有了完整的文档系统可以复现和维护，而只有代码则不行。文档编写的难度文档是给人看的（试想高中写作文，每年写申请书），代码是给机器看的。让学生选择写文档还是写代码软件工程的终极目标，文档既能被人看又能被机器理解。,课程介绍,主要内容文档分类 1、2章内容顺序调整一下标准化的概念软件文档的国标写作要求软件开发文档可行性报告、需求文档、概要设计、详细设计软件管理文档开发计划、测试计划和测试报告、进度报告、总结报告软件用户文档软件文档管理虽然没有实验，但是要完成课堂作业（准备练习本）,2.1 软件文档的概念,2.1.1 为什么需要文档文档是计算机软件产品的重要组成部分，没有文档就不成其为软件，也更不能成为软件产品。软件文档是一种重要的软件工程技术资料。如系统分析文档、设计文档、版本说明文档软件文档的规范编制，在软件开发工作中占有突出的地位和相当大的工作量。高质量、高效率的编制、分发、管理、维护文档，及时的变更、修正、扩充和使用文档，对于软件产品的设计开发、发行使用、变更维护、转让移植、二次开发等，对于充分发挥软件产品的效益，都有着重要的意义。,2.1 软件文档的概念,2.1.2 软件文档的定义软件文档写作是为了记录目标系统的定义、规划、分析、研究、设计、开发、应用等各个阶段的设计思想和研究成果。文档某种数据媒体和其中所记录的数据。文档具有永久性，并可供人或机器阅读，通常指专供人阅读的东西。文档作为计算机软件的重要组成部分，告诉用户如何操作和维护系统，提供关于未来改进和重新实施所需的信息，在开发人员、维护人员、管理人员、用户与计算机之间起着重要的桥梁作用。,2.1 软件文档的概念,文档的桥梁作用,2.2 软件文档的作用,1.项目管理的依据文档将通常“不可见的”软件开发进程转换成“可见的”文字资料，有利于项目的管理。“有据可查”2.技术交流的语言项目小组内部、项目平行开发的各小组之间进行的交流和联系，通常都是通过文档来实现的。3.项目质量保证文档是进行项目质量审查和评价的重要依据，有效文档的提供，可以满足项目质量保证人员和审查人员的工作需要。,2.2 软件文档的作用,4.支持培训与维护合格的软件文档通常都提供有关软件运行、维护和培训的必要信息，支持软件产品的应用和维护。5.支持软件维护软件文档提供系统开发的全部必要技术资料，有利于维护人员熟悉系统，开展维护工作；软件维护文档记载了软件维护过程中软件及其环境变化的全部信息。6.记载软件历史软件文档作为“记载软件历史的语言”，可用作未来项目的一种资源，向潜在用户报道软件的各种有利信息，便于他们判断自己是否需要该软件提供的服务。良好的系统文档，显然有助于完成软件的移植，或将软件转移到各种新的系统环境中去。,2.3 软件文档的分类,从形式上上将软件文档大致分成两类：软件开发过程中需要填写的各种图表编制的各种技术文件或管理资料根据其产生和使用的范围主要划分为三类：开发文档用户文档管理文档。,2.4 软件文档与使用者的关系,软件开发中产生的各类文档面向不同的用户，而软件用户应该得到的文档也在商业合同中有明确规定。,2.5 软件文档编制与软件生存周期的关系,软件文档的编制是随着软件生存期各个阶段工作的开展而适时进行的。其中，有的仅反映某一阶段的工作，有的则需要跨越多个阶段的工作。,2.5 软件文档编制与软件生存周期的关系,徐承志,Thank You!,