生产实习课程设计GB2312 24.docx
- 文档编号:11496014
- 上传时间:2023-03-02
- 格式:DOCX
- 页数:20
- 大小:104.10KB
生产实习课程设计GB2312 24.docx
《生产实习课程设计GB2312 24.docx》由会员分享,可在线阅读,更多相关《生产实习课程设计GB2312 24.docx(20页珍藏版)》请在冰豆网上搜索。
生产实习课程设计GB231224
辽宁工业大学
软件文档写作实训报告
题目:
车队管理系统软件文档
院(系):
软件学院
专业班级:
软件工程113班
学号:
111301080
学生姓名:
安凯辰
指导教师:
翟宝峰
教师职称:
副教授
起止时间:
2012.11.26-2012.12.02
实训任务及评语
院(系):
软件学院教研室:
软件教研室
学号
111301080
学生姓名
安凯辰
专业班级
软件工程113班
实训题目
车队管理系统软件文档
实训任务
实训任务及要求:
1、了解软件开发周期各阶段的文档。
2、掌握各文档阐述的内容及作用。
3、了解文档所采用的国际、国家等相关标准。
4、了解各文档所涉及的软件知识。
5、掌握各文档采用的描述工具。
6、具体编写出2个主要的软件文档。
实训过程中,要严格遵守实训的时间安排,听从指导教师的指导。
正确地完成上述内容,记录实习日记,规范完整地撰写出实训报告。
几个人为一组完成一个相对完整的软件系统开发文档,组内成员编写的文档不能重复,文档要严格按照所采用的标准编写,图表布局要合理规范。
指导教师评语及成绩
成绩:
指导教师签字:
年月日
目录
第1章实训目的与要求1
1.1实训目的1
1.2实训的实验环境1
1.3实训的预备知识1
1.4实训要求1
第2章软件文档及其组成2
2.1软件文档的作用及分类2
2.2软件文档所采用的标准3
2.2软件文档的主要内容4
第3章实例5
3.1车队管理系统概要设计实例5
3.2车队管理系统接口设计实例9
第4章实训日记13
第5章实训总结14
参考文献15
第1章实训目的与要求
1.1实训目的
本实训要求学生通过具体的实例,模仿软件开发过程中软件文档写作的具体方法和步骤,分组完成一套较为简单软件文档,具体要达到以下几点目的。
1、了解软件开发周期各阶段的文档。
2、掌握各文档阐述的内容及作用。
3、了解文档所采用的国际、国家等相关标准。
4、了解各文档所涉及的软件知识。
5、掌握各文档采用的描述工具。
6、具体编写出2个主要的软件文件。
1.2实训的实验环境
学校图书馆,互联网查询环境,具有软件图表制作软件的计算机。
1.3实训的预备知识
要求学生修完全部专科所有课程,具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。
该实训应安排在毕业设计之前进行。
1.4实训要求
实训过程中,要严格遵守实训的时间安排,听从指导教师的指导。
正确地完成上述内容,记录实习日记,规范完整地撰写出实训报告。
第2章软件文档及其组成
2.1软件文档的作用及分类
软件文档(document)也称文件,通常指的是一些记录的数据和数据媒体,它具有固定不变的形式,可被人和计算机阅读。
它和计算机程序共同构成了能完成特定功能的计算机软件(有人把源程序也当作文档的一部分)。
我们知道,硬件产品和产品资料在整个生产过程中都是有形可见的,软件生产则有很大不同,文档本身就是软件产品。
没有文档的软件,不成其为软件,更谈不到软件产品。
软件文档的编制(documentation)在软件开发工作中占有突出的地位和相当的工作量。
高效率、高质量地开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档,对于充分发挥软件产品的效益有着重要意义。
然而,在实际工作中,文档在编制和使用中存在着许多问题,有待于解决。
软件开发人员中较普遍地存在着对编制文档不感兴趣的现象。
从用户方面看,他们又常常抱怨:
文档售价太高、文档不够完整、文档编写得不好、文档已经陈旧或是文档太多,难于使用等等。
究竟应该怎样要求它,文档应该写哪些,说明什么问题,起什么作用?
这里将给出简要的介绍。
如图2.1开发流程
图2.1开发流程
文档在软件开发人员、软件管理人员、维护人员、用户以及计算机之间的多种桥梁作用可从图文档的桥梁作用中看出。
软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据,这个作用是显而易见的。
软件开发过程中软件开发人员需制定一些工作计划或工作报告,这些计划和报告都要提供给管理人员,并得到必要的支持。
管理人员则可通过这些文档了解软件开发项目安排、进度、资源使用和成果等。
软件开发人员需为用户了解软件的使用、操作和维护提供详细的资料,我们称此为用户文档。
以上三种文档构成了软件文档的主要部分。
在软件的生产过程中,总是伴随着大量的信息要记录、要使用。
因此,软件文档在产品的开发生产过程中起着重要的作用。
1)提高软件开发过程的能见度。
把开发过程中发生的事件以某种可阅读的形式记录在文档中。
管理人员可把这些记载下来的材料作为检查软件开发进度和开发质量的依据,实现对软件开发的工程管理。
2)提高开发效率。
软件文档的编制,使得开发人员对各个阶段的工作都进行周密思考、全盘权衡、从而减少返工。
并且可在开发早期发现错误和不一致性,便于及时加以纠正。
3)作为开发人员在一定阶段的工作成果和结束标志。
4)记录开发过程中的有关信息,便于协调以后的软件、开发、使用和维护。
5)提供对软件的运行、维护和培训的有关信息,便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解。
使软件开发活动更科学、更有成效。
6)便于潜在用户了解软件的功能、性能等各项指标,为他们选购符合自己需要的软件提供依据。
文档在各类人员、计算机之间的多种桥梁作用中看出:
既然软件已经从手工艺人的开发方式发展到工业化的生产方式,文档在开发过程中就起到关键作用。
从某种意义上来说,文档是软件开发
规范的体现和指南。
按规范要求生成一整套文档的过程,就是按照软件开发规范完成一个软件开发的过程。
所以,在使用工程化的原理和方法来指导软件的开发和维护时,应当充分注意软件文档的编制和管理。
软件文档从形式上来看,大致可分为两类:
一类是开发过程中填写的各种图表,可称之为工作表格;另一类是应编制的技术资料或技术管理资料,可称之为文档或文件。
软件文档的编制,可以用自然语言,特别设计的形式语言,介于两者之间的半形式语言(结构化语言),各类图形表示。
表格来编制文档。
文档可以书写,也可以在计算机支持系统中产生,但它必须是可阅读的。
按照文档产生和使用的范围,软件文档大致可分为三类:
1)开发文档:
这类文档是在软件开发过程中,作为软件开发人员前一阶段工作成果的体现和后一阶段工作依据的文档。
包括软件需求说明书、数据要求说明书、概要设计说明书、详细设计说明书、可行性研究报告、项目开发计划。
2)管理文档:
这类文档是在软件开发过程中,由软件开发人员制定的需提交人员的一砦工作计划或工作报告。
使管理人员能够通过这些文档了解软件开发项目安排、进度、资源使用和成果等。
包括项目开发计划、测试计划、测试报告、开发进度月报及项目开发总结。
3)用户文档:
这类文档是软件开发人员为用户准备的有关该软件使用、操作、维护的资料。
包括用户手册、操作手册、维护修改建议、软件需求说明书。
2.2软件文档所采用的标准
参照其它工程领域对工程标准划分的方法,软件工程标准主要有两种划分方法:
按标准的类型划分和按标准的范围划分。
按标准的类型划分主要有过程标准、产品标准、行业标准、记法标准等。
过程标准与开发一个产品或从事一项服务的一系列活动或操作有关。
过程标准使用一组方法、工具和技术,给出“谁来做”、“做什么”、“如何做”、“何时做”、“何地做”及在软件工程活动中进行的不同层次工作的过程模型。
(方法、技术和度量)产品标准则涉及软件工程事务的格式和内容。
软件开发和维护活动文档化的结果就是软件产品,软件文档是软件工程活动进一步开展的基础。
(需求、设计、部件、描述、计划、报告)软件开发作为一种行业,其行业标准涉及软件工程的所有方面,如职业认证、职业培训、产品许可等。
行业标准可以等同于行业行为规范。
(职别、道德准则、认证、特许、课程)记法标准规定了在软件工程行业范围内,以唯一的方式进行交流的方法,如术语、表示法、语言等。
它其实是一种语境规范。
(术语、表示法、语言)。
按标准的范围划分主要是根据软件的任务功能和软件生存期进行比较、判定、评价和确定软件工程标准的范围和内容。
任务功能可以表示软件工程过程,可以划分为产品工程功能、验证与确认功能以及技术管理功能3个部分。
产品工程功能包括定义、生产和支持最终产品所必须的过程。
验证和确认功能是检查产品质量的活动。
技术管理功能是构造和控制产品工程的过程。
这3个部分并不集中在单个的软件生存周期里,而是并行进行的生产、检查和控制活动。
在项目开发过程中,应该按要求编写好十三种文档,文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。
◇可行性分析报告:
说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性,评述为了合理地达到开发目标可供选择的各种可能实施方案,说明并论证所选定实施方案的理由。
◇项目开发计划:
为软件项目实施方案制订出具体计划,应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。
◇软件需求说明书(软件规格说明书):
对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。
它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的,也是实施开发工作的基础。
该说明书应给出数据逻辑和数据采集的各项要求,为生成和维护系统数据文件做好准备。
◇概要设计说明书:
该说明书是概要实际阶段的工作成果,它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等,为详细设计提供基础。
◇详细设计说明书:
着重描述每一模块是怎样实现的,包括实现算法、逻辑流程等。
◇用户操作手册:
本手册详细描述软件的功能、性能和用户界面,使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识,特别是操作方法的具体细节。
◇测试计划:
为做好集成测试和验收测试,需为如何组织测试制订实施计划。
计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。
◇测试分析报告:
测试工作完成以后,应提交测试计划执行情况的说明,对测试结果加以分析,并提出测试的结论意见。
◇开发进度月报:
该月报系软件人员按月向管理部门提交的项目进展情况报告,报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。
◇项目开发总结报告:
软件项目开发完成以后,应与项目实施计划对照,总结实际执行的情况,如进度、成果、资源利用、成本和投入的人力,此外,还需对开发工作做出评价,总结出经验和教训。
◇软件维护手册:
主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明,便于软件的维护。
◇软件问题报告:
指出软件问题的登记情况,如日期、发现人、状态、问题所属模块等,为软件修改提供准备文档。
◇软件修改报告:
软件产品投入运行以后,发现了需对其进行修正、更改等问题,应将存在的问题、修改的考虑以及修改的影响作出详细的描述,提交审批。
2.2软件文档的主要内容
文档作为计算机软件的重要组成部分,告诉用户如何操作和维护系统,提供关于未来改进和重新实施所需的信息,在开发人员、维护人员、管理人员、用户与计算机之间起着重要的桥梁作用。
如按照标准,一般软件开发过程需要产生的文档有14种之多。
但针对一个具体的软件开发项目,可以根据灵活性原则,决定哪些文档需要标准,哪些可以合并,哪些又可以省略。
一般而言,当项目的规模、复杂性和潜在风险增大时,文档编制的范围、数量、管理手续和详细程度都将随之增加;反之,则可适当减少。
文档的详细程度取决于项目的规模、复杂性和项目负责人对项目开发及运行环境需求情况的判断。
当然,还取决于其自身的经验和对文档涉众的了解程度。
为了使软件文档能起到前节所提到的多种桥梁作用,使它有助于程序员编制程序,有助于管理人员监督和管理软件开发,有助于用户了解软件的工作和应做的操作,有助于维护人员进行有效的修改和扩充,文档的编制必须保证一定的质量。
质量差的软件文档不仅使读者难于理解,给使用者造成许多不便,而且会削弱对软件的管理(管理人员难以确认和评价开发工作的进展),增高软件的成本(一些工作可能被迫返工),甚至造成更加有害的后果(如误操作等)。
程序与文档的形式分离,不仅是用各自独立的形式存放,而且使用不同的工具在不同的时间里书写和检索。
维护程序时不能方便地得到文档的帮助,不能同步修改文档。
程序与文档的内容分离,由于程序与文档采用不同的描述,既有计算机语言也有自然语言。
维护过程中不能及时、一致地更新文档或程序,使文档不能准确地描述程序而几乎成为废纸甚至带来负面价值。
软件开发与维护的分离,绝大多数软件在设计、开发时不太考虑以后可能的修改,加大了软件维护的难度,而且使维护容易引入新的错误。
这些分离也表现在设计、开发的不同阶段的文档之间的不相容性,例如:
需求分析说明书是纸上的东西,在概要设计阶段不能很好地继承、利用需求分析说明书,设计、编制概要设计时必须从零开始,需要重新分析、理解需求分析,这种思维上的脱节,不仅延缓开发进度、加重设计人员的负担,而且由于理解上的不同导致不同阶段描述的对象有许多不相容情况。
这些分离使得文档在系统的设计、开发、维护中的作用下降,这也是很多软件人员不愿意编写文档的主要原因。
第3章实例
3.1车队管理系统概要设计实例
1引言
1.1概要设计编写目的
随着计算机的普及和网络技术的发展,我国的运输行业信息化建设很早就已经开始在全国展开部署了。
车队管理系统就是其中之一。
传统的手写管理由于工作量巨大、存放麻烦、更新困难、不易备份,已随着时代的发展而显的落伍了。
这就要我们创造更快更新的管理系统。
电子管理以快捷、方便的使用而受到欢迎。
车队管理系统是一个运输单位不可缺少的部分,它的内容对于单位的决策者和管理者来说都至关重要,所以车队管理系统应该能够为用户提供充足的信息和快捷的查询手段。
但一直以来人们使用传统人工的方式管理文件档案,这种管理方式存在着许多缺点,如:
效率低、保密性差,另外时间一长,将产生大量的文件和数据,这对于查找、更新和维护都带来了不少的困难。
本系统可以避免单位管理的随意性,使得管理工作规范化、系统化、程序化,提高信息处理的速度和准确性,对于减轻工作人员的劳动量、提高劳动热情和服务质量,具有重要的现实意义。
1.2概要设计背景
本软件包含业务员和查询员。
负责人对系统基本信息的管理和报销审核,员工在前台进行业务管理和业务查询。
因此现有系统由管理员(负责人)、普通服务员(业务员)、查询用户(查询员)等组成。
当客户要托运某货物时,客户把他的运输托运单传给车队的调度,调度把托运单登记到运输文档,然后填写运输单给车队派车。
车队接到运输单后就选择车辆和司机。
并填写派车给司机并登记派车单文档。
司机完成运输日任务回到车队后,把运输单交于车队存档,并把运输过程中产生的成本填写报销单交于财务处报销。
如果在运输中发生车辆有任何问题要在交车的时候就随时填写维修申请交与维修部。
在车辆维修好后,维修部填写维修费用申请单交与财务部门报销。
货代出对帐单交财务部门审核。
审核通过后出费用确认单交财务部门等。
本文的应用背景为一车队运输单位。
该单位由各负责人和员工组成。
1.3参考资料
[1].陶宏才.《数据库原理及设计》.第1版.北京.清华大学出版社.2004年
[2].范立南《SQLServer2000实用教程》第2版.北京.清华大学出版社.2005年
[3].张海藩.软件工程概论(第五版).清华大学出版社
2.总体设计
2.1需求规定
托运管理模块:
(1)输入:
托运单信息
(2)输出:
操作是否成功
(3)处理内容:
检查输入信息的合法性后,调用数据库添加、修改、删除操作并返回结果信息
员工管理模块:
(1)输入:
员工编号,姓名,民族,身份证号,职务,联系电话,联系地址,Email
(2)输出:
操作是否成功
(3)处理内容:
检查输入信息的合法性后,调用数据库添加、修改、删除或者查询操作并返回结果信息。
用户管理模块:
(1)输入:
姓名,密码,权限
(2)输出:
用户添加/删除操作是否成功
(3)处理内容:
检查输入信息的合法性后,调用数据库添加、删除操作并返回结果信息。
运输调度模块
(1)输入:
运输单编号,托运单编号,派运车辆编号,派选司机编号,出发日期
(2)输出:
操作是否成功
(3)处理内容:
检查输入信息的合法性后,调用数据库修改操作,完成托运的调度操作,修改数据库信息。
查询模块
(1)输入:
无
(2)输出:
无
(3)处理内容:
检查输入信息的合法性后,调用数据库查询操作,完成对托运信息、运输信息、员工信息、司机信息、车辆信息、维修信息、报销信息等的查询。
用户登录模块
(1)输入:
用户名、密码。
(2)输出:
无
(3)处理内容:
验证用户名和密码的合法性,并根据用户权限,进入不同的主界面。
2.2运行环境
硬件平台:
(1)CPU:
PⅣ2.6G
(2)硬盘:
80G
(3)内存:
256M
(4)打印机:
可选
软件平台:
(1)操作系统:
WindowsXP
(2)软件开发环境:
VisualBasic6.0
(3)数据库管理系统:
sqlserver2000
(4)其它辅助软件:
Microsoftoffice2000等
2.3基本设计概念和处理流程
处理流程图如图3.1所示:
图3.1处理流程图
2.4结构
绘制数据流图,先要分析整个车队管理的总体情况,划分系统边界,明确各功能之间的关系。
根据对车队管理业务的详细调查和分析,绘制出系统的关联图——即系统的最高层数据。
其中F1:
派车单F2:
运输单F3:
回程单F4:
司机信息F5:
汽车信息F6:
维修单F7:
出库信息F8:
维修费用F9:
运输费用F10:
报销费用。
如图3.2所示:
图3.2数据流图
如上图所示,与系统关联的有三个外部项:
管理员、普通用户、查询用户。
业务员(普通用户)将托运信息输入系统,并对车辆和司机进行调度,同时负责日常的业务管理(包括托运、运输、登记、维修、报销申请等)的操作。
查询用户可以向系统查询他所关心的内容,如托运的现在的情况、是否完成等等。
系统还应该提供简单的Excel统计报表功能,这些统计信息根据不同的侧重,提交给管理员或者负责人,分别为单位和管理者决策时提供参考。
管理员可以对系统用户进行管理,数据库的恢复,和财务审核等。
2.5功能需求与程序的关系
功能需求与程序的关系如表3.3所示:
托运管理模块
员工管理模块
用户管理模块
运输调度模块
查询模块
用户登录模块
添加
√
√
√
√
删除
√
√
√
√
修改
√
√
√
表3.1功能需求与程序的关系表
2.6尚未解决问题
由于该车队未采用自动化管理,工作人员往往对车辆和司机的情况不甚了解,有时为了查找托运单的状态。
需要的许多的单据中寻找,非常吃力。
而各部门之间信息也不能及时沟通,在工作上也带来了诸多不便。
通过分析可以发现,现行系统存在的问题,主要是由于传统的手工操作方法难以满足当前大量业务操作需求而引,起的。
另外,传统手工操作方法的低效、易出错以及当前信息难以及时反映等不足,也在一定程度上加剧了当前系统难以满足现实需求的现状。
例如:
检索迅速、查找方便、可靠性高、存储量大、保密性好、寿命长、成本低等。
这些优点能够极大地提高学生学籍管理的效率,也是企业的科学化、正规化管理,与世界接轨的重要条件。
开发这样一套管理软件成为很有必要的事情,这样可以使得车队车辆司机资源管理更加有序和高效。
因此,根据车队管理现状,应用一套有效的管理业务软件是迫在眉睫的。
使用计算机对车队运输信息进行管理,具有手工管理所无法比拟的优点。
3.2车队管理系统接口设计实例
1.1用户接口
用户界面:
在界面设计上,应做到简单明了,易于操作,并且要注意到界面的布局,应突出的显示重要以及出错信息。
外观上也要做到合理化,考虑到用户多对WINDOW风格较熟悉,应尽量向这一方向靠拢。
(1)判断用户名是否为空:
DimtxtSqlAsString
UserName=""
IfTrim(txtUserName.Text)=""Then''
MsgBox"请输入帐号!
",vbOKOnly+vbExclamation,"警告"
txtUserName.SetFocus
(2)判断密码是否为空
IfTrim(txtPassword.Text)=""Then'
MsgBox"请输入密码!
",vbOKOnly+vbExclamation,"警告"
txtPassword.SetFocus
'判断是否有这个用户
txtSql="select*from用户信息表where用户名称='"&txtUserName.Text&"'"
IfRs.StateThenRs.Close
Rs.OpentxtSql,CN,adOpenStatic,adLockOptimistic
IfRs.EOF=TrueThen''如果没有这个用户
MsgBox"没有这个帐号,请重新输入帐号!
",vbOKOnly+vbExclamation,"警告"
txtUserName.Text=""
txtPassword.Text=""
txtUserName.SetFocus
Else''如果有用户
IfTrim(Rs.Fields
(1))=Trim(txtPassword.Text)Then
1.2外部接口
本系统设有人机操作界面,考虑到操作简单,易于管理方面,主要硬件接口设备为PC,鼠标,键盘。
而软件接口主要以windows平台为基本平台
连数据库代码
IfCN.StateThenCN.Close
CN.ConnectionString="Provider=SQLOLEDB.1;IntegratedSecurity=SSPI;PersistSecurityInfo=False;InitialCatalog=cargroup"
CN.Open
miCount=0
Ok=False
txtUserName.Text=GetSetting(App.Title,"Settings","user_name","")
Label2.MouseIcon=cmdOK.MouseIcon
ExitSub
Err:
MsgBoxErr.Description,,"数据库连接错误"
End
2.运行设计
2.1运行模块结合
1)、登录模块:
具有不同权限的管理人员可以通过用户名和密码登录系统,进入主界面。
2)、设备查询模块:
按操作员输入的编号、姓名能以查询一个至多个药库的库存记录,并可打印存档。
3)、设备录入模块:
录入设备信息,输入完成后,将数据存盘。
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 生产实习课程设计GB2312 24 生产 实习 课程设计 GB2312