软件工程写作ppt课件

《软件工程写作ppt课件》由会员分享，可在线阅读，更多相关《软件工程写作ppt课件（38页珍藏版）》请在装配图网上搜索。

1、单击此处编辑母版标题样式,,单击此处编辑母版文本样式,,第二级,,第三级,,第四级,,第五级,,,*,软件文档,,什么是文档,,文档(document),是指某种数据媒体和其中所记录的数据。,,它具有,永久性,，并可以由人或机器阅读，通常仅用于描述人工可读的东西。,,在软件工程中，文档常常用来表示对,活动,、,需求,、,过程,或,结果,进行,描述、定义、规定、报告或认证,的任何书面或图示的信息。,,软件文档的作用,在软件生产过程中，软件文档在产品的开发过程中起着重要的作用：,,提高,软件开发过程的能见度,。把开发过程中,发生的事件,以某种可阅读的形式,记录在文档中,。,,管理人员可把这些记载下

2、来的材料,作为检查软件开发进度和开发质量的依据，实现对软件开发的工程管理,。,,提高开发效率,。软件文档的编制，使得开发人员,对各个阶段的工作,都进行,周密思考,、,全盘权衡,、,减少返工,。并且可,在开发早期发现错误和不一致性,，便于及时加以纠正。,,作为开发人员在一定,阶段的,工作成果和结束标志,。,,记录开发过程中有关信息，便于,协调,以后的软件开发、使用和维护。,软件文档的作用,,提供对软件的,运行,、,维护,和,培训,的有关信息，,便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解,。使软件开发活动更科学、更有成效。,,便于潜在用户了解软件的功能、性能等各项指标,，为他们选

3、购符合自己需要的软件提供依据。,软件文档的作用,,文档的桥梁作用,,文档的分类,软件文档从形式上来看，大致可分为两类：,,一类是开发过程中填写的各种图表，称之为,工作表格,；,,一类是应编制的技术资料或技术管理资料，称之为,文档或文件,。,,,按照文档产生和使用的范围，软件文档大致可分为三类：,,1、开发文档,,,软件需求说明书 数据要求说明书,,概要设计说明书 详细设计说明书,,可行性研究报告 项目开发计划,,文档的分类,,2、,管理文档,,,项目开发计划 测试计划,,测试报告 开发进度月报,,项目开发总结,,3、,用户文档,,,用户手册 操作手册,,维护修改建议 软

4、件需求说明书,文档的分类,,软件文档的工作,国家标准局在1988年1月发布了,,《计算机软件开发规范》,,《软件产品开发文件编制指南》,,作为软件开发人员工作的准则和规程。它们,基于软件生存期方法,，把软件产品,从形成概念开始,，,经过开发,、,使用和不断增补修订,，,直到最后被淘汰,的,整个过程,应提交的文档归于以下十三种。,,1、可行性研究报告,,说明该软件项目的实现在,技术上,、,经济上,和,社会因素上,的,可行性,;,,评述为合理地达到开发目标,可供选择的,各种可能的实现方案,;,,说明并论证所选定实施方案的理由。,,文档的分类,,2、项目开发计划,,为软件项目实施方案制定出的具体计划

5、。它包括,,,各部分工作的负责人员,,开发的进度,,开发经费的概算,,所需的硬件和软件资源等,,项目开发计划应提供给管理部门，并,作为开发阶段评审的基础,。,文档的分类,,3、软件需求说明书,,对目标软件的,功能,、,性能,、,用户界面,及,运行环境,等,作出详细的说明,。,,它是用户与开发人员,双方对软件需求取得共同理解基础上达成的协议，也是实施开发工作的基础,。,,4、数据要求说明书,,给出,数据逻辑描述,和,数据采集,的各项要求, 为生成和维护系统的数据文件做好准备。,文档的分类,,5、概要设计说明书,,该说明书是概要设计工作阶段的成果。它应当说明,,,系统的功能分配,,模块划分,,程序

6、的总体结构,,输入输出及接口设计,,运行设计,,数据结构设计,,出错处理设计等,,为详细设计奠定基础。,文档的分类,,6、详细设计说明书,,着重描述,每一个模块是如何实现的，包括实现算法、逻辑流程等。,,7、用户手册,,详细描述软件的,功能,、,性能,和,用户界面,，使用户了解,如何使用该软件,。,,8、操作手册,,为操作人员提供,软件各种运行情况的有关知识,，特别是操作方法细节。,文档的分类,,9、测试计划,,针对,组装测试和确认测试,，需要,为组织测试制定计划,。计划应包括,,,测试的内容,,进度安排,,条件,,人员,,测试用例的选取原则,,测试结果允许的偏差范围等,文档的分类,,10、测

7、试分析报告,,测试工作完成后，应,提交测试计划执行情况的说明。对测试结果加以分析，并提出测试的结论性意见,。,,11、开发进度月报,,该月报是软件人员,按月向管理部门提交的项目进展情况的报告,。报告应包括,进度计划与实际执行情况的比较,、,阶段成果,、,遇到的问题和解决的办法,以及,下个月的打算,等。,文档的分类,,12、项目开发总结报告,,软件项目开发完成之后，应当,与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本,和,投入的人力,。,,还需,对开发工作作出评价，总结经验和教训,。,,文档的分类,,13、维护修改建议,,,软件产品投入运行之后，可能有修正、更改等问题,，应

8、当,对存在的问题,、,修改的考虑,以及,修改的影响估计,等,做详细的描述,，写成维护修改建议，提交审批。,,以上软件文档是在软件生存期中，随着各个阶段工作的开展适时编制的。其中，有的仅反映某一个阶段的工作，有的则需跨越多个阶段,。,文档的分类,,软件生存期各阶段与各种文档编制的关系,,,,文档最终要向,软件管理部门,，或向,用户,回答下列问题,,,哪些需求要被满足（What）；,,软件在什么环境中实现，所需信息从哪里来（Where）；,,开发时间如何安排（When）；,,开发(或维护)工作打算由谁来做（Who）；,,需求应如何实现（How）；,,为什么要进行这些软件开发或维护修改工作（Why）

9、。,,文档要回答的问题,,,,对文档编制的质量要求,如果不重视文档编写工作，或是对文档编写工作的安排不当，就不可能得到高质量的文档。,,质量差的文档,,使读者难于理解,，,给使用者造成许多不便,,会削弱对软件的管理,（难以确认和评价开发工作的进展情况)，,提高软件成本,(一些工作可能被迫返工),,造成,误操作,,对编制高质量文档的要求,(,1,),针对性,,,文档编制以前,应分清读者对象,。按不同的类型、不同层次的读者，决定怎样适应他们的需要。,,,管理文档主要面向管理人员,,,用户文档主要面向用户,,这两类文档不应像开发文档(面向开发人员)那样过多使用软件的专用术语。,,(2),精确性,,,

10、,文档的行文应当,十分确切,，,不能出现多义性的描述,。同一课题几个文档的内容应当是协调一致，没有矛盾的。,,(3) 清晰性,,,文档编写应,力求简明,，,如有可能，配以适当的图表，以增强其清晰性。,,,(4) 完整性,,任何一个文档都应当是,完整的,、,独立的,，它应,自成体系,。,,例如，,前言部分应做一般性介绍，正文给出中心内容，必要时还有附录，列出参考资料等。,,同一课题的几个文档之间可能有些部分内容相同，这种重复是必要的。,,,不要在文档中出现转引其它文档内容的情况,。,如，一些段落没有具体描述，用“见××文档××节”的方式,.,,(5) 灵活性,,,各个不同软件项目，其规模和复杂程

11、度有着许多实际差别，不能一律看待。,,应根据具体的软件开发项目，决定编制的文档种类。,,软件开发的管理部门应该,根据本单位承担的应用软件的专业领域和本单位的管理能力，制定一个对文档编制要求的实施规定。,,,对于一个具体的应用软件项目，项目负责人应根据上述实施规定，确定一个文档编制计划。其中包括：,,编制哪几种文档，详细程度如何,,各文档的编制负责人和进度要求,,审查/批准负责人和时间进度安排,,在开发时期内各文档的维护、修改和管理的负责人，以及批准手续,,当所开发的软件系统非常大时，一种文档可以分成几卷编写。,例如，,,,项目开发计划,可分写为：,,质量保证计划,,配置管理计划,,用户培训计划

12、,,安装实施计划等,。,,,系统设计说明书,可分写为：,,系统设计说明书,,子系统设计说明书。,,,,程序设计说明书,可分写为：,,程序设计说明书,,接口设计说明书,,版本说明。,,,操作手册,可分写为：,,操作手册,,安装实施过程。,,,测试计划,可分写为：,,,测试计划,,,测试设计说明,,测试规程,,测试用例。,,,测试分析报告,可分写为：,,综合测试报告,,验收测试报告。,,,项目开发总结报告,也可分写成：,,项目开发总结报告,,资源环境统计。,,对国标,GB8567-88,《,计算机软件产品开发文件编制指南,》所建议的所有条款都,,可以扩展,，进一步细分，以适应需要；,,如果条款中有些细节并非必需，,也可以根据实际情况压缩合并,。,,程序的设计表现形式，可以使用,程序流程图,、,判定表,、,程序描述语言,(,PDL,)、或,问题分析图,(,PAD,)等。,,当国标《,计算机软件产品开发文件编制指南,》中规定的文档种类不能满足某些应用部门的特殊需要时，,可以建立一些特殊的文档种类要求,，这些要求可以包含在本单位的文档编制实施规定中,。,,为使软件文档能起到多种桥梁的作用：,,有助于程序员编制程序,,有助于管理人员监督和管理软件的开发,,有助于用户了解软件的工作和应做的操作，,,有助于维护人员进行有效的修改和扩充,,文档的编制必须保证一定的质量。,,