客房管理系统软件文档.doc

辽 宁 工 业 大 学 软件文档写作 实训报告题目： 客房管理系统软件文档 院（系）： 软件学院 专业班级： 软件技术091班 学 号： 091404001 学生姓名： 章宇辰 指导教师： 翟宝峰 教师职称： 副教授 起止时间： 2011.12.26-2011.12.30 实训任务及评语院（系）：软件学院 教研室：网络教研室学 号091404001学生姓名章宇辰专业班级软件技术091班实训题目医院管理系统软件文档实训任务实训任务及要求：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章 实 例53.1数据库概念结构设计53.2数据库逻辑结构设63.3数据库物理结构设计73.4数据字典设计93.5 安全保密设计13第4章 实训日记14第5章 实训总结15参考文献16第1章 实训目的与要求1.1 实训目的 本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。1、了解软件开发周期各阶段的文档。2、掌握各文档阐述的内容及作用。3、了解文档所采用的国际、国家等相关标准。4、了解各文档所涉及的软件知识。5、掌握各文档采用的描述工具。6、具体编写出2个主要的软件文件。 1.2 实训的实验环境学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。1.3 实训的预备知识 要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。1.4 实训要求实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。 第2章 软件文档及其组成2.1软件文档的作用及分类软件文档的作用 在软件的生产过程中，总是伴随着大量的信息要记录、要使用。因此，软件文档在产品的开发生产过程中起着重要的作用。1）项目管理的依据。文档将通常“不可见的”软件开发进程转换成“可见的”文字资料，有利于项目的管理。2.）技术交流的语言。项目小组内部、项目平行开发的各小组之间进行的交流和联系，通常都是通过文档来实现的。3）项目质量保证。文档是进行项目质量审查和评价的重要依据，有效文档的提供，可以满足项目质量保证人员和审查人员的工作需要。4）支持培训与维护。合格的软件文档通常都提供有关软件运行、维护和培训的必要信息，支持软件产品的应用和维护。5）支持软件维护。软件文档提供系统开发的全部必要技术资料，有利于维护人员熟悉系统，开展维护工作；软件维护文档记载了软件维护过程中软件及其环境变化的全部信息。6）记载软件历史。软件文档作为“记载软件历史的语言”，可用作未来项目的一种资源，向潜在用户报道软件的各种有利信息，便于他们判断自己是否需要该软件提供的服务。7)提高软件开发过程的能见度。把开发过程中发生的事件以某种可阅读的形式记录在文档中。管理人员可把这些记载下来的材料作为检查软件开发进度和开发质量的依据，实现对软件开发的工程管理。 8)提高开发效率。软件文档的编制，使得开发人员对各个阶段的工作都进行周密思考、全盘权衡、从而减少返工。并且可在开发早期发现错误和不一致性，便于及时加以纠正。 9)提供对软件的运行、维护和培训的有关信息，便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解。使软件开发活动更科学、更有成效。 10)便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需要的软件提供依据。 所以，在使用工程化的原理和方法来指导软件的开发和维护时，应当充分注意软件文档的编制和管理。二、软件文档的分类：基于软件生存期方法，可以从形式上将软件文档大致分成两类：软件开发过程中需要填写的各种图表，及应编制的各种技术文件或管理资料。国家标准局在1988年1月颁布了计算机软件开发规范和计算机软件产品开发文件编制指南，作为软件开发和文档编制工作的准则和规程。基于软件生存期方法，可以从形式上将软件文档大致分成两类：软件开发过程中需要填写的各种图表，及应编制的各种技术文件或管理资料。软件文档根据其产生和使用的范围，主要划分为3大类：开发文档、用户文档和管理文档。2.2软件文档所采用的标准1.根据软件工程标准制定的机构和标准适用的范围，可分为5个层次：(1)国际标准: ISO 国际标准化组织(2)国家标准:GB中国ANSI美国BS英国JIS日本(3)行业标准: IEEE (4)企业(机构)标准: IBM(5)项目(课题)标准: CIMS 2.基本标准包括：(1) 软件工程术语,标准号为GB/T 11457-1989；(2) 信息处理数据流程、程序流程图、系统结构图、程序网络图、系统资源图的文件编制符号及约定,标准号为GB/T 1526-1989；(3) 软件工程标准分类法,标准号为GB/T 15538-1995；(4) 信息处理程序构造及其表示法的约定, 标准号为GB/T 13502-1992；(5) 信息处理单命中判定表规范，标准号为GB/T15535-1995(ISO 5806)；(6) 信息处理系统计算机系统配置图符号及其约定，标准号为GB/T14085-1993(ISO 8790)。3. 开发标准包括：(1) 信息技术软件生存期过程，标准号为GB/T 8566-1995；(2) 软件支持环境，标准号为GB/T 15853-1995；(3) 信息处理按记录组处理顺序文卷的程序流程，GB/T 15697-1995(ISO 6593)；(4) 软件维护指南，标准号为GB/T 14079-1993。4.文档标准包括：(1) 计算机软件产品开发文档编制指南，标准号为GB/T 8567-1988；(2) 计算机软件需求说明编制指南，标准号为GB/T 9385-1988；(3) 软件文档管理指南，标准号为GB/T 16680-1996。5.管理标准包括：(1) 计算机软件配置管理计划规范，标准号为GB/T 12505-1990；(2) 信息技术软件产品评价质量特性及其使用指南，标准号为GB/T 16260-1996；(3) 计算机软件质量保证计划规范，标准号为GB/T 12504-1990；(4) 计算机软件可靠性和可维护性管理，标准号为GB/T 14394-1993。2.2 软件文档的主要内容1. 功能要求 - 来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书。 2. 需求分析 - 包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等。以功能要求为基础，进行详细的功能分析 ( 包括客户提出的要求和根据开发经验建议的功能 ) ，列出本产品是什么，有什么特殊的概念，包括那些功能分类，需要具备什么功能，该功能的操作如何，实现的时候该注意什么细节，客户有什么要求，系统运行环境的要求等。这里的功能描述跟以后的使用手册是一致的。 3. 技术分析 - 包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。以需求分析为基础，进行详细的技术分析 ( 产品的性能和实现方法 ) ，列出本项目需要使用什么技术方案，为什么，有哪些技术问题要解决 ，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什么评价等。 4. 系统分析 - 包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以需求分析为基础，进行详细的系统分析 ( 产品的开发和实现方法 ) ，估计开发期间需要把什么问题说明白，程序员根据系统分析，开始在项目主管的带领下进行编码。 6. 数据库文档 - 包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。以系统分析为基础，进行详细的数据库设计。必要时可以用图表解说，特别是关系数据库。 7. 功能函数文档 - 包括变量名、变量初植、功能，函数名，参数，如何调用、备注、注意事项等。以系统分析为基础，进行详细的说明，列出哪个功能涉及多少个函数，以便以后程序员修改、接手和扩展。 8. 界面文档 - 包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的要求，这里与软件完成后的运行界面是一致的。 9. 编译手册 - 包括服务器编译环境、操作系统、编译工具、 GNU 的 C+ 编译器版本信息、目录说明、程序生成、源程序文件列表、 Makefile 配置及其相关程序的对应关系列表。客户端的编译过程、编译结果、编译示例、编译环境、操作系统、编译工具、源文件列表和制作安装程序的过程。 11. 项目总结 - 包括项目简介、项目参与人员和开发时间、项目风险管理过程、项目功能列表、项目结构特点、技术特点、对项目的升级建议、对以后的项目的建议、人员素质情况等。 第3章 实 例3.1数据库概念结构设计 经考察和分析,本案例客房管理系统包括以下实体：客户实体、客房实体、操作员实体、结算账单实体,它们的E-R图如以下所示。客房操作员退房结算账单结算返回 1n11n1入住登记m12.5客房管理系统E-R图客户编号客户姓名年龄性别操作员姓名操作员编号房间状态房号户籍住店天数总费用账单编号离店时间身份证号住店时间押金房间类型房间价格职称房号密码客户3.2数据库逻辑结构设根据E-R图,将图转换为关系模型即：将实体、实体的属性和实体之间的联系转换为关系模式,然后对数据模型进行优化得到如下关系数据表。客户：客户编号,姓名,性别,年龄,身份证号,原住地址,押金,住店时间,离店时间,房号,账单编号客房：房号,房间类型,房间状态,房间价格操作员：操作员编号,操作员姓名,职称结算账单：账单编号,住房天数,总费用,操作员编号,房号关系数据表确定后要进行数据表的逻辑结构设计,即定义关系数据表中字段名称、数据结构、是否允许为空、关键字、说明等。（1）客户表用于存放客户的入住信息,例如：客户名,房号等。表3.1 客户表字段名称数据结构是否允许为空说明客户编号IntNOT NULL ,主键姓名Varchar（8）NULL入住客户的姓名性别Varchar（2）NULL年龄IntNULL身份证号Varchar（18）NULL客户的身份证号原住地址Varchar（50）NULL客户的户籍地址住店时间Varchar（15）NOT NULL离店时间Varchar（15）NULL押金IntNULL房号IntNOT NULL账单编号IntNULL字段名称数据结构是否允许为空说明房号IntNOT NULL,主键唯一标识每个房间房间类型Varchar（18）NOT NULL房间价格IntNOT NULL房间状态Varchar（2）NOT NULL（2）客房表 用于存放客房的相关信息,例如：房号,房间类型,房间状态等。表3.2 （3）结算账单表结算帐单表用于存放客户消费的信息。表3.3 结算账单表字段名称数据结构是否允许为空说明账单编号IntNOT NULL,主键唯一标识每个账单房号IntNOT NULL姓名Varchar（8）NULL押金IntNULL入住时间Varchar（18）NOT NULL离店时间Varchar（18）NOT NULL住店天数IntNOT NULL房间价格IntNOT NULL总费用IntNOT NULL（4）操作员表用于存放操作员的的信息,例如：操作员的编号,密码等。表3.4 操作员表字段名称数据结构是否允许为空说明操作员编号IntNOT NULL,主键用于登陆和识别身份操作员姓名Varchar（8）NULL职称Varchar（10）NULL密码Varchar（10）NULL用于登陆输入密码3.3数据库物理结构设计在进行了数据表的逻辑结构定义后,需要为每个数据表创建其物理结构,即在数据库系统中定义数据表具体存放的格式、位置等。这里列出利用SQL Server2000 自带的数据库创建的数据表的物理结构。 1.“客房”表的物理结构 “客房”表的物理结构如图4.1所示,关键字为”房号”图 4.12. “客户”表的物理结构 “客户”表的物理结构如图4.2所示,关键字为“客户编号”,利用”房号”可与”结算账单”表和”客房”表建立联系。图 4.23.“结算账单”表的物理结构“结算账单”表的物理结构如图4.3所示,关键字为”账单编号”。 图 4.34. “操作员”表的物理结构 “操作员”表的物理结构如图4.4所示,关键字为”操作员编号”。5. “操作员_VIEW”视图的物理结构是客房和客户的连接。图 4.4图 4.53.4数据字典设计系统数据字典（DDDate Dictionary）是描述数据流程图中所有数据流、数据存储、处理功能等卡片的集合。数据字典提供一个可定义的不依赖于应用程序 的存储区域，用于创建扩展的属性集和描述数据的内容与外观。7其内容包括四种条目:数据流，数据元素、数据存储和数据加工。建立完善的数据字典是对所整理数据的一种分析归档方式，为下一步建立数据库和处理数据做准备。数据字典：“数据流”条目数据流是穿梭于数据加工与外界环境实体间的信息，即流动与数据处理间的数据。因此，数据流词条不仅要说明数据流的名称，组成等本身的特性，而且应指明它的来源、去向和流通量等。 数据流系统名： 宾馆客房管理 编号：1条目名： 客房信息 别名：来源：客房基本信息管理去处：客房基本信息存储数据流结构：客房信息=房间号+房间类型+房态+价格+营业日期+使用配置+设置+备注简要说明：房间的基本信息 修改记录：编写郭皓日期2006年5月审核日期表 2.2 客房管理数据流 数据流系统名： 宾馆客房管理 编号：2条目名： 预订信息 别名：来源：预订管理去处：预订信息存储数据流结构：预订信息=姓名+证件+证件号+联系电话+详细地址+工作单位+客房类型+操作员简要说明：预订房间所需要的信息 修改记录：编写郭皓日期2006年5月审核日期表 2.3 预订信息数据流 数据流系统名： 宾馆客房管理 编号：3条目名： 住宿信息 别名：来源：住宿管理去处：住宿信息存储数据流结构：住宿信息=住宿编号+证件+证件号+单位或地址+房间号+房间类型+操作员简要说明：住宿时需要登记记录的各种信息 修改记录：编写郭皓日期2006年5月审核日期表 2.4 住宿信息数据流数据字典：“数据元素”条目数据元素是数据流组成的最小单位，是无法再细分的数据流。它直接反应事物的某一特征。其描述需要以下信息：数据元素名、类型、长度、取值范围、相关的数据元素及数据结构。 数据元素系统名： 宾馆客房管理 编号：条目名： 房间号 别名：属于数据流：客房信息、住宿信息存储处：客房基本信息存储、住宿信息存储数据元素结构：代码类型 取值范围字符 0000000000-9999999999（由数字组成的字符串）简要说明：房间都有唯一的编号。修改记录：编写郭皓日期2006年5月审核日期表 2.5 房间号数据元素数据字典：“数据存储”条目数据存储是数据结构保存的地方。一个数据存储词条应有以下几项内容：数据存储名、简述、输入数据、输出数据、数据存储组织、记录数、记录组成。 数据存储系统名： 宾馆客房管理 编号：D1条目名： 客房信息 别名：存储组织每个房间一条记录记录数:主关键字：房间号记录组成:项名: 房间号 房间类型 房态 价格 使用设置 配置长度 10 16 10 20 40 40简要说明：使用设置和配置为房间内的软硬件设施，用于检查是否有损坏或使用。修改记录：编写郭皓日期2006年5月审核日期表 2.6 客房信息数据存储 数据存储系统名： 宾馆客房管理 编号：D2条目名： 住宿信息 别名：存储组织每位客人一条记录记录数:主关键字：住宿编号记录组成:项名: 住宿编号 姓名 证件 证件号 单位或地址 操作员长度 10 10 10 20 40 10简要说明：客户有特殊要求在备注中说明。修改记录：编写郭皓日期2006年5月审核日期表 2.7 住宿信息数据存储 数据存储系统名： 宾馆客房管理 编号：D3条目名： 挂账结算 别名：存储组织：每位客人一条记录记录数：约300主关键字：客户编号记录组成：项名： 工作单位 结款方式 还款金额 还款人 操作员近似长度： 6 20 4 8 6简要说明：修改记录：编写郭皓日期2006年5月审核日期表 2.8 挂帐结算数据存储数据字典：“加工”条目加工逻辑是对数据流程图中各个基本处理的精确描述。 加工系统名： 宾馆客房管理 编号：1条目名： 住宿管理 别名：输入数据：客房信息、住宿登记信息输出数据：住宿信息加工逻辑：1 选择已入住或处于维修状态的房间会有警告提示2 入住日期自动读取系统时间简要说明：修改记录：编写郭皓日期2006年5月审核日期表 2.9 住宿管理加工 加工系统名： 宾馆客房管理 编号：2条目名： 结账管理 别名：输入数据:住宿信息输出数据:消费清单、挂账信息、客房信息加工逻辑:1 根据住宿信息以及其他费用结账2 其他费用在此处添加3 客人可选择结账方式简要说明：结账可以选择多种方式。修改记录：编写郭皓日期2006年5月审核日期表 2.10 结帐管理加工3.5 安全保密设计数据库只被少数授权用户访问，必须提供用户名和正确的密码。存储数据库的服务器也只能让系统管理员或少数高级管理人员登录。 数据库的安全策略，遵从SQL Server 2000的安全策略事项。 第4章 实训日记 今天是实训的第一天，今天我们主要总结了软件开发过程和软件项目计划的相关内容，其实这方面的知识我们在上学期的软件工程课上也已经学过了，只是当时学得比较浅，所以对软件开发过程尤其是软件项目计划没有形成一个系统和全面的认识。 今天是实习的第二天，还有另外一个收获就是今天我们学习了一个数据库建模工具Power Designer，这个软件我们在学校并没有接触过，是在这里第一次接触的。分析设计人员利用Power Designer可建立三类模型，即面向对象模型（OOM）、概念数据模型（CDM）、物理数据模型（PDM）。 今天是实习的第三天，在这其中有一个很核心的技术就是J2EE。J2EE简单而统一的基于组件结构，内建的可伸缩性和安全性支持，提供稳定和可靠的基础，与企业信息系统和遗留系统的集成，Web服务的内建支持，建立于厂家和平台的可移植应用，这些特点使J2EE解决了企业开发中的难点。今天一天我们主要是确定及编写项目开发计划，项目开发计划是整个项目的关键所在，如果计划不好，那么后面的工作也不会出色到哪去。因为整个软件项目组分为项目经理、开发组、配置组、测试组和SQA组等几个小组，所以大家分工合作，各自岁自己所在小组所要完成的工作进行了进一步的明确之后，都把自己小组的初步计划制定出来，然后大家各个小组在一块互相商量和探讨了一下，经过协商和统一，各自对自己的计划进行修改之后。最后一天文档完成上交作业。 第5章 实训总结在做软件文档设计以前，作者对管理信息系统开发的理解只是停留在理论知识的水平上，是纸上谈兵，缺乏实际的软件开发经验。这次通过做毕业设计，作者完成了宾馆客房管理信息系统的软件开发任务。在整个开发过程中遇到了很多的问题，但最终都一一解决，对其中比较深刻的几点体会总结如下：第一，让作者发愁的是对宾馆客房的具体业务流程不太熟悉。通过走访各宾馆和查阅资料，经过反复的修改论证，才完成了系统的分析和设计工作。第二，面临的困难是不熟悉软件开发工具。作者只好翻阅了有关PowerBuilder的书籍，同时又不断向老师和同学们请教，才逐渐熟练和掌握了开发工具。第三，从教条主义到理论联系实际的转变。因为没有写论文的经验，所以开始总是生搬硬套书本上的理论和概念，结果写出的论文就非常死板，缺乏新意，不能真正描述出自己软件的开发过程，犯了教条主义的错误。后来经过老师的多次指点，作者对论文从结构和内容上都进行了大幅度的调整和修改，删掉了论文中过多的理论和概念，利用理论知识把自己实际的开发过程，用自己的语言和科学方法准确的表达出来，经过多次修改终于完成了论文的写作。这使作者真正体会到什么叫理论联系实际。第四，在软件开