辽 宁 工 学 院
软件文档写作 实训报告
题目： 财务管理系统软件文档
院（系）: 专业班级： 学 号： 学生姓名： 指导教师： 教师职称： 起止时间： 2009.11.30-2009.12.11
实训任务及评语
院（系）：软件学院 教研室：软件教研室 学 号 实训题目 实训任务及要求： 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软件文档所采用的标准 ................................................ 2 2.2 软件文档的主要内容 .................................................. 2 第3章 实 例 ................................................................ 6
3.1数据库设计说明书实例 ................................................ 6 3.2详细设计说明书实例 ................................................. 14 第4章 实训日记 ............................................................ 22 第5章 实训总结 ............................................................ 23 参考文献 ................................................................... 24
辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）
第1章 实训目的与要求
1.1 实训目的
本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。
1、了解软件开发周期各阶段的文档。 2、掌握各文档阐述的内容及作用。
3、了解文档所采用的国际、国家等相关标准。 4、了解各文档所涉及的软件知识。 5、掌握各文档采用的描述工具。 6、具体编写出2个主要的软件文件。 1.2 实训的实验环境
学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。 1.3 实训的预备知识
要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。 1.4 实训要求
实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。
1
辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）
第2章 软件文档及其组成
2.1软件文档的作用及分类
2.2软件文档所采用的标准
可行性研究报告：说明该软件开发项目的实现在技术上、经 济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施的方案，说明并论证所选定实施方案的理由。
项目开发计划：为软件项目实施方案制定出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。项目开发计划应提供给管理部门，并作 为开发阶段评审的参考。
软件需求说明书：也称软件规格说明书，其中对所开发软 件的功能、性能、用户界面及运行环境等做出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议，也是实施开发工作的基础。
数据要求说明书：该说明书应给出数据逻辑描述和数据采集的各项要求，为生成和维护系统数据文卷作好准备。
概要设计说明书：该说 明书是概要设计阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设 计、数据结构设计和出错处理设计等，为详细设计奠定基础。
详细设计说明书：着重 描述每一模块是怎样实现的，包括实现算法、逻辑流程等。用户手册：本手册详细描述软件的功能、性能和用户界面，使用户了解如何使用该软件。
2.2 软件文档的主要内容
一、开发文档
1. 功能要求是来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。这份文档是需求分析的基础。
2