软件文档写作实训-(20).doc

辽 宁 工 业 大 学 软件文档写作 实训报告题目： 车队管理系统软件文档 院（系）: 软件学院 专业班级： 软件工程 教师职称： 副教授 起止时间： 2012.11.26-2012.12.02 实训任务及评语院（系）：软件学院 教研室：软件教研室学 号实训题目 车队管理系统软件文档实训任务实训任务及要求：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 概要设计实例63.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软件文档的作用及分类1.软件文档的作用 在软件的生产过程中，总是伴随着大量的信息要记录、要使用。因此，软件文档在产品的开发生产过程中起着重要的作用。1)提高软件开发过程的能见度。把开发过程中发生的事件以某种可阅读的形式记录在文档中。管理人员可把这些记载下来的材料作为检查软件开发进度和开发质量的依据，实现对软件开发的工程管理。2)提高开发效率。软件文档的编制，使得开发人员对各个阶段的工作都进行周密思考、全盘权衡、从而减少返工。并且可在开发早期发现错误和不一致性，便于及时加以纠正。3)作为开发人员在一定阶段的工作成果和结束标志。 4)记录开发过程中的有关信息，便于协调以后的软件、开发、使用和维护。 5)提供对软件的运行、维护和培训的有关信息，便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解。使软件开发活动更科学、更有成效。 6)便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需要的软件提供依据。 文档在各类人员、计算机之间的多种桥梁作用中看出： 既然软件已经从手工艺人的开发方式发展到工业化的生产方式，文档在开发过程中就起到关键作用。从某种意义上来说，文档是软件开发规范的体现和指南。按规范要求生成一整套文档的过程，就是按照软件开发规范完成一个软件开发的过程。所以，在使用工程化的原理和方法来指导软件的开发和维护时，应当充分注意软件文档的编制和管理。2.文档的分类软件文档从形式上来看，大致可分为两类：一类是开发过程中填写的各种图表，可称之为工作表格；另一类是应编制的技术资料或技术管理资料，可称之为文档或文件。软件文档的编制，可以用自然语言，特别设计的形式语言，介于两者之间的半形式语言(结构化语言)，各类图形表示。表格来编制文档。文档可以书写，也可以在计算机支持系统中产生，但它必须是可阅读的。按照文档产生和使用的范围，软件文档大致可分为三类： 1)开发文档：这类文档是在软件开发过程中，作为软件开发人员前一阶段工作成果的体现和后一阶段工作依据的文档。包括软件需求说明书、数据要求说明书、概要设计说明书、详细设计说明书、可行性研究报告、项目开发计划。2)管理文档：这类文档是在软件开发过程中，由软件开发人员制定的需提交人员的一砦工作计划或工作报告。使管理人员能够通过这些文档了解软件开发项目安排、进度、资源使用和成果等。包括项目开发计划、测试计划、测试报告、开发进度月报及项目开发总结。3)用户文档：这类文档是软件开发人员为用户准备的有关该软件使用、操作、维护的资料。包括用户手册、操作手册、维护修改建议、软件需求说明书。2.2软件文档所采用的标准软件文档采用软件工程标准化。参照其它工程领域对工程标准划分的方法，软件工程标准主要有两种划分方法：按标准的类型划分和按标准的范围划分。按标准的类型划分：主要有过程标准、产品标准、行业标准、记法标准等。1)过程标准:过程标准与开发一个产品或从事一项服务的一系列活动或操作有关。过程标准使用一组方法、工具和技术，给出“谁来做”、“做什么”、“如何做”、“何时做”、“何地做”及在软件工程活动中进行的不同层次工作的过程模型。（方法、技术和度量）。2)产品标准:产品标准则涉及软件工程事务的格式和内容。软件开发和维护活动文档化的结果就是软件产品，软件文档是软件工程活动进一步开展的基础。（需求、设计、部件、描述、计划、报告 ）。3)行业标准：软件开发作为一种行业，其行业标准涉及软件工程的所有方面，如职业认证、职业培训、产品许可等。行业标准可以等同于行业行为规范。（职别、道德准则、认证、特许、课程 ）。4)记法标准：记法标准规定了在软件工程行业范围内，以唯一的方式进行交流的方法，如术语、表示法、语言等。它其实是一种语境规范。（术语、表示法、语言 ）。按标准的范围划分主要是根据软件的任务功能和软件生存期进行比较、判定、评价和确定软件工程标准的范围和内容。任务功能可以表示软件工程过程，可以划分为产品工程功能、验证与确认功能以及技术管理功能3个部分。1)产品工程功能：产品工程功能包括定义、生产和支持最终产品所必须的过程。2)验证和确认功能：验证和确认功能是检查产品质量的活动。3)技术管理功能：技术管理功能是构造和控制产品工程的过程。这3个部分并不集中在单个的软件生存周期里，而是并行进行的生产、检查和控制活动。2.2 软件文档的主要内容下面给出软件文档主要类型的大纲，这个大纲不是详尽的或最后的，但适合作为主要类型软件文档的检验表。而管理者应规定何时定义他们的标准文档类型。软件文档归入如下三种类别： a) 开发文档描述开发过程本身； b) 产品文档描述开发过程的产物； c) 管理文档记录项目管理的信息。 1、开发文档: 开发文档是描述软件开发过程，包括软件需求、软件设计、软件测试、保证软件质量的一类文档，开发文档也包括软件的详细技术描述（程序逻辑、程序间相互关系、数据格式和存储等）。 开发文档起到如下五种作用：a) 它们是软件开发过程中包含的所有阶段之间的通信工具，它们记录生成软件需求、设计、编码和测试的详细规定和说明；b) 它们描述开发小组的职责。通过规定软件、主题事项、文档编制、质量保证人员以及包含在开发过程中任何其他事项的角色来定义做直截了当、如何做和何时做； c) 它们用作检验点而允许管理者评定开发进度。如果开发文档丢失、不完整或过时，管理者将失去跟踪和控制软件项目的一个重要工具；d) 它们形成了维护人员所要求的基本的软件支持文档。而这些支持文档可作为产品文档的一部分； e) 它们记录软件开发的历史。基本的开发文档是： 可行性研究和项目任务书； 需求规格说明； 功能规格说明； 设计规格说明，包括程序和数据规格说明； 开发计划； 软件集成和测试计划； 质量保证计划、标准、进度； 安全和测试信息。2、产品文档: 产品文档规定关于软件产品的使用、维护、增强、转换和传输的信息。产品的文档起到如下三种作用：a) 为使用和运行软件产品的任何人规定培训和参考信息；b) 使得那些未参加开发本软件的程序员维护它； c) 促进软件产品的市场流通或提高可接受性。产品文档用于下列类型的读者： 用户 他们利用软件输入数据、检索信息和解决问题；运行者 他们在计算机系统上运行软件； 维护人员 他们维护、增强或变更软件。产品文档包括如下内容： 用于管理者的指南和资料，他们监督软件的使用； 宣传资料 通告软件产品的可用性并详细说明它的功能、运行环境等； 一般信息 对任何有兴趣的人描述软件产品。 基本的产品文档包括： 培训手册； 参考手册和用户指南；软件支持手册； 产品手册和信息广告。 3、 管理文档 这种文档建立在项目管理信息的基础上，诸如： 开发过程的每个阶段的进度和进度变更的记录；软件变更情况的记录；相对于开发的判定记录；职责定义。 这种文档从管理的角度规定涉及软件生存的信息。第3章 实 例3.1 概要设计实例3.1.1引言1.概要设计编写目的随着计算机的普及和网络技术的发展，我国的运输行业信息化建设很早就已经开始在全国展开部署了。车队管理系统就是其中之一。传统的手写管理由于工作量巨大、存放麻烦、更新困难、不易备份，已随着时代的发展而显的落伍了。这就要我们创造更快更新的管理系统。电子管理以快捷、方便的使用而受到欢迎。车队管理系统是一个运输单位不可缺少的部分,它的内容对于单位的决策者和管理者来说都至关重要,所以车队管理系统应该能够为用户提供充足的信息和快捷的查询手段。但一直以来人们使用传统人工的方式管理文件档案，这种管理方式存在着许多缺点,如:效率低、保密性差,另外时间一长,将产生大量的文件和数据,这对于查找、更新和维护都带来了不少的困难。本系统可以避免单位管理的随意性，使得管理工作规范化、系统化、程序化，提高信息处理的速度和准确性。 2.概要设计背景本软件包含业务员和查询员。负责人对系统基本信息的管理和报销审核，员工在前台进行业务管理和业务查询。因此现有系统由管理员（负责人）、普通服务员（业务员）、查询用户（查询员）等组成。当客户要托运某货物时，客户把他的运输托运单传给车队的调度，调度把托运单登记到运输文档，然后填写运输单给车队派车。车队接到运输单后就选择车辆和司机。并填写派车给司机并登记派车单文档。司机完成运输日任务回到车队后，把运输单交于车队存档，并把运输过程中产生的成本填写报销单交于财务处报销。如果在运输中发生车辆有任何问题要在交车的时候就随时填写维修申请交与维修部。在车辆维修好后，维修部填写维修费用申请单交与财务部门报销。货代出对帐单交财务部门审核。审核通过后出费用确认单交财务部门等。本文的应用背景为一车队运输单位。该单位由各负责人和员工组成。3.1.2 总体设计1.需求规定(1)托运管理模块：1)输入：托运单信息2)输出：操作是否成功3)处理内容：检查输入信息的合法性后，调用数据库添加、修改、删除操作并返回结果信息(2)员工管理模块：1)输入：员工编号，姓名，民族，身份证号，职务，联系电话，联系地址，Email2)输出：操作是否成功3)处理内容：检查输入信息的合法性后，调用数据库添加、修改、删除或者查询操作并返回结果信息。(3)用户管理模块：1)输入：姓名，密码，权限2)输出：用户添加/删除操作是否成功3)处理内容：检查输入信息的合法性后，调用数据库添加、删除操作并返回结果信息。(4)运输调度模块1)输入：运输单编号，托运单编号，派运车辆编号，派选司机编号，出发日期2)输出：操作是否成功3)处理内容：检查输入信息的合法性后，调用数据库修改操作，完成托运的调度操作，修改数据库信息。(5)查询模块1)输入：无2)输出：无3)处理内容：检查输入信息的合法性后，调用数据库查询操作，完成对托运信息、运输信息、员工信息、司机信息、车辆信息、维修信息、报销信息等的查询。(6)登录模块1)输入：用户名、密码。2)输出：无3)处理内容：验证用户名和密码的合法性，并根据用户权限，进入不同的主界面。2.运行环境硬件平台：(1)CPU: P 2.6G (2)硬盘：80G(3)内存：256M(4)打印机：可选(5)光驱：24速以上软件平台：(1)操作系统：Windows XP(2)软件开发环境：Visual Basic6.0(3)数据库管理系统：sqlserver 2000(4)其它辅助软件：Microsoft office 2000, Photoshop7.0等3.1.3运行设计1.运行模块结合1)登录模块：具有不同权限的管理人员可以通过用户名和密码登录系统，进入主界面。2)设备查询模块：按操作员输入的编号、姓名能以查询一个至多个药库的库存记录，并可打印存档。 3)设备录入模块：录入设备信息，输入完成后，将数据存盘。 4)设备修改模块：对已存档的设备库进行日常管理，如修改、增加、删除等基本操作。 5)设备统计分析模块：对设备库按部门，姓名升序或降序排列的设备库报表，并给出分析报告。 6)用户管理模块：赋予高级管理者以增加、删除、修改普通管理员的权限。赋予普通管理员修改密码的权限。2.运行控制FORE_frm窗体(登陆窗体)，输入正确的用户和密码单击确定进入管理系统的主界面，如果用户名或密码错误，给出相应的提示信息，如果连续三次错误，自动退出系统。GLXT_frm(系统管理)，提供物品基本信息的录入、修改、查询等功能。单击填加按钮保存将存入数据库中。查询提供精确和模糊两种查询方法。从下拉列表框中，选择要查询的项目在文本框中输入要查询的关键字单击查询可得到相应的查询结果。模糊查询同上。3.运行时间系统的响应时间小于3秒，实时更新处理，数据转换与传输时间，运行时间很短。 3.2测试分析实例3.2.1 引言1测试分析编写目的：这份测试计划报告书是为了测试本系统是否可行，当输入车辆信息时测试其信息能不能完整的保存在数据库中以备日后查询用。当输入的数据不符合要求时看系统能不能给出提示。价格信息修改后看修改后的信息能不能被系统接受并保存在数据库中。测试的目的就是为了能以最少的人力和是发现潜在的各种错误和缺陷。系统测试是保证系统质量和可靠性的关键步骤，是对系统开开过程的系统分析，系统设计和实施的最后检查。测试程序的执行过程，目的在于发现错误；一个好的测试用例在于能发现至今未发现的错误；设计测试的目标是想以最少的时间和人力系统地找出软件中潜在的各种错误和缺陷。如果我们成功地实施了测试，就能够发现软件中的错误。测试的附带收获是他能够证明软件的功能和性能与需求说明相符合。此外，实施测试收集到的测试结果数据为可靠性分析提供了依据。测试不能表明软件中不存在错误，它只能说明软件中存在错误。2测试分析背景被测试软件系统的名称；车队管理系统该软件的任务提出者：车队管理人员开发者：辽宁工业大学软件学院电子商务081班第 小组用户：中小型车队用户安装此软件的计算中心：CPU：pIV 2.6G 硬盘：80G内存：256M打印机：可选操作系统：windows XP软件开发环境：Visual Basic6.0、sqlserver 2000其它辅助软件：Microsoft office 2000, Photoshop7.0等测试环境：与实际运行环境 之间可能存在的差异以及这些差异对测试结果的影响。3定义：SQL SERVER：系统服务器所使用的数据库管理系统（DBMS）。SQL：一种用于访问查询数据库的语言。主键：数据库表中的关键域。值互不相同。外部主键：数据库表中与其他表主键关联的域。3.2.2测试结果及发现1测试1（系统登陆测试）在此测试过程中，必需输入正确的用户名和密码才能进入系统，和预期要求一致。2测试2（管理员测试）1)管理员输入车队信息成功，如图3.1：图3.12)管理员查询车队信息列表，选择需要更新的具体车队信息 成功 如图3.2： 图3.23)管理员选择要删除的车队信息，删除车队信息 成功 如图3.3：图3.34)管理员查询车辆信息列表，选择需要更新的具体车辆信息成功 如图3.4图3.410)管理员修改车辆信息，提交更新信息成功 如图3.5图3.53.2.3对软件功能的结论1功能1（系统登陆测试）1)能力:输入用户名和密码都正确，看是否能添加，更改，删除信息。如用户名和密码输入不正确，会出现什么情况，是否也能添加，更改，删除信息。2)限制: 如果输入的用户名过长，会出现错误，导致程序关闭。2. 功能2(管理员测试)分析管理员是否有输入，提交信息，查询车队信息列表，更新具体信息等权限。如输入不符合要求会出现“不存在此功能”。第4章 实训日记经过一周多的学生选课系统软件写作文档设计，记录情况如下：实训内容：今天老师布置了实训的内容以及小组情况，分配了实训的题目，并且说明了实训报告的要求以及相关内容。我小组一共3个人。我们所做的题目是车队管理系统，车队管理信息系统主要是提供司机、领导、乘客方便的查询等相关操作，对车辆和司机管理信息能统一规范化。具体要达到以下几点目的：1）确定产品所期望的用户类别。2）获取每个用户类的需求。3）了解实际用户任务和目标以及这些任务所支持的业务需求。4）分析源于用户的信息以区别用户任务需求、功能需求、业务规则、质量属性、建议解决方法和附加信息。功能块的相应操作分别由其对应的子模块实现。通过互联网把整个车队的信息汇聚起来，为车队管理部门提供全面及时的车辆和司机信息，方便管理，同时亦可通过互联网扩展各类信息化应用，共享车队信息。车队可通过一个简化的车队管理信息系统，使车队管理信息工作系统化，规范化，自动化，从而达到提高车队管理信息效率的目的。具体要达到以下几点目的：1）将系统级的需求分为几个子系统，并将需求中的一部份分配给软件组件；2）了解相关质量属性的重要性。3）商讨实施优先级的划分。4）将所收集的用户需求编写成文档和模型。第5章 实训总结本次课设，我充分认识到设计并开发一个车队管理信息系统的必要性和迫切性，本次设计和开发的车队管理信息系统应符合车队管理信息的规定，满足对车队管理信息的需要，并达到操作过程中的直观，方便，实用，安全等要求。系统采用模块化程序设计的方法，既便于系统功能的组合和修改，又便于未参与系统开发的技术维护人员补充和维护。我对于这个管理系统的设想目标是，能尽量使更多的车队业务做到方便和高效，能简略一些多余的操作和流程，达到提高车队的工作效率和准确性的目的，这也是一条削减车队日常成本，提高效益的途径。同时我们也希望通过我们这次车队信息化管理模式的尝试，发现其优点和不足之处，能提出更好的方案。本软件运用了VB作为前台，使用的大部分的控件，控件在VB程序设计中扮演重要的角色，它是VB程序的基本组成部分。合理恰当地使用各种不同的控件，以及熟练掌握各个控件的属性设置，是进行VB程序设计的基础。另外控件应用的好坏直接影响应用程序界面的美观性和操作的方便性。运用SQL作为后台服务，从数据库、数据表的创建和修改开始的，表是建立关系数据库的基本结构，用来存储数据具有已定义的属性，在表的操作过程中，有查看表信息、查看表属性、修改表中的数据、删除表中的数据及修改