软件文档写作实训

1、辽 宁 工 业 大 学 软件文档写作 实训报告题目： 酒店管理系统软件文档 院（系）: 软件学院 专业班级： 软件工 学 教师职称： 教 授 起止时间： 2012.11.22-2012.12.05 实训任务及评语院（系）：软件学院 教研室：软件教研室学 号实训题目酒店管理系统软件文档实训任务实训任务及要求：1、 了解软件开发周期各阶段的文档。2、 掌握各文档阐述的内容及作用。3、 了解文档所采用的国际、国家等相关标准。4、 了解各文档所涉及的软件知识。5、 掌握各文档采用的描述工具。6、 具体编写出2个主要的软件文档。实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容

2、，记录实习日记，规范完整地撰写出实训报告。几个人为一组完成一个相对完整的软件系统开发文档，组内成员编写的文档不能重复，文档要严格按照所采用的标准编写，图表布局要合理规范。指导教师评语及成绩成绩： 指导教师签字： 年 月 日目 录第1章 实训目的与要求11.1 实训目的11.2 实训的实验环境11.3 实训的预备知识11.4 实训要求1第2章软件文档及其组成22.1软件文档的作用及分类22.2软件文档所采用的标准32.3 软件文档的主要内容3第3章实 例43.1概要设计实例43.2用户手册实例12第4章实训日记19第5章实训总结20参考文献21第1章 实训目的与要求1.1 实训目的 本实训要求学

3、生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的：1、了解软件开发周期各阶段的文档。2、掌握各文档阐述的内容及作用。3、了解文档所采用的国际、国家等相关标准。4、了解各文档所涉及的软件知识。5、掌握各文档采用的描述工具。6、具体编写出2个主要的软件文件。 1.2 实训的实验环境学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。1.3 实训的预备知识要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。1.4 实训要求实训过程中，要严格遵守实训的时间安

4、排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。 第2章 软件文档及其组成2.1软件文档的作用及分类1、软件文档的作用： 软件文档在软件开发中占有突出的地位和相当的工作量。高效率、高质量的开发、分发、管理和维护对转让、变更、修正、扩充和使用文档。对充分发挥软件产品的效益有着重要意义。软件文档的作用如下：1) 项目管理的依据。文档将通常“不可见的”软件开发进程转换成“可见的”文字资料，有利于项目的管理。2) 技术交流的语言。项目小组内部、项目平行开发的各小组之间进行的交流和联系，通常都是通过文档来实现的。3) 项目质量保证。文档是进行项目质量审查和评价的重要依

5、据，有效文档的提供，可以满足项目质量保证人员和审查人员的工作需要。4)支持培训与维护.合格的软件文档通常都提供有关软件运行、维护和培训的必要信息，支持软件产品的应用和维护。5)支持软件维护。软件文档提供系统开发的全部必要技术资料，有利于维护人员熟悉系统，开展维护工作；软件维护文档记载了软件维护过程中软件及其环境变化的全部信息。6) 记载软件历史。软件文档作为“记载软件历史的语言”。可用作未来项目的一种资源，向潜在用户报道软件的各种有利信息，便于他们判断自己是否需要该软件提供的服务。良好的系统文档，显然有助于完成软件的移植，或将软件转移到各种新的系统环境中去。2、软件文档分类：从形式上来看，大致

6、可分为两类： 1)是开发过程中填写的各种图表，可称之为工作表格。2)是应编制的技术资料或技术管理资料，可称之为文档或文件。 按照文档产生和使用的范围，软件文档大致可分为三类： 1)开发文档：这类文档是在软件开发过程中，作为软件开发人员前一阶段工作成果的体现和后一阶段工作依据的文档。包括软件需求说明书、数据要求说明书、概要设计说明书、详细设计说明书、可行性研究报告、项目开发计划。 2)管理文档：这类文档是在软件开发过程中，由软件开发人员制定的需提交人员的一些工作计划或工作报告。使管理人员能够通过这些文档了解软件开发项目安排、进度、资源使用和成果等。包括项目开发计划、测试计划、测试报告、开发进度月

7、报及项目开发总结。 3)用户文档：这类文档是软件开发人员为用户准备的有关该软件使用、操作、维护的资料。包括用户手册、操作手册、数据要求说明书、软件需求说明书。2.2软件文档所采用的标准根据软件工程标准制定的机构和标准适用的范围，可分为5个层次：国际标准、国家标准、行业标准、企业(机构)标准、项目(课题)标准。ISO 9000标准概述：ISO 9000是国际标准化组织建立以来制订和公布的几千个标准中，影响最深远和普及最迅速的一个，其对各国经济生活所起的以下特点作用不可低估。我们在观察这一现象时，注意到ISO 9000的以下几个特点：(1) 国际性。ISO 9000已成为各国对质量保证和质量管理制

8、度的共同理解。(2) 完整性。ISO 9000系列标准包含了术语、质量保证、质量管理到支持件技术标准及实施指南等一整套共计20个标准，形成了一个完整的体系结构。(3) 兼容性。作为ISO 9000系列标准核心的三个质量保证标准是逐一包容的。即9001标准的内容最全面，9002标准排除了设计工作的质量要求，仅限于生产制造过程，9003标准仅限于检验和试验工作的质量要求。可以说，依次适用范围渐窄。(4) 主动性。选用和实施ISO 9000标准、建立质量体系的主体，是企业的主动行为。(5) 可信性。ISO 9000的认证是授权认证机构对供方质量体系进行的独立、公正的活动，因此，具有相当的说服力和可信

9、度。(6) 指导性。ISO 9000标准文本只是给出了质量管理和质量保证的原则，具体如何实施，需要供方结合自身机构的实际情况，特别是供方企业文化，进行创造性的解决。(7) 科学性。ISO 9000标准的背后是现代质量管理的科学原理。(8) 实践性。具体表现在，标准文本不是空洞的条文，并基于大量的质量管理实践。如标准可向前追溯，得知其源于英国国家标准和美国军用标准等。2.3软件文档的主要内容我所做的软件文档是酒店管理系统软件文档。酒店管理系统软件文档包括5个模块，其具体内容如下： 1) 基本信息管理：客户信息，客房类型，客房信息。2)前台接待管理：预定客房，入住登记，续住登记，退房登记。3)收银

10、统计管理：实收房款，客户消费，实收统计。4)系统用户管理：用户信息，修改密码，切换用户。第3章 实 例3.1 概要设计实例概要设计说明书1引言1.1编写目的编写本说明书的目的是说明对程序系统的设计考虑，包括程序系统的基本处理流程、编写程序系统的组织结构、功能分配、模块划分、接口设计、运行设计、数据结构设计和出错设计等，为程序的详细设计打下基础。预期读者为：软件开发人员、项目评审人员、及软件测试人员。1.2背景1)待开发的软件系统的名称：酒店管理系统。2)本项目的任务提出者：酒店管理人员。3)本项目的任务开发者：酒店管理系统软件开发小组。1.3定义酒店住宿管理：对住宿进行管理，并存储顾客住宿记录

11、。顾客信息：顾客的姓名、证件类型、证件号、性别、年龄、籍贯、工作单位等各项基本信息，管理员负责管理顾客基本信息房间信息：包括房间编号、房间类型、房间价格等基本信息入住登记信息：记录编号、客户编号、客房编号、入住日期、退房日期、入住天数、经办人等用户信息：用户名、员工姓名、密码、用户类型等1.4参考资料1 黄梯云等编著.管理信息系统.高等教育出版社.2005.8 2 萨师煊.数据库系统概论.高等教育出版社.2009.6 2总体设计2.1需求规定1、顾客住宿管理1)顾客住宿管理由合法用户进行操作，首先用户应先登录该系统，经系统检查合法并具有相应权限后方能使用。2)输入 顾客姓名，证件号，年龄，籍贯

12、，工作单位等；3)处理过程描述 先检查顾客的正确身份，提供房间信息，让顾客选择满意的房间并录入系统。用户住宿完毕后，给顾客结账，并保存顾客的住宿信息到数据库中。4)输出 操作成功或失败的提示信息。2、账号信息管理1)账号信息管理是由合法用户进行操作，首先用户应先登录该系统，经检查合法后方能使用。2)输入 系统管理员用户名和密码3)处理过程描述 先检查用户名和密码是否正确，如检查正确，方能使用。账号信息户可以增减用户，设定用户权限等。4)输出操作成功或失败的提示信息。3、数据库信息管理1)数据库信息管理由合法用户进行操作，首先用户先登录该系统，检查合法后方能使用，并根据用户权限进行查询，增减，修

13、改等操作。2)输入 用户名和密码3)先检查用户名和密码是否正确，如检查正确，方能使用。用户可以权限范围内的事。4)输出4、操作成功或失败的提示信息2.2运行环境硬件环境用户终端机：CPU P4 1.8GHz以上，内存512MB，硬盘20GB以上服务器：CPU P4 1.8GHz以上，内存1GB，高速硬盘组100GB，高速缓存软件环境系统建模采用支持UML的CASE工具 Rose 2004开发环境。本系统实现语言采用Microsoft Visual Studio.NET编程。数据管理采用Microsoft SQL Server 2000数据库管理系统。系统操作平台采用微软的Windows XP。

14、服务器端系统的运行环境：Windows 2000 Server，Windows XP。2.3基本设计概念和处理流程1)系统模块 该系统模块按照输入->处理->输出的流程进行工作:用户输入酒店管理系统显示系统系统处理图3.1 系统流程图2)输入输出处理及系统处理：预定请求房态查 询查询请求房态调查房态调查退房结帐定单入住请求客户P3收银管理P4客房管理P5查询管理P2接待管理P1预定管理管理员P6 房间状态D1 文档财务图3.2 数据流图2.4结构表3.1结构图层次及编号模块名称子程序实现功能1 第一层主模块Main实现整个系统结构2 第二层用户输入模块User input输入用户名

15、及口令3 第二层输出模块Output输出显示4 第三层系统管理模块System management系统处理5 第三层输出管理模块Display显示正误信息6 第三层用户输入处理模块User use判断用户类型7 第四层住宿管理员用户模块Zhusu management住宿管理员用户权限8 第四层数据库信息管理员模块Data management数据库信息管理员权限9 第四层账号信息管理员用户模块ID management账号信息管理员权限10第五层住宿管理模块Zhusu information住宿管理11第五层据库信息管理模块Data information数据库信息管理12第六层房间信息管

16、理模块Manager fangjian房间信息管理13第六层顾客住宿记录管理模块Manager zhusu顾客住宿记录信息管理14第七层正常显示模块Right display正常显示信息15第七层出错显示模块Error display出错显示信息2.5功能需求与程序的关系本条用一张如下的矩阵图说明各项功能需求的实现同各块程序的分配关系：表3.2 分配关系图基本信息管理前台接待管理收银统计管理系统用户管理客户信息管理客房类型管理客房信息管理预定客房管理入住登记管理续住登记管理退房登记管理实收房款管理客户消费管理实收款统计用户修改信息修改自身密码切换用户2.6人工处理过程对于用户类型的分类，即用户

17、的分配需要人工处理为系统用户增加用户名及权限。2.7尚未问决的问题本系统在处理用户异常输入时，在本时期内还没有具体设计应该如何处理，在设计时将会从分考虑以提高系统的性能。3接口设计3.1用户接口向系统管理员提供的用户名为：Admin,初始密码为000000，系统管理员使用后进行密码修改。用户名：类型为字符型，长度为20字节;密码：类型为字符型，长度为至少6字节，最多为20字节；若用户输入密码错误，系统将会给出密码错误的提示，连续三次输入错误，系统则关闭。使用鼠标、键盘等外部构件进行功能选择及输入。其余均为可视化界面，用户可以根据系统提示进行功能选择。3.2外部接口本系统提供基于access的数

18、据导入和导出功能，方便工作人员操作。软件接口：需要与写卡软件建立接口联系，以便可以记录顾客入住登记信息。硬件接口：需要与打鼠标和键盘建立接口联系，以便数据管理人员进行相关的操作。3.3内部接口系统内部又分为：基本信息管理，前台接待信息管理，收银统计管理，系统用户管理四个子系统，还有账号信息管理系统和数据库信息管理系统。4运行设计4.1运行模块组合输入用户名和密码，登录后使用该系统，按照用户的权限的不同，允许其做其权限内的事情。4.2运行控制用户使用时，使用鼠标键盘进行运行时的选择控制。4.3运行时间系统中的模块所占用的时间不多，应控制在0.5s以内。5系统数据结构设计5.1逻辑结构设计要点（1

19、）顾客基本信息和前台接待信息表如下：表3.3 顾客基本信息和前台接待信息表数据项名称数据项含义说明数据类型长度记录编号为用户记录编号整型4客户编号为每客户编号码可变字符型40客房编号为房间编写号码可变字符型10入住日期入住的时间日期和时间8退房日期退房时间日期和时间8入住天数入住天数整型4单价单价价格单精度浮点型8折扣折扣价格整型4其他收费金额收费价格整型4押金押金数目整型4其他说明说明可变字符型200经办人经办人的信息可变字符型40用户名用户姓名可变字符型40员工姓名员工姓名可变字符型40密码设置密码可变字符型40用户类型1领班2普通用户可变字符型50（2）基本信息和收银统计表如下：表3.4

20、基本信息和收银统计表数据项名称数据项含义说明数据类型长度类型编号客房的类型和编号数字数据类型4类型名称房间属于的类型字符型100房间数量旅店拥有房间数量数字数据型4床位数量拥有床位数量数字数据类型4空调是否有空调数字数据类型4电话是否有电话数字数据类型4电视是否有电视数字数据类型4独立卫生间是否有独立卫生间数字数据类型4冰箱是否有冰箱数字数据类型4客房编号客房的编号号码字符型10房间朝向房间所朝的方向字符型100物品列表房间中所有物品的列表字符型400标准价格物品的标准价格单精度浮点型85.2物理结构设计要点本系统所使用的数据存储要求为数据库，各个数据选项都要从数据库中存取，存取单位是表格，存

21、储区域在系统的硬盘内，系统数据要满足保密性，每位用户都设定了权限，只有满足权限的用户才能使用某项数据，需要在用户输入用户名时对其权限进行判断。5.3数据结构与程序的关系表3.5数据结构与程序的关系程序设计的功能模块涉及的主要表结构基本信息管理顾客信息前台接待管理预定信息收银统计管理房间信息系统用户管理顾客信息6系统出错处理设计6.1出错信息出错信息表：表3.6出错信息表出错或故障系统输出信息处理方法用户名或口令错误系统提示用户名出错或口令出错不允许用户登录计算机病毒提示发现病毒安装杀毒软件并定期升级6.2补救措施定期进行数据备份，每天进行增量转储，每月一次进行海量转储，可使用静态转储也可使用动

22、态转储。6.3系统维护设计专用模块为系统备份模块系统备份模块即为系统自动拷贝模块，在每天都进行一次动态增量转储，在终端上安装杀毒软件，以防止其他人对系统进行恶意的破坏。3.2用户手册实例用户手册（GB856788）1引言1.1编写目的编写本说明书的目的是说明对程序系统的设计考虑，包括程序系统的基本处理流程、编写程序系统的组织结构、功能分配、模块划分、接口设计、运行设计、数据结构设计和出错设计等，为程序的详细设计打下基础。预期读者为：软件开发人员、项目评审人员、及软件测试人员。1.2背景1)待开发的软件系统的名称：酒店管理系统。2)本项目的任务提出者：酒店管理人员。3)本项目的任务开发者：酒店管

23、理系统软件开发小组。1.3定义酒店住宿管理：对住宿进行管理，并存储顾客住宿记录。顾客信息：顾客的姓名，证件类型，证件号，性别，年龄，籍贯，工作单位等各项基本信息，管理员负责管理顾客基本信息。房间信息：包括房间编号，房间类型，房间价格等基本信息入住登记信息：记录编号，客户编号，客房编号，入住日期，退房日期，入住天数，经办人等。用户信息：用户名、员工姓名、密码、用户类型等。1.4参考资料1 黄梯云等编著.管理信息系统.高等教育出版社.2005.8 2 萨师煊.数据库系统概论.高等教育出版社.2009.6 2用途2.1功能该软件主要功能是实现酒店信息的管理，具体包括基本信息管理（客户信息客房类型、客

24、房信息），前台接待（预定客房、入住登记、续住登记、退房登记），收银统计（实收房款、客户消费、实收款统计），系统用户（用户信息、修改密码、切换用户）。2.2性能精度在运行此软件时候，若输入数据时文本类型的数据，则其精度要求为最精度的数据；若输出数据时整型或长整形类型，则其精度要求为保留小数点后一位。例如：输入的基本信息中应包括：姓名（字符串）、性别（布尔值）、身份证号（字符串）、登记日期（字符串）、退房日期（字符串）、其他信息（字符）。时间特性要求系统响应时间，更新处理时间，数据传输，转换时间，计算时间都在2秒以内，即是说系统对指令的响应都是迅速的。响应时间：页面首次访问响应时间为<3s，

25、非首次访问响应时间为<2s；处理时间：页面处理时间为<2s；数据传输时间和转换时间：页面数据传输时间和转换时间为<2s。灵活性a.在操作方式方面：操作指令既可以用鼠标直接点击输入，也可以使用键盘输入快捷键命令；b.在运行环境方面：此软件可以在当前的所有windows操作系统上运行使用；c在于其他软件皆空方面：保证此软件可以和当前大部份打印机相连接；d.在有效期限以及计划方面：保证在以后的较长一段时间内此软件易于升级和维护。2.3安全保密本软件系统在登陆时必须经过身份的验证，但验证为非法用户时，该用户无法登陆系统，此外，在设计到添加、修改、删除预定客房信息作时，系统也会先验证该

26、用户的使用权限，如无权限，这些操作也会中断。3运行环境3.1硬设备运行本软件所需要的硬件设备的最小配置：奔腾133、内存16兆以上的pc机（硬盘空间为2G）满足输入端条件；打印机可选。3.2支持软件运行本软件所需要的支持软件，如：操作系统：Windows xp及Windows NT均可运行。编程语言：VB编程语言。数据库管理系统的名称和版本号：windows XP Server；后台数据库管理工具是 SQL2000其他支持软件：系统直接调用3.3数据结构本系统使用的数据库是SQL2000数据库文件。4使用过程软件的功能同系统的输入源结构，输出接受机构之间的相互关系由下文可知。4.1安装与初始化

27、1点击setup显示如下界面：图3.3 setup显示界面2.选择安装目录和允许使用的用户后，点击下一步如下界面：图3.4 确认安装界面3.点击进入下一步：图3.5 安装完成界面4. 点击关闭按钮，安装完成。4.2输入规定输入数据和参量的准备要求。输入数据的现实背景说明输入数据的现实背景，主要是情况顾客入住；情况出现的频度例如是周期性的、随机的、一项操作状态的函数；情况来源一前台接待；输入媒体例如键盘、穿孔卡片、磁带；限制有效的输入范围就是输入各个项，当输入有误时无法跟数据库对应，则不显示任何信息或弹出错误提示，需重新输入；质量管理检查输入顾客的证件信息是否合法，进行存储。支配确定输入信息的正

28、确性，决定取消或者办理入住。输入格式数码对初始数据和参量的格式要求，包括语法规则和有关约定，如：长度int(4)char(20)varchar(50)格式基准文本，整型，数字等标号标记或标识符；顺序各个数据项的次序及位置；标点用来表示行，数据组等的开始或结束而那个的空格、斜线、星号、字符组；词汇表给出允许使用的字符组合的列表，禁止使用字符组合的列表；省略和重复给出用来表示输入元素可省略或重复的表示方式；控制给出用来表示输入开始或结束的控制信息。输入举例为每个完整的输入形式提供样本，包括：控制或首部用来表示输入的种类和类型的信息，标志符输入日期，正文起点和对所用编码的规定；主体输入数据的主体，包

29、括数据文卷的输入表述部分；尾部用来表述输入结束的控制信息，累计字符总数；省略可为空的数据输入数据是可省略的：重复非标识列输入数据是可以重复的。4.3输出对每项输出作出说明输出数据的现实背景说明输出数据的现实背景，主要是：使用酒店数据库管理人员；使用频度随时备份查阅；媒体打印，CRT显示，磁带，卡片，磁盘；质量管理合理性检查，出错纠正的规定；支配输入数据是保留还是废弃，分配权限。输出格式给出对每一类输出信息的解释，主要是：首部输入数据的标识符，输出日期和输出编号；主体输出信息的主体，包括分栏标题；尾部包括累计总数，结束标记。输出举例为每种输出类型提供例子。对例子中的每一项，说明：定义每项输出信息

30、的意义和用途；来源是从特定的输入中抽出、从数据库文卷中取出、或从软件的计算过程中得到；特性输出的值域、计量单位、在什么情况下可缺省等。4.4文卷查询这一条编写针对具有查询能力的软件，内容包括：同数据库查询有关的初始化、准备、及处理所需要的详细规定，说明查询的能力、方式、所使用的命令和所要求的控制规定。如：对数据的查询4.5出错处理和恢复1用户输入不合法报错。2数据库及时备份。4.6终端操作当软件是在多终端系统上工作时，应编写本条，以说明终端的配置安排，连接步骤，数量和参数输入步骤以及控制规定，说明通过终端操作进行查询，检索，修改数据文卷的能力，语言，过程以及辅助性程序等。第4章 实训日记第1天

31、：自由分组，选择题目。我们小组4个人选择的题目是酒店管理系统。第2-5天：网上查阅了大量关于酒店管理系统软件工程文档的相关资料并且布置给每个组内成员相应的任务，分配了每个人设计文档说明书各部分，并且要对每个细节要进行全面的设计和说明。第6-13天：我做的是概要设计和用户手册文档。首相了解对软件工程文档作用及分类并对其中内容整理到报告中，了解软件工程文档所采用的标准及分类并对内容整理到报告中，整理软件工程文档主要内容到报告中，完成报告实例一，对其中遇到的问题记录下来，然后通过从网上查资料找答案和大家共同研究探索解决，再完成实例一之后用同样的方式按部就班的进行着实例二的编写，再完成实例二之后，通过2周的实训，完成实训总结内容，总结这2周的收获。第14天：完成酒店管理系统软件工程文档报告，上交作品。第5章 实训总结随着社会经济的迅速发展和科学技术的全面进步，计算机与通信技术为基础的信息系统正处于蓬勃发展的时期，计算机的应用越来越广泛。通过实验使我们很好的巩固并掌握了书本知识。也极大的锻炼了我们的动手能力,分析问题解决问题和应用知识能力，通过实验也使我认识到干事要有耐心，恒心，细心，要有认真的态度！如果早期的错误隐藏下来，对后面的工作影响就会很大，甚至有