软件文档写作要求(ppt 32页)

软件文档写作SoftwareDocumentComposition,主讲：李晓蕾E-mail:cathy1217,2,课程重要性,规范软件开发过程,设计一个图书馆管理系统,从哪里开始呢？,3,课程重要性,软件水平考试,4,课程重要性,使用说明中的词语，给出图1-2中的数据存储D1D5的名称。,5,课程重要性,论文,毕业设计,6,教材,教材：软件文档编写高等教育出版社辛明海等编参考资料：计算机软件工程标准(文档部分GB/T8567-1988、GB/T9385-1988)国家标准汇编中国标准出版社,7,课程学时分配和评分标准课时分配：每周2课时，共16周课后作业4次考试方法：过程化考核，4份报告（小组）评分标准：期末考试(60%)考勤(20%)作业(20%),8,软件文档写作过程化考核项目要求：每组不超过4人，设组长一名；组长负责：组织、分工、安排进度等；组长职权：最后根据小组总分分配成员得分；目的：通过项目，实际体验软件工程各阶段的主要工作以及相关文档写作，特别注意吸取教训；学会与他人合作，培养团队精神。因此，单干户将得不到成绩。,9,工作内容（1）可行性分析报告（书面）（2）需求规格说明书（书面）（3）概要设计说明书（书面）（4）详细设计说明书（书面）要求：根据软件工程技术和项目管理理念，在组内合理分工，协同工作。,10,补充：软件工程,软件发展的三个阶段,程序设计时代（50-60年代）软件指程序，软件开发关注程序编写，用汇编及机器语言,程序系统时代（60-70年代）软件指程序及说明书，软件开发包括程序设计和测试，用高级语言,软件工程时代（70年代以后）软件指程序、文档、数据，软件开发包括软件生命期，用软件语言（包括需求定义语言、软件功能语言、软件设计语言、程序设计语言等）,11,补充：软件工程,软件危机:,摆脱软件危机的出路：软件开发的工程化和标准化,在软件开发过程中遇到的问题找不到解决的办法，致使问题积累起来形成了日益尖锐的矛盾。危机实例：IBM公司1963-1966年开发IBM360操作系统，项目花了5000人-年的工作量，最多时有1000人投入开发工作，写出100万行源程序，但发行的每一新版本都是上一版1000个错误的修正。事后负责人F.D.Brooks总结教训时说：“正象一只逃亡的野兽落到泥潭中做垂死的挣扎，越是挣扎，陷的越深。最后无法逃脱灭顶的灾难。程序设计工作正像这样一个泥潭，一批批程序员被迫在泥潭中拼命挣扎，谁也没料到问题竟会陷入这样的困境”,12,补充：软件工程,软件工程:,软件工程是用科学知识和技术原理来定义、开发、维护软件的一门综合性的交叉学科，软件工程是开发与维护软件的规范化系统方法。它综合应用计算机科学、数学及管理科学等原理开发软件的工程。其中计算机科学、数学用于构造模型与算法，工程科学用于制定规范、设计范型、评估成本及确定权衡，管理科学用于用于计划、资源、质量、成本等管理。,13,软件生存周期,生存周期概念生存周期模型生存周期各阶段,14,软件生存周期,软件生存周期（softwarelifecycle）又称为软件生命期，生存期。是指从形成开发软件概念起，所开发的软件使用以后，直到失去使用价值消亡为止的整个过程。一般来说，整个生存周期包括计划、开发、运行三个时期，每一个时期又划分为若干阶段。每个阶段有明确的任务，这样使规模大、结构复杂和管理复杂的软件开发变得容易控制和管理。,软件生存周期概念,15,软件生存周期,软件生存周期模型描述软件开发过程中各种活动如何执行的模型。是软件工程过程的简化的抽象描述。瀑布模型演化模型螺旋模型喷泉模型增量模型,16,软件生存周期模型.瀑布模型,优点：支持结构化软件开发、控制软件开发复杂性、促进软件开发工程化。,缺点：阶段间具有顺序性，各阶段依赖性强，缺乏灵活性。,适用于系统需求明确、技术成熟工程管理较严格的场合。对需求不明确的问题，开发完成后才发现不是用户所需，要纠正偏差会付出高额代价。,17,软件生存周期模型2。演化模型快速原型化方法,优点：与用户见面快、开发成功率高。,缺点：开发周期长，开发成本较高。,适用于需求不太明确的大系统,18,软件生存周期模型3。螺旋模型,结合了瀑布模型和演化模型的优点，加入了风险分析的因素。,沿着螺旋线在坐标系的四个象限分别表达四个方面的活动：制定计划、风险分析、实施工程、客户评估。每转一圈表示一个新的版本的开发。,适用于大型软件开发。,19,软件生命周期,软件生命期各阶段,软件计划与可行性研究软件系统需求分析软件设计软件编码软件测试与调试软件运行与维护,软件生命期一般包括以下各阶段：,20,一、问题定义问题定义阶段必须回答的关键问题是：“要解决的问题是什么?”二、可行性研究此阶段的任务不是具体解决问题，而是研究问题的范围，探索这个问题是否值得去解决，是否有可行的解决办法。三、需求分析这个阶段的任务，主要是确定目标系统必须具备哪些功能。,软件生命周期,21,四、总体设计这个阶段必须回答的关键问题是：“应该如何解决这个问题?”五、详细设计详细设计阶段的任务就是把解法具体化，设计出程序的详细规格说明，包括必要的细节，程序员可以根据它们写出实际的程序代码。六、编码和单元测试这个阶段的任务是程序员根据目标系统的性质和实际环境，选取一种适当的高级程序设计语言(必要时用汇编语言)，把详细设计的结果翻译成用选定的语言书写的程序，并且仔细测试编写出的每一个模块。,22,七、综合测试这个阶段的任务是通过各种类型的测试，使软件达到预定的要求。八、软件维护维护阶段的任务，是通过各种必要的维护活动使系统持久地满足用户的需要。,23,第一章软件文档概念,1.1为什么需要软件文档？文档是计算机软件产品的重要组成部分，没有文档就不成其为软件，也更不能成为软件产品。软件文档是一种重要的软件工程技术资料。如系统分析文档、设计文档、版本说明文档软件文档的规范编制，在软件开发工作中占有突出的地位和相当大的工作量。高质量、高效率的编制、分发、管理、维护文档，及时的变更、修正、扩充和使用文档，对于软件产品的设计开发、发行使用、变更维护、转让移植、二次开发等，对于充分发挥软件产品的效益，都有着重要的意义。,观点：“如果不记下来，它就并不存在”。正如老子在道德经中所述：鱼不可脱于渊，国之利器不可以示人。,24,1.2软件文档的定义软件文档写作是为了记录目标系统的定义、规划、分析、研究、设计、开发、应用等各个阶段的设计思想和研究成果。文档某种数据媒体和其中所记录的数据。文档具有永久性，并可供人或机器阅读，通常指专供人阅读的东西。文档作为计算机软件的重要组成部分，告诉用户如何操作和维护系统，提供关于未来改进和重新实施所需的信息，在开发人员、维护人员、管理人员、用户与计算机之间起着重要的桥梁作用。,计算机软件,25,1.3文档的作用软件文档在产品开发过程中具有十分重要的桥梁作用，主要反映在以下几个方面：1.项目管理的依据文档将通常“不可见的”软件开发进程转换成“可见的”文字资料，有利于项目的管理。2.技术交流的语言项目小组内部、项目平行开发的各小组之间进行的交流和联系，通常都是通过文档来实现的。3.项目质量保证文档是进行项目质量审查和评价的重要依据，有效文档的提供，可以满足项目质量保证人员和审查人员的工作需要。,26,4.支持培训与维护合格的软件文档通常都提供有关软件运行、维护和培训的必要信息，支持软件产品的应用和维护。5.支持软件维护软件文档提供系统开发的全部必要技术资料，有利于维护人员熟悉系统，开展维护工作；软件维护文档记载了软件维护过程中软件及其环境变化的全部信息。6.记载软件历史软件文档作为“记载软件历史的语言”，可用作未来项目的一种资源，向潜在用户报道软件的各种有利信息，便于他们判断自己是否需要该软件提供的服务。良好的系统文档，显然有助于完成软件的移植，或将软件转移到各种新的系统环境中去。,27,1.4软件文档的分类国家标准局在1988年1月颁布了计算机软件开发规范和计算机软件产品开发文件编制指南，作为软件开发和文档编制工作的准则和规程。基于软件生存期方法，可以从形式上将软件文档大致分成两类：软件开发过程中需要填写的各种图表，及应编制的各种技术文件或管理资料。软件文档根据其产生和使用的范围，主要划分为3大类：开发文档、用户文档和管理文档。,软件文档,开发文档,用户文档,管理文档,可行性研究报告,项目开发计划,软件需求说明书,数据库设计说明书,概要设计说明书,详细设计说明书,用户手册,操作手册,软件需求说明书,数据要求说明书,项目开发计划,模块开发卷宗,开发进度月报,测试计划,测试分析报告,项目开发总结报告,28,1.5软件文档与使用者的关系软件开发中产生的各类文档面向不同的用户，而软件用户应该得到的文档也在商业合同中有明确规定。,软件文档的使用对象,开发人员,维护人员,管理人员,用户,可行性研究报告,项目开发计划,软件需求说明书,数据要求说明书,概要设计说明书,详细设计说明书,数据库设计说明书,测试计划,测试分析报告,设计说明书,测试分析报告,模块开发卷宗,可行性研究报告,项目开发计划,模块开发卷宗,开发进度月报,项目开发总结报告,用户手册,操作手册,29,1.6软件文档编制与软件生存期的关系软件文档的编制是随着软件生存期各个阶段工作的