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

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

《软件文档写作实训报告(康亚瑞)车队管理.doc》由会员分享，可在线阅读，更多相关《软件文档写作实训报告(康亚瑞)车队管理.doc（19页珍藏版）》请在冰豆网上搜索。

辽宁工业大学

软件文档写作实训报告

题目：

车队管理系统软件文档

院（系）:

软件学院

专业班级：

软件技术081

学号：

081404017

学生姓名：

安凯辰

指导教师：

王彦华

教师职称：

助教

起止时间：

2010.11.22-2010.12.06

实训任务及评语

院（系）：

软件学院教研室：

软件教研室

学号

081404017

学生姓名

安凯辰

专业班级

软件技术081

实训题目

车队管理系统软件文档

实训任务

实训任务及要求：

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章实例 6

3.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软件文档的主要内容

系统的目标，就是选用VB6.0作为开发工具，设计并实现一个能够满足车队运输资源管理的管理信息系统。

具体包括以下功能：

1）.根据日常工作需求，提供必要功能，如：

员工、司机、车辆管理维护、托运过程管理维护、维修管理维护、报销申请审核管理等；

2）.提供强大的查询功能，不同用户可以根据需求，以不同的项目为目标，完成对托运过程信息、司机信息以及报销统计等的查询；

3）.进行必要的安全考虑，如权限管理、数据库备份恢复等；

4）.效率高，界面友好，操作方便。

软件开发系统的建立与应用可以划分成总体规划、系统开发和系统运行三个阶段，其中系统开发阶段还可进一步分为系统分析、系统设计和系统实施等工作环节。

本软件为车队运输单位。

该系统由各负责人和员工组成。

员工分为业务员和查询员。

负责人对系统基本信息的管理和报销审核，员工在前台进行业务管理和业务查询。

因此现有系统由管理员（负责人）、普通服务员（业务员）、查询用户（查询员）等组成。

本软件具体的操作为当客户要托运某货物时，客户把他的运输托运单传给车队的调度，调度把托运单登记到运输文档，然后填写运输单给车队派车。

车队接到运输单后就选择车辆和司机。

并填写派车给司机并登记派车单文档。

司机完成运输日任务回到车队后，把运输单交于车队存档，并把运输过程中产生的成本填写报销单交于财务处报销。

如果在运输中发生车辆有任何问题要在交车的时候就随时填写维修申请交与维修部。

在车辆维修好后，维修部填写维修费用申请单交与财务部门报销。

货代出对帐单交财务部门审核。

审核通过后出费用确认单交财务部门等。

针对目前世界上流行的大量软件和开发工具，经过认真分析其优缺点，结合计量器具管理系统的需要和目前的硬件环境，我们选用微软WINDOWS平台下的VisualBasic6.0（简写为VB6.0）作为软件开发工具。

作为数据库系统的开发，VisualBasic是一个非常理想选择。

数据库是MIS中的重要支持技术，在MIS开发过程中，如何选择数据库管理是一个重要的问题，目前，数据库产品较多，每种产品都具有各自的特点和适用范围，因此，在选择数据库时，应考虑数据库应用的特点及适用范围，本系统选用的数据库语言VisualBasic语言，该开发工具具有很多长处：

VisualBasic是一种可视化的、面对对象和条用事件驱动方式的结构化高级程序设计，可用于开发Windows环境下的种类应用程序。

它简单易学、效率高，且功能强大，可以与Windows的专业开发工具SDK相媲美，而且程序开发人员不必具有C/C++编程基础。

在VisualBasic环境下，利用事件驱动的编程机制、新颖易用的可视化设计工具，使用Windows内部的应用程序接口（API）函数，以及动态链接库（DLL）、动态数据交换（DDE）、对象的链接与嵌入（OLE）、开放式数据访问（ODBC）等技术，可以高效、快速地开发出Windows环境下功能强大、图形界面丰富的应用软件系统。

第3章实例

3.1概要设计实例

一．引言

1.概要设计编写目的

随着计算机的普及和网络技术的发展，我国的运输行业信息化建设很早就已经开始在全国展开部署了。

车队管理系统就是其中之一。

传统的手写管理由于工作量巨大、存放麻烦、更新困难、不易备份，已随着时代的发展而显的落伍了。

这就要我们创造更快更新的管理系统。

电子管理以快捷、方便的使用而受到欢迎。

车队管理系统是一个运输单位不可缺少的部分,它的内容对于单位的决策者和管理者来说都至关重要,所以车队管理系统应该能够为用户提供充足的信息和快捷的查询手段。

但一直以来人们使用传统人工的方式管