软件文档写作宿舍管理系统.doc.doc

辽 宁 工 业 大 学 软件文档写作 实训报告 题目： 宿舍管理系统软件文档 院（系）: 软件学院 专业班级： 电子商务112班 学 号： 111401049 学生姓名： 傅 瑶 指导教师： 闫海龙 教师职称： 助 教 起止时间： 2013.12.03-2013.12.09 实训任务及评语 院（系）：软件学院 教研室：软件教研室 学 号 111401049 学生姓名 傅 瑶 专业班级 电子商务112班 实训题目 宿舍管理系统软件文档 实训任务 实训任务及要求： 了解软件开发周期各阶段的文档。 掌握各文档阐述的内容及作用。 了解文档所采用的国际、国家等相关标准。 了解各文档所涉及的软件知识。 掌握各文档采用的描述工具。 具体编写出2个主要的软件文档。 实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。 几个人为一组完成一个相对完整的软件系统开发文档，组内成员编写的文档不能重复，文档要严格按照所采用的标准编写，图表布局要合理规范。 指导教师评语及成绩 成绩： 指导教师签字： 年 月 日 目录 第1章 实训目的与要求 0 1.1 实训目的 0 1.2 实训的实验环境 1 1.3 实训的预备知识 1 1.4 实训要求 1 第2章 软件文档及其组成 2 2.1软件文档的作用及分类 2 2.2软件文档所采用的标准 3 2.3 软件文档的主要内容 5 第3章 实 例 7 3.1 用户手册实例 7 3.2 数据库设计说明书实例 11 第4章 实训日记 14 第5章 实训总结 15 参考文献 16 第1章 实训目的与要求 1.1 实训目的 本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。 1、了解软件开发周期各阶段的文档。 2、掌握各文档阐述的内容及作用。 3、了解文档所采用的国际、国家等相关标准。 4、了解各文档所涉及的软件知识。 5、掌握各文档采用的描述工具。 6、具体编写出2个主要的软件文件。 1.2 实训的实验环境 学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。 1.3 实训的预备知识 要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。 1.4 实训要求 实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。  第2章 软件文档及其组成 2.1软件文档的作用及分类 软件文档也称文件，通常指的是一些记录的数据和数据媒体，它具有固定不变的形式，可 被人和计算机阅读。它和计算机程序共同构成了能完成特定功能的计算机软件。我们知道，硬件产品和产品资料在整个生产过程中都是有形可见的，软件 生产则有很大不同，文档本身就是软件产品。没有文档的软件，不成其为软件，更谈不到软件 产品。软件文档的编制在软件开发工作中占有突出的地位和相当的工作量。高效率、高质量地 开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档，对于充分发挥软件产 品的效益有着重要意义。然而，在实际工作中，文档在编制和使用中存在着许多问题，有待于解决。软件开发人员 中较普遍地存在着对编制文档不感兴趣的现象。这里将给出简要的介绍文档应该写哪些，说明什么问题，起什么作用。可行性研究报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性， 可行性研究报告 评述为了合理地达到开发目标可供选择的各种可能实施的方案，说明并论证所选定实施 方案的理由。项目开发计划：为软件项目实施方案制定出具体计划，应该包括各部分工作的负责人员、 项目开发计划 开发的进度、开发经费的预算、所需的硬件及软件资源等。项目开发计划应提供给管理 部门，并作为开发阶段评审的参考。软件需求说明书：也称软件规格说明书，其中对所开发软件的功能、性能、用户界面及 软件需求说明书 运行环境等作出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上 达成的协议，也是实施开发工作的基础。数据要求说明书：该说明书应给出数据逻辑描述和数据采集的各项要求，为生成和维护