辽 宁 工 业 大 学
实训报告
题目： 宿舍管理系统软件文档
院（系）: 软件学院
专业班级： 电子商务112班
学 号： 111401049
学生姓名： 傅 瑶
指导教师： 闫海龙
教师职称： 助 教
起止时间： 2013.12.03-2013.12.09
实训任务及评语
目录
第1章 实训目的与要求 ....................................................... 1
1.1 实训目的 ............................................................ 1
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 数据库设计说明书实例 ............................................... 10
第4章 实训日记 ............................................................ 13
第5章 实训总结 ............................................................ 14
参考文献 ............................................................... 15
第1章 实训目的与要求
1.1 实训目的
本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。
1、了解软件开发周期各阶段的文档。
2、掌握各文档阐述的内容及作用。
3、了解文档所采用的国际、国家等相关标准。
4、了解各文档所涉及的软件知识。
5、掌握各文档采用的描述工具。
6、具体编写出2个主要的软件文件。
1.2 实训的实验环境
学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。
1.3 实训的预备知识
要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。
1.4 实训要求
实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成
上述内容，记录实习日记，规范完整地撰写出实训报告。
第2章 软件文档及其组成
2.1软件文档的作用及分类
软件文档也称文件，通常指的是一些记录的数据和数据媒体，它具有固定不变的形式，可 被人和计算机阅读。它和计算机程序共同构成了能完成特定功能的计算机软件。我们知道，硬件产品和产品资料在整个生产过程中都是有形可见的，软件 生产则有很大不同，文档本身就是软件产品。没有文档的软件，不成其为软件，更谈不到软件 产品。软件文档的编制在软件开发工作中占有突出的地位和相当的工作量。高效率、高质量地 开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档，对于充分发挥软件产 品的效益有着重要意义。
然而，在实际工作中，文档在编制和使用中存在着许多问题，有待于解决。软件开发人员 中较普遍地存在着对编制文档不感兴趣的现象。这里将给出简要的介绍：文档应该写哪些，说明什么问题，起什么作用。
可行性研究报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性， 可行性研究报告 评述为了合理地达到开发目标可供选择的各种可能实施的方案，说明并论证所选定实施 方案的理由。
项目开发计划：为软件项目实施方案制定出具体计划，应该包括各部分工作的负责人员、 项目开发计划 开发的进度、开发经费的预算、所需的硬件及软件资源等。项目开发计划应提供给管理 部门，并作为开发阶段评审的参考。
软件需求说明书：也称软件规格说明书，其中对所开发软件的功能、性能、用户界面及 软件需求说明书 运行环境等作出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上 达成的协议，也是实施开发工作的基础。数据要求说明书：该说明书应给出数据逻辑描述和数据采集的各项要求，为生成和维护 数据要求说明书 系统数据文卷作好准备。
概要设计说明书：该说明书是概要设计阶段的工作成果，它应说明功能分配、模块划分、 概要设计说明书 程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等， 为详细设计奠定基础。
软件文档分为以下几个部分：
详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。 详细设计说明书
用户手册：本手册详细描述软件的功能、性能和用户界面，使用户了解如何使用该软件。
操作手册：本手册为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的 操作手册 具体细节。
测试计划：为做好组装测试和确认测试，需为如何组织测试制定实施计划。计划应包括 测试计划 测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。
测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明。对测试结果加以 测试分析报告 分析，并提出测试的结论意见。
开发进度月报：该月报系软件人员按月向管理部门提交的项目进展情况报告。报告应包 开发进度月报 括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的 打算等。
项目开发总结报告：软件项目开发完成以后，应与项目实施计划对照，总结实际执行的 项目开发总结报告 情况，如进度、成果、资源利用、成本和投入的人力。此外还需对开发工作作出评价， 总结出经验和教训。
维护修改建议：软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存 维护修改建议 在的问题、修改的考虑以及修改的影响估计作详细的描述，写成维护修改建议，提交审 批。以上这些文档是在软件生存期中，随着各阶段工作的开展适时编制。其中有的仅反 映一个阶段的工作，有的则需跨越多个阶段。
2.2软件文档所采用的标准
软件文档采用的标准分以下几类：基础标准、开发标准、文档标准、管理标准。其中基础标准中又包括软件工程术语、数据流程、程序流程图、系统结构图、程序网络图、系统资源图的文件编制符号及约定、软件工程标准分类法、程序构造及其表示法的约定、单命中判定表规范、计算机系统配置图符号及其约定；开发标准中包括软件生存期过程、软件支持环境、按记录组处理顺序文卷的程序流程、软件维护指南；文档中包括计算机软件产品开发文档编制指南、计算机软件需求说明编制指南、计算机软件测试文档编制规范、软件文档管理指南；管理标准中包括计算机软件配置管理计划规范、软件产品评价质量特性及其使用指南、计算机软件质量保证计划规范、计算机软件可靠性和可维护性管理。
合理的软件文档要满足以下几条准则：从读者的角度编写文档；避免出现不必要的重复；避免歧义；使用标准结构记录基本原理；使文档保持更新，但频度不要过高；针对目标的适宜性对文档进行评审。
可行性分析报告：说明该软件开发项目的实现在技术上、经济上和社会因素 上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明 并论证所选定实施方案的理由。 项目开发计划：为软件项目实施方案制订出具体计划，应该包括各部
分工作 的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。
软件需求说明书：对所开发软件的功能、性能、用户界 面及运行环境等作出详细的说明。 它是在用户与开发人员双方对软件需求取得共 同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出 数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。
概要设计说明书： 该说明书是概要实际阶段的工作成果， 它应说明功能分配、 模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计 和出错处理设计等，为详细设计提供基础。
详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流 程等。 用户操作手册：本手册详细描述软件的功能、性能和用户界面，使用户对如 何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知 识，特别是操作方法的具体细节。
测试计划：为做好集成测试和验收测试，需为如何组织测试制订实施计划。 计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允 许的偏差范围等。
测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明，对测 试结果加以分析，并提出测试的结论意见。
开发进度月报：该月报系软件人员按月向管理部门提交的项目进展情况报 告，报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决 的办法以及下个月的打算等。
项目开发总结报告：软件项目开发完成以后，应与项目实施计划对照，总结 实际执行的情况，如进度、成果、资源利用、成本和投入的人力，此外，还需对 开发工作做出评价，总结出经验和教训。
软件维护手册：主要包括软件系统说明、程序模块说明、操作环境、支持软 件的说明、维护过程的说明，便于软件的维护。 软件问题报告：指出软件问题的登记情况，如日期、发现人、状态、问题所 属模块等，为软件修改提供准备文档。 软件修改报告：软件产品投入运行以后，发现了需对其进行修正、更改等问 题，应将存在的问题、修改的考虑以及修改的影响作出详细的描述，提交审批。
拥有准确技术文档不仅对于公司是非常有益处，而且也能够让客户从中受益。由于产品如何使用在某种程度上是要依赖技术文档来进行说明，因此技术文档必须十分准确可靠。使用不准确和已经过时技术文档对于公司发展也会产生一定阻碍，同样，它也会对公司客户们产生消极影响。一旦客户发现在他们使用产品时候遇到了问题，却不能通过求助于伴随产品技术文档手段进行解决时候，客户们就会对这种产品产生怀疑乃至于失去信心，那么，公司信誉和利益自然而然就会受到损害。这就是不准确和过时技术文档给我们带来危害。
缺乏准确性以及内容晦涩难懂都会让开发新手以及其他一些技术工作者们对这些技术文档敬而远之，从而不利于他们学习和掌握。在本篇文章中，我们要讨论就是如何在你开发小组中编写出准确而且易于掌握技术文档。
2.3 软件文档的主要内容
软件文档分为开发文档和产品文档，其中开发文档包括：功能要求、投标方案、需求分析、技术分析、系统分析、数据库文档、功能函数文档、界面文档、编译手册、QA 文档、项目总结、等；产品文档包括：产品简介、产品演示、疑问解答、功能介绍、技术白皮书、评测报告、安 装手册、使用手册、维护手册、用户报告、销售培训。
功能要求：来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出功能要求个模糊的功能概念，或者要求解决一个实际的问题，或者参照同类软件的一个功能。有软件经验的客户还会提出比较详细的技术规范书， 把他们的要求全部列表书写在文档中， 必要时 加以图表解说。这份文档时需求分析的基础。
投标方案：根据用户的功能要求，经过与招标方沟通和确认，技术人员开始书写投标方案，方案书一般包括以下几个重要的章节： 前言：项目背景、公司背景和业务、技术人员结构、公司的成功案例介绍等。 需求分析：项目要求、软件结构、功能列表、功能描述、注意事项等。 技术方案：总体要求和指导思想、技术解决方案、软件开发平台、网络结构体系等。 项目管理： 描述公司的软件开发流程、 工程实施服务、 组织和员工分工、 开发进度控制、 软件质量保证、先后木验收和人员培训、软件资料文档等。 技术支持：公司的技术支持和服务介绍、服务宗旨和目标、服务级别和响应时间、技术 服务区域、技术服务期限、授权用户联系人等。 系统报价：软硬件平台报价列表、软件开发费用、系统维护费用等 项目进度：整个项目的进度计划，包括签署合同、项目启动、需求分析、系统分析、程 序开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规划。 操作流程、 功能列表和解说、注意事项系统环境等。
需求分析包括产品概述、主要概念、以《功能要求》为基础，进行详细的功能分析，列出本产品是什么，有什么特殊的概念，包括那些功能的分类，需要具备什么功能， 该功能的操作如何， 实现的时候该注意什么细节， 客户有什么要求， 系统运行环境的要求等。 这里的功能跟描述跟以后的使用手册是一致的。
技术分析包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。以需求分析为基础，进行详细的技术分析，列出本项目需要使用什么技术方案，为什么，有哪些技术 问题要解决，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什 么评价等。
系统分析：包括功能实现，模块组成、功能流程图、函数接口、数据字典、软件开发需求、系统分析要考虑的各种问题等。以需求分析为基础，进行详细的系统分析，估
计开发期间需要把什么问题说明白，程序员根据系统分析，开始在项目主管的带 领下进行编码。
数据库文档：数据库文档包括数据库名称、表明、字段名、字段类型、字段说明、备注、字段数值、数据库文档计算公式等。以系统分析为基础，进行详细的数据库设计。必要时可以用图表姐说，特 别是关系数据库。
功能函数文档：功能函数文档包括变量名、变量初值、功能、函数名、参数、如何调用、备注、注意 功能函数文档事项等。以系统分析为基础，进行详细的说明，列出哪个功能设计多少个函数，以便以 后程序员修改、接手和扩展。
界面文档：包括软件的外观、界面素材、编辑工具、文件名、菜单、按钮和其他界面部界面文档。
编译手册：包括服务器编译环境、操作系统、编译工具、GNU 的 C++编译器版本信息、编译手册目录说明、程序生成、源程序文件列表、Makefile 配置及其相关程序的对应关系列表。客户 端的编译过程，编译结果、编译事例、编译环境、操作系统、编译工具、源文件列表和制作 安装程序的过程。
QA文档：包括产品简介、产品原理、产品功能列表、功能描述、功能流程、执行结果、 QA 文档数据库结构、测试要求等，提供给软件测试人员使用。
项目总结：包括项目简介、项目参与人员和开发时间、项目风险管理过程、项目功能列、项目总结表、项目结构特点、技术特点、对项目的升级建议、对以后的项目建议、人员素质情况等。
产品文档中
产品简介：包括公司背景、产品概念、适用范围、产品功能、功能特点、运行要求和司联系地址。
产品演示：包括公司的简介、产品背景、产品描述、产品特点、产品作用、适用范围、适用分析、功能模块、解决问题、合作伙伴、成功案例等。一般用 PPT 或是 VCD 录制软件 实现。
疑问解答 ：列出用户关心的问题和处理方法。用于解答软件的操作功能和解决用户的疑难问题。
功能介绍：以需求分析为书写基础，包括功能实现、技术选型、关键技术问题的解决、 功能介绍、技术方案特点、技术升级方向等。
评测报告 ：第三方权威评测报告。包括评测目的、评测范围、评测环境、评测内容、实测数据、性能表现、结果分析和评测总结等。
安装手册 ：包括运行环境、运行平台、产品安装过程、初始环境设置，安装记录等。 使用手册：包括产品简介、功能列表、功能描述和解释、功能操作、客户服务和
联系方式等。
维护手册：包括产品简介、系统须知、初始环境设置、系统配置、数据管理和备份
技术问题解答和联系方式等。
用户报告：包括产品简介、购买时间、使用目的、使用时间、使用地点、实施过程、出现问题和解决、产品总结和建议等。
销售培训：包括项目简介、产品功能、产品特点、商业优势、系统运行环境、适用范围、 目标客户等。
第3章 实 例
3.1 用户手册实例
3.2 数据库设计说明书实例
第4章 实训日记
课程设计的第一天根据老师所布置的任务，本小组对宿舍管理系统文档课题进行研究讨论，包括操作手册、测试分析报告、测试计划、概要设计、开发进度、可行性研究、模块开发、软件需求、数据库设计、数据要求、详细设计、项目开发和用户手册等等几方面。
以后的实训都是针对以上讨论的内容逐个展开， 在软件的生产过程中，总是伴随着大量的信息要记录、要使用。因此，软件文档在产品的开发生产过程中起着重要的作用。 软件文档可以提高软件开发过程的能见度。把开发过程中发生的事件以某种可阅读的形式记录在文档中。管理人员可把这些记载下来的材料作为检查软件开发进度和开发质量的依据，实现对软件开发的工程管理。
软件文档可以提高开发效率。软件文档的编制，使得开发人员对各个阶段的工作都进行周密思考、全盘权衡、从而减少返工。并且可在开发早期发现错误和不一致性，便于及时加以纠正。
软件文档可以作为开发人员在一定阶段的工作成果和结束标志。
软件文档可以记录开发过程中的有关信息，便于协调以后的软件、开发、使用和维护。
软件文档可以提供对软件的运行、维护和培训的有关信息，便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解。使软件开发活动更科学、更有成效。 软件文档可以便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需要的软件提供依据。
文档在各类人员、计算机之间的多种桥梁作用中看出：
既然软件已经从手工艺人的开发方式发展到工业化的生产方式，文档在开发过程中就起到关键作用。从某种意义上来说，文档是软件开发
规范的体现和指南。按规范要求生成一整套文档的过程，就是按照软件开发规范完成一个软件开发的过程。所以，在使用工程化的原理和方法来指导软件的开发和维护时，应当充分注意软件文档的编制和管理。
第5章 实训总结
本次实训我学到了许多关于软件文档的知识，由于第一次接触这一部分，实验中查找了不少相关书籍、资料，受益匪浅。
首先是软件文档，软件文档通常指的是一些记录的数据和数据媒体，它具有固定不变的形式，可被人和计算机阅读。它和 计算机程序共同构成了能完成特定功能的计算机软件。我们知道，硬件产品和产品资料在整 个生产过程中都是有形可见的，软件生产则有很大不同，文档本 身就是软件产品。没有文档的软件，不成其为软件，更谈不到软件 产品。软件文档的编制在软件开发工作中占有突 出的地位和相当的工作量。高效率、高质量地开发、分发、管理和维 护文档对于转让、变更、修正、扩充和使用文档，对于充分发挥软 件产品的效益有着重要意义。
然而，在实际工作中，文档在编制和使用中存在着许多问 题，有待于解决。软件开发人员中较普遍地存在着对编制文档不感兴趣的现象。从用户方面看，他们又常常抱怨：文档售价太高、文 档不够完整、文档编写得不好、文档已经陈旧或是文档太多，难于 使用等等。
文档在软件开发人员、软件管理人员、维护人员、用户以及计 算机之间的多种桥梁作用。软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据，这个作用是显而易见的。软件开发过程中软件开发人员需制定 一些工作计划或工作报告，这些计划和报告都要提供给管理人员， 并得到必要的支持。管理人员则可通过这些文档了解软件开发项 目安排、进度、资源使用和成果等。
综上所述， 作为一个学习软件的学生，了解软件文档的构成、作用是非常有必要的，非常感谢老师对这次软件文档实训课程的支持，是我们对所学到软件开发的了解又近了一步。
参考文献
[1] 徐世河 《管理信息系统设计教程》 电子工业出版社 2003.8
[2] 余金山 《SQL Server 2005企业项目开发与实战》电子工业出版社，2009.7
[3] 朱如龙 《SQL Server 2000 数据库应用系统开发》机械工业出版社，2006.3
[4] 潘孝铭 《软件文档编写》高等教育出版社 2004.2
[5] 王新颖 《软件工程与文档编写》 北京大学出版社 2007.6
[6] 候清富 《软件工程师实战基本功》 人民邮电出版社 2005.1
[7] 萨师煊 王珊 主编《数据库系统概论》高等教育出版社 2004.7
[8] 顾小航 《软件工程技术原理》 中国青年出版社 2005.5
[9] 唐任仲 《工程应用软件开发技术》 化学工业出版社 1999.5
[10] 郑人杰 《实用软件工程（第4版）》清华大学出版社 2003.4
辽 宁 工 业 大 学
实训报告
题目： 宿舍管理系统软件文档
院（系）: 软件学院
专业班级： 电子商务112班
学 号： 111401049
学生姓名： 傅 瑶
指导教师： 闫海龙
教师职称： 助 教
起止时间： 2013.12.03-2013.12.09
实训任务及评语
目录
第1章 实训目的与要求 ....................................................... 1
1.1 实训目的 ............................................................ 1
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 数据库设计说明书实例 ............................................... 10
第4章 实训日记 ............................................................ 13
第5章 实训总结 ............................................................ 14
参考文献 ............................................................... 15
第1章 实训目的与要求
1.1 实训目的
本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。
1、了解软件开发周期各阶段的文档。
2、掌握各文档阐述的内容及作用。
3、了解文档所采用的国际、国家等相关标准。
4、了解各文档所涉及的软件知识。
5、掌握各文档采用的描述工具。
6、具体编写出2个主要的软件文件。
1.2 实训的实验环境
学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。
1.3 实训的预备知识
要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。
1.4 实训要求
实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成
上述内容，记录实习日记，规范完整地撰写出实训报告。
第2章 软件文档及其组成
2.1软件文档的作用及分类
软件文档也称文件，通常指的是一些记录的数据和数据媒体，它具有固定不变的形式，可 被人和计算机阅读。它和计算机程序共同构成了能完成特定功能的计算机软件。我们知道，硬件产品和产品资料在整个生产过程中都是有形可见的，软件 生产则有很大不同，文档本身就是软件产品。没有文档的软件，不成其为软件，更谈不到软件 产品。软件文档的编制在软件开发工作中占有突出的地位和相当的工作量。高效率、高质量地 开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档，对于充分发挥软件产 品的效益有着重要意义。
然而，在实际工作中，文档在编制和使用中存在着许多问题，有待于解决。软件开发人员 中较普遍地存在着对编制文档不感兴趣的现象。这里将给出简要的介绍：文档应该写哪些，说明什么问题，起什么作用。
可行性研究报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性， 可行性研究报告 评述为了合理地达到开发目标可供选择的各种可能实施的方案，说明并论证所选定实施 方案的理由。
项目开发计划：为软件项目实施方案制定出具体计划，应该包括各部分工作的负责人员、 项目开发计划 开发的进度、开发经费的预算、所需的硬件及软件资源等。项目开发计划应提供给管理 部门，并作为开发阶段评审的参考。
软件需求说明书：也称软件规格说明书，其中对所开发软件的功能、性能、用户界面及 软件需求说明书 运行环境等作出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上 达成的协议，也是实施开发工作的基础。数据要求说明书：该说明书应给出数据逻辑描述和数据采集的各项要求，为生成和维护 数据要求说明书 系统数据文卷作好准备。
概要设计说明书：该说明书是概要设计阶段的工作成果，它应说明功能分配、模块划分、 概要设计说明书 程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等， 为详细设计奠定基础。
软件文档分为以下几个部分：
详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。 详细设计说明书
用户手册：本手册详细描述软件的功能、性能和用户界面，使用户了解如何使用该软件。
操作手册：本手册为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的 操作手册 具体细节。
测试计划：为做好组装测试和确认测试，需为如何组织测试制定实施计划。计划应包括 测试计划 测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。
测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明。对测试结果加以 测试分析报告 分析，并提出测试的结论意见。
开发进度月报：该月报系软件人员按月向管理部门提交的项目进展情况报告。报告应包 开发进度月报 括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的 打算等。
项目开发总结报告：软件项目开发完成以后，应与项目实施计划对照，总结实际执行的 项目开发总结报告 情况，如进度、成果、资源利用、成本和投入的人力。此外还需对开发工作作出评价， 总结出经验和教训。
维护修改建议：软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存 维护修改建议 在的问题、修改的考虑以及修改的影响估计作详细的描述，写成维护修改建议，提交审 批。以上这些文档是在软件生存期中，随着各阶段工作的开展适时编制。其中有的仅反 映一个阶段的工作，有的则需跨越多个阶段。
2.2软件文档所采用的标准
软件文档采用的标准分以下几类：基础标准、开发标准、文档标准、管理标准。其中基础标准中又包括软件工程术语、数据流程、程序流程图、系统结构图、程序网络图、系统资源图的文件编制符号及约定、软件工程标准分类法、程序构造及其表示法的约定、单命中判定表规范、计算机系统配置图符号及其约定；开发标准中包括软件生存期过程、软件支持环境、按记录组处理顺序文卷的程序流程、软件维护指南；文档中包括计算机软件产品开发文档编制指南、计算机软件需求说明编制指南、计算机软件测试文档编制规范、软件文档管理指南；管理标准中包括计算机软件配置管理计划规范、软件产品评价质量特性及其使用指南、计算机软件质量保证计划规范、计算机软件可靠性和可维护性管理。
合理的软件文档要满足以下几条准则：从读者的角度编写文档；避免出现不必要的重复；避免歧义；使用标准结构记录基本原理；使文档保持更新，但频度不要过高；针对目标的适宜性对文档进行评审。
可行性分析报告：说明该软件开发项目的实现在技术上、经济上和社会因素 上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明 并论证所选定实施方案的理由。 项目开发计划：为软件项目实施方案制订出具体计划，应该包括各部
分工作 的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。
软件需求说明书：对所开发软件的功能、性能、用户界 面及运行环境等作出详细的说明。 它是在用户与开发人员双方对软件需求取得共 同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出 数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。
概要设计说明书： 该说明书是概要实际阶段的工作成果， 它应说明功能分配、 模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计 和出错处理设计等，为详细设计提供基础。
详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流 程等。 用户操作手册：本手册详细描述软件的功能、性能和用户界面，使用户对如 何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知 识，特别是操作方法的具体细节。
测试计划：为做好集成测试和验收测试，需为如何组织测试制订实施计划。 计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允 许的偏差范围等。
测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明，对测 试结果加以分析，并提出测试的结论意见。
开发进度月报：该月报系软件人员按月向管理部门提交的项目进展情况报 告，报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决 的办法以及下个月的打算等。
项目开发总结报告：软件项目开发完成以后，应与项目实施计划对照，总结 实际执行的情况，如进度、成果、资源利用、成本和投入的人力，此外，还需对 开发工作做出评价，总结出经验和教训。
软件维护手册：主要包括软件系统说明、程序模块说明、操作环境、支持软 件的说明、维护过程的说明，便于软件的维护。 软件问题报告：指出软件问题的登记情况，如日期、发现人、状态、问题所 属模块等，为软件修改提供准备文档。 软件修改报告：软件产品投入运行以后，发现了需对其进行修正、更改等问 题，应将存在的问题、修改的考虑以及修改的影响作出详细的描述，提交审批。
拥有准确技术文档不仅对于公司是非常有益处，而且也能够让客户从中受益。由于产品如何使用在某种程度上是要依赖技术文档来进行说明，因此技术文档必须十分准确可靠。使用不准确和已经过时技术文档对于公司发展也会产生一定阻碍，同样，它也会对公司客户们产生消极影响。一旦客户发现在他们使用产品时候遇到了问题，却不能通过求助于伴随产品技术文档手段进行解决时候，客户们就会对这种产品产生怀疑乃至于失去信心，那么，公司信誉和利益自然而然就会受到损害。这就是不准确和过时技术文档给我们带来危害。
缺乏准确性以及内容晦涩难懂都会让开发新手以及其他一些技术工作者们对这些技术文档敬而远之，从而不利于他们学习和掌握。在本篇文章中，我们要讨论就是如何在你开发小组中编写出准确而且易于掌握技术文档。
2.3 软件文档的主要内容
软件文档分为开发文档和产品文档，其中开发文档包括：功能要求、投标方案、需求分析、技术分析、系统分析、数据库文档、功能函数文档、界面文档、编译手册、QA 文档、项目总结、等；产品文档包括：产品简介、产品演示、疑问解答、功能介绍、技术白皮书、评测报告、安 装手册、使用手册、维护手册、用户报告、销售培训。
功能要求：来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出功能要求个模糊的功能概念，或者要求解决一个实际的问题，或者参照同类软件的一个功能。有软件经验的客户还会提出比较详细的技术规范书， 把他们的要求全部列表书写在文档中， 必要时 加以图表解说。这份文档时需求分析的基础。
投标方案：根据用户的功能要求，经过与招标方沟通和确认，技术人员开始书写投标方案，方案书一般包括以下几个重要的章节： 前言：项目背景、公司背景和业务、技术人员结构、公司的成功案例介绍等。 需求分析：项目要求、软件结构、功能列表、功能描述、注意事项等。 技术方案：总体要求和指导思想、技术解决方案、软件开发平台、网络结构体系等。 项目管理： 描述公司的软件开发流程、 工程实施服务、 组织和员工分工、 开发进度控制、 软件质量保证、先后木验收和人员培训、软件资料文档等。 技术支持：公司的技术支持和服务介绍、服务宗旨和目标、服务级别和响应时间、技术 服务区域、技术服务期限、授权用户联系人等。 系统报价：软硬件平台报价列表、软件开发费用、系统维护费用等 项目进度：整个项目的进度计划，包括签署合同、项目启动、需求分析、系统分析、程 序开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规划。 操作流程、 功能列表和解说、注意事项系统环境等。
需求分析包括产品概述、主要概念、以《功能要求》为基础，进行详细的功能分析，列出本产品是什么，有什么特殊的概念，包括那些功能的分类，需要具备什么功能， 该功能的操作如何， 实现的时候该注意什么细节， 客户有什么要求， 系统运行环境的要求等。 这里的功能跟描述跟以后的使用手册是一致的。
技术分析包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。以需求分析为基础，进行详细的技术分析，列出本项目需要使用什么技术方案，为什么，有哪些技术 问题要解决，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什 么评价等。
系统分析：包括功能实现，模块组成、功能流程图、函数接口、数据字典、软件开发需求、系统分析要考虑的各种问题等。以需求分析为基础，进行详细的系统分析，估
计开发期间需要把什么问题说明白，程序员根据系统分析，开始在项目主管的带 领下进行编码。
数据库文档：数据库文档包括数据库名称、表明、字段名、字段类型、字段说明、备注、字段数值、数据库文档计算公式等。以系统分析为基础，进行详细的数据库设计。必要时可以用图表姐说，特 别是关系数据库。
功能函数文档：功能函数文档包括变量名、变量初值、功能、函数名、参数、如何调用、备注、注意 功能函数文档事项等。以系统分析为基础，进行详细的说明，列出哪个功能设计多少个函数，以便以 后程序员修改、接手和扩展。
界面文档：包括软件的外观、界面素材、编辑工具、文件名、菜单、按钮和其他界面部界面文档。
编译手册：包括服务器编译环境、操作系统、编译工具、GNU 的 C++编译器版本信息、编译手册目录说明、程序生成、源程序文件列表、Makefile 配置及其相关程序的对应关系列表。客户 端的编译过程，编译结果、编译事例、编译环境、操作系统、编译工具、源文件列表和制作 安装程序的过程。
QA文档：包括产品简介、产品原理、产品功能列表、功能描述、功能流程、执行结果、 QA 文档数据库结构、测试要求等，提供给软件测试人员使用。
项目总结：包括项目简介、项目参与人员和开发时间、项目风险管理过程、项目功能列、项目总结表、项目结构特点、技术特点、对项目的升级建议、对以后的项目建议、人员素质情况等。
产品文档中
产品简介：包括公司背景、产品概念、适用范围、产品功能、功能特点、运行要求和司联系地址。
产品演示：包括公司的简介、产品背景、产品描述、产品特点、产品作用、适用范围、适用分析、功能模块、解决问题、合作伙伴、成功案例等。一般用 PPT 或是 VCD 录制软件 实现。
疑问解答 ：列出用户关心的问题和处理方法。用于解答软件的操作功能和解决用户的疑难问题。
功能介绍：以需求分析为书写基础，包括功能实现、技术选型、关键技术问题的解决、 功能介绍、技术方案特点、技术升级方向等。
评测报告 ：第三方权威评测报告。包括评测目的、评测范围、评测环境、评测内容、实测数据、性能表现、结果分析和评测总结等。
安装手册 ：包括运行环境、运行平台、产品安装过程、初始环境设置，安装记录等。 使用手册：包括产品简介、功能列表、功能描述和解释、功能操作、客户服务和
联系方式等。
维护手册：包括产品简介、系统须知、初始环境设置、系统配置、数据管理和备份
技术问题解答和联系方式等。
用户报告：包括产品简介、购买时间、使用目的、使用时间、使用地点、实施过程、出现问题和解决、产品总结和建议等。
销售培训：包括项目简介、产品功能、产品特点、商业优势、系统运行环境、适用范围、 目标客户等。
第3章 实 例
3.1 用户手册实例
3.2 数据库设计说明书实例
第4章 实训日记
课程设计的第一天根据老师所布置的任务，本小组对宿舍管理系统文档课题进行研究讨论，包括操作手册、测试分析报告、测试计划、概要设计、开发进度、可行性研究、模块开发、软件需求、数据库设计、数据要求、详细设计、项目开发和用户手册等等几方面。
以后的实训都是针对以上讨论的内容逐个展开， 在软件的生产过程中，总是伴随着大量的信息要记录、要使用。因此，软件文档在产品的开发生产过程中起着重要的作用。 软件文档可以提高软件开发过程的能见度。把开发过程中发生的事件以某种可阅读的形式记录在文档中。管理人员可把这些记载下来的材料作为检查软件开发进度和开发质量的依据，实现对软件开发的工程管理。
软件文档可以提高开发效率。软件文档的编制，使得开发人员对各个阶段的工作都进行周密思考、全盘权衡、从而减少返工。并且可在开发早期发现错误和不一致性，便于及时加以纠正。
软件文档可以作为开发人员在一定阶段的工作成果和结束标志。
软件文档可以记录开发过程中的有关信息，便于协调以后的软件、开发、使用和维护。
软件文档可以提供对软件的运行、维护和培训的有关信息，便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解。使软件开发活动更科学、更有成效。 软件文档可以便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需要的软件提供依据。
文档在各类人员、计算机之间的多种桥梁作用中看出：
既然软件已经从手工艺人的开发方式发展到工业化的生产方式，文档在开发过程中就起到关键作用。从某种意义上来说，文档是软件开发
规范的体现和指南。按规范要求生成一整套文档的过程，就是按照软件开发规范完成一个软件开发的过程。所以，在使用工程化的原理和方法来指导软件的开发和维护时，应当充分注意软件文档的编制和管理。
第5章 实训总结
本次实训我学到了许多关于软件文档的知识，由于第一次接触这一部分，实验中查找了不少相关书籍、资料，受益匪浅。
首先是软件文档，软件文档通常指的是一些记录的数据和数据媒体，它具有固定不变的形式，可被人和计算机阅读。它和 计算机程序共同构成了能完成特定功能的计算机软件。我们知道，硬件产品和产品资料在整 个生产过程中都是有形可见的，软件生产则有很大不同，文档本 身就是软件产品。没有文档的软件，不成其为软件，更谈不到软件 产品。软件文档的编制在软件开发工作中占有突 出的地位和相当的工作量。高效率、高质量地开发、分发、管理和维 护文档对于转让、变更、修正、扩充和使用文档，对于充分发挥软 件产品的效益有着重要意义。
然而，在实际工作中，文档在编制和使用中存在着许多问 题，有待于解决。软件开发人员中较普遍地存在着对编制文档不感兴趣的现象。从用户方面看，他们又常常抱怨：文档售价太高、文 档不够完整、文档编写得不好、文档已经陈旧或是文档太多，难于 使用等等。
文档在软件开发人员、软件管理人员、维护人员、用户以及计 算机之间的多种桥梁作用。软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据，这个作用是显而易见的。软件开发过程中软件开发人员需制定 一些工作计划或工作报告，这些计划和报告都要提供给管理人员， 并得到必要的支持。管理人员则可通过这些文档了解软件开发项 目安排、进度、资源使用和成果等。
综上所述， 作为一个学习软件的学生，了解软件文档的构成、作用是非常有必要的，非常感谢老师对这次软件文档实训课程的支持，是我们对所学到软件开发的了解又近了一步。
参考文献
[1] 徐世河 《管理信息系统设计教程》 电子工业出版社 2003.8
[2] 余金山 《SQL Server 2005企业项目开发与实战》电子工业出版社，2009.7
[3] 朱如龙 《SQL Server 2000 数据库应用系统开发》机械工业出版社，2006.3
[4] 潘孝铭 《软件文档编写》高等教育出版社 2004.2
[5] 王新颖 《软件工程与文档编写》 北京大学出版社 2007.6
[6] 候清富 《软件工程师实战基本功》 人民邮电出版社 2005.1
[7] 萨师煊 王珊 主编《数据库系统概论》高等教育出版社 2004.7
[8] 顾小航 《软件工程技术原理》 中国青年出版社 2005.5
[9] 唐任仲 《工程应用软件开发技术》 化学工业出版社 1999.5
[10] 郑人杰 《实用软件工程（第4版）》清华大学出版社 2003.4