软件文档写作实训报告(韩旭)车队管理
软件文档写作实训报告(韩旭)车队管理
————————————————————————————————作者：————————————————————————————————日期：
辽宁工业大学软件文档写作实训报告
题目：车队管理系统软件文档
院（系）: 软件学院
专业班级：软件技术081
学号： 081401020
学生姓名：安凯辰
指导教师：王彦华
教师职称：助教
起止时间：2010.11.22-2010.12.06
实训任务及评语
院（系）：软件学院教研室：软件教研室
学号081401020 学生姓名安凯辰专业班级软件技术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)开发文档：这类文档是在软件开发过程中，作为软件开发人员前一阶段工作成果的体现和后一阶段工作依据的文档。包括软件需求说明书、数据要求说明书、概要设计