软件文档写作实训报告学生信息管理.docx
- 文档编号:27420987
- 上传时间:2023-06-30
- 格式:DOCX
- 页数:20
- 大小:28.99KB
软件文档写作实训报告学生信息管理.docx
《软件文档写作实训报告学生信息管理.docx》由会员分享,可在线阅读,更多相关《软件文档写作实训报告学生信息管理.docx(20页珍藏版)》请在冰豆网上搜索。
软件文档写作实训报告学生信息管理
辽宁工业大学
软件文档写作实训报告
题目:
学生信息管理系统软件文档
院(系):
软件学院
专业班级:
软件技术081班
学号:
13
学生姓名:
安凯辰
指导教师:
王彦华
教师职称:
助教
起止时间:
2010.11.22-2010.12.05
实训任务及评语
院(系):
软件学院教研室:
软件教研室
学号
13
学生姓名
安凯辰
专业班级
软件技术081班
实训题目
学生信息管理系统软件文档
实训任务
实训任务及要求:
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软件文档所采用的标准3
2.3软件文档的主要内容3
第3章实例4
3.1软件需求实例4
3.2项目开发计划实例11
第4章实训日记19
第5章实训总结20
第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)是应编制的技术资料或技术管理资料,可称之为文档或文件。
按照文档产生和使用的范围,软件文档大致可分为三类:
1)开发文档:
这类文档是在软件开发过程中,作为软件开发人员前一阶段工作成果的体现和后一阶段工作依据的文档。
包括软件需求说明书、数据要求说明书、概要设计说明书、详细设计说明书、可行性研究报告、项目开发计划。
2)管理文档:
这类文档是在软件开发过程中,由软件开发人员制定的需提交人员的一砦工作计划或工作报告。
使管理人员能够通过这些文档了解软件开发项目安排、进度、资源使用和成果等。
包括项目开发计划、测试计划、测试报告、开发进度月报及项目开发总结。
3)用户文档:
这类文档是软件开发人员为用户准备的有关该软件使用、操作、维护的资料。
包括用户手册、操作手册、数据要求说明书、软件需求说明书。
2.2软件文档所采用的标准
根据软件工程标准制定的机构和标准适用的范围,可分为5个层次:
国际标准、国家标准、行业标准、企业(机构)标准、项目(课题)标准。
9000标准概述:
9000是国际标准化组织建立以来制订和公布的几千个标准中,影响最深远和普及最迅速的一个,其对各国经济生活所起的以下特点作用不可低估。
我们在观察这一现象时,注意到9000的以下几个特点:
(1)国际性。
9000已成为各国对质量保证和质量管理制度的共同理解。
(2)完整性。
9000系列标准包含了术语、质量保证、质量管理到支持件技术标准及实施指南等一整套共计20个标准,形成了一个完整的体系结构。
(3)兼容性。
作为9000系列标准核心的三个质量保证标准是逐一包容的。
即9001标准的内容最全面,9002标准排除了设计工作的质量要求,仅限于生产制造过程,9003标准仅限于检验和试验工作的质量要求。
可以说,依次适用范围渐窄。
(4)主动性。
选用和实施9000标准、建立质量体系的主体,是企业的主动行为。
(5)可信性。
9000的认证是授权认证机构对供方质量体系进行的独立、公正的活动,因此,具有相当的说服力和可信度。
(6)指导性。
9000标准文本只是给出了质量管理和质量保证的原则,具体如何实施,需要供方结合自身机构的实际情况,特别是供方企业文化,进行创造性的解决。
(7)科学性。
9000标准的背后是现代质量管理的科学原理。
(8)实践性。
具体表现在,标准文本不是空洞的条文,并基于大量的质量管理实践。
如标准可向前追溯,得知其源于英国国家标准和美国军用标准等。
2.3软件文档的主要内容
我所做的软件文档是学生信息管理系统软件文档。
学生信息管理系统软件文档包括3个模块,其具体内容如下:
1)基本信息管理:
学生信息,成绩类型,课程信息。
2)教师管理:
教师教室。
3)系统用户管理:
用户信息,修改密码,切换用户。
第3章实例
3.1软件需求说明实例
软件需求说明书
1引言
1.1编写目的
在学生管理系统中,需要从大量的日常教学活动中提取相关信息,以反映教学情况。
传统的手工操作方式,易发生数据丢失,统计错误,劳动强度高,且速度慢。
使用计算机可以高速,快捷地完成以上工作。
在计算机联网后,数据在网上传递,可以实现数据共享,避免重复劳动,规范教学管理行为,从而提高了管理效率和水平。
学籍管理信息系统以计算机为工具,通过对教务管理所需的信息管理,管理人员从繁琐的数据计算及操作处理中解脱出来,使其有更多的精力从事教务管理政策的研究实施,教学计划的制定执行和教学质量的监督检查,从而全面提高教学质量。
1.2背景
本软件的功能和要求是解决高校对学生的管理的问题,为进一步完善学校的对学生档案学籍的管理,实现学生信息数据包括与学生有关的数据的管理与操作处理,具体实现学生学籍异动管理、档案管理。
基本数据流动为用户数据的输入,学生信息,课程信息,班级信息的输入,以及有关用户提出的对学生信息等等的查询要求所产生的数据输出。
本软件采用的数据库系统是,数据安全和保密有一定的保障。
开发此学籍管理系统软件,使教学人员及操作者进行学籍管理,方便操作者随时添加、查询、修改,使工作人员从繁琐的填表,查表工作中解放出来;使供需双方都获得满意的结果;促进报表、统计数字的规范化;提高工作效率;降低学籍管理维护费用,提高行政工作效率,改善服务质量,为学校领导决策提供支持,该软件的设计目标尽量达到人力与设备的节省,并且处理数据的速度提高。
该系统面向教务处、学生处、各院系、后勤管理和全校学生,实现对学生学籍及相关数据的管理等。
表1-1本系统的人员简介
软件的名称
学籍管理系统
任务提出者
王晏华老师
开发者
陈曙光、米希尔、倪中华、张士波。
用户
学生、老师、班主任、各级有关部门、系统管理员
适用范围
本校局域网范围内所有计算机
1.3定义
列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
1.4参考资料
1)肖刚,古辉,程振波,张元鸣。
实用软件文档写作。
北京:
清华大学出版社
2)于松涛,精通2000数据库管理与开发,北京:
人民邮电出版社,2001
2任务概述
2.1目标
开发意图,应用目标:
本软件旨在为各学校提供一个功能齐全、使用方便的学生学籍管理系统,以代替传统的手动管理方式。
并使老师同学掌握最新学校学生学籍的相关信息。
作用范围以及背景:
学生学籍管理工作是学校管理工作的重要组成部分,现在相当一部分学校的学生学籍管理工作仍沿用手工方式。
随着学校规模的扩大、学生人数的增加,效率低下、容易出错的手工方式越来越不适应实际管理工作的需要,利用计算机技术和数据库技术设计开发学生学籍管理系统、实现学生学籍管理工作的自动化成为学生管理部门的迫切需要。
开发相关的软件:
2003:
比较常用的一种数据库,自带的一种程序。
|
2.2用户的特点
本软件适用于各个学校,它可以迅速、准确、方便地提供学生学籍管理系统的各项管理功能,同时力求为用户提供方便、高效、实用的功能。
操作人员不需要很高的教育和技术水平,仔细阅读产品使用说明书经过简单的培训即可掌握对软件系统的操作。
软件系统的使用频度为一个学期的开始和结束对学生的学籍,课程,班级,专业,以及老师信息的管理。
由数据库的管理人员进行管理和维护。
学生跟老师是系统的用户。
2.3假定和约束
软件开发期限为2周,分工合作,按照工作计划完成。
软件系统为学习实验用,开发经费为0。
由于时间和掌握的知识技能有限,很多细节方面有待科学处理。
3需求规定
3.1对功能的规定
1.功能划分
·登录功能
·身份验证功能
·查询功能
·删除功能
·添加功能
·更新功能
·编辑功能
·生成报表功能
2.功能描述
(1)登录功能
登入界面有两种身份,如果你是教务管理人员,那么你登录时应该选择“教务管理人员”用这个身份登录。
如果你是学生,那么你选择“学生”这个身份,用这个身份登录系统。
(2)身份验证功能
如果你登录的密码或用户名是错误的,系统会提示你登录错误,请重复登录。
(3)查询功能
不论你时学生还是教务管理人员,你都有权利查询信息。
不过学生只能查询自己的信息不能查询其他学生的信息,而教务管理人员就不同了,他可以查询所用学生的信息。
(4)删除功能
这个功能只有你是以教务管理人员的身份登录后才有的功能。
所以这是教务管理人员独有的权利。
删除一位学生的信息,并且提供确认机制。
(5)添加功能
与删除功能一样只有教务管理人员才有的。
添加一位学生的信息,并且提供确认机制。
(6)更新功能
与删除功能一样只有教务管理人员才有的。
更新学生的信息。
(7)编辑功能
也是只有教务管理人员才有的功能。
编辑功能其实就是修改学生的信息。
(8)报表生成功能
只有教务管理人员才有的功能。
把学生的基本信息导出来。
可以用打印机打印出来。
3.2对性能的规定
3.2.1精度
查询时应保证查询所有的相关信息。
即保证查全率。
查询时应保证你所查信息的准确率。
3.2.2时间特性要求
一般操作的响应时间应在1~2秒内,对软件磁盘和打印机的操作,以及数据的导入和导出也是在可以接受的范围内完成。
3.2.3灵活性
1.外部接口需求
(1)用户界面:
采用的通用图形界面,对用户友好,且必须对鼠标和
键盘提供支持,界面的设计应遵循如下的规则.
界面要具有一致性,界面规范应遵循软件的界面的规范。
提供简单的错误处理。
提供信息反馈,画面要简洁明快,富有现代气息。
(2)硬件接口支持一般的机或更高的微机,笔记本。
(3)软件接口运行于的操作系统。
3.3输人输出要求
对数据操作如删除和修改时,除了数据类型的属性,一般都是型,如果输入过长或者不输入时,本系统均有异常处理,提示用户输入正确的数据。
3.4数据管理能力要求
1.静态数据各位学生的信息。
2.动态数据输入数据:
学生的各种信息,输出数据:
查询的结果及各位学生的信息报表。
数据库介绍我使用的数据库是最简单的一种即数据库;
3.5故障处理要求
正常运行时不应出错,若出现某些系统故障,本系统采用了数据库恢复技术,保证了数据库完好,提高了系统的性能。
3.6其他专门要求
1)可维护性:
学生管理系统在运行时发现错误,能够快速、准确对其定位、诊断和修改。
2)易读性:
为了能让用户方便实用学生管理系统,界面设计符合目前界面规范。
3)复用性:
对系统内模块接口尽可能的达到高内聚、低耦合的程度,提
了本系统的复用性。
4)安全保密性:
要进入本系统,须经过身份认证,对于输入密码或用户名不正确的不允许登入本系统提高了系统安全性。
4运行环境规定
4.1设备
硬件、外部设备(P4微机一台、打印机一台)
运行本软件所要求的硬设备的最小配置:
a. 奔腾4代、内存256M;
I/O设备:
显示器、鼠标、键盘;
4.2支持软件
1).操作系统:
98及以上版本
2).支撑框架:
1.1
3).数据库:
2000。
4).2005编译软件。
4.3接口
1)用户界面:
采用的通用图形界面,对用户友好,且必须对鼠标和键盘提供支持,界面的设计应遵循如下规则。
●界面要具有一致性,界面规范应遵循软件界面的规范;
●提供简单的错误处理
●提供信息反馈,用多种信息提示用户当前软件运行状态、软件界面元件的功能;
●操作可逆,其动作可以是单个的操作,或者是一个相对独立的操作序列;
●设计良好的联机帮助;
●显示启动画面,画面简洁明快,富有现代气息,不能太过花哨;
●应遵循国家关于计算机词汇的标准,用词应当简练准确,没有歧义,图形的意义明朗。
2)硬件接口:
支持一般的PⅡ或更高档微机、笔记本电脑。
3)软件接口:
运行于95/982000,且具有32的操作系统之上。
4)通信接口:
本软件应提供电子邮件、浏览器等的支持。
5)故障处理:
正常使用时不应出错,若运行时遇到不可恢复的系统错误,也必须保证数据库的完好无损。
4.4控制
该软件用户主要通过键盘及鼠标来操作。
3.2项目开发计划实例
项目开发计划(8567——88)
1引言
1.1编写目的
编写本文档是为了详细,准确和全面的定义“学生信息管理系统”的概要设计。
指导软件系统的第三个阶段。
它把系统的详细设计和需求分析设计结合起来对系统进行说明,大体阐述系统的功能是怎么实现的,以及功能与功能之间的关联。
提供一个操作和说明的基准。
本文档的读者对象包括:
1)系统分析人员
2)软件设计人员
3)软件实现人员
4)软件测试人员
1.2背景
本项目作为《软件文档写作》课程的训练项目的提出,可使我们了解软件文档的相关标准和编写原则,训练并掌握软件各类文档写作的技巧。
开发软件名称:
学生信息管理系统。
项目任务提出者:
老师。
项目开发者:
陈曙光、米希尔、张士波、倪中华。
用户:
学校。
实现软件单位:
学校。
项目与其他软件,系统的关系:
本项目采用客户机/服务器原理,客户端的程序是建立在以及更高的操作系统上,采用2.0以上版本的开发软件的应用程序,服务器端采用以及更高的操作系统的工作站。
1.3定义
1):
套接字
2):
传输控制协议/网络协议
3):
流输入输出
4):
客户端/服务器
5):
操作系统
6):
序列化
7):
反序列化
1.4参考资料
[1]张海藩.软件工程导论.北京:
清华大学出版社2005.
[2]郑人杰.实用软件工程.北京:
清华大学出版社2005.
[3]肖刚.实用软件文档写作.北京:
清华大学出版社2009.
[4](美)罗宾逊,(美)内格尔著,李敏波翻译,高级编程(第3版)[M],清华大学出版社,2005年6月。
[5][美]佩佐尔特著,杨涛等译,程序设计[M],机械工程出版社,2004年4月。
2项目概述
2.1工作内容
成绩管理简要描叙:
此模块实现对学生成绩的增删改查。
目的和意义:
随着学校的扩展,学校的学生越来越多,少则几十人、多则上万人。
例如我们学校就有几万人,为了能够更好的了解,知道这些学生的信息,修改学生的信息,学校必须要有一个好的管理系统,管理学生的信息。
根据这个问题提出了这个系统的开发。
我们根据这些问题开发了一个小型的学籍信息管理系统。
而对学生的成绩进行管理是管理学生信息的重要部分。
程序的特点:
该程序是常驻内存的,属于子程序,没有覆盖的要求,属于顺序处理。
说明该程序应具有的功能,可采用图(即输入一处理一输出图)的形式。
模块名称
成绩管理
模块代码
输入
功能
输出
2010年4月29日
学生的相关信息(学号,姓名,教室,课程名,分数,类型,状态)
把学生的相关信息存入数据库
提示操作成功或错误信息
启动条件
该用户拥有添加学生成绩的权限
模块名称
成绩管理
模块代码
输入
功能
输出
2010年4月29日
学生的相关信息(学号)
把该学号关联的学生的相关信息从数据库中删除
提示操作成功或错误信息
启动条件
该用户拥有删除学生成绩的权限
模块名称
成绩管理
模块代码
输入
功能
输出
2010年4月29日
学生的相关信息(学号,姓名,教室,课程名,分数,类型,状态),按钮命令
把学生的修改后的相关存入数据库
提示操作成功或错误信息
启动条件
该用户拥有学生成绩的权限
模块名称
成绩管理
模块代码
输入
功能
输出
2010年4月29日
学号,按钮命令
显示学生的相关学习成绩信息
提示操作成功或错误信息
启动条件
该用户拥有查询学生成绩的权限
根据内容分工:
每人设计不同模块。
2.2主要参加人员
本组成员:
倪中华(组长),米希尔,张士波,陈曙光。
对于本系统,每个人都能对系统进行相应的运行,对于自己设计部分,更能有着更全面的解释。
相关的更新和维护,本组成员一起完成!
每个成员都有系统的程序设计学习与操作经验,都能熟练地运用、等语言
2.3产品
2.3.1程序
移交给最终用户的内容包括完整的软件081班学生信息管理系统,以及相关的代码、使用说明书及范例。
采用的、编码。
使用
2.3.2文件
列出须移交用户的每种文件的名称及内容要点。
2.3.3服务
系统可以实现对不同权限人员的相关信息查询、信息更新、修改和文档的打印输出等信息服务,如:
学生信息管理人员方面:
学生信息的查询,更新、修改和文档打印,以及系统的正常维护和维修等。
学生和相关人员方面:
学生信息的查询、和打印等可行
2.3.4非移交的产品
1.在项目开发过程中所编写的各种文档,例如《项目问题处理跟踪表》,《项目跟踪》,《项目变更通知单》,《里程碑》,《评审检查》等。
2.涉及到原创的专利技术的某些程序。
2.4验收标准
1.系统运行流畅,出错率为:
2次/年;
2.文档:
(1)项目开发计划:
是否按软件文档国家标准建立文档;和客户陈述的需求是否有偏离,如果有,是否有正当的理由解释偏离的原因;是否有明确的开发进度;成本预算是否真实可靠;是否列出了风险和应对风险相关的计划;是否完成了文档地评审;文档是否全部完成。
(2)资金分配方案:
是否按软件文档国家标准建立文档;资金分配的预计方案是否真实可靠;是否列出了风险和应对风险相关的计划;是否完成了文档地评审;文档是否全部完成。
(3)系统使用手册:
是否全面地详细地将使用方法准确地表达出来;里面地信息是否真实可靠;是否将使用该系统时应注意地事项写入其中;是否完成了文档地评审;文档是否全部完成。
(4)系统维护手册:
是否需要特殊技能,如果需要,如何得到这样的资源;是否完成了文档地评审;文档是否全部完成。
3.服务:
(1)人员培训:
是否熟练掌握了该系统的使用方法;是否清楚用户所需的各功能如
何实现;
(2)系统安装:
系统是否正常运行;
(3)系统保修:
发生故障是否能及时得到解决并保证保修质量;服务态度是否友好;(4)系统维护:
是否保证定期对系统进行检查;是否保证该系统可以及时得到升级。
2.5完成项目的最迟期限
完成最后期限为:
2011-01-12
2.6本计划的批准者和批准日期
批准单位:
辽宁工业大学教务处
批准日期:
2010年11月24日
3实施计划
3.1工作任务的分解与人员分工
软件需求与开发计划陈曙光
概要设计和用户手册米希尔
数据库设计和操作手册倪中华
详细设计和测试分析张士波
3.2接口人员
负责接口工作的人员及他们的职责,包括:
a.负责本项目同用户的接口人员:
陈曙光
b.负责本项目同本单位各管理机构,如合同计划管理部门、财务部门、质量管理部门等的接口人员:
倪中华
c.负责本项目同个份合同负责单位的接口人员:
张士波
3.3进度
2010.11.20-2010.11.21:
初步完成需求分析、系统设计规划,熟悉系统和环境以及数据库开发环境。
2010.11.21-2010.11.27:
设计数据应用程序、开发数据库、编写数据服务代码、完成界面布置。
2010.11.28-2011.11.30:
初步完成开发,进行调试及代码优化。
3.4预算
由于该系统是开发人员的学习过程,在资金方面不需要很大的支出,只需有机一台,大约指出为4000元人民币,该费用由学校提供。
3.5关键问题
对于开发人员来说,由于是学习,本项目实现的关键不在于已经相对熟悉的操作系统环境以及数据库开发环境。
而在于数据库之间的逻辑关系编程,和能否把整个系统组装在一起。
这也是开发系统能否给人以可信度的关键。
本项目最终的理想实现途径是学校的学生信息的管理。
但作为学生实践项目,在演示阶段,我们需要更容易实现学生信息的管理。
4支持条件
4.1计算机系统支持
推荐配置:
客户机 奔腾以上处理器内存512M以上硬盘10G以上
服务器奔腾或至强处理器内存1G硬盘
各普通用户和管理员的计算机都使用机,操作系统使用公司的中文2000操作系统;数据库服务器采用公司的2000操作系统;测试操作系统采用20004,应用系统采用2003。
4.2需由用户承担的工作
考虑到本项目的最终用户为学生,学校应向本系统开放其内部数据库资源,以便实现所有功能。
4.3由外单位提供的条件
此项暂缺。
5专题计划
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 软件 文档 写作 报告 学生 信息管理