软件文档写作实训报告韩旭车队管理.doc

软件文档写作实训报告韩旭车队管理

辽 宁 工 业 大 学
软件文档写作 实训报告

题目： 车队管理系统软件文档

院（系）: 软件学院
专业班级： 软件技术081
学 号：
学生姓名： 安凯辰
指导教师： 王彦华
教师职称： 助 教
起止时间： .11.22- .12.06

实训任务及评语
院（系）：软件学院 教研室：软件教研室
学 号

学生姓名
安凯辰
专业班级
软件技术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.3 软件文档的主要内容 4
第3章 实 例 6
3.1 数据库设计实例 6
第4章 实训日记 16
第5章 实训总结 17
参考文献 错误！未定义书签。

第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.3 软件文档的主要内容
系统的目标，就是选用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)软件相关组：指软件配置管理组、文档支持组、测试组。
(2)软件质量保证组：指计划和实施软件质量保证活动的人员的集合。
4.参考资料
[1]外部设计徐绪松：《信息系统原理》，科学出版社， 第1版，第200-272页。
[2 ]朱志强：《管理信息系统——原理、开发及应用》，复旦大学出版社， 第1版，第109-194页。
[3] 何勇、郑文钟：《管理信息系统的原理方法及应用》，浙江大学出版社， 第1版第21-79页。
二．外部设计
1.标识符和状态
联系用途，详细说明用于唯一地标识该数据库的代码、名称或标识符，附加的描述性信息亦要给出。如果该数据库属于尚在实验中、尚在测试中或是暂时使用的，则要说明这一特点及其有效时间范围。
2.约定
1)常量和变量的命名约定
下面为在编码过程中会用到的常量和变量统一的命名，如表3.1所示:

表3.1常量和变量命名约定
变量名
数据类型
变量类型
含义
UserShenFen
String
全局变量
用户身份标志
LogOK
Boolean
全局变量
登陆状态
UserName
String
全局变量
用户名
GongYingShangID
String
全局变量
供应商编号
GongYingShang
String
全局变量
供应商名称
TuShuBianHao
String
全局变量
图书编号
DingJia
Single
全局变量
图书定价
ShuMing
String
全局变量
书名
HuiYuanKaHao
String
全局变量
会员卡号
HYXingMing
String
全局变量
会员姓名
HYDengJi
String
全局变量
会员等级
编码应清晰、可读性好，运用缩进、空行，结合大小写区别等方法保持程序结构良好
2)结构化编码约定
凡与数据库操作相关的模块一律加上容错代码，涉及多表操作的模块应该运用“事务”处理，以保持数据完整性。
编码风格参照下例进行：
Public Sub CheckUser(userID As String, passwd As String)
Dim userDB As Database
Dim userRD As Recordset
Dim dbName As String
Dim STRSQL As String
Screen.MousePointer = 11
On Error GoTo errEnd
dbName = App.Path
If Right(dbName, 1) <> "、" Then dbName = dbName + "、"
dbName = dbName + "DataBase、WFSSDataBase.mdb"
STRSQL = "select [用户身份] from [Admin] where [用户ID]=""" & userID & """ and [用户密码]=""" & passwd & """"
'打开数据库
Set userDB = DBEngine.Workspaces(0).OpenDatabase(dbName, False, True)
'检索用户,验证密码
Set userRD = userDB.OpenRecordset(STRSQL, dbOpenSnapshot)
If userRD.RecordCount > 0 Then
'设置用户身份
UserShenFen = userRD![用户身份]
'关闭数据库
userRD.Close
Set userRD = Nothing
userDB.Close
Set userDB = Nothing
'进入用户环境
Load FrmMain
FrmMain.Show
Unload FrmLogIn
logOK = True
userName = userID
Screen.MousePointer = vbDefault
Else
'关闭数据库
userRD.Close
Set userRD = Nothing
userDB.Close
Set userDB = Nothing
logOK = False
Screen.MousePointer = vbDefault
MsgBox "用户名或密码错误！请重新输入！", vbOKOnly + vbExclamation, "登陆失败"
End If
Exit Sub
errEnd：
Screen.MousePointer = vbDefault
MsgBox Err.Description, vbOKOnly + vbExclamation, "登陆错误"
logOK = False
Err.Clear
'关闭数据库
userRD.Close
Set userRD = Nothing
userDB.Close
Set userDB = Nothing
Exit Sub
End Sub
4）数据源的约定
需用数据源的组件如：DataGrid一律采用Adodb控件。有特殊需求的情况如：身份验证应引用DAO(数据访问对象)。
5）数据库访问约定
数据库引擎采用Microsoft.Jet.OLEDB.4.0，由Adodb组件进行数据库的访问，并为其它组件提供数据源。特殊情况、身份验证等由 DAO访问数据库。无需数据显示的情况由DAO提供数据库支持，有数据显示的情况由ADODB组件提供数据库支持。
三．结构设计
1.概念结构设计
系统E-R图：将费用报销单，司机信息表，车辆信息表，维修费用表，回程单等表之间的联系描绘出关系模型。联系是指车队系统中各个实体的联系，拥有一对一、一对多、多对多的联系。如图31所示：
费用报销单
维修费用单
回程表
车辆信息表
司机信息表
报销
维修
出车
回程
费用
M
N
N
1
M
M
1
M
1

图3.1 系统E-R图

2．逻辑结构设计
车队管理系统包含用户信息表、车辆信息表、报销信息表、运输信息表、维修信息表、托运信息表、司机信息表、民族、职务、员工信息表组成。利用各个表的主键把各个表连接到一起。利用关系图表现出来。如图3.2所示：
图3.2车队管理系统关系图

3.物理结构设计
（1）车辆表删除代码：
CREATE PROCEDURE clx_delete
@clx varchar(50),@flag int output
as
if exists(select *from 车辆表 where 车辆编号=@clh and 载重=0)
begin
delete from 车辆表 where 车辆编号=@clh and 载重=0
set @flag=0
end
else set @flag=1
GO
（2）车辆表插入代码：
CREATE PROCEDURE clx_insert
@clbh char(20),@cph char(20),@sccj char(50),@zz char(20),@zws char(20),@ccrq char(20)，@bz char(100)
as
insert into 车辆表 (车辆编号,车牌号,生产厂家,载重,座位数,出厂日期，备注)
values (@clbh,@cph,@sccj,@zz,@zws,@ccrq,@bz)
GO
（3）车辆表修改代码：
CREATE PROCEDURE clx_update
@clbh char(20),@cph char(20),@sccj char(50),@zz char(20),@zws char(20),@ccrq char(20),@bz char(100)
as
delete xs where 车辆编号=@clbh
insert into车辆表 (车辆编号,车牌号,生产厂家,载重,座位数,出厂日期，备注)
values (@sph,@spmc,@kcl,@dj,@splx,@cs, @bz)
GO
四．运用设计
1．数据字典设计
下面列出了本系统中数据流、数据元素、数据存储、外部项、和数据加工的DD的例子。
表3.2 数据流的DD表举例
数据流
系统名：车队管理系统
编号：
条目名：托运信息
别名：无
来源：添加托运
存储处：D31 托运信息库
数据流结构：
F31={托运信息}
流量：约30/每天
简要说明：
托运信息是客户托运的相关信息。
修改记录：
编写：
日期：
审核：
日期：

表3.3 数据元素的DD表举例
数据元素
系统名：车队管理系统
编号：
条目名：托运状态
别名：无
属于数据流：托运信息
存储处：D31 托运信息库
数据元素值：运输状态\调度状态\托运完成
代码类型： CHAR
取值范围：
长度：20
意义：托运的过程信息。
简要说明：
记录每个托运单所处的状态。
修改记录：
编写：
日期：
审核：
日期：

表3.4数据存储的DD表举例
数据存储
系统名：车队管理系统
编号：
条目名：托运信息库
别名： 无
存储组织：
记录数：无限制
主关键字：托运单编号
二维表
数据量：约300KB
辅关键字：无
记录组成：
托运信息
简要说明：
存放托运单的相关信息
修改记录：
编写：
日期：
审核：
日期：

表3.5 数据加工的DD表举例
数据加工
系统名：车队管理系统
编号：
条目名：新托运单入库
别名： 无
输入：托运信息
输出：
添加是否成功
加工逻辑：在托运信息库中添加一条记录，将输入的新记录信息对应保存。
简要说明：用于记录添加新的托运信息到库存中。
修改记录：
编写：
日期：
审核：
日期：

表3.6 外部项的DD表举例
外部项
系统名：车队管理系统
编号：
条目名：报销统计
别名：
输入数据流：
输出数据流：

汇总报销记录统计信息
主要特征：
对某段时间内报销相关信息等情况进行汇总，生成EXCEL报表。
简要说明：
供管理者决策参考。
修改记录：
编写：
日期：
审核：
日期：

2．安全保密设计
MIS系统的安全性设计能够分为数据库级安全设计、应用软件级安全设计两个级别。数据库级安全设计在数据库级经过赋予用户不同的操作权限，控制用户对数据库的访问，对用进行存取控制；另外并发控制、完整性约束以及数据的备份和恢复策略等等，这些安全性都能够充分利用数据库管理系统（DBMS）本身具有的功能来完成。
应用软件级安全设计能够在系统平台上根据不同的登陆身份和权限，给出不同的用户界面，允许不同的操作。本系统的登录模块、用户管理模块配合，就是完成这样的功能。另外，系统还提供了灵活方便的数据备份、恢复功能，有用户自己选择合适的时机进行数据的备份和恢复，隐藏了对DBMS操作的复杂细节，使得系统具有更强的支持灾难性数据恢复的功能。

第4章 实训日记
一．时间： 11月22 日 地点：9#-710
实训题目：软件测试文档 指导教师:张健
实训目的：本实训要求学生经过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档。
实训内容：今天老师布置了实训的内容以及小组情况，分配了实训的题目，而且说明了实训报告的要求以及相关内容。我小组一共3个人。我们所做的题目是车队管理系统，车队管理信息系统主要是提供司机、领导、乘客方便的查询等相关操作，对车辆和司机管理信息能统一规范化。具体要达到以下几点目的：
1）确定产品所期望的用户类别。
2）获取每个用户类的需求。
3）了解实际用户任务和目标以及这些任务所支持的业务需求。
4）分析源于用户的信息以区别用户任务需求、功能需求、业务规则、质量属性、建议解决方法和附加信息。
二．时间: 11月29日 地点：9#-710
实训题目：软件测试文档 指导教师:张健
实训目的：本实训要求学生经过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档。
实训内容：功能块的相应操作分别由其对应的子模块实现。经过互联网把整个车队的信息汇聚起来，为车队管理部门提供全面及时的车辆和司机信息，方便管理，同时亦可经过互联网扩展各类信息化应用，共享车队信息。车队可经过一个简化的车队管理信息系统，使车队管理信息工作系统化，规范化，自动化，从而达到提高车队管理信息效率的目的。具体要达到以下几点目的：
1）将系统级的需求分为几个子系统，并将需求中的一部份分配给软件组件；
2）了解相关质量属性的重要性。
3）商讨实施优先级的划分。
4）将所收集的用户需求编写成文档和模型。
第5章 实训总结
经过我的努力下，终于完成了本次软件文档的实训，其功能基本符合用户需求，能够完成车队的基本功能。并提供部分系统维护功能,对于数据的一致性的问题也经过程序进行了有效的解决。
经过此次软件文档的实训，真正达到了学与用的结合，增强了对数据库方面应用的理解，在实验过程中，从建立数据开始，对数据库理念有了更高的认识，从需求分析，到概念设计和逻辑设计，E_R图的表示，懂的了不少有关数据库开发过程中的知识，在实验中建表，以及关系模式，关系代数的建立及理解，将SQL的查询语句运用的淋漓尽致，增强了自己在数据库中应用SQL语言的灵活性，其中包括，插入，删除，修改，查询涉及表和表之间的联系，主键与外键的定义。在这次的毕业设计中遇到了不少的问题，大部分得到了很好的解决，但也有少部分遗留的问题。调研的不充分。由于以前根本未曾接触过软件的整体开发设计，因此在前期的调研中相当不充分，开题也有些盲目，以为把属性和表格写得越多越好，这个问题越到后来越严种，而且因为客观的原因耽误了进度。可是在老师的指导下，我们小组对系统进行全面的分析，对系统的作用以及实现的步骤作了记录。
经过实际操作，学会 数据库程序编程的基本步骤、基本方法，开发了自己的逻辑思维能力，培养了分析问题、解决问题的能力。深刻体会到“没有做不到的，只有想不到的”，“团结就是力量”，“实践是检验真理的标准”，“不耻下问”……的寓意。

参考文献
[1]．黄剀涛 .Visual Basic 6.0中文版高级应用与开发指南.北京大学出版社， :31-35页
[2]. 孙春来， 韩正清.SQL Server中文版编程基础与范例.电子工业出版社， ：195-239页
[3]. 知寒工作室.SQL Server 简明案例教程.机械工业出版社 ， ：619页
[4]. 徐建平，赵永.SQL Server 基础教程.机械工业出版社出版日期， ：51-69页
[5]. 张鲁.Visual Basic编程技巧与实例分析.水利水电出版社， ：284-296页
[6]. 张磊.Visual Basic 6.0使用详解.械工业出版社， ：196页
[7]. 康耀红，黄健青.SQL Server 数据库设计.京大学出版社： ：156-189页
[8].郑刚.SQL Server 实效编程百例.人民邮电出版社， ：189页
[9]. 李加福.SQL Server 中文版入门与提高.清华大学出版社， ：146-189页
[10]. 陈明.SQL Server 程序设计.清华大学出版社， ：179页
[11]. 刘鹏，李冬梅，高燕.Visual Basic 6.0全攻略宝典.水利水电出版社， ：123页
[12]. 章立民.SQL Server 中文版程序设计-基础加强篇.中国铁道出版社， ：154页
[13]. 郑阿奇.Visual Basic 6.0实用教程. 电子工业出版社， ：125-189页