軟件文档写作实训报告.doc

辽 宁 工 业 大 学 软件文档写作 实训报告 题目： 实验室设备管理系统 院（系）: 专业班级： 学 号： 学生姓名： 指导教师： 教师职称： 起止时间： 2013.11.25-2013.12.01 实训任务及评语 院（系）：软件学院 教研室：软件教研室 学 号 学生姓名 专业班级 实训题目 实验室设备管理系统 实训任务 实训任务及要求： 了解软件开发周期各阶段的文档。 掌握各文档阐述的内容及作用。 了解文档所采用的国际、国家等相关标准。 了解各文档所涉及的软件知识。 掌握各文档采用的描述工具。 具体编写出2个主要的软件文档。 实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。 几个人为一组完成一个相对完整的软件系统开发文档，组内成员编写的文档不能重复，文档要严格按照所采用的标准编写，图表布局要合理规范。 指导教师评语及成绩 成绩： 指导教师签字： 2013年 12月 05日 目 录 第1章 实训目的与要求 1 1.1 实训目的 1 1.2 实训的实验环境 1 1.3 实训的预备知识 1 1.4 实训要求 1 第2章 软件文档及其组成 2 2.1软件文档的作用及分类 2 2.2软件文档所采用的标准 2 2.2 软件文档的主要内容 2 第3章 实 例 3 3.1 ******实例 3 3.2 ******实例 3 第4章 实训日记 4 第5章 实训总结 5 第1章 实训目的与要求 1.1 实训目的 本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。 1、了解软件开发周期各阶段的文档。 2、掌握各文档阐述的内容及作用。 3、了解文档所采用的国际、国家等相关标准。 4、了解各文档所涉及的软件知识。 5、掌握各文档采用的描述工具。 6、具体编写出2个主要的软件文件。 1.2 实训的实验环境 学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。 1.3 实训的预备知识 要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。 1.4 实训要求 实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。 第2章 软件文档及其组成 2.1软件文档的作用及分类 软件文档的作用：?? 软件文档在软件开发中占有突出的地位和相当的工作量。高效率、高质量的开发、分发、管理和维护对转让、变更、修正、扩充和使用文档。对充分发挥软件产品的效益有着重要意义。软件文档的作用如下：? 1)?项目管理的依据。文档将通常“不可见的”软件开发进程转换成“可见的”文字资料，有利于项目的管理。2)?技术交流的语言。项目小组内部、项目平行开发的各小组之间进行的交流和联系，通常都是通过文档来实现的。3)?项目质量保证。文档是进行项目质量审查和评价的重要依据，有效文档的提供，可以满足项目质量保证人员和审查人员的工作需要。4)支持培训与维护.合格的软件文档通常都提供有关软件运行、维护和培训的必要信息，支持软件产品的应用和维护。5)支持软件维护。软件文档提供系统开发的全部必要技术资料，有利于维护人员熟悉系统，开展维护工作；软件维护文档记载了软件维护过程中软件及其环境变化的全部信息。6)?记载软件历史。软件文档作为“记载软件历史的语言”，可用作未来项目的一种资源，向潜在用户报道软件的各种有利信息，便于他们判断自己是否需要该软件提供的服务。良好的系统文档，显然有助于完成软件的移植，或将软件转移到各种新的系统环境中去。? 软件文档分类：? 从形式上来看，大致可分为两类：?1)是开发过程中填写的各种图表，可称之为工作表格。2)是应编制的技术资料或技术管理资料，可称之为文档或文件。??按照文档产生和使用的范围，软件文档大致可分为三类：?1)开发文档：这类文档是在软件开发过程中，作为软件开发人员前一阶段工作成果的体现和后一阶段工作依据的文档。包括软件需求说明