软件文档写作实训-(8)精品资料

辽宁工业大学软件文档写作实训报告题目：酒店管理系统软件文档院（系）:软件学院专业班级：起止时间：2012.11.26-2012.12.02实训任务及评语院（系）：软件学院教研室：软件教研室学号实训题目酒店管理系统软件文档实训任务实训任务及要求：1、了解软件开发周期各阶段的文档。2、掌握各文档阐述的内容及作用。3、了解文档所采用的国际、国家等相关标准。4、了解各文档所涉及的软件知识。5、掌握各文档采用的描述工具。6、具体编写出2个主要的软件文档。实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。几个人为一组完成一个相对完整的软件系统开发文档，组内成员编写的文档不能重复，文档要严格按照所采用的标准编写，图表布局要合理规范。指导教师评语及成绩成绩：指导教师签字：年月日目录第1章实训目的与要求.......................................................11.1实训目的............................................................11.2实训的实验环境......................................................11.3实训的预备知识......................................................11.4实训要求............................................................1第2章软件文档及其组成.....................................................22.1软件文档的作用及分类................................................22.2软件文档所采用的标准................................................32.2软件文档的主要内容..................................................4第3章实例................................................................73.1酒店管理系统的软件需求实例..........................................73.2酒店管理系统的项目开发设计实例.....................................14第4章实训日记............................................................21第5章实训总结............................................................22参考文献...................................................................23第1章实训目的与要求1.1实训目的本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。1、了解软件开发周期各阶段的文档。2、掌握各文档阐述的内容及作用。3、了解文档所采用的国际、国家等相关标准。4、了解各文档所涉及的软件知识。5、掌握各文档采用的描述工具。6、具体编写出2个主要的软件文件。1.2实训的实验环境学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。1.3实训的预备知识要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。1.4实训要求实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。第2章软件文档及其组成2.1软件文档的作用及分类（一）软件文档的作用：软件文档（document）也称文件，通常指的是一些记录的数据和数据媒体，它具有固定式，可被人和计算机阅读。它和计算机程序共同构成了能完成特定功能的计算机软件（有人把源程序也当作文档的一部分）。我们知道，硬件产品和产品资料在整个生产过程中都是有形可见的，软件生产则有很大不同，文档本身就是软件产品。没有文档的软件不成其为软件，更谈不到软件产品。软件文档的编制（documentation）在软件开发工作中占有突出的地位和相当的工作量。高效率、高质量地开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档，对于充分发挥软件产品的效益有着重要意义。然而，在实际工作中，文档在编制和使用中存在着许多问题，有待于解决。软件开发人员中较普遍地存在着对编制文档不感兴趣的现象。从用户方面看。他们又常常抱怨：文档售价太高、文档不够完整、文档编写得不好、文档已经陈旧或是文档太多，难于使用等等。在软件的生产过程中，总是伴随着大量的信息要记录、要使用。因此，软件文档在产品的开发生产过程中起着重要的作用。1)提高软件开发过程的能见度。把开发过程中发生的事件以某种可阅读的形式记录在文档中。管理人员可把这些记载下来的材料作为检查软件开发进度和开发质量的依据，实现对软件开发的工程管理。2)提高开发效率。软件文档的编制，使得开发人员对各个阶段的工作都进行周密思考、全盘权衡、从而减少返工。并且可在开发早期发现错误和不一致性，便于及时加以纠正。3)作为开发人员在一定阶段的工作成果和结束标志。4)记录开发过程中的有关信息，便于协调以后的软件、开发、使用和维护。5)提供对软件的运行、维护和培训的有关信息，便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解。使软件开发活动更科学、更有成效。6)便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需要的软件提供依据。文档在软件开发人员,软件管理人员,维护人员,用户以及计算机之间的多种桥梁作用可以看出：既然软件已经从手工艺人的开发方式发展到工业化的生产方式，文档在开发过程中就起到关键作用。从某种意义上来说，文档是软件开发。可从图中看出软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据,这个作用是显而易见的。软件开发过程中软件开发人员需制定一些工作计划或工作报告,这些计划和报告都要提供给管理人员,并得到必要的支持。管理人员则可通过这些文档了解软件开发项目安排,进度,资源使用和成果等。软件开发人员需为用户了解软件的使用,操作和维护提供详细的资料,我们称此为用户文档。以上三种文档构成了软件文档的主要部分。规范的体现和指南。按规范要求生成一整套文档的过程，就是按照软件开发规范完成一个软件开发的过程。所以，在使用工程化的原理和方法来指导软件的开发和维护时，应当充分注意软件文档的编制和管理。（二）软件文档的分类：软件文档从形式上来看，大致可分为两类：一类是开发过程中填写的各种图表，可称之为工作表格；另一类是应编制的技术资料或技术管理资料，可称之为文档或文件。软件文档的编制，可以用自然语言，特别设计的形式语言，介于两者之间的半形式语言(结构化语言)，各类图形表示。表格来编制文档。文档可以书写，也可以在计算机支持系统中产生，但它必须是可阅读的。按照文档产生和使用的范围，软件文档大致可分为三类：1）开发文档：这类文档是在软件开发过程中，作为软件开发人员前一阶段工作成果的体现和后一阶段工作依据的文档。包括软件需求说明书、数据要求说明书、概要设计说明书、详细设计说明书、可行性研究报告、项目开发计划。2)管理文档：这类文档是在软件开发过程中，由软件开发人员制定的需提交人员的一些工作计划或工作报告。使管理人员能够通过这些文档了解软件开发项目安排、进度、资源使用和成果等。包括项目开发计划、测试计划、测试报告、开发进度月报及项目开发总结。3)用户文档：这类文档是软件开发人员为用户准备的有关该软件使用、操作、维护的资料。包括用户手册、操作手册、维护修改建议、软件需求说明书。2.2软件文档所采用的标准系统在设计开发使用过程中都要涉及到很多计算机硬件、软件。所有这些都要符合主流国际、国家和行业标准。例如在开发中使用的操作系统、网络系统、开发工具都必须符合通用标准。如规范的数据操纵界面、作为业界标准的TCP/IP网络协议及ISO9002标准所要求的质量规范等；同时，在自主开发本系统时，要进行良好的设计工作，制订行之有效的软件工程规范，保证代码的易读性、可操作性和可移植性。根据软件工程标准制定的机构和标准适用的范围，可分为5个层次：国际标准：ISO国际标准化组织；国家标准：GB中国ANSI美国BS英国JIS日本；行业标准：IEEE;企业（机构）标准：IBM；项目（课题）标准：CIMS。基础标准软件工程术语GB/T11457-89信息处理—流程图编辑符号GB1526-891（ISO5807-1985）信息处理—流程图编辑符号GB/T15538-1995信息处理—程序构造约定GB13502-92（ISO5806）信息处理系统配置图符号及其约定GB/T14085-93（ISO8790）开发标准软件开发规范GB8566-88信息处理—按记录组处理顺序文卷的程序流程ISO6593-1985软件维护指南GB/T14079-93文档标准计算机软件产品开发文件编制指南GB8567-88计算机软件需求说明编制指南GB9386-88计算机软件测试文件编制指南GB9385-88管理标准计算机软件配置管理计划规范GB/T12505-90计算机软件质量保证计划规范GB/T12504-90计算机软件可靠性和可维护性管理GB/T14394-93质量管理和质量保证标准第三部分GB/T19000394质量标准规定与质量有关的术语ISO8402质量管理和质量保证标准ISO9000-3可靠性管理标准ISODIS9000-4对ISO9000-3未具体示出的软件质量特性规定标准ISO/IEC9126对质量体系核查指南中核查步骤的规定ISO13011-1软件配置管理ISO/TC1762.2软件文档的主要内容一软件需求与开发计划1项目开发计划：可行性研究报告；项目开发计划。（1）可行性研究报告：说明该软件开发项目的实现在技术上,经济上和社会因素上的可行性,评述为了合理地达到开发目标可供选择的各种可能实施的方案,说明并论证所选定实施方案的理由。（2）项目开发计划：为软件项目实施方案制定出具体计划,应该包括各部分工作的负责人员,开发的进度,开发经费的预算,所需的硬件及软件资源等。项目开发计划应提供给管理部门,并作为开发阶段评审的参考。2软件需求说明：软件需求说明；数据要求说明。（1）软件需求说明书：也称软件规格说明书,其中对所开发软件的功能,性能,用户界面及运行环境等作出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议,也是实施开发工作的基础。（2）数据要求说明书：该说明书应给出数据逻辑描述和数据采集的各项要求,为生成和维护系统数据文卷作好准备。3测试计划：测试计划。测试计划：为做好组装测试和确认测试，需为如何组织测试制定实施计划。计划应包括测试的内容，进度，条件，人员，测试用例的选取原则，测试结果允许的偏差范围等。二软件设计说明软件设计说明：概要设计说明；详细设计说明；数据库设计说明。1概要设计说明：概要设计说明书：该说明书是概要设计阶段的工作成果，它应说明功能分配，模块划分，程序的总体结构，输入输出以及接口设计，运行设计，数据结构设计和出错处理设计等，为详细设计奠定基础.。2详细设计说明：详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法，逻辑流程等。3数据库设计说明：数据库设计说明：数据库设计的内容，概念结构设计，逻辑结构设计，物理结构设计，数据字典设计，安全保密设计等等。数据库设计主