学生管理系统软件文档软件文档写作实训报告.docx
- 文档编号:25427208
- 上传时间:2023-06-08
- 格式:DOCX
- 页数:9
- 大小:20.70KB
学生管理系统软件文档软件文档写作实训报告.docx
《学生管理系统软件文档软件文档写作实训报告.docx》由会员分享,可在线阅读,更多相关《学生管理系统软件文档软件文档写作实训报告.docx(9页珍藏版)》请在冰豆网上搜索。
学生管理系统软件文档软件文档写作实训报告
辽宁工业大学
软件文档写作实训报告
题目:
学生管理系统软件文档
院(系):
软件学院
专业班级:
学号:
学生姓名:
指导教师:
丁宝柱
教师职称:
起止时间:
2012.12.03-2012.12.09
实训任务及评语
院(系):
软件学院教研室:
软件教研室
学号
学生姓名
专业班级
实训题目
学生管理系统软件文档
实训任务
实训任务及要求:
1、了解软件开发周期各阶段的文档。
2、掌握各文档阐述的内容及作用。
3、了解文档所采用的国际、国家等相关标准。
4、了解各文档所涉及的软件知识。
5、掌握各文档采用的描述工具。
6、具体编写出2个主要的软件文档。
实训过程中,要严格遵守实训的时间安排,听从指导教师的指导。
正确地完成上述内容,记录实习日记,规范完整地撰写出实训报告。
几个人为一组完成一个相对完整的软件系统开发文档,组内成员编写的文档不能重复,文档要严格按照所采用的标准编写,图表布局要合理规范。
指导教师评语及成绩
成绩:
指导教师签字:
年月日
目录
第1章实训目的与要求1
1.1实训目的1
1.2实训的实验环境1
1.3实训的预备知识1
1.4实训要求1
第2章软件文档及其组成2
2.1软件文档的作用及分类2
2.2软件文档所采用的标准2
2.2软件文档的主要内容2
第3章实例3
3.1******实例3
3.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软件文档的作用及分类
在软件的生产过程中,总是伴随着大量的信息要记录、要使用。
因此,软件文档在产品的开发生产过程中起着重要的作用。
(1)提高软件开发过程的能见度。
把开发过程中发生的事件以某种可阅读的形式记录在文档中。
管理人员可把这些记载下来的材料作为检查软件开发进度和开发质量的依据,实现对软件开发的工程管理。
(2)提高开发效率。
软件文档的编制,使得开发人员对各个阶段的工作都进行周密思考、全盘权衡、从而减少返工。
并且可在开发早期发现错误和不一致性,便于及时加以纠正。
(3)作为开发人员在一定阶段的工作成果和结束标志。
(4)记录开发过程中的有关信息,便于协调以后的软件、开发、使用和维护。
(5)提供对软件的运行、维护和培训的有关信息,便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解。
使软件开发活动更科学、更有成效。
(6)便于潜在用户了解软件的功能、性能等各项指标,为他们选购符合自己需要的软件提供依据。
文档在各类人员、计算机之间的多种桥梁作用中看出:
既然软件已经从手工艺人的开发方式发展到工业化的生产方式,文档在开发过程中就起到关键作用。
从某种意义上来说,文档是软件开发。
规范的体现和指南。
按规范要求生成一整套文档的过程,就是按照软件开发规范完成一个软件开发的过程。
所以,在使用工程化的原理和方法来指导软件的开发和维护时,应当充分注意软件文档的编制和管理。
对于充分发挥软件产品的效益,都有着重要的意义。
软件文档从形式上来看,大致可分为两类:
一类是开发过程中填写的各种图表,可称之为工作表格;另一类是应编制的技术资料或技术管理资料,可称之为文档或文件。
软件文档的编制,可以用自然语言,特别设计的形式语言,介于两者之间的半形式语言(结构化语言),各类图形表示。
表格来编制文档。
文档可以书写,也可以在计算机支持系统中产生,但它必须是可阅读的。
按照文档产生和使用的范围,软件文档大致可分为三类:
(1)开发文档:
这类文档是在软件开发过程中,作为软件开发人员前一阶段工作成果的体现和后一阶段工作依据的文档。
包括软件需求说明书、数据要求说明书、概要设计说明书、详细设计说明书、可行性研究报告、项目开发计划。
(2)管理文档:
这类文档是在软件开发过程中,由软件开发人员制定的需提交人员的一砦工作计划或工作报告。
使管理人员能够通过这些文档了解软件开发项目安排、进度、资源使用和成果等。
包括项目开发计划、测试计划、测试报告、开发进度月报及项目开发总结。
(3)用户文档:
这类文档是软件开发人员为用户准备的有关该软件使用、操作、维护的资料。
包括用户手册、操作手册、维护修改建议、软件需求说明书。
2.2软件文档所采用的标准
根据软件工程标准制定的机构和标准适用的范围,可分为5个层次:
国际标准:
ISO、国际标准化组织、国家标准:
GB中国ANSI美国BS英国JIS日本、行业标准:
IEEE、企业(机构)标准:
IBM项目(课题)标准:
CIMS。
标准标准标准
2.2软件文档的主要内容
软件文档的主要内容包括引言、任务概述,需求规定和运行环境规定。
引言包括:
编写的目的、背景、定义和参考资料。
编写的目的是说明编写这份需求说明书的目的,指出预期的读者。
背景开发包括:
待开发的系统的名称、本项目的任务提出者、开发者、用户、该系统同其他系统或其他机构的基本的相互来往关系。
定义是指列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
参考资料是指需要列出用得着的参考资料。
任务概述包括:
目标、用户的特点、假定和约束。
目标是指叙述该系统开发的意图、应用目标、作用范围以及其他应向读者说明的有关该系统开发的背景材料。
解释被开发系统与其他有关系统之间的关系;用户的特点是指列出本系统的最终用户的特点,充分说明操作人员、维护人员的教育水平和技术专长,以及本系统的预期使用频度;假定和约束是指列出进行本系统开发工作的假定和约束。
需求规定包括:
对功能的规定、对性能的规定、精度、时间特性要求、灵活性、输入输出要求、数据管理能力要求(针对软件系统)、故障处理要求和其他专门要求。
对功能的规定是指用列表的方式,逐项定量和定性地叙述对系统所提出的功能要求,说明输入什么量、经怎么样的处理、得到什么输出,说明系统的容量,包括系统应支持的终端数和应支持的并行操作的用户数等指标;精度是说明对该系统的输入、输出数据精度的要求,可能包括传输过程中的精度;时间特性要求是说明对于该系统的时间特性要求;灵活性是说明对该系统的灵活性的要求,即当需求发生某些变化时,该系统对这些变化的适应能力;输入输出要求是指解释各输入输出数据类型,并逐项说明其媒体、格式、数值范围、精度等。
对系统的数据输出及必须标明的控制输出量进行解释并举例;数据管理能力要求(针对软件系统)是指说明需要管理的文卷和记录的个数、表和文卷的大小规模,要按可预见的增长对数据及其分量的存储要求作出估算;故障处理要求是指列出可能的软件、硬件故障以及对各项性能而言所产生的后果和对故障处理的要求;其他专门要求是指如用户单位对安全保密的要求,对使用方便的要求,对可维护性、可补充性、易读性、可靠性、运行环境可转换性的特殊要求等。
运行环境规定包括:
设备、支持软件、接口和控制。
设备是指列出运行该软件所需要的硬设备。
说明其中的新型设备及其专门功能,包括:
处理器型号及内存容量、外存容量、联机或脱机、媒体及其存储格式,设备的型号及数量、输入及输出设备的型号和数量,联机或脱机;、数据通信设备的型号和数量和功能键及其他专用硬件;支持软件是指列出支持软件,包括要用到的操作系统、编译程序、测试支持软件等;接口是说明该系统同其他系统之间的接口、数据通信协议等;控制是说明控制该系统的运行的方法和控制信号,并说明这些控制信号的来源。
第3章实例
3.1******实例
数据库设计说明书(GB8567——88)
1引言
1.1编写目的
说明编写这份数据库设计说明书的目的,指出预期的读者。
1.2背景
说明:
a.说明待开发的数据库的名称和使用此数据库的软件系统的名称;
b.列出该软件系统开发项目的任务提出者、用户以及将安装该软件和这个数据库的计算站(中心)。
1.3定义
列出本文件中用到的专门术语的定义、外文首字母组词的原词组。
1.4参考资料
列出有关的参考资料:
a.本项目的经核准的计划任务书或合同、上级机关批文;
b.属于本项目的其他已发表的文件;
c.本文件中各处引用到的文件资料,包括所要用到的软件开发标准。
列出这些文件的标题、文件编号、发表日期和出版单位,说明能够取得这些文件的来源。
2外部设计
2.1标识符和状态
联系用途,详细说明用于唯一地标识该数据库的代码、名称或标识符,附加的描述性信息亦要给出。
如果该数据库属于尚在实验中、尚在测试中或是暂时使用的,则要说明这一特点及其有效时间范围。
2.2使用它的程序
列出将要使用或访问此数据库的所有应用程序,对于这些应用程序的每一个,给出它的名称和版本号。
2.3约定
陈述一个程序员或一个系统分析员为了能使用此数据库而需要了解的建立标号、标识的约定,例如用于标识数据库的不同版本的约定和用于标识库内各个文卷、、记录、数据项的命名约定等。
2.4专门指导
向准备从事此数据库的生成、从事此数据库的测试、维护人员提供专门的指导,例如将被送入数据库的数据的格式和标准、送入数据库的操作规程和步骤,用于产生、修改、更新或使用这些数据文卷的操作指导。
如果这些指导的内容篇幅很长,列出可参阅的文件资料的名称和章条。
2.5支持软件
简单介绍同此数据库直接有关的支持软件,如数据库管理系统、存储定位程序和用于装入、生成、修改、更新数据库的程序等。
说明这些软件的名称、版本号和主要功能特性,如所用数据模型的类型、允许的数据容量等。
列出这些支持软件的技术文件的标题、编号及来源。
3结构设计
3.1概念结构设计
说明本数据库将反映的现实世界中的实体、属性和它们之间的关系等的原始数据形式,包括各数据项、记录、系、文卷的标识符、定义、类型、度量单位和值域,建立本数据库的每一幅用户视图。
3.2逻辑结构设计
说明把上述原始数据进行分解、合并后重新组织起来的数据库全局逻辑结构,包括所确定的关键字和属性、重新确定的记录结构和文卷结构、所建立的各个文卷之间的相互关系,形成本数据库的数据库管理员视图。
3.3物理结构设计
建立系统程序员视图,包括:
a.数据在内存中的安排,包括对索引区、缓冲区的设计;
b.所使用的外存设备及外存空间的组织,包括索引区、数据块的组织与划分;
c.访问数据的方式方法。
4运用设计
4.1数据字典设计
对数据库设计中涉及到的各种项目,如数据项、记录、系、文卷、模式、子模式等一般要建立起数据字典,以说明它们的标识符、同义名及有关信息。
在本节中要说明对此数据字典设计的基本考虑。
4.2安全保密设计
说明在数据库的设计中,将如何通过区分不同的访问者、不同的访问类型和不同的数据对象,进行分别对待而获得的数据库安全保密的设计考虑。
3.2******实例
第4章实训日记
第5章实训总结
参考文献
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 学生 管理 系统软件 文档 软件 写作 报告
![提示](https://static.bdocx.com/images/bang_tan.gif)