软件文档写作 实训报告 超市管理系统.docx
- 文档编号:4311306
- 上传时间:2022-11-29
- 格式:DOCX
- 页数:14
- 大小:57.54KB
软件文档写作 实训报告 超市管理系统.docx
《软件文档写作 实训报告 超市管理系统.docx》由会员分享,可在线阅读,更多相关《软件文档写作 实训报告 超市管理系统.docx(14页珍藏版)》请在冰豆网上搜索。
软件文档写作实训报告超市管理系统
辽宁工业大学
软件文档写作实训报告
题目:
超市管理系统软件文档
院(系):
软件学院
专业班级:
电子商务092班
学号:
091401050
学生姓名:
洪竹
指导教师:
张莉莉
教师职称:
助教
起止时间:
2011.11.28-2011.12.03
实训任务及评语
院(系):
软件学院教研室:
软件教研室
学号
洪竹
学生姓名
091401050
专业班级
电子商务092班
实训题目
超市管理系统软件文档
实训任务
实训任务及要求:
1、了解软件开发周期各阶段的文档。
2、掌握各文档阐述的内容及作用。
3、了解文档所采用的国际、国家等相关标准。
4、了解各文档所涉及的软件知识。
5、掌握各文档采用的描述工具。
6、具体编写出2个主要的软件文档。
实训过程中,要严格遵守实训的时间安排,听从指导教师的指导。
正确地完成上述内容,记录实习日记,规范完整地撰写出实训报告。
几个人为一组完成一个相对完整的软件系统开发文档,组内成员编写的文档不能重复,文档要严格按照所采用的标准编写,图表布局要合理规范。
指导教师评语及成绩
成绩:
指导教师签字:
2011年12月03日
目录
第1章实训目的与要求1
1.1实训目的1
1.2实训的实验环境1
1.3实训的预备知识1
1.4实训要求1
第2章软件文档及其组成2
2.1软件文档的作用及分类2
2.2软件文档所采用的标准2
2.2软件文档的主要内容3
第3章实例5
3.1超市管理系统软件需求说明书的编写实例5
第4章实训日记11
第5章实训总结12
参考文献13
第1章实训目的与要求
1.1实训目的
本实训要求学生通过具体的实例,模仿软件开发过程中软件文档写作的具体方法和步骤,分组完成一套较为简单软件文档,具体要达到以下几点目的。
1、了解软件开发周期各阶段的文档。
2、掌握各文档阐述的内容及作用。
3、了解文档所采用的国际、国家等相关标准。
4、了解各文档所涉及的软件知识。
5、掌握各文档采用的描述工具。
6、具体编写出2个主要的软件文件。
1.2实训的实验环境
学校图书馆,互联网查询环境,具有软件图表制作软件的计算机。
1.3实训的预备知识
要求学生修完全部专科所有课程,具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。
该实训应安排在毕业设计之前进行。
1.4实训要求
实训过程中,要严格遵守实训的时间安排,听从指导教师的指导。
正确地完成上述内容,记录实习日记,规范完整地撰写出实训报告。
第2章软件文档及其组成
2.1软件文档的作用及分类
软件文档是一种重要的软件工程技术资料。
如系统分析文档、设计文档、版本说明文档等。
软件文档的规范编制,在软件开发工作中占有突出的地位和相当大的工作量。
高质量、高效率的编制、分发、管理、维护文档,及时的变更、修正、扩充和使用文档,对于软件产品的设计开发、发行使用、变更维护、转让移植、二次开发等,对于充分发挥软件产品的效益,都有着重要的意义。
软件文档可按照基于软件生存期方法以及根据其产生和使用的范围两大类分类。
1.基于软件生存期方法,可以从形式上将软件文档大致分成两类:
软件开发过程中需要填写的各种图表,及应编制的各种技术文件或管理资料。
2.软件文档根据其产生和使用的范围,主要划分为3大类:
开发文档、用户文档和管理文档。
其中,开发文档包括:
可行性研究报告,项目开发计划,软件需求说明书,数据库设计说明书,概要设计说明书,详细设计说明书。
用户文档包括:
用户手册,操作手册,软件需求说明书,数据要求说明书。
管理文档包括:
项目开发计划,模块开发卷宗,开发进度月报,测试计划,测试分析报告,项目开发总结报告。
而供开发人员使用的文档为可行性研究报告,项目开发计划,软件需求说明书,数据要求说明书,概要设计说明书,详细设计说明书,数据库设计说明书,测试计划,测试分析报告。
维护人员使用的文档为设计说明书,测试分析报告,模块开发卷宗。
管理人员使用的文档为可行性研究报告,项目开发计划,模块开发卷宗,开发进度月报,项目开发总结报告。
用户使用的文档则为用户手册和操作手册。
2.2软件文档所采用的标准
1.根据软件工程标准制定的机构和标准适用的范围,可分为4个层次:
(1)国际标准:
ISO国际标准化组织
(2)国家标准:
GB中国ANSI美国BS英国JIS日本
(3)行业标准:
IEEE
(4)企业(机构)标准:
IBM
IBM(InternationalBusinessMachinesCorporation),国际商业机器公司,或万国商业机器公司的简称。
IBM公司同时也是备受世人尊重的公司。
受人尊重的原因,其中之一是能够在近百年的历史过程中,多次领导产业革命,尤其是在IT行业中,制定多项标准,并努力帮助客户成功。
另外,该公司一直在世界500强中位居前列。
更为重要的是,其受人尊重的原因在于,IBM公司近百年的历史当中,一直坚持遵守“沃森哲学”。
在1914年创办IBM公司时,托马斯为公司制定了“行为准则”,这些准则一直牢记在公司每位人员的心中,任何一个行动及政策都直接受到这三条准则的影响,“沃森哲学”对公司的成功所贡献的力量,比技术革新、市场销售技巧,或庞大财力所贡献的力量更大,主要包括:
必须尊重个人;
必须尽可能给予别人最好的服务;
必须追求优异的工作表现。
IBM新的政策的原则如下:
根据标准化机构所制定的标准质量及其流程、会员制度和知识产权政策的开放程度,决定是否参加或退出该标准化机构。
倡导新兴国家和发达国家采用开放的全球标准、并参与这些标准的制定。
推动标准化机构建立规章制度,以保证技术决策、投票和争议解决由独立的参与者公正做出,避免受到不当利益的影响。
与标准化机构和开发者社区合作,确保可以自由地获得和实施开放的软件互操作标准。
协力推动标准化机构创建清晰、简洁和贯彻始终的知识产权政策,使得标准开发者和实施者可以在信息透明的环境下做出技术和商业决策。
IBM倡导标准化社区的成员采用类似的原则,它们比现存法律和政策的要求更加严格。
IBM新的标准化政策推崇简化和统一的知识产权操作规程,强调包括开源社区和成长型市场在内的所有利益相关方在参与标准化过程中一律平等。
2.3软件文档的主要内容
本软件文档是超市管理系统软件文档。
超市系统软件文档包括超市系统操作手册、超市系统测试计划、超市系统概要设计说明书、超市系统可行性分析报告、超市系统需求说明书、超市系统详细设计说明书、超市系统项目计划、超市系统项目总结报告、超市系统用户手册。
首先本超市管理系统分为以下几个功能:
系统设置、商品供应商信息管理、员工档案管理、商品信息管理、商品入库管理、销售管理、销售数据查询。
我在超市管理系统软件文档所作的内容为:
可行性分析报告:
说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性,评述为了合理地达到开发目标可供选择的各种可能实施方案,说明并论证所选定实施方案的理由。
项目开发计划:
为软件项目实施方案制订出具体计划,应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。
软件需求说明书(软件规格说明书):
对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。
它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的,也是实施开发工作的基础。
该说明书应给出数据逻辑和数据采集的各项要求,为生成和维护系统数据文件做好准备。
测试计划:
为做好集成测试和验收测试,需为如何组织测试制订实施计划。
计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。
数据要求说明书:
通过数据录入和处理的准确性和实时性,数据的一致性与完整性,数据的共享与独立性,静态数据,动态输入输出数据等,已达到了解数据库,了解超市管理系统的存储及输出。
以提高系统工作效率和管理水平。
第3章实例
3.1超市管理系统软件需求说明书的编写实例
一、概述:
1编写目的
通过研究讨论:
性能,处理能力,超市经营物品的采购、库存、销售及核算的手工信息管理,设备等的需求进行分析。
方便用户和软件开发人员双方对软件的运行环境、功能和性能需求的初始规定有一个共同的理解,使之成为整个软件开发工作的基础,并为概要设计提供需求分析。
2背景
现代化的今天新的物流方式需要新的系统的支持。
这是因为计算机为企业提供了新的方式来处理存货和送货等传统的任务。
比如,协作计划,预测和补给(CPFR)战略使零售商与制造商可以比较各自对特定产品的预测,并且预警系统的开发有助与满足时常需求和依据定货来进行及时的调整库存。
供应链执行与计划软件拥有响应的可视化库存软件。
新兴的基于网络的软件模型使大中小企业得意于仓库管理软件和运输管理软件。
因为只需支付月费用或交易费就可以使用应用服务提供商的解决方案。
而不必为了安装软件和进行更多的软件集成来支付数额更大的费用。
3定义
维度(Dimension):
数据仓库用于组织大量运作数据和历史数据的一种形式,例如时间是一个重要的维度。
索引:
(Indexing):
用于提高查找与检索数据库记录的数据访问方法,是改善数据库查询性能的一种经常使用的技术。
事务复制(TransactionReplication):
事务复制发布的是修改发表数据的语句,如INSERT,UPDATE,DELETE,而实际的数据并不会传输。
事务复制需要连续监视出版服务器事务日志的改变。
数据流图(DataFlowDiagram):
是从"数据"和"对数据的加工"两方面表达数据处理系统工作过程的一种图形表示法,具有直观、易于被用户和软件人员双方理解的特点。
完整性约束(IntegrityConstraint):
对数据库数据的正确性和有效性的约束。
假如在任何时刻,一个数据库满足显式指定的验证规则集合,就说该数据库是满足完整性约束的。
触发器(Trigger):
触发器是一种特殊类型的存储过程,它由一系列的命令组成。
当关系表中数据被修改时,系统自动执行触发器定义的操作。
关键字(PrimaryKey):
表中的一个属性或几个属性的组合、其值能唯一地标识关系中的一个元组。
关键字属性不能取空值。
数据项(DataItem):
是DBTG命名的网状数据模型中的最小数据单位,表示实体的属性。
4参考资料
1.刘雅丽.《计算机SQL应用技术》.大连师范大学
2.陈宁.《C语言课程应用详解》.辽宁工业出版社
3.贾进.《计算机基础及其应用》.沈阳师范大学出版社
4.明涛.《sql三程序设计》,电脑科学出版社
5.耷零.《SQLServer2000数据库管理》.沈亚工业出版社
6.江涛.《数据库应用基础》.吉林工业出版社
7.宁康.《SQL工作原理》.沈阳工业出版社
8.郭杰.《计算机实用教程》.古迹出版社
9.邝意.《C语言应用技术》.吉林出版社
10.耿纠.《数据库资源利用》.教案出版社
二、任务概述
1目标
超市经营物品的采购、库存、销售及核算的手工信息管理使得工作量巨大、服务质量差、工作效率低。
同时对市场的反馈的信息不能及时的处理,从而导致销售与市场脱节。
最终的结果只能使超市在经营中立于不利的地位。
目的就是为了解决超市管理的紊乱,使得在超市日常经营及销售中,能够有迹可寻,随时跟踪市场,而且减少了不必要的劳力资本,使得经营者能够实现用最小的成本,获得最大的利润。
本系统的目的是以优质的服务和品种齐全的商品,面向本地区的所有消费者,以使经营者能够实现利润。
具体的目标为:
最方便的提供消费者所需购买物品,详细如实的记录物品的品种分类,了解市场发展方向,及时修正进货信息,修改库存管理办法、结算工作办法、采购管理办法等,提高工作效率,节余财力物力资源。
2用户的特点
用户有销售人员、仓库管理员、系统管理员,其文化水平不高,计算机操作水平一般。
维护人员为系统的开发人员,大学本科教育程度,掌握了多项计算机技能,能够训练地使用C#语言,以及.net平台,SQLserver数据库的应用,在系统出现问题时能及时地进行维护等。
本系统天天使用,对系统的性能要求比较高。
3假定和约束
假定系统在运行过程中不出现任何问题,则达到开发本系统的最终目的。
假定本系统的开发能在预期的时间之内完成任务,则经费支出为2000元,其中开发期限为10天。
三、需求规定
1对功能的规定
本超市管理系统协助中小型超市管理员实现各种日常事务的管理。
系统维护一数据库,及时修正进货信息,修改库存管理、结算工作、采购管理,便于管理员管理超市人员统计、仓库管理、进货、采购、库存、销售及核算,还可根据需要随时进行数据的查询和统计并按所需格式和方式输出。
利用这些数据,系统可协助员工进行本超市职工和货物进行实时管理等操作,统计、仓库管理、进货、采购、库存、销售及核算都可由系统承担,大大减轻了员工的工作量。
此外,对于系统本身的维护,系统具备一定的安全机制和信息备份机制,对用户分级管理,设置用户权限,保证系统安全性;提供数据库文件的备份功能,按用户要求备份,防止意外数据丢失影响系统工作。
2对性能的规定
2.1精度
对于价格和会员的剩余金额等有关与价格的数值需要2位有效数字,即精确到分(不会出现低于这个精度的情况)
对于进货时间、销售时间需要精确到分钟。
标准商品条形码的位数为12,超市自定义条形码的位数为8位。
2.2时间特性要求
1)由于销售商品是需要实时处理,所以对与商品在数据库里的查询速度有较高的要求。
2)会员管理、进货、库存等处理时的时间要求较低。
2.3灵活性
1)由于实际进行操作时发生的情况较多,例如有可能会出现忘记录入或者不同种商品录入成相同商品的错误,所以在销售时需要对库存量进行判断。
2)由于价格浮动,所以在计算利润的时候需要使用当次进货批次的进货价格。
3输人输出要求
主要的输入数据有:
(1)会员信息
会员编号:
5位数字,会员的唯一标识码。
会员姓名:
10位以内汉字,会员的姓名。
会员住址:
25位以内汉字,会员的家庭住址。
会员充值卡号:
15位以内数字,充值卡的唯一物理识别码。
会员帐户余额:
浮点数,精确到小数点后两位小数(分)
(2)系统使用者
用户名:
15位以内字符,系统使用者的唯一标识符。
用户密码:
20位以内字符,用户密码
用户权限:
一个整数,用来标记用户的权限。
(3)商品信息
商品条形码:
15位以内数字,商品的唯一标识码。
商品名称:
15位以内汉字,商品名称。
商品出售价格:
浮点数,精确到小数点后两位小数(分)
(4)进货信息
编号:
进货单编号,代表了进货批次。
商品进货价格:
浮点数,精确到小数点后两位小数(分)
商品进货数量:
整数,此批次的进货数量。
商品进货时间:
时间类型,记录进货时间。
(5)库存信息
商品剩余数量:
整数,记录某批次商品的剩余数量。
(6)销售信息
编号:
销售单编号,代表了销售批次。
会员编号:
见会员信息,记录了购买此商品的用户。
销售时间:
时间类型,记录了销售时间。
4数据管理能力要求
该系统使用SQLSEVER数据库系统存放数据,主要的数据表有:
会员信息表,商品信息表,进货信息表,销售信息表,管理员信息表。
其中库存记录中的剩余数量在进货信息表中,和某一批次绑定。
由于涉及到帐目,所以所有信息在一年的安全期内不能够进行任何改动。
在这期间的数据增长量较大,尤其是销售记录的增长可能会达到每天1500条。
但是对于SQLSEVER系统来说,还是可以在这种增长量下正常工作的。
5故障处理要求
由于涉及到帐目,对于数据库数据项的生成有着较高的要求,要求程序和数据库进行连接时的安全性非常高。
这方面主要依靠SQLSEVER数据库系统的自身特征进行处理。
另外为数据库提供备份和还原功能,在服务器发生操作系统级的失败时可以挽回一定的数据损失。
6其他专门要求
根据软件和用户组织的特性等,某些需求放在下面各项中描述。
需求分析阶段的工作,除功能需求和性能需求外,还有以下需求:
环境需求:
这对系统运行时所在环境的要求。
计算机硬件其最低要求前台pc机最低配置要求网卡、CPU赛杨400、64MB内存。
后台服务器最低配置PIV2.0G,256MB内存、20G硬盘、网卡。
软件其最低要求MicrosoftWindows2000
EclipseJava1.4.2DreamweaverMX
在使用方面,操作人员的技术水平上应具备熟练操作SQL,Eclipse等。
可靠性需求:
在需求分析时应对目标软件在投入运行后不发生故障的概率,按实际的运行环境提出要求,对于重要软件,最好应用正版,或免费的软件开发,应提出较高的可靠性要求,以期在开发的过程中采取必要的措施,使软件产品能够高度可靠的稳定运行。
安全保密要求:
工作在不同环境的软件对其安全性、保密性显然不同的尽可能的安全,保密,稳定.
用户界面需求:
系统与用户界面的友好性是用户能够方便快捷的应用该软件.
软件成本消耗与开发进度需求:
在软件项目立项后,要根据合同规定,对软件开发的进度和各步骤的费用提出要求,作为开发管理的依据。
预先估计以后系统可能达到的效果。
这样,在开发过程中,可对系统将来可能的扩充与修改做准备。
一旦需要时,就比较容易进行补充和修改。
如果在做需求分析之前没有做过可行性分析,那么补充完成这部分工作是必要的。
在定义阶段尽早发现将来可能在开发过程中遇到的问题,及早做出决定,可以避免大量的人工、金钱、时间上的浪费。
四运行环境规定
1设备
硬件环境:
服务器IntelPIII866XeonCache2M或更高配置
内存256M以上
网络适配器10MB或100MB的网卡
打印机一台
UPS(选配)
客户机CPUPentium200或更高配置
内存256M以上
硬盘至少20G以上
网络适配器10MB或100MB的网卡
打印机(选配)
网络至少一台服务器
至少一台工作站
使用TCP/IP协议的局域网。
2支持软件
操作系统:
Windows98、WindowsNT、WindowsXP、WindowsVista、Windows7等能够安装LAN或支持.NET平台的操作系统;
前台开发工具:
MicrosoftVisualStudio2005;
后台开发工具:
MicrosoftSQLServer2005;
3接口
3.1软件接口
运行于MicrosoftWindows2000AdvancedServer以上或同系列OS。
3.2通信接口
本软件应提供电子邮件、Web浏览器等支持。
4控制
采用手工操作和扫描仪配合的方法,完成会员信息、系统使用者、商品信息、进货信息、库存信息、销售信息等功能。
第4章实训日记
第一天:
我们确立了分工小组,研究了课题,我们确立的题目是超市管理系统。
第二天:
我们就开始了我们的工作,由于分工明确,我们小组顺利的完成了资料查询工作,并进一步进行分组分模块的分工。
第三天:
我们小组内部又分出一部分去网上查阅资料,另一部分负责对搜集来的资料进行整理和分析,从而确立了超市管理系统的代码。
第四天:
我们对现有的程序代码进行了测试与修改,并记录了几组测试信息。
第五天:
我们对现有的代码进行分工,分模块进行文档的编写,通过前几天对系统的测试数据我们进行进一步的分析整理逐步完善了系统的稳定性以及文档的及时记录。
第六天,我们进行了文档的收官阶段,小组集体进行文档的查缺补漏,完善文档信息,并对一周以来的工作进行总结分析,吸取经验教训为以后的进一步学习奠定基础。
并将编写完的文档上交。
第5章实训总结
在一周的时间内,我们小组分工合作,顺利的完成了本次课程设计。
本次课程设计我们选的题目是超市管理系统,对于软件文档的写作我不是很了解,但是在小组成员的帮助和我们共同的努力之下,我们完成了本次软件文档的写作,我们之所以选择超市管理系统是因为超市在我们的生活之中无处不在,对于超市的运行流程我们也是略有了解,所以对文档的写作会有一定的帮助,同样之下也降低了本次文档写作的难度,在小组的合作分工下我们完成了对超市的整体运营的了解,完成了对文档写作的初识,完成了对超市管理系统的编写及测试,同样也完成了本次课程设计,在此其中我们经历了很多困难,比如说代码运行错误,文档内容的陌生,以及分工不太谨慎导致工作日程的的滞后等等,但是在大家的共同研讨和共同努力之下我们一一克服了困难,我们在困难中进步,学到了知识也积累了经验。
在这次的课设设计中我学到了很多,不但是对软件文档的写作理解的更近一步加深,也增进了我们之间友谊。
参考文献
[1]霍林.《c语言软件详解》.北京:
北京大学出版社,2008.6
[2]王陵.《软件知识概括》.北京:
清华大学出版社,2009.4
[3]袁建.《计算机网络工程》.上海:
化学工业出版社2011.5
[4]郑涛.《SQL课程设计》.宁波:
高等教育出版社2009.7
[5]刘宁.《SQL软件》.北京:
清华大学出版社2009.9
[6]康玲.《软件基础要点》.武汉:
机械工业出版社2009.10
[7]尨博.《计算机软件》.湖北:
电子工业出版社2010.8
[8]孙菱.《C语言工作原理》.天津:
中国青年出版社2005.5
[9]赵成.《程序设计介绍》.四川:
电子工业出版社2008.3
[10]吴宁.《实用软件工程技术》.浙江:
电子工业出版社2006.6
[11]张彀.《软件工程技术》.北京:
北京航空航天大学出版社2008.1
[12]康雪.《软件文档写作》.北京:
清华大学出版社2007.11
[13]襄澄.《软件测试详解》.北京:
人民邮电出版社2005.6
[14]程明.《计算机基础理论》.重庆:
重庆大学出版社2008.3
[15]兰梅.《计算机软件技术》.辽宁:
辽宁交通大学出版社2011.8
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 软件文档写作 实训报告 超市管理系统 软件 文档 写作 报告 超市 管理 系统