软件文档写作实训报告(康亚瑞)车队管理

辽 宁 工 业 大 学 软件文档写作 实训报告题目： 车队管理系统软件文档 院（系）: 软件学院 专业班级： 软件技术081 学 号： 学生姓名： 安凯辰 指导教师： 王彦华 教师职称： 助 教 起止时间： 2010.11.22 -2010.12.06 实训任务及评语院（系）：软件学院 教研室：软件教研室学 号学生姓名安凯辰专业班级软件技术081实训题目 车队管理系统软件文档实训任务实训任务及要求：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章 实 例63.1 概要设计实例6第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）软件文档的作用 在软件的生产过程中，总是伴随着大量的信息要记录、要使用。因此，软件文档在产品的开发生产过程中起着重要的作用。 1)提高软件开发过程的能见度。把开发过程中发生的事件以某种可阅读的形式记录在文档中。管理人员可把这些记载下来的材料作为检查软件开发进度和开发质量的依据，实现对软件开发的工程管理。2)提高开发效率。软件文档的编制，使得开发人员对各个阶段的工作都进行周密思考、全盘权衡、从而减少返工。并且可在开发早期发现错误和不一致性，便于及时加以纠正。3)作为开发人员在一定阶段的工作成果和结束标志。 4)记录开发过程中的有关信息，便于协调以后的软件、开发、使用和维护。 5)提供对软件的运行、维护和培训的有关信息，便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解。使软件开发活动更科学、更有成效。 6)便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需要的软件提供依据。 文档在各类人员、计算机之间的多种桥梁作用中看出： 既然软件已经从手工艺人的开发方式发展到工业化的生产方式，文档在开发过程中就起到关键作用。从某种意义上来说，文档是软件开发 规范的体现和指南。按规范要求生成一整套文档的过程，就是按照软件开发规范完成一个软件开发的过程。所以，在使用工程化的原理和方法来指导软件的开发和维护时，应当充分注意软件文档的编制和管理。 (2)文档的分类 软件文档从形式上来看，大致可分为两类： 一类是开发过程中填写的各种图表，可称之为工作表格；另一类是应编制的技术资料或技术管理资料，可称之为文档或文件。 软件文档的编制，可以用自然语言，特别设计的形式语言，介于两者之间的半形式语言(结构化语言)，各类图形表示。表格来编制文档。文档可以书写，也可以在计算机支持系统中产生，但它必须是可阅读的。 按照文档产生和使用的范围，软件文档大致可分为三类： 1)开发文档：这类文档是在软件开发过程中，作为软件开发人员前一阶段工作成果的体现和后一阶段工作依据的文档。包括软件需求说明书、数据要求说明书、概要设计说明书、详细设计说明书、可行性研究报告、项目开发计划。 2)管理文档：这类文档是在软件开发过程中，由软件开发人员制定的需提交人员的一些工作计划或工作报告。使管理人员能够通过这些文档了解软件开发项目安排、进度、资源使用和成果等。包括项目开发计划、测试计划、测试报告、开发进度月报及项目开发总结。 3)用户文档：这类文档是软件开发人员为用户准备的有关该软件使用、操作、维护的资料。包括用户手册、操作手册、维护修改建议、软件需求说明书。2.2软件文档所采用的标准软件文档采用软件工程标准化。参照其它工程领域对工程标准划分的方法，软件工程标准主要有两种划分方法：按标准的类型划分和按标准的范围划分。按标准的类型划分：主要有过程标准、产品标准、行业标准、记法标准等。 1).过程标准:过程标准与开发一个产品或从事一项服务的一系列活动或操作有关。过程标准使用一组方法、工具和技术，给出“谁来做”、“做什么”、“如何做”、“何时做”、“何地做”及在软件工程活动中进行的不同层次工作的过程模型。（方法、技术和度量）。 2).产品标准:产品标准则涉及软件工程事务的格式和内容。软件开发和维护活动文档化的结果就是软件产品，软件文档是软件工程活动进一步开展的基础。（需求、设计、部件、描述、计划、报告 ）。 3).行业标准：软件开发作为一种行业，其行业标准涉及软件工程的所有方面，如职业认证、职业培训、产品许可等。行业标准可以等同于行业行为规范。（职别、道德准则、认证、特许、课程 ）。 4).记法标准：记法标准规定了在软件工程行业范围内，以唯一的方式进行交流的方法，如术语、表示法、语言等。它其实是一种语境规范。（术语、表示法、语言 ）。按标准的范围划分主要是根据软件的任务功能和软件生存期进行比较、判定、评价和确定软件工程标准的范围和内容。任务功能可以表示软件工程过程，可以划分为产品工程功能、验证与确认功能以及技术管理功能3个部分。1).产品工程功能：产品工程功能包括定义、生产和支持最终产品所必须的过程。2).验证和确认功能：验证和确认功能是检查产品质量的活动。3).技术管理功能：技术管理功能是构造和控制产品工程的过程。这3个部分并不集中在单个的软件生存周期里，而是并行进行的生产、检查和控制活动。2.2 软件文档的主要内容系统的目标，就是选用VB 6.0作为开发工具，设计并实现一个能够满足车队运输资源管理的管理信息系统。具体包括以下功能：1).根据日常工作需求，提供必要功能，如：员工、司机、车辆管理维护、托运过程管理维护、维修管理维护、报销申请审核管理等；2).提供强大的查询功能，不同用户可以根据需求，以不同的项目为目标，完成对托运过程信息、司机信息以及报销统计等的查询；3).进行必要的安全考虑，如权限管理、数据库备份恢复等；4).效率高，界面友好，操作方便。软件开发系统的建立与应用可以划分成总体规划、系统开发和系统运行三个阶段，其中系统开发阶段还可进一步分为系统分析、系统设计和系统实施等工作环节。本软件为车队运输单位。该系统由各负责人和员工组成。员工分为业务员和查询员。负责人对系统基本信息的管理和报销审核，员工在前台进行业务管理和业务查询。因此现有系统由管理员（负责人）、普通服务员（业务员）、查询用户（查询员）等组成。本软件具体的操作为当客户要托运某货物时，客户把他的运输托运单传给车队的调度，调度把托运单登记到运输文档，然后填写运输单给车队派车。车队接到运输单后就选择车辆和司机。并填写派车给司机并登记派车单文档。司机完成运输日任务回到车队后，把运输单交于车队存档，并把运输过程中产生的成本填写报销单交于财务处报销。如果在运输中发生车辆有任何问题要在交车的时候就随时填写维修申请交与维修部。在车辆维修好后，维修部填写维修费用申请单交与财务部门报销。货代出对帐单交财务部门审核。审核通过后出费用确认单交财务部门等。针对目前世界上流行的大量软件和开发工具，经过认真分析其优缺点，结合计量器具管理系统的需要和目前的硬件环境，我们选用微软WINDOWS平台下的Visual Basic 6.0（简写为VB6.0）作为软件开发工具。 作为数据库系统的开发，Visual Basic是一个非常理想选择。数据库是MIS中的重要支持技术，在MIS开发过程中，如何选择数据库管理是一个重要的问题，目前，数据库产品较多，每种产品都具有各自的特点和适用范围，因此，在选择数据库时，应考虑数据库应用的特点及适用范围，本系统选用的数据库语言Visual Basic语言，该开发工具具有很多长处：Visual Basic是一种可视化的、面对对象和条用事件驱动方式的结构化高级程序设计，可用于开发Windows环境下的种类应用程序。它简单易学、效率高，且功能强大，可以与Windows的专业开发工具SDK相媲美，而且程序开发人员不必具有C/C+编程基础。在Visual Basic环境下，利用事件驱动的编程机制、新颖易用的可视化设计工具，使用Windows内部的应用程序接口(API)函数，以及动态链接库(DLL)、动态数据交换(DDE)、对象的链接与嵌入(OLE)、开放式数据访问(ODBC)等技术，可以高效、快速地开发出Windows环境下功能强大、图形界面丰富的应用软件系统。 第3章 实 例3.1 概要设计实例一引言1.概要设计编写目的随着计算机的普及和网络技术的发展，我国的运输行业信息化建设很早就已经开始在全国展开部署了。车队管理系统就是其中之一。传统的手写管理由于工作量巨大、存放麻烦、更新困难、不易备份，已随着时代的发展而显的落伍了。这就要我们创造更快更新的管理系统。电子管理以快捷、方便的使用而受到欢迎。车队管理系统是一个运输单位不可缺少的部分,它的内容对于单位的决策者和管理者来说都至关重要,所以车队管理系统应该能够为用户提供充足的信息和快捷的查询手段。但一直以来人们使用传统人工的方式管理文件档案，这种管理方式存在着许多缺点,如:效率低、保密性差,另外时间一长,将产生大量的文件和数据,这对于查找、更新和维护都带来了不少的困难。本系统可以避免单位管理的随意性，使得管理工作规范化、系统化、程序化，提高信息处理的速度和准确性，对于减轻工作人员的劳动量、提高劳动热情和服务质量，具有重要的现实意义。2.概要设计背景本软件包含业务员和查询员。负责人对系统基本信息的管理和报销审核，员工在前台进行业务管理和业务查询。因此现有系统由管理员（负责人）、普通服务员（业务员）、查询用户（查询员）等组成。当客户要托运某货物时，客户把他的运输托运单传给车队的调度，调度把托运单登记到运输文档，然后填写运输单给车队派车。车队接到运输单后就选择车辆和司机。并填写派车给司机并登记派车单文档。司机完成运输日任务回到车队后，把运输单交于车队存档，并把运输过程中产生的成本填写报销单交于财务处报销。如果在运输中发生车辆有任何问题要在交车的时候就随时填写维修申请交与维修部。在车辆维修好后，维修部填写维修费用申请单交与财务部门报销。货代出对帐单交财务部门审核。审核通过后出费用确认单交财务部门等。本文的应用背景为一车队运输单位。该单位由各负责人和员工组成。3.参考资料1.陶宏才.数据库原理及设计.第1版.北京.清华大学出版社.2004年2.范立南SQL Server 2000 实用教程第2版.北京.清华大学出版社.2005年3.张海藩.软件工程概论（第五版）.清华大学出版社二总体设计1.需求规定托运管理模块：（1）输入：托运单信息（2）输出：操作是否成功（3）处理内容：检查输入信息的合法性后，调用数据库添加、修改、删除操作并返回结果信息员工管理模块：（1）输入：员工编号，姓名，民族，身份证号，职务，联系电话，联系地址，Email（2）输出：操作是否成功（3）处理内容：检查输入信息的合法性后，调用数据库添加、修改、删除或者查询操作并返回结果信息。用户管理模块：（1）输入：姓名，密码，权限（2）输出：用户添加/删除操作是否成功（3）处理内容：检查输入信息的合法性后，调用数据库添加、删除操作并返回结果信息。运输调度模块（1）输入：运输单编号，托运单编号，派运车辆编号，派选司机编号，出发日期（2）输出：操作是否成功（3）处理内容：检查输入信息的合法性后，调用数据库修改操作，完成托运的调度操作，修改数据库信息。查询模块（1）输入：无（2）输出：无（3）处理内容：检查输入信息的合法性后，调用数据库查询操作，完成对托运信息、运输信息、员工信息、司机信息、车辆信息、维修信息、报销信息等的查询。用户登录模块（1）输入：用户名、密码。（2）输出：无（3）处理内容：验证用户名和密码的合法性，并根据用户权限，进入不同的主界面。2.运行环境硬件平台：（1）CPU: P 2.6G （2）硬盘：80G（3）内存：256M（4）打印机：可选软件平台：（1）操作系统：Windows XP（2）软件开发环境：Visual Basic6.0（3）数据库管理系统：sqlserver 2000（4）其它辅助软件：Microsoft office 2000, Photoshop7.0等3.基本设计概念和处理流程处理流程图如图3.1所示：图3.14.结构绘制数据流图，先要分析整个车队管理的总体情况，划分系统边界，明确各功能之间的关系。根据对车队管理业务的详细调查和分析，绘制出系统的关联图即系统的最高层数据。其中F1:派车单 F2:运输单 F3:回程单 F4:司机信息 F5:汽车信息 F6:维修单 F7:出库信息 F8:维修费用 F9:运输费用 F10:报销费用。如图3.2所示：图3.2如上图所示，与系统关联的有三个外部项：管理员、普通用户、查询用户。业务员(普通用户)将托运信息输入系统，并对车辆和司机进行调度，同时负责日常的业务管理(包括托运、运输、登记、维修、报销申请等)的操作。查询用户可以向系统查询他所关心的内容，如托运的现在的情况、是否完成等等。系统还应该提供简单的Excel统计报表功能，这些统计信息根据不同的侧重，提交给管理员或者负责人，分别为单位和管理者决策时提供参考。管理员可以对系统用户进行管理，数据库的恢复，和财务审核等。5.功能需求与程序的关系如表3.3所示：托运管理模块员工管理模块用户管理模块运输调度模块查询模块用户登录模块添加删除修改表3.36.尚未解决问题由于该车队未采用自动化管理，工作人员往往对车辆和司机的情况不甚了解，有时为了查找托运单的状态。需要的许多的单据中寻找，非常吃力。而各部门之间信息也不能及时沟通，在工作上也带来了诸多不便。通过分析可以发现，现行系统存在的问题，主要是由于传统的手工操作方法难以满足当前大量业务操作需求而引，起的。另外，传统手工操作方法的低效、易出错以及当前信息难以及时反映等不足，也在一定程度上加剧了当前系统难以满足现实需求的现状。便、可靠性高、存储量大、保密性好、寿命长、成本低等。这些优点能够极大地提高学生学籍管理的效率,也是企业的科学化、正规化管理,与世界接轨的重要条件。 开发这样一套管理软件成为很有必要的事情,这样可以使得车队车辆司机资源管理更加有序和高效。因此，根据车队管理现状，应用一套有效的管理业务软件是迫在眉睫的。使用计算机对车队运输信息进行管理,具有手工管理所无法比拟的优点.例如:检索迅速、查找方三接口设计1.用户接口用户界面：在界面设计上，应做到简单明了，易于操作，并且要注意到界面的布局，应突出的显示重要以及出错信息。外观上也要做到合理化，考虑到用户多对WINDOW 风格较熟悉，应尽量向这一方向靠拢。（1）判断用户名是否为空：Dim txtSql As String UserName = If Trim(txtUserName.Text) = Then MsgBox 请输入帐号！, vbOKOnly + vbExclamation, 警告 txtUserName.SetFocus（2）判断密码是否为空If Trim(txtPassword.Text) = Then MsgBox 请输入密码！, vbOKOnly + vbExclamation, 警告 txtPassword.SetFocus判断是否有这个用户 txtSql = select * from 用户信息表 where 用户名称 = & txtUserName.Text & If Rs.State Then Rs.Close Rs.Open txtSql, CN, adOpenStatic, adLockOptimistic If Rs.EOF = True Then 如果没有这个用户 MsgBox 没有这个帐号，请重新输入帐号!, vbOKOnly + vbExclamation, 警告 txtUserName.Text = txtPassword.Text = txtUserName.SetFocus Else 如果有用户 If Trim(Rs.Fields(1) = Trim(txtPassword.Text) Then2.外部接口本系统设有人机操作界面，考虑到操作简单，易于管理方面，主要硬件接口设备为PC，鼠标，键盘。而软件接口主要以windows平台为基本平台连数据库代码If CN.State Then CN.CloseCN.ConnectionString = Provider=SQLOLEDB.1;Integrated Security=SSPI;Persist Security Info=False;Initial Catalog=cargroupCN.OpenmiCount = 0Ok = FalsetxtUserName.Text = GetSetting(App.Title, Settings, user_name, )Label2.MouseIcon = cmdOK.MouseIconExit SubErr:MsgBox Err.Description, , 数据库连接错误End四运行设计1.运行模块结合1）、登录模块：具有不同权限的管理人员可以通过用户名和密码登录系统，进入主界面。2）、设备查询模块：按操作员输入的编号、姓名能以查询一个至多个药库的库存记录，并可打印存档。 3）、设备录入模块：录入设备信息，输入完成后，将数据存盘。 4）、设备修改模块：对已存档的设备库进行日常管理，如修改、增加、删除等基本操作。 5）、设备统计分析模块：对设备库按部门，姓名升序或降序排列的设备库报表，并给出分析报告。 6）、用户管理模块：赋予高级管理者以增加、删除、修改普通管理员的权限。赋予普通管理员修改密码的权限。2.运行控制FORE_frm窗体(登陆窗体)，输入正确的用户和密码单击确定进入管理系统的主界面，如果用户名或密码错误，给出相应的提示信息，如果连续三次错误，自动退出系统。GLXT_frm(系统管理)，提供物品基本信息的录入、修改、查询等功能。单击填加按钮保存将存入数据库中。查询提供精确和模糊两种查询方法。从下拉列表框中，选择要查询的项目在文本框中输入要查询的关键字单击查询可得到相应的查询结果。模糊查询同上。3.运行时间系统的响应时间小于3秒，实时更新处理，数据转换与传输时间，运行时间很短六系统出错处理设计1.出错信息由于数据在数据库中已经有备份，故在系统出错后可以依靠数据库的恢复功能，并且依靠日志文件使系统再启动，就算系统崩溃用户数据也不会丢失或遭到破坏。但有可能占用更多的数据存储空间，权衡措施由用户来决定。2.补救措施1）数据库连接错误补救措施：这类错误主要是数据库设置不正确，或sql server异常引起的，我们只要取消本次操作，提醒用户检查数据库问题就可。2）输入错误补救措施：这主要是用户输入不规范造成的，我们在尽量减少用户出错的条件的情况下，主要也是通过对话框，提醒用户，然后再次操作。其他操作错误：对于用户的不正当操作，有可能使程序发生错误。我们主要是中止操作，并提醒用户中止的原因和操作的规范。3）其他不可预知的错误补救措施：程序也会有一些我们无法预知或没考虑完全的错误，我们对此不可能作出万全的异常处理，这时我们主要要保证数据的安全，所以要经常的进行数据库备份，并能及时的和我们联系，以逐步的完善我们的程序。3.系统维护设计系统的运行与维护，是软件开发的最后一个环节。系统运行中出现的问题，可以反馈到编码阶段甚至逻辑设计阶段，进行反复的修改运行操作，直至系统完善。而有效的系统维护，可以大大延长软件的声明周期，尽可能提高系统的利用率和所带来的效益。本系统是个较复杂的人-机系统，由于系统外部环境与内部因素的变化，不断影响系统的运行，同时需要系统不断地适应这些变化，不断地完善系统，以提高系统运行的效率与服务水平，这就需要自始至终进行系统的维护工作。系统的维护主要包括四个方面：（1）程序的维护：指的是修改部分或全部程序，这种维护往往是在条件发生变化或原系统的效率低的情况下进行的。（2）数据文件的维护：指的是按照用户的要求对数据文件进行不定期的修改。（3）代码的维护：随着系统的发展和变化，可能会出现旧代码不能适应新要求的问题，因此，有必要变更代码，予以维护。（4）硬件的维护：指的是对系统所使用的设备进行维护。本系统的日常维护由专人来负责，如果出现一些不能解决的问题，则由开发者来负责。 第4章 实训日记一时间：2010年11月 22日 地点：9#-708 实训题目：软件测试文档 指导教师:王彦华实训目的：本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档。实训内容：今天老师布置了实训的内容以及小组情况，分配了实训的题目，并且说明了实训报告的要求以及相关内容。我小组一共4个人。我们所做的题目是车队管理系统，车队管理信息系统主要是提供司机、领导、乘客方便的查询等相关操作，对车辆和司机管理信息能统一规范化。具体要达到以下几点目的：1）确定产品所期望的用户类别。2）获取每个用户类的需求。3）了解实际用户任务和目标以及这些任务所支持的业务需求。4）分析源于用户的信息以区别用户任务需求、功能需求、业务规则、质量属性、建议解决方法和附加信息。二时间:2010年11月29日 地点：9#-708 实训题目：软件测试文档 指导教师:王彦华实训目的：本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档。实训内容：功能块的相应操作分别由其对应的子模块实现。通过互联网把整个车队的信息汇聚起来，为车队管理部门提供全面及时的车辆和司机信息，方便管理，同时亦可通过互联网扩展各类信息化应用，共享车队信息。车队可通过一个简化的车队管理信息系统，使车队管理信息工作系统化，规范化，自动化，从而达到提高车队管理信息效率的目的。具体要达到以下几点目的：1）将系统级的需求分为几个子系统，并将需求中的一部份分配给软件组件；2）了解相关质量属性的重要性。3）商讨实施优先级的划分。4）将所收集的用户需求编写成文档和模型。第5章 实训总结经过将近半个月的设计和研究，我们小组集体设计的车队管理系统已经设计完毕。其功能基本符合用户需求，能够完成车队的基本功能。并提供部分系统维护功能,对于数据的一致性的问题也通过程序进行了有效的解决。但是由于毕业设计时间较短，所以该系统还有许多不尽如人意的地方，比如联机文档比较少，用户界面不够美观，出错处理不够等多方面问题。这些都有待进一步改善。总的来说，在这次课设中我们遇到了很多问题，经过我们集体的努力大部分问题都得到解决，只有少部分遗留的问题。从中我们也吸取了很多经验教训，对所学的专业知识也得到了充分利用，在今后的发展中这都会成为我们的一种宝贵财富。首先是开始基础没有打好，匆忙之中就定了个题目，刚开始接触