《客房管理系统软件文档》由会员分享，可在线阅读，更多相关《客房管理系统软件文档（19页珍藏版）》请在金锄头文库上搜索。
1、辽 宁 工 业 大 学 软件文档写作 实训报告题目： 客房管理系统软件文档 院（系）： 软件学院 专业班级： 软件技术091班 学 号： 091404001 学生姓名： 章宇辰 指导教师： 翟宝峰 教师职称： 副教授 起止时间： 2011.12.26-2011.12.30 实训任务及评语院（系）：软件学院 教研室：网络教研室学 号091404001学生姓名章宇辰专业班级软件技术091班实训题目医院管理系统软件文档实训任务实训任务及要求：1、 了解软件开发周期各阶段的文档。2、 掌握各文档阐述的内容及作用。3、 了解文档所采用的国际、国家等相关标准。4、 了解各文档所涉及的软件知识。5、 掌握各
2、文档采用的描述工具。6、 具体编写出2个主要的软件文档。实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。几个人为一组完成一个相对完整的软件系统开发文档，组内成员编写的文档不能重复，文档要严格按照所采用的标准编写，图表布局要合理规范。指导教师评语及成绩成绩： 指导教师签字： 年 月 日 / 目 录第1章 实训目的与要求11.1 实训目的11.2 实训的实验环境11.3 实训的预备知识11.4 实训要求1第2章 软件文档及其组成22.1软件文档的作用及分类22.2软件文档所采用的标准32.2 软件文档的主要内容4第3章 实 例5
3、3.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 实训的实验环境学校图书馆，互联网查询环境，
4、具有软件图表制作软件的计算机。1.3 实训的预备知识 要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。1.4 实训要求实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。 第2章 软件文档及其组成2.1软件文档的作用及分类软件文档的作用 在软件的生产过程中，总是伴随着大量的信息要记录、要使用。因此，软件文档在产品的开发生产过程中起着重要的作用。1）项目管理的依据。文档将通常“不可见的”软件开发进程转换成“可见的”文字资料，有利于项目的管理。2.）技术交流的
5、语言。项目小组内部、项目平行开发的各小组之间进行的交流和联系，通常都是通过文档来实现的。3）项目质量保证。文档是进行项目质量审查和评价的重要依据，有效文档的提供，可以满足项目质量保证人员和审查人员的工作需要。4）支持培训与维护。合格的软件文档通常都提供有关软件运行、维护和培训的必要信息，支持软件产品的应用和维护。5）支持软件维护。软件文档提供系统开发的全部必要技术资料，有利于维护人员熟悉系统，开展维护工作；软件维护文档记载了软件维护过程中软件及其环境变化的全部信息。6）记载软件历史。软件文档作为“记载软件历史的语言”，可用作未来项目的一种资源，向潜在用户报道软件的各种有利信息，便于他们判断自己
6、是否需要该软件提供的服务。7)提高软件开发过程的能见度。把开发过程中发生的事件以某种可阅读的形式记录在文档中。管理人员可把这些记载下来的材料作为检查软件开发进度和开发质量的依据，实现对软件开发的工程管理。 8)提高开发效率。软件文档的编制，使得开发人员对各个阶段的工作都进行周密思考、全盘权衡、从而减少返工。并且可在开发早期发现错误和不一致性，便于及时加以纠正。 9)提供对软件的运行、维护和培训的有关信息，便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解。使软件开发活动更科学、更有成效。 10)便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需要的软件提供依据。 所以，
7、在使用工程化的原理和方法来指导软件的开发和维护时，应当充分注意软件文档的编制和管理。二、软件文档的分类：基于软件生存期方法，可以从形式上将软件文档大致分成两类：软件开发过程中需要填写的各种图表，及应编制的各种技术文件或管理资料。国家标准局在1988年1月颁布了计算机软件开发规范和计算机软件产品开发文件编制指南，作为软件开发和文档编制工作的准则和规程。基于软件生存期方法，可以从形式上将软件文档大致分成两类：软件开发过程中需要填写的各种图表，及应编制的各种技术文件或管理资料。软件文档根据其产生和使用的范围，主要划分为3大类：开发文档、用户文档和管理文档。2.2软件文档所采用的标准1.根据软件工程标
8、准制定的机构和标准适用的范围，可分为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；
9、(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-
10、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. 功能要求 - 来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出
11、一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书。 2. 需求分析 - 包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等。以功能要求为基础，进行详细的功能分析 ( 包括客户提出的要求和根据开发经验建议的功能 ) ，列出本产品是什么，有什么特殊的概念，包括那些功能分类，需要具备什么功能，该功能的操作如何，实现的时候该注意什么细节，客户有什么要求，系统运行环境的要求等。这里的功能描述跟以后的使用手册是一致的。 3. 技术分析 - 包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、
12、技术方案评价，竞争对手技术分析等。以需求分析为基础，进行详细的技术分析 ( 产品的性能和实现方法 ) ，列出本项目需要使用什么技术方案，为什么，有哪些技术问题要解决 ，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什么评价等。 4. 系统分析 - 包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以需求分析为基础，进行详细的系统分析 ( 产品的开发和实现方法 ) ，估计开发期间需要把什么问题说明白，程序员根据系统分析，开始在项目主管的带领下进行编码。 6. 数据库文档 - 包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计
13、算公式等。以系统分析为基础，进行详细的数据库设计。必要时可以用图表解说，特别是关系数据库。 7. 功能函数文档 - 包括变量名、变量初植、功能，函数名，参数，如何调用、备注、注意事项等。以系统分析为基础，进行详细的说明，列出哪个功能涉及多少个函数，以便以后程序员修改、接手和扩展。 8. 界面文档 - 包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的要求，这里与软件完成后的运行界面是一致的。 9. 编译手册 - 包括服务器编译环境、操作系统、编译工具、 GNU 的 C+ 编译器版本信息、目录说明、程序生成、源程序文件列表、 Makefile 配置及其相关程序的对应关系列表。客
14、户端的编译过程、编译结果、编译示例、编译环境、操作系统、编译工具、源文件列表和制作安装程序的过程。 11. 项目总结 - 包括项目简介、项目参与人员和开发时间、项目风险管理过程、项目功能列表、项目结构特点、技术特点、对项目的升级建议、对以后的项目的建议、人员素质情况等。 第3章 实 例3.1数据库概念结构设计 经考察和分析,本案例客房管理系统包括以下实体：客户实体、客房实体、操作员实体、结算账单实体,它们的E-R图如以下所示。客房操作员退房结算账单结算返回 1n11n1入住登记m12.5客房管理系统E-R图客户编号客户姓名年龄性别操作员姓名操作员编号房间状态房号户籍住店天数总费用账单编号离店时间身份证号住店时间押金房间类型房间价格职称房号密码客户3.2数据库逻辑结构设根据E-R图,将图转换为关系
