工业大学软件文档写作实训报告分析样本.doc

辽 宁 工 业 大 学 软件文档写作 实训汇报题目： 学生管理系统软件文档 院（系）: 软件学院 专业班级： 学 号： 学生姓名： 指导老师： 翟宝峰 老师职称： 副教授 起止时间： .12.26-.12.31 实训任务及评语院（系）：软件学院 教研室：软件教研室学 号学生姓名专业班级实训题目 学生管理系统软件文档实训任务实训任务及要求：1、 了解软件开发周期各阶段文档。2、 掌握各文档叙述内容及作用。3、 了解文档所采取国际、国家等相关标准。4、 了解各文档所包含软件知识。5、 掌握各文档采取描述工具。6、 具体编写出2个关键软件文档。实训过程中，要严格遵守实训时间安排，听从指导老师指导。正确地完成上述内容，统计实习日志，规范完整地撰写出实训汇报。多个人为一组完成一个相对完整软件系统开发文档，组内组员编写文档不能反复，文档要严格根据所采取标准编写，图表布局要合理规范。指导老师评语及成绩成绩： 指导老师签字： 年 月 日目 录第1章 实训目标和要求11.1 实训目标11.2 实训试验环境11.3 实训预备知识11.4 实训要求1第2章软件文档及其组成22.1软件文档作用及分类22.2软件文档所采取标准22.2 软件文档关键内容2第3章实 例33.1 *实例33.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软件文档作用及分类软件文档(document)也称文件，通常指是部分统计数据 和数据媒体，它含有固定不变形式，可被人和计算机阅读。它和 计算机程序共同组成了能完成特定功效计算机软件(有些人把源 程序也看成文档一部分)。我们知道，硬件产品和产品资料在整 个生产过程中全部是有形可见，软件生产则有很大不一样，文档本 身就是软件产品。没有文档软件，不成其为软件，更谈不到软件 产品。软件文档编制(documentation)在软件开发工作中占有突 出地位和相当工作量。高效率、高质量地开发、分发、管理和维 护文档对于转让、变更、修正、扩充和使用文档，对于充足发挥软 件产品效益有着关键意义。 然而，在实际工作中，文档在编制和使用中存在着很多问 题，有待于处理。软件开发人员中较普遍地存在着对编制文档不感 爱好现象。从用户方面看，她们又常常埋怨：文档售价太高、文 档不够完整、文档编写得不好、文档已经陈旧或是文档太多，难于 使用等等。到底应该怎样要求它，文档应该写哪些，说明什么问 题，起什么作用?这里将给出简明介绍。 图 文档桥梁作用文档在软件开发人员、软件管理人员、维护人员、用户和计 算机之间多个桥梁作用可从图92中看出。软件开发人员在各 个阶段中以文档作为前阶段工作结果表现和后阶段工作依 据，这个作用是显而易见。软件开发过程中软件开发人员需制订 部分工作计划或工作汇报，这些计划和汇报全部要提供给管理人员， 并得到必需支持。管理人员则可经过这些文档了解软件开发项 目安排、进度、资源使用和结果等。软件开发人员需为用户了解软 件使用、操作和维护提供具体资料，我们称此为用户文档。以 上三种文档组成了软件文档关键部分。我们把这三种文档所包 括内容列在图6中。其中列举了十三个文档，这里对它们作 部分简明说明： 可行性研究汇报：说明该软件开发项目标实现在技术上、经 济上和社会原因上可行性，评述为了合理地达成开发目标可供 选择多种可能实施方案，说明并论证所选定实施方案理 由。 项目开发计划：为软件项目实施方案制订出具体计划，应 该包含各部分工作责任人员、开发进度、开发经费预算、所 需硬件及软件资源等。项目开发计划应提供给管理部门，并作 为开发阶段评审参考。 软件需求说明书：也称软件规格说明书，其中对所开发软 件功效、性能、用户界面及运行环境等作出具体说明。它是用 户和开发人员双方对软件需求取得共同了解基础上达成协议， 也是实施开发工作基础。 数据要求说明书：该说明书应给出数据逻辑描述和数据采 集各项要求，为生成和维护 系统数据文卷作好准备。 概要设计说明书：该说 明书是概要设计阶段工作 结果，它应说明功效分配、模 块划分、程序总体结构、输 入输出和接口设计、运行设 计、数据结构设计和犯错处理 设计等，为具体设计奠定基 础。 具体设计说明书：着重 描述每一模块是怎样实现， 包含实现算法、逻辑步骤等。 用户手册：本手册具体 描述软件功效、性能和用户 界面，使用户了解怎样使用该软件。文档用户文档用户手册操作手册维护修改提议软件需求（规格）说明书开发文档软件需求（规格）说明书数据要求说明书概要设计说明书具体设计说明书可行性研究汇报项目开发计划管理文档项目开发计划测试计划测试汇报开发进度月报开发总结汇报 操作手册：本手册为操作人员提供该软件多种运行情况 相关知识，尤其是操作方法具体细节。 测试计划：为做好组装测试和确定测试，需为怎样组织测试 制订实施计划。计划应包含测试内容、进度、条件、人员、测试用 例选择标准、测试结果许可偏差范围等。 测试分析汇报：测试工作完成以后，应提交测试计划实施 情况说明。对测试结果加以分析，并提出测试结论意见。 开发进度月报：该月报系软件人员按月向管理部门提交 项目进展情况汇报。汇报应包含进度计划和实际实施情况比较、 阶段结果、碰到问题和处理措施和下个月计划等。 项目开发总结汇报：软件项目开发完成以后，应和项目实 施计划对照，总坚固际实施情况，如进度、结果、资源利用、成本 和投入人力。另外还需对开发工作作出评价，总结出经验和教 训。 维护修改提议，软件产品投入运行以后，发觉了需对其进 行修正、更改等问题，应将存在问题、修改考虑和修改影 响估量作具体描述，写成维护修改提议，提交审批。 以上这些文档是在软件生存期中，伴随各阶段工作开展适 时编制。其中有仅反应一个阶段工作，有则需跨越多个阶 段。表5给出了各个文档应在软件生存期中哪个阶段编写。这 些文档最终要向软件管理部门，或是向用户回复以下问题： 表9.2 软件生存期各阶段编制文档 阶段文档可行性药酒和计划需求分析设计代码编写测试运行和维护可行性研究汇报项目开发计划软件需求说明数据要求说明概要设计说明星系设计说明测试计划用户手册操作手册测试分析汇报开发进度月报项目开发总结维护修改提议 哪些需求要被满足，即回复“做什么?” 所开发软件在什么环境中实现和所需信息从哪里来， 即回复“从何处?” 一些开发工作时间怎样安排，即回复“何时干?” 一些开发(或维护)工作计划由“谁来干?” 一些需求是怎么实现? 为何要进行那些软件开发或维护修改工作? 上述十三个文档全部在一定程度上回复了这六个方面问题。这可从表中看到。表 文档所回复问题所提问题文档什么 何处 何时 谁 怎样 为何 可行性研究汇报 项目开发计划 软件需求说明 数据要求说明 概要设计说明 具体设计说明 测试计划 用户手册 操作手册 测试分析汇报 开发进度月报 项目开发总结 维护修改提议 至此，我们对文档作用有了深入了解。每一个文档任 务也是明确，任何一个文档全部此是多出。2.2软件文档所采取标准2.2 软件文档关键内容 第3章 实 例3.1 *实例1.1*里写什么什么设计说明书1.23.2 *实例 第4章 实训日志第5章 实训总结参考文件