软件文档写作实训报告(马林)物流车队(共21页).doc

《软件文档写作实训报告(马林)物流车队(共21页).doc》由会员分享，可在线阅读，更多相关《软件文档写作实训报告(马林)物流车队(共21页).doc（21页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、精选优质文档-倾情为你奉上辽 宁 工 业 大 学 软件文档写作 实训报告题目： 物流车队管理系统软件文档 院（系）: 软件学院 专业班级： 软件技术081 学 号： 学生姓名： 安凯辰 指导教师： 王彦华 教师职称： 助 教 起止时间： 2010.11.22-2010.12.6 实训任务及评语院（系）：软件学院 教研室：软件教研室学 号学生姓名安凯辰专业班级软件技术081实训题目 物流车队管理系统软件文档实训任务实训任务及要求：1、 了解软件开发周期各阶段的文档。2、 掌握各文档阐述的内容及作用。3、 了解文档所采用的国际、国家等相关标准。4、 了解各文档所涉及的软件知识。5、 掌握各文档采用

2、的描述工具。6、 具体编写出2个主要的软件文档。实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。几个人为一组完成一个相对完整的软件系统开发文档，组内成员编写的文档不能重复，文档要严格按照所采用的标准编写，图表布局要合理规范。指导教师评语及成绩成绩： 指导教师签字： 年 月 日专心-专注-专业目 录第1章 实训目的与要求1.1 实训目的 本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。1、了解软件开发周期各阶段的文档。2、掌握各文档阐述的内容及

3、作用。3、了解文档所采用的国际、国家等相关标准。4、了解各文档所涉及的软件知识。5、掌握各文档采用的描述工具。6、具体编写出2个主要的软件文件。 1.2 实训的实验环境学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。1.3 实训的预备知识 要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。1.4 实训要求实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。 第2章 软件文档及其组成2.1软件文档的作用及分类(1)软件文档的作用 在软件的生产过程中，

4、总是伴随着大量的信息要记录、要使用。因此，软件文档在产品的开发生产过程中起着重要的作用。 1).提高软件开发过程的能见度。把开发过程中发生的事件以某种可阅读的形式记录在文档中。管理人员可把这些记载下来的材料作为检查软件开发进度和开发质量的依据，实现对软件开发的工程管理。2)提高开发效率。软件文档的编制，使得开发人员对各个阶段的工作都进行周密思考、全盘权衡、从而减少返工。并且可在开发早期发现错误和不一致性，便于及时加以纠正。3)作为开发人员在一定阶段的工作成果和结束标志。 4)记录开发过程中的有关信息，便于协调以后的软件、开发、使用和维护。 5)提供对软件的运行、维护和培训的有关信息，便于管理人

5、员、开发人员、操作人员、用户之间的协作、交流和了解。使软件开发活动更科学、更有成效。 6)便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需要的软件提供依据。 文档在各类人员、计算机之间的多种桥梁作用中看出： 既然软件已经从手工艺人的开发方式发展到工业化的生产方式，文档在开发过程中就起到关键作用。从某种意义上来说，文档是软件开发 规范的体现和指南。按规范要求生成一整套文档的过程，就是按照软件开发规范完成一个软件开发的过程。所以，在使用工程化的原理和方法来指导软件的开发和维护时，应当充分注意软件文档的编制和管理。(2)文档的分类 软件文档从形式上来看，大致可分为两类： 一类是开发过

6、程中填写的各种图表，可称之为工作表格；另一类是应编制的技术资料或技术管理资料，可称之为文档或文件。 软件文档的编制，可以用自然语言，特别设计的形式语言，介于两者之间的半形式语言(结构化语言)，各类图形表示。表格来编制文档。文档可以书写，也可以在计算机支持系统中产生，但它必须是可阅读的。 按照文档产生和使用的范围，软件文档大致可分为三类： 1)开发文档：这类文档是在软件开发过程中，作为软件开发人员前一阶段工作成果的体现和后一阶段工作依据的文档。包括软件需求说明书、数据要求说明书、概要设计说明书、详细设计说明书、可行性研究报告、项目开发计划。 2)管理文档：这类文档是在软件开发过程中，由软件开发人

7、员制定的需提交人员的一些工作计划或工作报告。使管理人员能够通过这些文档了解软件开发项目安排、进度、资源使用和成果等。包括项目开发计划、测试计划、测试报告、开发进度月报及项目开发总结。 3)用户文档：这类文档是软件开发人员为用户准备的有关该软件使用、操作、维护的资料。包括用户手册、操作手册、维护修改建议、软件需求说明书。2.2软件文档所采用的标准软件文档采用软件工程标准化。参照其它工程领域对工程标准划分的方法，软件工程标准主要有两种划分方法：按标准的类型划分和按标准的范围划分。按标准的类型划分：主要有过程标准、产品标准、行业标准、记法标准等。1)过程标准:过程标准与开发一个产品或从事一项服务的一

8、系列活动或操作有关。过程标准使用一组方法、工具和技术，给出“谁来做”、“做什么”、“如何做”、“何时做”、“何地做”及在软件工程活动中进行的不同层次工作的过程模型。（方法、技术和度量。2)产品标准:产品标准则涉及软件工程事务的格式和内容。软件开发和维护活动文档化的结果就是软件产品，软件文档是软件工程活动进一步开展的基础。（需求、设计、部件、描述、计划、报告 ）。3)行业标准：软件开发作为一种行业，其行业标准涉及软件工程的所有方面，如职业认证、职业培训、产品许可等。行业标准可以等同于行业行为规范。（职别、道德准则、认证、特许、课程 ）。4)记法标准：记法标准规定了在软件工程行业范围内，以唯一的方

9、式进行交流的方法，如术语、表示法、语言等。它其实是一种语境规范。（术语、表示法、语言 ）。按标准的范围划分主要是根据软件的任务功能和软件生存期进行比较、判定、评价和确定软件工程标准的范围和内容。任务功能可以表示软件工程过程，可以划分为产品工程功能、验证与确认功能以及技术管理功能3个部分。1)产品工程功能：产品工程功能包括定义、生产和支持最终产品所必须的过程。2)验证和确认功能：验证和确认功能是检查产品质量的活动。3)技术管理功能：技术管理功能是构造和控制产品工程的过程。这3个部分并不集中在单个的软件生存周期里，而是并行进行的生产、检查和控制活动。2.3 软件文档的主要内容系统的目标，就是选用V

10、B 6.0作为开发工具，设计并实现一个能够满足车队运输资源管理的管理信息系统。具体包括以下功能：1)根据日常工作需求，提供必要功能，如：员工、司机、车辆管理维护、托运过程管理维护、维修管理维护、报销申请审核管理等；2)提供强大的查询功能，不同用户可以根据需求，以不同的项目为目标，完成对托运过程信息、司机信息以及报销统计等的查询；3)进行必要的安全考虑，如权限管理、数据库备份恢复等；4)效率高，界面友好，操作方便。软件开发系统的建立与应用可以划分成总体规划、系统开发和系统运行三个阶段，其中系统开发阶段还可进一步分为系统分析、系统设计和系统实施等工作环节。本软件为车队运输单位。该系统由各负责人和员

11、工组成。员工分为业务员和查询员。负责人对系统基本信息的管理和报销审核，员工在前台进行业务管理和业务查询。因此现有系统由管理员（负责人）、普通服务员（业务员）、查询用户（查询员）等组成。本软件具体的操作为当客户要托运某货物时，客户把他的运输托运单传给车队的调度，调度把托运单登记到运输文档，然后填写运输单给车队派车。车队接到运输单后选择车辆和司机。并填写派车给司机并登记派车单文档。司机完成运输日任务回到车队后，把运输单交于车队存档，并把运输过程中产生的成本填写报销单交于财务处报销。如果在运输中发生车辆有任何问题要在交车的时候就随时填写维修申请交与维修部。在车辆维修好后，维修部填写维修费用申请单交与

12、财务部门报销。货代出对帐单交财务部门审核。审核通过后出费用确认单交财务部门等。其基本思想是把整个系统开发过程分成若干个阶段，每个阶段进行若干活动，每项活动应用一系列标准、规范、方法和技术，完成一个或多个任务，形成符合给定规范的产品。采用结构化生命周期法开发管理信息系统时，应遵循的主要原则：(1)用户参与的原则，就是在开发前，了解用户的需求，开发过程中，参考用户对于需求的变化。因此，我需要对杭州的一些车队进行实地的了解，并通过电话的方式，询问一些司机的意见.(2)“先逻辑后物理”的原则，先整理好系统的构架，有一个模型，然后，按照设想的构架去开发系统。其具体开发步骤可分为以下四步：系统规划，系统开

13、发（包括系统分析，系统设计，系统实施），系统的运行及维护，系统评价 。 第3章 实 例3.1 测试分析实例一引言1测试分析编写目的：这份测试计划报告书是为了测试本系统是否可行，当输入车辆信息时测试其信息能不能完整的保存在数据库中以备日后查询用。当输入的数据不符合要求时看系统能不能给出提示。价格信息修改后看修改后的信息能不能被系统接受并保存在数据库中。测试的目的就是为了能以最少的人力和是发现潜在的各种错误和缺陷。系统测试是保证系统质量和可靠性的关键步骤，是对系统开开过程的系统分析，系统设计和实施的最后检查。测试程序的执行过程，目的在于发现错误；一个好的测试用例在于能发现至今未发现的错误；设计测试

14、的目标是想以最少的时间和人力系统地找出软件中潜在的各种错误和缺陷。如果我们成功地实施了测试，就能够发现软件中的错误。测试的附带收获是他能够证明软件的功能和性能与需求说明相符合。此外，实施测试收集到的测试结果数据为可靠性分析提供了依据。测试不能表明软件中不存在错误，它只能说明软件中存在错误。2测试分析背景被测试软件系统的名称；车队管理系统该软件的任务提出者：车队管理人员开发者：辽宁工业大学软件学院电子商务081班第 小组用户：中小型车队用户安装此软件的计算中心：CPU：pIV 2.6G 硬盘：80G内存：256M打印机：可选操作系统：windows XP软件开发环境：Visual Basic6.

15、0、sqlserver 2000其它辅助软件：Microsoft office 2000, Photoshop7.0等测试环境：与实际运行环境 之间可能存在的差异以及这些差异对测试结果的影响。3定义：SQL SERVER：系统服务器所使用的数据库管理系统（DBMS）。SQL：一种用于访问查询数据库的语言。主键：数据库表中的关键域。值互不相同。外部主键：数据库表中与其他表主键关联的域。4参考资料梁冰，陈丹丹，苏宇，SQL语言参考大全。人民电邮出版社，2008陶红才编。数据库原理及设计。人民电邮出版社，2007Watts S.Humphrey。软件工程规范。清华大学出版社，2006张立科,数据库开

16、发技术与工程实践,人民邮电出版社,2004张红军, 王虹 等 Visual basic 6.0 中文版高级应用与开发指南, 人民邮电出版社, 2002姚巍，Visual Basic数据库开发及工程实例，人民邮电出版社二测试概要： 1系统登陆测试用例：功能特性：正确验证系统角色用户，正常进入系统进行操作测试目的：对输入的用户名、密码、验证码进行合法性检查。预置条件：注册用户名:admina密码：admina角色：超级管理员组参考信息：用户名区分大小写,用户名长度为：6 18个字符，密码长度为大于6个数字，如表3.1表3.1用例说明输入数据预期结果实际结果测试结果不输入信息输入为空, 其它为预置条

17、件提示请输入用户名和密码或用户名密码无效用户名密码无效正确随便输入一个用户名和密码户名:aa4557密码： 提示请输入用户名和密码或用户名密码无效用户名密码无效正确只输入用户名用户名: admina它为预置条件输入密码无效输入密码无效正确只输入密码密码它为预置条件输入用户名无效输入用户名或密码无效错误输入用户名和密码用户名:admina, 密码：admina其它为预置条件验证码无效输入的验证码无效正确输入用户名和密码和随便的验证码用户名:admina, 密码：admina验证码：4586验证码无效输入的验证码无效正确输入用户名和密码和正确的验证码用户名:admina, 密码：admina验证码

18、：系统随机生成登录成功登录成功正确2管理员测试用例：功能特性：正确录入车队、车辆及司机，正常进行查看修改删除操作测试目的：查找错误，保证系统正常运行。预置条件：注册用户名:hschsc密码：角色：运输管理员参考信息：如表3.2表3.2用例说明输入数据预测结果实际结果测试结果不输入信息车队注册号输入为空, 其它为预置条件提示请输入车队注册号，数据录入不成功提示请输入车队注册号正确随便输入一个车队注册号车队号: aa4557提示请确保车队注册号正确车队注册号无效正确随便输入一个车队注册号车队号: 4557提示该注册号的车队已存在提示违反了唯一约束正确只输入一个车队注册号车队号: 4660它为预置条

19、件提示其他输入数据不能为空其他输入数据不能为空正确只输入车队名车队名：长江它为预置条件提示其他输入数据不能为空其他输入数据不能为空正确输入车队号、车队名车队号: 4660车队名：长江提示所属地区、备注不能为空所属地区不能为空错误输入车队号、车队名、所属地区车队号: 4660车队名：长江所在地区：江苏提示备注不能为空所属地区、备注不能为空错误输入全部输入数据(区分数据类型)车队号: 4660车队名：长江所在地区：江苏备注：大车队添加成功添加成功正确三.测试结果及发现1测试1（系统登陆测试）在此测试过程中，必需输入正确的用户名和密码才能进入系统，和预期要求一致。2测试2（管理员测试）1)管理员输入

20、车队信息成功，如图3.1图3.12)管理员提交车队信息 成功 如图3.2图3.23)管理员查询车队信息列表，选择需要更新的具体车队信息 成功 如图3.3 图3.34)管理员修改车队信息成功 如图3.4图3.45)管理员输入查询条件 ，不存在此功能6)管理员选择要删除的车队信息，删除车队信息 成功 如图3.5图3.57)管理员输入车辆信息成功 如图3.6图3.68)管理员提交车辆信息成功 如图3.7图3.79)管理员查询车辆信息列表，选择需要更新的具体车辆信息成功 如图3.8图3.810)管理员修改车辆信息，提交更新信息成功 如图3.9 图3.911)管理员输入查询条件 不存在此功能12)管理员

21、选择要删除的车辆信息，删除车辆信息成功 如图3.10 图3.1013)管理员输入驾驶员信息成功 如图3.11 图3.1114)管理员提交驾驶员信息成功 如图3.12 图3.1215)管理员查询驾驶员信息成功 如图3.13 图3.1316)管理员修改驾驶员信息，提交驾驶员信息成功。如图3.14 图3.1417)管理员输入查询条件 不存在此功能。四.对软件功能的结论 1功能1（系统登陆测试）1)能力:输入用户名和密码都正确，看是否能添加，更改，删除信息。如用户名和密码输入不正确，会出现什么情况，是否也能添加，更改，删除信息。2)限制: 如果输入的用户名过长，会出现错误，导致程序关闭。2. 功能2(

22、管理员测试)分析管理员是否有输入，提交信息，查询车队信息列表，更新具体信息等权限。如输入不符合要求会出现“不存在此功能”。 五分析摘要1能力：限制：目前我们的使用范围还比较狭窄，且本软件是我们的初次版本，如果该软件提高版本，本软件需要大量的修改和更新缺陷和限制。2建议： 1) 在项目开始的时候应该定制编码标准，数据库标准，需求变更标准，开发和测试人员都严格按照标准进行，可以在后期减少因为开发，测试不一致而导致的问题，同时也可以降低沟通成本。2)发布版本的时候，正确布置测测试环境。3)建议开发多种版本，方便管理。4)将所有索引设置为使用INDX表空间，减少资源争抢。3.评价：在注册用户，对输入数

23、据不符合以及错误的格式输入都能做出测试，对车辆信息进行调整时，对输入的不符合数据以及错误格式能做出测试，增加车辆信息时也能做出正常的测试，但是当输入的数据过大或者字符长度过长时，可能会使程序发生中断而停止执行，基本达到目标，可以交付使用。六测试资源消耗总结测试工作的资源消耗数据，如工作人员的水平级别数量、机时消耗等。测试时间：2010年11月22日至2010年12月6日测试人力：1人*5+1人*5+1人*5=15人天硬件资源：服务器：PC 3台 客户端：PC 2台 第4章 实训日记一时间：2010年11月 22日 地点：9#-708 实训题目：软件测试文档 指导教师:王彦华实训目的：本实训要求

24、学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档。实训内容：今天老师布置了实训的内容以及小组情况，分配了实训的题目，并且说明了实训报告的要求以及相关内容。我小组一共3个人。我们所做的题目是车队管理系统，车队管理信息系统主要是提供司机、领导、乘客方便的查询等相关操作，对车辆和司机管理信息能统一规范化。具体要达到以下几点目的：1）确定产品所期望的用户类别。2）获取每个用户类的需求。3）了解实际用户任务和目标以及这些任务所支持的业务需求。4）分析源于用户的信息以区别用户任务需求、功能需求、业务规则、质量属性、建议解决方法和附加信息。二时间:2010年1

25、1月22日 地点：9#-708 实训题目：软件测试文档 指导教师: 王彦华实训目的：本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档。实训内容：功能块的相应操作分别由其对应的子模块实现。通过互联网把整个车队的信息汇聚起来，为车队管理部门提供全面及时的车辆和司机信息，方便管理，同时亦可通过互联网扩展各类信息化应用，共享车队信息。车队可通过一个简化的车队管理信息系统，使车队管理信息工作系统化，规范化，自动化，从而达到提高车队管理信息效率的目的。具体要达到以下几点目的：1）将系统级的需求分为几个子系统，并将需求中的一部份分配给软件组件；2）了

26、解相关质量属性的重要性。3）商讨实施优先级的划分。4）将所收集的用户需求编写成文档和模型。第5章 实训总结经过将近半个月的设计和研究，我们小组集体设计的物流车队管理系统已经设计完毕。其功能基本符合用户需求，能够完成车队的基本功能。并提供部分系统维护功能,对于数据的一致性的问题也通过程序进行了有效的解决。但是由于毕业设计时间较短，所以该系统还有许多不尽如人意的地方，比如联机文档比较少，用户界面不够美观，出错处理不够等多方面问题。这些都有待进一步改善。总的来说，在这次课设中我们遇到了很多问题，经过我们集体的努力大部分问题都得到解决，只有少部分遗留的问题。从中我们也吸取了很多经验教训，对所学的专业知

27、识也得到了充分利用，在今后的发展中这都会成为我们的一种宝贵财富。首先是开始基础没有打好，匆忙之中就定了个题目，刚开始接触设计程序特别盲目，也不知从何处入手，对于车队信息管理系统，我们也没机会亲身去考察，我们只能在网上找些客观资料来了解它。其次就是软件的问题，只能在机房操作课设系统，在VB为前台，SQL为后台的要求上，让我们非常困惑，自己的电脑都没安装SQL，此软件非常难安，我们就只能在寝室做下前台VB的设计，再去机房做下SQL的后台设计，以及各种程序中所需要解释，说明的截图等。最后就是调程序的问题，实在是给我们出了个大难题，面对偌大的一个程序，从中排错选优，对我们这些初学者的确是一件难事。刚开

28、始我们小心翼翼的调试，有时调了一上午程序的运行界面还是跑不出来，偶尔也会产生抱怨和不耐烦的情绪。总之在我们集体努力的情况下，我们克服了一切困难，才完成这次课设。课设结束了，我们从中学到了很多平时学不到的知识。首先要感谢我们的指导老师，没有她悉心的关怀，和孜孜不倦的教导，我们是做不出如此成功的程序的。再次就要感谢我的伙伴们，我们能在这么炎热的夏天，禁住闷热的天气，集体完成这项课设，你们的精神就是我们完成课设的动力。参考文献1黄剀涛 .Visual Basic 6.0中文版高级应用与开发指南.北京大学出版社，2006年:31-35页2. 孙春来， 韩正清.SQL Server中文版编程基础与范例.

29、电子工业出版社，2008年：195-239页3. 知寒工作室.SQL Server 2000简明案例教程.机械工业出版社 ，2007年：619页4. 徐建平，赵永.SQL Server 2000基础教程.机械工业出版社出版日期，2006年：51-69页5. 张鲁.Visual Basic编程技巧与实例分析.水利水电出版社，2004年：284-296页6. 张磊.Visual Basic 6.0使用详解.械工业出版社，2006年：196页7. 康耀红，黄健青.SQL Server 2000数据库设计.京大学出版社：2008年：156-189页8.郑刚.SQL Server 2000实效编程百例.人民邮电出版社，2009年：189页9. 李加福.SQL Server 2000中文版入门与提高.清华大学出版社，2004年：146-189页10. 陈明.SQL Server 2000 程序设计.清华大学出版社，2006年：179页11. 刘鹏，李冬梅，高燕.Visual Basic 6.0全攻略宝典.水利水电出版社，2005年：123页12. 章立民.SQL Server 2000中文版程序设计-基础加强篇.中国铁道出版社，2009年：154页13. 郑阿奇.Visual Basic 6.0实用教程. 电子工业出版社，2007年：125-189页