软件文档写作实训 7.docx
《软件文档写作实训 7.docx》由会员分享，可在线阅读，更多相关《软件文档写作实训 7.docx（18页珍藏版）》请在冰豆网上搜索。
软件文档写作实训7
辽宁工业大学
软件文档写作实训报告
题目：
酒店管理系统软件文档
院（系）:
软件学院
专业班级：
教师职称：
副教授
起止时间：
2012.11.26-2012.12.02
实训任务及评语
院（系）：
软件学院教研室：
软件教研室
学号
实训题目
酒店管理系统
实训任务
实训任务及要求：
1、了解软件开发周期各阶段的文档。
2、掌握各文档阐述的内容及作用。
3、了解文档所采用的国际、国家等相关标准。
4、了解各文档所涉及的软件知识。
5、掌握各文档采用的描述工具。
6、具体编写出2个主要的软件文档。
实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。
正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。
几个人为一组完成一个相对完整的软件系统开发文档，组内成员编写的文档不能重复，文档要严格按照所采用的标准编写，图表布局要合理规范。
指导教师评语及成绩
成绩：
指导教师签字：
2012年12月02日
目录
第1章实训目的与要求1
1.1实训目的1
1.2实训的实验环境1
1.3实训的预备知识1
1.4实训要求1
第2章软件文档及其组成2
2.1软件文档的作用及分类2
2.2软件文档所采用的标准3
2.2软件文档的主要内容3
第3章实例5
3.1软件需求实例5
3.2开发计划实例10
第4章实训日记15
第5章实训总结16
第1章实训目的与要求
1.1实训目的
本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。
1、了解软件开发周期各阶段的文档。
2、掌握各文档阐述的内容及作用。
3、了解文档所采用的国际、国家等相关标准。
4、了解各文档所涉及的软件知识。
5、掌握各文档采用的描述工具。
6、具体编写出2个主要的软件文件。
1.2实训的实验环境
学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。
1.3实训的预备知识
要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。
该实训应安排在毕业设计之前进行。
1.4实训要求
实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。
正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。
第2章软件文档及其组成
2.1软件文档的作用及分类
软件文档的作用
文档是计算机软件产品的重要组成部分，没有文档就不成其为软件，也更不能成为软件产品。
软件文档是一种重要的软件工程技术资料。
如系统分析文档、设计文档、版本说明文档。
软件文档的规范编制，在软件开发工作中占有突出的地位和相当大的工作量。
高质量、高效率的编制、分发、管理、维护文档，及时的变更、修正、扩充和使用文档，对于软件产品的设计开发、发行使用、变更维护、转让移植、二次开发等，对于充分发挥软件产品的效益，都有着重要的意义。
软件文档的分类
基于软件生存期方法，可以从形式上将软件文档大致分成两类：
软件开发过程中需要填写的各种图表，及应编制的各种技术文件或管理资料。
软件文档根据其产生和使用的范围，主要划分为3大类：
开发文档、用户文档和管理文档。
2.2软件文档所采用的标准
类型
标准名称
标准号
基
础
标
准
软件工程术语
GB/T11457-1989
信息处理——数据流程、程序流程图、系统结构图、程序网络图、系统资源图的文件编制符号及约定
GB/T1526-1989
软件工程标准分类法
GB/T15538-1995
信息处理——程序构造及其表示法的约定
GB/T13502-1992
信息处理——单命中判定表规范
GB/T15535-1995（ISO5806）
信息处理系统——计算机系统配置图符号及其约定
GB/T14085-1993（ISO8790）
开
发
标
准
信息技术——软件生存期过程
GB/T8566-1995
软件支持环境
GB/T15853-1995
信息处理——按记录组处理顺序文卷的程序流程
GB/T15697-1995（ISO6593）
软件维护指南
GB/T14079-1993
文
档
标
准
计算机软件产品开发文档编制指南
GB/T8567-1988
计算机软件需求说明编制指南
GB/T9385-1988
计算机软件测试文档编制规范
GB/T9386-1988
软件文档管理指南
GB/T16680-1996
管
理
标
准
计算机软件配置管理计划规范
GB/T12505-1990
信息技术——软件产品评价质量特性及其使用指南
GB/T16260-1996
计算机软件质量保证计划规范
GB/T12504-1990
计算机软件可靠性和可维护性管理
GB/T14394-1993
图1国家标准:
GB中国ANSI美国BS英国JIS日本
2.3软件文档的主要内容
酒店管理系统是一款专业的酒店管理软件，它集前台酒店客房管理系统（酒店客房管理软件），酒店员工管理系统，酒店客户管理系统,酒店物品管理系统，酒店订房系统等强大功能为一身，充分结合中国酒店业的管理实情,系统界面简洁优美，操作直观简单，无需专门培训即可正常使用。
是广大酒店宾馆，饭店，旅馆，招待所等信息化管理场所理想的宾馆客房管理软件。
1.酒店管理软件的主要功能
1）散客和团体开单功能
2）提供多次预定房间功能
3）提供营销管理功能
4）提供一房多价功能
5）提供夜审功能
6）提供长包房服务
7）提供门锁配套服务
8）提供VIP会员和协议单位管理
9）支持积分和储值会员卡
10）支持2代身份证
11）支持黑名单功能
12）提供电话计费管理
2．特点：
1）界面美观华丽，流程直观规范，对服务员只需要很少的培训就能正常操作。
2）2年时间不断开发升级，超过500家酒店场所成功运营，软件的成熟度稳定性非常之高。
3）功能超强：
软件具有客户管理，小票打印，营业报表等功能涵盖酒店行业方方面面。
4）安装简便，对软件维护要求非常的低。
3.计费设置：
计费设置主要是提供计算收取在店宾客消费费用的方法。
主要包括：
（1）全场打折设置：
如果启用了全场打折，那么在宾客结账时将根据设置好的打折比率进行打折优惠；
（2）全天计费（钟点计费）：
此设置作用于设置房间的计费方法，宾客登记后，房间将按此设置的方法开始计费。
此项目在系统设置中设置。
服务生设置：
服务生是指能为宾客提供服务的本店员工，在此设置中可增加、修改、删除服务生信息，还可为每个服务生设置相应的服务生等级（例如：
高级技师、中级技师、普通技师等）。
有了服务生等级可在商品项目中为每种服务项目所对应的服务生等级设置相应的提成金额（如果有此需求），此项设置可为宾客提供服务的服务生自动计算提成金额。
客户设置：
客户是本店的VIP客户、签单客户、团会客户、合约客户、其他客户的统称。
可设置客户等级（例如：
协议单位、团体客户、散客等）还可为每种客户等级设置打折比例。
操作员设置：
操作员是指使用本系统的本店员工，管理员可为其分配相应的操作权限。
打印设置：
打印设置可控制在宾客结账时是否为宾客打印结账清单及控制票据的打印格式。
本软件完美支持pos58系列小票打印机，相关驱动程序可以在我们网站下载。
来宾登记→散客开单（团体开单）：
每个客户发生消费前必须进行登记（建立客户帐），给客户安排一个房间（房间）等房间项目，房间项目必须是在“系统设置”模块中的“房间项目”中已经设置，系统只能对已设置的房间项目（房间）进行登记。
第3章实例
3.1软件需求实例
软件需求
1引言
1.1编写目的
在开发软件系统特别是大型系统的漫长过程中，面对着极其错综复杂的问题，人的主观认识不可能完全符合客观现实，与工程密切相关的各类人员之间的通信和配合也不可能完美无缺，因此在软件生命周期的每个阶段都不可避免地产生差错。
如果在软件投入生产性运行之前，没有发现并纠正软件中的大部分错误，则这些错误迟早会在生产过程中暴露出来，那时不仅改正这些错误的代价高，而且往往会造成很恶的后果。
1.2背景
a．测试计划所从属的软件系统的名称：
SQLSever2008；
b．该开发项目的历史为2012年11月26日。
1.3定义
测试计划Testingplan，描述了要进行的测试活动的范围、方法、资源和进度的文档。
它确定测试项、被测特性、测试任务、谁执行任务、各种可能的风险。
测试计划可以有效预防计划的风险，保障计划的顺利实施。
1.4参考资料
[1]张海潘.软件工程（第二版）.人民邮电出版社,2008
[2]JacksonMA.PrinciplesofProgramDesign.Oxford:
AcademicPress,1975
[3]金敏,周翔.高级软件开发过程.清华大学出版社,2005
[4]吴钦藩.软件工程——原理,方法与应用.人民交通出版社出版
[5]任胜兵,邢琳.软件工程.北京邮电大学出版社
[6]张湘辉等.软件开发过程与管理.清华大学出版社,2004
[7]王少锋.面向对象技术UML教程.清华大学出版社,2004
[8]SchachSR.SoftwareEngineeringwithJava.机械工业出版社,1999
[9]张海藩等.计算机第四代语言.电子工业出版社,1996
2计划
2.1软件说明
测试计划的来源
《酒店管理系统测试计划书》2010/07/05
测试用例的来源
《酒店管理系统测试用例》2010/07/05
测试对象描述
酒店管理系统
测试环境描述
硬件：
cpuAMD5000+2gb内存软件：
Ecilpsesqlserver2000
测试驱动程序描述
JUnit4.0
测试人员
JAVASQL
测试时间
2012/11/26
……
图2软件说明
2.2测试内容
序号
功能模块名称
是否测试
是否通过测试
1
进货管理模块
进货
退货
2
销售管理模块
销售
退货
3
库存管理
库存管理
商品价格调整
4
查询统计
库存查询
入出库查询
客户信息查询
商品信息查询
5
信息管理
商品信息管理
客户信息管理
6
系统维护
权限管理
更改密码
退出系统
图3测试内容
2.3测试（标识符）
这项测试内容的参与单位是本小组成员，被测试的部位为软件所有程序。
2.3.1进度安排
任务
开始日期
结束日期
需求
标志
项目开发计划
2012.11.26
2012.11.27
相关资料
完成计划
可行性分析
2012.11.27
2012.11.28
调研结果、市场分析
完成分析
需求分析
2012.11.28
2012.11.29
调研、市场分析、用户交流
完成分析
总体设计
2012.11.29
2012.11.30
需求分析报告、相关资料
完成模块
详细设计
2012.11.30
2012.12.1
需求分析报告、相关资料
完成细化
实现
2012.11.27
2012.11.28
总体设计、详细设计报告、相关资料
实现程序
测试
2012.11.28
2012.11.29
实现程序、测试用例
测试通过
编册
2012.11.30
2012.12.1
所有内容
完成编册
审查、交付
2012.12.2
2012.12.2
由老师审查通过之后交付用户
审查、交付
图4进度安排
2.3.2条件
对测试用例要有正确的态度：
第一，测试用例应当由测试输入数据和预期输出结果这两部分组成；第二，在设计测试用例时，不仅要考虑合理的输入条件，更要注意不合理的输入条件。
因为软件投入实际运行中，往往不遵守正常的使用方法，却进行了一些甚至大量的意外输入导致软件一时半时不能做出适当的反应，就很容易产生一系列的问题，轻则输出错误的结果，重则瘫痪失效！
因此常用一些不合理的输入条件来发现更多的鲜为人知的软件缺陷。
2.3.3测试资料
步骤
单据
检测要点
关联应用/关联检验点
零星业务通知单录入
选择单据类型
事先定义好的单据类型
选择业务类型
选择物料号
物料查询
输入应收发数量
收发数量不得大于可用库存量在实际入库/出库时反写实际出库入库数量
零星业务执行（出入库）
选择来源单号为零星业务通知单号
所有的未完零星业务单都可选。
检测已完成的零星业务是否可选
零星单查询
选择物料号
不得超出来源单据的范围
输入数量
不得超出来源单据的未完成数量
保存，审核后自动更改仓库数量，单据的已入出库量
检验仓库相关区位箱的物料数量，检验零星业务通知单的出入库数量
图5测试资料
3测试设计说明
3.1测试（标识符）
由于是单独的对该程序进行测试，故需先在数据库中建立好相应的表，存入相应要求的数据。
对程序进行白盒测试等。
另一方面对程序设定多做测试用例进行多次测试，特别是对边界值等特殊的情况的测试，同时逐步精化程序。
3.1.1控制
主要由操作人员对数据输出输入的控制。
数据库主要由专业人员进行控制和维护及更新。
该系统将各种配置连接好后就可以进入运行状态。
3.1.2输入
输入项主要为用户对查询内容的关键字的输入。
3.1.3输出
输出系统查找到得数据的信息，其格式按照相应的表中的要求处理，在打印报表时操作人员可以做相应的调整。
3.1.4过程
由于系统不是全智能化的所以存在某些方面需要人工处理：
1.企业原有内容的整理输入作为系统判断的一个依据。
2.对于货物的进、销、存情况仍然是由人为输入的，没有达到一定的智能水平。
3.系统虽有一定的自身维护功能例如：
系统备份等，但某些方面的维护需要人工处理。
4评价准则
4.1范围
对于系统开发的所需的经费基本在中小型企业的承受范围之内，假定该项目开发费用在20万元内。
同时假定要求开发的企业单位具有一定得相关技术维护人员，配备有全部或部分相关的设施等。
由于开发时间、资金的限制对于系统开发是个最大的约束，由于考虑到企业对系统对数据处理的高效、安全性等问题，故对系统的数据库方面的要求比较的高，需要仔细研究确定相应方案。
4.2数据整理
（1）现场收集数据,应逐日、逐周和品管部门所收集的数据作核对,以求整理真实且具有代表性的数据。
（2）数据整理,改善前、后所具备的条件要一致,如此所作的数据整理和比较才有意义。
（3）异常发生要采取措施,一定要以整理后之数据为研究依据。
（4）使用经别人发表的次级数据应注意:
a.原搜集数据之目的与数据之来源如何?
b.原使用之单位是否与所欲研究者一致,如不一致应如何调整始为合用?
c.原来搜集所得之数字,可靠程度如何?
如何靠当然可以取用,不可靠时,应寻求原因,力谋解决。
d.原来搜集方法如何?
有无重复或遗漏之处?
e.如根据两种以上不同原始来源之数据,使用之前应查明其内容互异之处,寻求错误原因再定取舍。
4.3尺度
项目的资金、功能的评价主要依据开发时所编写的需求报告为依据，项目主要以企业进货、销售和查询统计功能为主,对于库存、销售和进货的记录信息应该及时、准确地保存,并提供相应的查询和统计。
确保系统功能的实现符合用户的需求，同时在开发资金的控制范围内。
3.2开发计划实例
开发计划
1引言
1.1编写目的
为准确说明系统的数据存储与处理方式，特编写本数据要求说明。
该数据要求说明书主要提供给系统实现人员使用，并用于与用户沟通，确认系统满足用户的功能需求。
1.2背景
酒店管理系统要处理的数据主要是订单信息数据、库存信息数据、销售信息数据等。
下面是关于数据库设计的关键说明。
（1）系统名称：
酒店管理信息系统。
（2）数据库名称：
mtgxdb。
（3）数据库管理系统：
采用MySQL
1.3定义
（1）PK，主码，是唯一确定一条记录的关键数据项[8]。
（2）ER图，实体联系图，是反映与数据相关的实体及实体之间关系的图。
（3）MyEclipse,是IBM公司开发的Java开发工具，是本系统开发的工具。
1.4参考资料
[1]张海潘.软件工程（第二版）.人民邮电出版社,2008
[2]JacksonMA.PrinciplesofProgramDesign.Oxford:
AcademicPress,1975
[3]金敏,周翔.高级软件开发过程.清华大学出版社,2005
[4]吴钦藩.软件工程——原理,方法与应用.人民交通出版社出版
[5]任胜兵,邢琳.软件工程.北京邮电大学出版社
[6]张湘辉等.软件开发过程与管理.清华大学出版社,2004
[7]王少锋.面向对象技术UML教程.清华大学出版社,2004
[8]SchachSR.SoftwareEngineeringwithJava.机械工业出版社,1999
[9]张海藩等.计算机第四代语言.电子工业出版社,1996
2数据的逻辑描述
对数据进行逻辑描述时可把数据分为动态数据和静态数据。
所谓静态数据，指在运行过程中主要作为参考的数据，它们在很长的一段时间内不会变化，一般不随运行而改变。
所谓动态数据，包括所有在运行中要发生变化的数据以及在运行中要输入、输出的数据。
进行描述时应把各数据元素逻辑地分成若干组，列如函数、源数据或对于其应用更为恰当的逻辑分组。
给出每一数据元的名称（包括缩写和代码）、定义（或物理意义）度量单位、值域、格式和类型等有关信息。
2.1静态数据
（1）系统用户基本信息，包括帐号、用户名等。
（2）长期供应商信息，包括供应商号、供应商名、品种类型等
2.2动态输人数据
1.能够输入商品信息、客户信息等内容。
2.能对输入的数据进行基础的检错。
3.数据类输入确定数据的进度、类型等具体要求见详细设计报告。
2.3动态输出数据
1.系统能对用户的要求输出的内容做出快速反应，响应时间最多不超过5秒。
2.能够实现数据的打印报表等功能。
2.4内部生成数据
（1）用户（帐号，密码，权限，用户名，性别，职位，部门，联系方式）。
PK=（帐号）
（2）供应商（供应商号，供应商名，联系方式，地址，煤炭品名，单价）。
PK=（供应商号）
（3）收货通知单（收货通知单编号，收货品名，收货数量，收货日期，供应商号，采购订单编号）
PK=（收货通知单编号）,FK=（采购订单编号）
（4）采购订单（订单编号，煤炭品名，数量，交货日期，单价，供应商,缺货单编号）。
PK=（订单编号），FK1=（供应商号）,FK2=（缺货单编号）
（5）入库单（入库单编号，送检编号，煤炭品名，皮重，毛重，净重）
PK=（入库单编号），FK=（送检编号）
（6）出库单（出库单编号，煤炭品名，皮重，毛重，净重,出库申请单编号）
PK=（出库单编号），FK=（出库申请单编号）
（7）送检入库单（送检编号，煤炭品名，发热量，灰分，含硫量,收货通知单编号）
PK=（送检编号），FK=（收货通知单编号）
（8）付款通知单（付款单编号，付款单位，收款单位，付款金额，发货数量，货物价格，付款日期限制,入库单编号）
PK=（付款单编号），FK=（入库单编号）
（9）库存帐（煤炭品种，库存总量）
（11）销售订单（销售订单编号，订购数量，订购品种，单价，订购单位，日期，质量要求，交货日期，月账编号）
PK=（销售订单编号），FK=（月账编号）
（12）出库申请单（出库申请单编号，煤炭品名，发货数量，交货日期，发货单位，收货单位，货物质量描述，销售订单编号）
PK=（出库申请单编号），FK=（销售订单编号）
（13）月销售账单（账单编号，煤炭品名，销售年份，销售月份，销售总额，销售总量）
PK=（账单编号）
2.5数据约定
（1）容量：
2G
（2）文卷：
1024卷
（3）记录页数：
2500页
（4）数据元的个数的最大值：
5500
（5）设计和开发中确定是临界性的限制：
资金限制
3数据的采集
3.1要求和范围
酒店管理系统的数据采集来自采购、销售、和仓储部门，其数据范围包括煤炭信息的相关数据。
（1）采购负责联系上游煤炭供应商，管理供应商信息数据。
（2）仓储部门获取煤炭入库信息等数据。
（3）销售部获取需求信息以及销售业绩数据。
3.2输人的承担者
长期合作供应商数据输入的承担者为负责采购管理的采购部员工，入库信息数据输入的承担者为负责仓储管理的员工，而需求信息数据的输入主要由销售部门的员工负责。
3.3预处理
在网络系统环境下，由销售部进行销售订单、销售额等数据处理，订单数据处理后送交仓储部门；仓储部门根据煤炭入库信息及订单信息进行库存管理。
采购部门根据库存状况进行适当的采购。
3.4影响
该系统为B/S网络版的煤炭进销存管理系统，需要企业设立专门的信息中心，负责共享数据库服务器的管理。
第4章实训日记
2012年11月26日星期一：
今天是上软件文档写作实训课的第一天，到了教室后老师将与该实训相关的资料共享给我们并向我们布置了每个人的任务之后让我们回去做。
2012年11月27日星期二：
由于昨天有课没时间所以今天才开始做课设，昨天我们分好了小组并布置好每个人的任务，我分到的是第一个任务，刚看自己分得的任务就蒙了不知所措，我做的是文档这些文档包括：
可行性报告、项目开发计划、软件需求说明、数据要求说明、测试计划。
真的很头疼没头绪问问别的同学，别的同学也没头绪。
2012年11月29日星期四：
三天过去了我对这个课设还是没有什么头绪还是不知该如何下手，我突然想起老师跟我们说过做该课设所用到的一些资料老师已给。
我查了查老师给的材料，嗯，有点头绪我把我应做的那部分所有模板复制到论文中，复制之后才发现那些模板改动的地方非常之多很多东西都涉及到专业知识，这可咋办?
查呗！
还能咋整？
听说图书馆还没开相关的书籍也是借不了的，只能通过互联网来找。
2012年11月30日星期五：
今天是我做课设的第二天感觉还可以，总的来说现在对这个课设算是有点头绪了知道相关材料该怎么找了，有些专业知识点我们还没涉及到只能在网上查阅相关知识现学现卖。
2012年12月01日星期六：
今天是做课设第三天，前两天课设内容已完成一半今天继续努力完成剩下部分。
在查找资料过程中我遇到了点麻烦，有一部分内容在网上怎么找也没找到，这把我急的不知如何是好还好我对床的同学看出我的心思帮我在网上找到相关内容，真的太感谢他了。
2012年12月02日星期日
今天是最激动人心的日子，在忙碌的三天时间我的论文终于完成了，回想这三天多的日子真是辛苦，因为有很多专业知识没学就做这份论文对我来说的确是个挑战，话说回来那里有挑战哪里就有我，我就是为挑战而生的。
这几天
升级会员 