软件文档写作实训报告1.docVIP

辽宁工业大学 软件文档写作一实训报告 题目： 实验室设备管理系统 院（系）： 专业班级： 学 号： 学生姓名： 指导教师： 教师职称： 起止时间:2013. 11.25-2013. 12.01 实训任务及评语 号 学 名 姓 生 统 系 理 管 备 设 验 实 实训任务 八易。-、x 的作国知具件守实相严 段及、件T-软连录个毋 阶容际软述的格记一 m 各内国的描要严，成対 期的的及的主要容完， 碉述用涉用个，内组复 JC:发阐采歼采2中述一重 及齡砂袞鶯也黑轩 够 解握解解握幣劳地几対忍 1H3了掌了 了掌貝 确 的规 月 E 弓里 、、、、、、 ?1? 任一 E 孚 1 2 3 4 5 6 指导教师评语及成绩 日 05 月 2 11 年 3 仔201 成 院（系）：软件学院 教研室：软件教研室 目 录 TOC \o 1-5 \h \z \o Current Document \h 第1章实训目的与耍求 1 \o Current Document \h 1.1实训目的 1 \o Current Document \h 1.2实训的实验环境 1 \o Current Document \h 1.3实训的预备知识 1 1.4实训要求 1 \o Current Document \h 第2章 软件文档及其组成 2 \o Current Document \h 2.1软件文档的作用及分类 2 \o Current Document \h 2?2软件文档所采用的标准 2 \o Current Document \h 2.2软件文档的主要内容 3 \o Current Document \h 第3章实例 5 \o Current Document \h 3. 1用户手册 5 \o Current Document \h 3.2模块开发卷宗 13 第4章实训H记 16 \o Current Document \h 第5章实训总结 17 第1章实训目的与要求 1.1实训目的 本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和 步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。 1、 了解软件开发周期各阶段的文档。 2、 掌握各文档阐述的内容及作用。 3、 了解文档所采用的国际、国家等相关标准。 4、 了解各文档所涉及的软件知识。 5、 掌握各文档采用的描述工具。 6、 具体编写出2个主要的软件文件。 1.2实训的实验环境 学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。 1.3实训的预备知识 要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能 力及动手实践能力。该实训应安排在毕业设计之前进行。 1.4实训要求 实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述 内容，记录实习日记，规范完整地撰写出实训报告。 第2章软件文档及其组成 2. 1软件文档的作用及分类 软件文档是一种重要的软件工程技术资料。如系统分析文档、设计文档、版木 说明文档等。 软件文档的规范编制，在软件开发工作中占有突出的地位和相当大的工作量。 高质量、高效率的编制、分发、管理、维护文档，及吋的变更、修正、扩充和使用 文档，对于软件产品的设计开发、发行使用、变更维护、转让移植、二次开发等， 对于充分发挥软件产品的效益，都有着重要的意义。 软件文档可按照基于软件生存期方法以及根据其产生和使用的范围两大类分 类。 1?基于软件生存期方法，可以从形式上将软件文档大致分成两类：软件开发过 程小需要填写的各种图表，及应编制的各种技术文件或管理资料。 2.软件文档根据其产生和使用的范围，主耍划分为3大类：开发文档、用户文 档和管理文档。 其屮，开发文档包括：可行性研究报告，项口开发计划，软件需求说明书，数 据库设计说明书，概要设计说明书，详细设计说明书。 用户文档包括：用户手册，操作手册，软件需求说明书，数据要求说明书。 管理文档包括：项口开发计划，模块开发卷宗，开发进度月报，测试计划，测 试分析报告，项目开发总结报告。 而供开发人员使用的文档为可行性研究报告，项目开发计划，软件需求说明书, 数据要求说明书，概要设计说明书，详细设计说明书，数据库设计说明书，测试计 划，测试分析报告。 维护人员使用的文档为设计说明书，测试分析报告，模块开发卷宗。 管理人员使用的文档为可行性研究报告，项口开发计划，模块开发卷宗，开发 进度月报，项目开发总结报告。 用户使用的文档则为用户手册和操作手册。 2. 2软件文档所采用的标准 根据软件工程标准制定的机构和标准适用的范帀，可分为5个层次：国际标准、国 家标准、行业标准、企业（机构）标准、项目（课题）标准