2022年软件文档写作实训报告 .pdf
《2022年软件文档写作实训报告 .pdf》由会员分享,可在线阅读,更多相关《2022年软件文档写作实训报告 .pdf(21页珍藏版)》请在淘文阁 - 分享文档赚钱的网站上搜索。
1、辽宁工业大学软件文档写作实训报告题目:实验室设备管理系统院(系) : 专业班级:学号:学生姓名:指导教师:教师职称:起止时间:2013.11.25-2013.12.01名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 1 页,共 21 页 - - - - - - - - - 实训任务及评语院(系) :软件学院教研室:软件教研室学 号学生姓名实训题目实验室设备管理系统实训任务实训任务及要求:1、了解 软件开发周期各阶段的文档。2、掌握各文档阐述的内容及作用。3、了解 文档所采用的国际、国
2、家等相关标准。4、了解各文档所涉及的软件知识。5、掌握各文档采用的描述工具。6、具体编写出 2 个主要的软件文档。实训过程中,要严格遵守实训的时间安排,听从指导教师的指导。正确地完成上述内容,记录实习日记,规范完整地撰写出实训报告。几个人为一组完成一个相对完整的软件系统开发文档,组内成员编写的文档不能重复, 文档要严格按照所采用的标准编写,图表布局要合理规范。指导教师评语及成绩成绩:指导教师签字: 2013年 12 月 05 日名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 2 页,
3、共 21 页 - - - - - - - - - 辽 宁 工 业 大 学 课 程 设 计 说 明 书(论文)目录第 1 章 实训目的与要求 . . 1 1.1 实训目的 . . 1 1.2 实训的实验环境 . . 1 1.3 实训的预备知识 . . 1 1.4 实训要求 . . 1 第 2 章软件文档及其组成. 2 2.1 软件文档的作用及分类. 2 2.2 软件文档所采用的标准. 2 2.2 软件文档的主要内容 . . 3 第 3 章实 例 . 5 3.1 概要设计说明书实例 . . 5 3.2 项目开发总结报告实例. . 12 第 4 章实训日记 . 16 第 5 章实训总结 . 17 名
4、师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 3 页,共 21 页 - - - - - - - - - 辽 宁 工 业 大 学 综 合 实 训 说 明 书(论文)1 第 1 章 实训目的与要求1.1 实训目的本实训要求学生通过具体的实例,模仿软件开发过程中软件文档写作的具体方法和步骤,分组完成一套较为简单软件文档,具体要达到以下几点目的。1、了解 软件开发周期各阶段的文档。2、掌握各文档阐述的内容及作用。3、了解 文档所采用的国际、国家等相关标准。4、了解各文档所涉及的软件知识。5、
5、掌握各文档采用的描述工具。6、具体编写出 2 个主要的软件文件。1.2 实训的实验环境学校图书馆,互联网查询环境,具有软件图表制作软件的计算机。1.3 实训的预备知识要求学生修完全部专科所有课程, 具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。1.4 实训要求实训过程中,要严格遵守实训的时间安排,听从指导教师的指导。正确地完成上述内容,记录实习日记,规范完整地撰写出实训报告。名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 4 页,共 21
6、 页 - - - - - - - - - 辽 宁 工 业 大 学 综 合 实 训 说 明 书(论文)2 第 2 章 软件文档及其组成2.1 软件文档的作用及分类文档的作用和分类软件文档 (document) 也称文件,通常指的是一些记录的数据和数据媒体,它具有固定不变的形式,可被人和计算机阅读。它和计算机程序共同构成了能完成特定功能的计算机软件 ( 有人把源程序也当作文档的一部分 ) 。 我们知道,硬件产品和产品资料在整个生产过程中都是有形可见的,软件生产则有很大不同,文档本身就是软件产品。没有文档的软件,不成其为软件,更谈不到软件产品。软件文档的编制 (documentation) 在软件开
7、发工作中占有突出的地位和相当的工作量。高效率、高质量地开发、分发、管理和维 护文档对于转让、变更、修正、扩充和使用文档,对于充分发挥软件产品的效益有着重要意义。然而,在实际工作中, 文档在编制和使用中存在着许多问题,有待于解决。软件开发人员中较普遍地存在着对编制文档不感兴趣的现象。从用户方面看,他们又常常抱怨:文档售价太高、 文 档不够完整、文档编写得不好、 文档已经陈旧或是文档太多,难于 使用等等。究竟应该怎样要求它,文档应该写哪些,说明什么问题,起什么作用?这里将给出简要的介绍。文档在软件开发人员、 软件管理人员、 维护人员、用户以及计算机之间的多种桥梁作用可从图中看出。软件开发人员在各个
8、阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据,这个作用是显而易见的。软件开发过程中软件开发人员需制定一些工作计划或工作报告,这些计划和报告都要提供给管理人员,并得到必要的支持。管理人员则可通过这些文档了解软件开发项目安排、进度、资源使用和成果等。软件开发人员需为用户了解软件的使用、操作和维护提供详细的资料,我们称此为用户文档。2.2 软件文档所采用的标准根据软件工程标准制定的机构和标准适用的范围,可分为5 个层次:国际标准、国家标准、行业标准、企业(机构) 标准、项目 ( 课题) 标准。ISO9000 标准概述:ISO9000 是国际标准化组织建立以来制订和公布的几千个标准中,影响最
9、深远和普及最迅速的一个,其对各国经济生活所起的以下特点作用不可低估。我们在观察这一现象时,注意到 ISO 9000的以下几个特点:(1) 国际性。ISO9000 已成为各国对质量保证和质量管理制度的共同理解。(2) 完整名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 5 页,共 21 页 - - - - - - - - - 辽 宁 工 业 大 学 综 合 实 训 说 明 书(论文)3 性。ISO9000 系列标准包含了术语、质量保证、质量管理到支持件技术标准及实施指南等一整套共计 2
10、0 个标准,形成了一个完整的体系结构。 (3) 兼容性。作为 ISO9000系列标准核心的三个质量保证标准是逐一包容的。即9001 标准的内容最全面, 9002 标准排除了设计工作的质量要求, 仅限于生产制造过程, 9003标准仅限于检验和试验工作的质量要求。可以说,依次适用范围渐窄。(4) 主动性。选用和实施ISO9000标准、建立质量体系的主体,是企业的主动行为。(5) 可信性。 ISO9000 的认证是授权认证机构对供方质量体系进行的独立、公正的活动,因此,具有相当的说服力和可信度。(6) 指导性。ISO9000 标准文本只是给出了质量管理和质量保证的原则,具体如何实施,需要供方结合自身
11、机构的实际情况, 特别是供方企业文化, 进行创造性的解决。 (7) 科学性。ISO9000标准的背后是现代质量管理的科学原理。(8) 实践性。具体表现在,标准文本不是空洞的条文,并基于大量的质量管理实践。如标准可向前追溯,得知其源于英国国家标准和美国军用标准等。2.2 软件文档的主要内容我所做的软件文档是学生管理系统软件文档。学生管理系统软件文档包括2 个模块,其具体内容如下:1) 概要设计说明书:总体设计- 需求规定,运行环境,基本设计概念和处理流程 , 结构, 功能器求与程序的关系 , 人工处理过程 , 尚未问决的问题等。 2)项目开发总结报告:产品,主要功能和性能,基本流程,进度,费用等
12、。名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 6 页,共 21 页 - - - - - - - - - 辽 宁 工 业 大 学 综 合 实 训 说 明 书(论文)4 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 7 页,共 21 页 - - - - - - - - - 辽 宁 工 业 大 学 综 合 实 训 说 明 书(论文)5 第 3 章 实 例3.1 概要设计说明
13、书实例1 引言1.1 编写目的1.1.1为开发人员、维护人员、客户之间提供共同的协议而创立基础,对实验室设备管理系统软件功能的实现作概要描叙。1.1.2本说明书的预期读者为分析人员、测试人员、用户文档编写者、项目管理人员。1.2 背景说明:待开发软件系统的名称:实验室设备管理系统项目的任务提出者:第一组项目开发者:第一组用户:软件学院实现软件单位:辽宁工业大学1.3 定义概要设计的基本目的是:概括地说, 系统应该如何实现?这阶段的重要任务是设计软件的结构,也就是要确定系统中每个程序是有哪些模块组成的,以及这些模块相互间的关系。1.4 参考资料软件工程导论张海藩清华大学出版社实验室设备管理系统可
14、行性研究报告第一组实验室设备管理系统需求分析报告第一组2 总体设计2.1 需求规定主要的输入输出项目:新设备信息、修理信息、申请购买信息、报废信息、具体查询统计要求;对名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 8 页,共 21 页 - - - - - - - - - 辽 宁 工 业 大 学 综 合 实 训 说 明 书(论文)6 实验室设备使用情况进行统计、更新。2.2 运行环境运行环境: windows xp 以上2.3 基本设计概念和处理流程处理流程图:系统的软件结构图:实验
15、设 备 管理系 统功能设 备 管用 户 管设备添加设备维修设备删除设备查询用户添加用户删除用户修改用户查询用户名设备名输入数据处理数据操作读 入 信息差错控制输出用 户 信息设 备 信息名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 9 页,共 21 页 - - - - - - - - - 辽 宁 工 业 大 学 综 合 实 训 说 明 书(论文)7 2.4 结构用一览表及框图的形式说明本系统的系统元素(各层模块、子程序、公用程序等)的划分,扼要说明每个系统元素的标识符和功能,分层次
16、地给出各元素之间的控制与被控制关系. 2.5 功能器求与程序的关系本条用一张如下的矩阵图说明各项功能需求的实现同各块程序的分配关系:程序 1 程序 2 程序 n 功能需求1 功能需求2 功能需求n 2.6 人工处理过程人员对数据的查询2.7 尚未问决的问题各个模块的数据字典和流程图,本概要设计中未能体现,但在详细设计中都会完成。3 接口设计3.1 用户接口说明将向用户提供的命令和它们的语法结构,以及软件的回答信息。3.2 外部接口321 用户界面在用户界面部分,根据需求分析的结果,用户需要一个用户友善界面。在界面设计上, 应做到简单明了,易于操作, 并且要注意到界面的布局,应突出的显示重要以及
17、出错信息。外观上也要做到合理化,考虑到用户多对WINDOWS 风格较熟悉,应尽量向这一方向靠拢。在设计语言上,已决定使用 Visual Basic 进行编程,在界面上可使用Visual Basic 所提供的可视化组件,向WINDOWS 风格靠近。其中服务器程序界面要做到操作简单,易于管理。在设计上采用下拉式菜单方式,在出错显示上可调用Visual Basic库中的错误提示函数。总的来说,系统的用户界面应作到可靠性、简单性、易学习和使用名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 1
18、0 页,共 21 页 - - - - - - - - - 辽 宁 工 业 大 学 综 合 实 训 说 明 书(论文)8 322 软件接口服务器程序可使用Visual Basic提供的对 SQL SERVER 的接口,进行对数据库的所有访问。服务器程序上可使用SQL SERVER 的对数据库的备份命令,以做到对数据的保存。在网络软件接口方面, 使用一种无差错的传输协议,采用滑动窗口方式对数据进行网络传输及接收。323 硬件接口在输入方面,对于键盘、鼠标的输入,可用Visual Basic的标准输入 / 输出,对输入进行处理。在输出方面,打印机的连接及使用,也可用Visual Basic 的标准输
19、入 / 输出对其进行处理。在网络传输部分,在网络硬件部分,为了实现高速传输,将使用高速ATM 。3.3 内部接口内部接口方面, 各模块之间采用函数调用、参数传递、返回值的方式进行信息传递。具体参数的结构将在下面数据结构设计的内容中说明。接口传递的信息将是以数据结构封装了的数据,以参数传递或返回值的形式在各模块间传输。4 运行设计4.1 运行模块组合功能分配功能模块划分图中各个模块的功能如下:1、登录模块:具有不同权限的管理人员可以通过用户名和密码登录系统,进入主界面。3、设备管理模块:录入设备信息,输入完成后,将数据存盘。对已存档的设备库进行日常管理,如修改、 增加、删除等基本操作。 按操作员
20、输入的编号、设备名能以查询一个至多个数据库的库存记录,并可打印存档。4、用户管理模块:赋予高级管理者以增加、删除、修改普通管理员的权限。赋予普通管理员修改密码的权限。4.2 运行控制说登陆窗体: 输入正确的用户和密码单击确定进入管理系统的主界面,如果用户名或密码错误,给出相应的提示信息,如果连续三次错误,自动退出系统。系统管理:提供物品基本信息的录入、修改、查询等功能。单击添加按钮保存将存入数据库中。查询提供精确和模糊两种查询方法。从下拉列表框中, 选择要查询的项目在文本框中输入要查询的关键字单击查询可得到相应的查询结果。模糊查询同上。4.3 运行时间系统的响应时间小于3 秒,实时更新处理,数
21、据转换与传输时间,运行时间很短。名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 11 页,共 21 页 - - - - - - - - - 辽 宁 工 业 大 学 综 合 实 训 说 明 书(论文)9 5 系统数据结构设计5.1 逻辑结构设计要点用户信息:用户名,密码, 登入权限实验室信息:名称、编号、管理员编号维修报表:设备编号,设备名称,设备类型,损坏数量,维修费用,维修单位,修理日期设备信息:设备名称,设备编号,设备类型, 设备供应商, 购置日期, 单价, 购买数量,保修年限,
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 2022年软件文档写作实训报告 2022 软件 文档 写作 报告
限制150内