软件文档写作实训7.docVIP

辽 宁 工 业 大 学 软件文档写作 实训报告 题目： 酒店管理系统软件文档 院（系）: 软件学院 专业班级： 教师职称： 副教授 起止时间： 2012.11.26-2012.12.02 实训任务及评语 院（系）：软件学院 教研室：软件教研室 学 号 实训题目 酒店管理系统 实训任务 实训任务及要求： 了解软件开发周期各阶段的文档。 掌握各文档阐述的内容及作用。 了解文档所采用的国际、国家等相关标准。 了解各文档所涉及的软件知识。 掌握各文档采用的描述工具。 具体编写出2个主要的软件文档。 实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。 几个人为一组完成一个相对完整的软件系统开发文档，组内成员编写的文档不能重复，文档要严格按照所采用的标准编写，图表布局要合理规范。 指导教师评语及成绩 成绩： 指导教师签字： 2012 目 录 TOC \o 1-3 \h \z \u 第1章 实训目的与要求 1 1.1 实训目的 1 1.2 实训的实验环境 1 1.3 实训的预备知识 1 1.4 实训要求 1 第2章 软件文档及其组成 2 2.1软件文档的作用及分类 2 2.2软件文档所采用的标准 3 2.2 软件文档的主要内容 3 第3章 实 例 5 3.1软件需求实例 5 3.2开发计划实例 10 第4章 实训日记 15 第5章 实训总结 16 第1章 实训目的与要求 1.1 实训目的 本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。 1、了解软件开发周期各阶段的文档。 2、掌握各文档阐述的内容及作用。 3、了解文档所采用的国际、国家等相关标准。 4、了解各文档所涉及的软件知识。 5、掌握各文档采用的描述工具。 6、具体编写出2个主要的软件文件。 1.2 实训的实验环境 学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。 1.3 实训的预备知识 要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。 1.4 实训要求 实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。 第2章 软件文档及其组成 2.1软件文档的作用及分类 软件文档的作用 文档是计算机软件产品的重要组成部分，没有文档就不成其为软件，也更不能成为软件产品。 软件文档是一种重要的软件工程技术资料。如系统分析文档、设计文档、版本说明文档。 软件文档的规范编制，在软件开发工作中占有突出的地位和相当大的工作量。高质量、高效率的编制、分发、管理、维护文档，及时的变更、修正、扩充和使用文档，对于软件产品的设计开发、发行使用、变更维护、转让移植、二次开发等，对于充分发挥软件产品的效益，都有着重要的意义。 软件文档的分类 基于软件生存期方法，可以从形式上将软件文档大致分成两类：软件开发过程中需要填写的各种图表，及应编制的各种技术文件或管理资料。 软件文档根据其产生和使用的范围，主要划分为3大类：开发文档、用户文档和管理文档。 2.2软件文档所采用的标准 类型 标准名称 标准号 基 础 标 准 软件工程术语 GB/T 11457-1989 信息处理——数据流程、程序流程图、系统结构图、程序网络图、系统资源图的文件编制符号及约定 GB/T 1526-1989 软件工程标准分类法 GB/T 15538-1995 信息处理——程序构造及其表示法的约定 GB/T 13502-1992 信息处理——单命中判定表规范 GB/T 15535-1995(ISO 5806) 信息处理系统——计算机系统配置图符号及其约定 GB/T 14085-1993(ISO 8790) 开 发 标 准 信息技术——软件生存期过程 GB/T 8566-1995 软件支持环境 GB/T 15853-1995 信息处理——按记录组处理顺序文卷的程序流程 GB/T 15697-1995(ISO 6593) 软件维护指南 GB/T 14079-1993 文 档 标 准 计算机软件产品开发文档