软件文档写作.docx

软件文档写作.docx

《软件文档写作.docx》由会员分享，可在线阅读，更多相关《软件文档写作.docx（23页珍藏版）》请在冰点文库上搜索。

软件文档写作

软件文档写作

题目学校学生学籍管理系统

学生姓名XXX

学生学号3号

专业班级会计+软件06-3班

页数页

完成日期2007年5月9日

文挡编号:

WD-STUDENT-SRS-070509

版本号:

V1.0

软件需求说明书

项目名称学校学生学籍管理系统

项目负责人XXX

项目开发单位大连交通大学软件学院

2007年5月9日

一、引言

编写目的

背景

定义

参考资料

二、任务概述

目标

用户的特点

假定和约束三、需求规定

对功能的规定

对性能的规定四、运行环境规定

设备

支持软件

一、引言

编写目的

本文档将要描述对小学的学生学籍管理系统的功能模块。

本文档的阅读者是项目策划，设计，评审人员，各科老师以及学生。

背景

本系统用Windows界面进入本系统，对操作人员的要求也不是很高，操作简单明了，可以直接通过键盘和鼠标来完成所有的功能:

包括输入，输出，查询，删除，修改以及文件的保存和调用。

进一步提高办学效益和现代化水平。

帮助广大教师提高工作效率，实现学生学籍信息管理工作流程的系统化、规范化和自动化。

本系统是以菜单及窗口的形式展现，选项清晰，按照用户所选择的各项功能进行处理。

能完美全面的完成用户的要求。

定义

STUDENT:

学生学籍管理

参考资料

《java课程设计》耿祥义，2003

《开发要求说明》

《系统功能说明书》

二、任务概述

目标

21世纪以来，人类经济高速发展，人们发生了日新月异的变化，特别是计算机的应用及普及到经济和社会生活的各个领域。

使原本的旧的管理方法越来越不适应现在社会的发展。

许多人还停留在以前的手工操作。

这大大地阻碍了人类经济的发展。

为了适应现代社会人们高度强烈的时间观念，学校学生档案信息管理系统软件为学校办公室带来了极大的方便。

在各大中小学校，用计算机管理学校的信息已经越来越普遍了。

用计算机不但可以提高工作效率，而且还节省了许多人力物力，增强了学校资料的安全性。

提高了学校的管理能力，为此，用计算机来管理学校的信息，是非常必要的。

学生档案管理是学校管理的一个重要内容。

随着时代的进步，学校也逐渐变的庞大起来。

如何管理好学生的信息，成为学校管理中的一个重要问题。

在这种情况下，一个可以规范化，自动化的学生档案管理系统就显的非常重要。

最初的学生档案管理，都是靠人力来完成。

当学校规模比较小的时候，人力可以完成，随着学校规模越来越大，学生的人数越来越多，依然维持着人力进管理必然会造成工作效率低，工作错误增高等问题。

学生档案管理系统就是把学生的信息实行统一，集中，规范的收集管理。

建立分类编号管理，电脑存贮查询以及防火，防潮，防盗等现代化，专业化的管理系统。

为学校老师和学生解除后顾之忧。

用户的特点

用户不需要任何的技术背景，就可以进行添加，修改，查询，删除等功能。

假定和约束

本软件的开发期限为三周。

完成项目的主要困难是缺乏C/S软件开发的背景和知识，缺少高质量的编辑器以及软件工程的实际经验。

三、需求规定

对功能的规定

本课题所研究的学生档案管理系统面对一般小学学校，主要内容包括:

“学生档案信息”、“课程信息”“学生成绩”“班级信息”“管理员信息”模块。

各个模块中都能实现对模块内信息的添加、修改、查询、删除等操作。

选择添加时，可以在数据库中添加一条新的学生记录。

选择修改时，可以对于已有的学生记录除了对其学号进行修改外，其他信息都可以修改。

当选择查询时，可以输入相应的选择条件将满足其条件的学生记录找到。

选择删除的话，可以将相应的学生记录从数据库中删除掉。

依据以上的需求，本系统需要完成的功能模块包括:

管理员登录:

管理员打开页面之后，输入用户名和密码进行登入。

添加操作员:

管理员可以添加和删除操作员，操作员只能操作系统，不能使用“添加操作员”的功能。

学生档案信息管理:

可以添加、修改、删除和查询学生档案信息。

班级信息管理:

可以添加、修改、删除班级。

课程信息管理:

可以添加、修改、删除和查询课程。

学生成绩信息管理:

可以添加、修改、删除和查询学生成绩。

退出系统:

管理员、操作员登录之后，可以退出系统。

学生档案管理系统

学生信息管理课程管理班级管理成绩管理管理员管理

班班成成成操操登学学学学课课课课班

生生生生程程程程级级级绩绩绩作作录信信信信信信信信信信信信信信员员退息息息息息息息息息息息息息息删添出添修删查添修删查添修删查添删除加系

加询加统除除加改除询加改除询改

根据学生档案管理系统的需求，设计对应的数据表及功能如下:

学生档案信息表:

存放学生基本信息相关的信息数据。

班级信息表:

存放班级基础信息数据。

课程信息表:

存放课程相关信息数据。

成绩信息表:

存放考试成绩详细信息数据。

管理员信息表:

存放管理员的相关信息数据。

操作员信息表:

存放操作员的相关信息数据

对性能的规定

1（精度

本软件对数据的精度没有特殊的要求。

2.时间特性要求

等待计算的时间不超过15秒。

3.灵活性

本软件采用可视化界面，用户通过单击界面上所显示的数字和回车键以及相关信息的输入就可以完成各项操作。

4.输入输出的要求

四、运行环境规定

设备

硬件最低要求:

内存32MB以上，硬盘15MB以上。

支持软件

操作系统:

Windows98/NT/2000/XP等能安装java2的操作系统。

文挡编号:

WD-STUDENT-SRS-070509

版本号:

V1.0

概要设计说明书

项目名称学校学生学籍管理系统

项目负责人XXX

项目开发单位大连交通大学软件学院

2007年5月9日

一、引言

编写目的

背景

定义

参考资料

二、总体设计

需求规定

运行环境

基本设计概念和处理流程

系统结构框架

功能需求与程序的关系

人工处理过程

三、接口设计

用户接口

外部接口

内部接口

四、系统出错处理设计

出错信息

补救措施

系统维护设计

一、引言

编写目的

本文档将要描述对小学的学生学籍管理系统的功能模块。

本文档的阅读者是项目策划，设计，评审人员，各科老师以及学生。

背景

本系统用Windows界面进入本系统，对操作人员的要求也不是很高，操作简单明了，可以直接通过键盘和鼠标来完成所有的功能:

包括输入，输出，查询，删除，修改以及文件的保存和调用。

进一步提高办学效益和现代化水平。

帮助广大教师提高工作效率，实现学生学籍信息管理工作流程的系统化、规范化和自动化。

本系统是以菜单及窗口的形式展现，选项清晰，按照用户所选择的各项功能进行处理。

能完美全面的完成用户的要求。

定义

STUDENT:

学生成绩管理

参考资料

《java课程设计》耿祥义，2003

《开发要求说明》

《系统功能说明书》

二、总体设计

需求规定

对功能的规定

本课题所研究的学生档案管理系统面对一般小学学校，主要内容包括:

“学生档案信息”、“课程信息”“学生成绩”“班级信息”“管理员信息”模块。

各个模块中都能实现对模块内信息的添加、修改、查询、删除等操作。

选择添加时，可以在数据库中添加一条新的学生记录。

选择修改时，可以对于已有的学生记录除了对其学号进行修改外，其他信息都可以修改。

当选择查询时，可以输入相应

的选择条件将满足其条件的学生记录找到。

选择删除的话，可以将相应的学生记录从数据库中删除掉。

依据以上的需求，本系统需要完成的功能模块包括:

管理员登录:

管理员打开页面之后，输入用户名和密码进行登入。

添加操作员:

管理员可以添加和删除操作员，操作员只能操作系统，不能使用“添加操作员”的功能。

学生档案信息管理:

可以添加、修改、删除和查询学生档案信息。

班级信息管理:

可以添加、修改、删除班级。

课程信息管理:

可以添加、修改、删除和查询课程。

学生成绩信息管理:

可以添加、修改、删除和查询学生成绩。

退出系统:

管理员、操作员登录之后，可以退出系统。

根据学生档案管理系统的需求，设计对应的数据表及功能如下:

学生档案信息表:

存放学生基本信息相关的信息数据。

班级信息表:

存放班级基础信息数据。

课程信息表:

存放课程相关信息数据。

成绩信息表:

存放考试成绩详细信息数据。

管理员信息表:

存放管理员的相关信息数据。

操作员信息表:

存放操作员的相关信息数据

对性能的规定

2（精度

本软件对数据的精度没有特殊的要求。

2.时间特性要求

等待计算的时间不超过15秒。

3.灵活性

本软件采用可视化界面，用户通过单击界面上所显示的数字和回车键以及相关信息的输入就可以完成各项操作。

4.输入输出的要求

运行环境

设备:

硬件最低要求:

内存32MB以上，硬盘15MB以上。

支持软件:

操作系统:

Windows98/NT/2000/XP等能安装java2的操作系统。

基本设计概念和处理流程

信息社会的高科技，商品经济化的高效益，使计算机的应用已普及到经济和社会生活的各个领域。

计算机虽然与人类的关系愈来愈密切，还有人由于计算机操作不方便继续用手工劳动。

为了适应现代社会人们高度强烈的时间观念，学生学籍管理系统软件为教学办公室带来了极大的方便。

该软件是以汉语编程语言为实现语言，其功能在系统内部有源代码直接完成。

通过用户使用手册，使用者可以了解本软件的基本工作原理。

操作人员只需输入一些简单的汉字、数字，即可达到自己的目标。

下就是详细的用户使用说明，通过阅读此使用说明，管理员能够方便的对信息进行输入，追加，修改，删除，查询，显示等操作。

系统结构框架

学生档案管理系统

学生信息管理课程管理班级管理成绩管理管理员管理

班成成成操操登学学学学课课课课班班

级级绩绩绩作作录生生生生程程程程级

信信信信信信信信信信信信信信员员退息息息息息息息息息息息息息息删添出添修删查添修删查添修删查添删除加系

询加统加改除询加改除询改除除加

功能需求与程序的关系

功能需求程序单元或模块（实现功能需求）

添加学生信息StudentSituation.java

修改学生信息StudentModify.java

删除学生信息StudentDelete.java

查询学生信息StudentInquest.java

添加课程信息LessonSituation.java

修改课程信息LessonModify.java

删除课程信息LessonDelete.java

查询课程信息LessonInquest.java

添加班级信息ClassSituation.java

修改班级信息ClassModify.java

删除班级信息ClassDelete.java

查询成绩信息ScoreInquest.java

添加成绩信息ScoreSituation.java

删除成绩信息ScoreDelete.java

添加操作员ManagerSituation.java

删除操作员ManagerDelete.java

登录退出系统System.java

人工处理过程

用户可以根据需要单击各种选择按钮，以决定系统进程。

三、接口设计

用户接口

本系统采用图形用户结构，以鼠标和键盘为用户接口，方便管理员对数据的操作。

外部接口

本系统提供基于Access的数据导入和导出功能，方便各类用户使用。

内部接口

本软件需要实现的内部接口是各个模块之间的接口。

四、系统出错处理设计

出错信息

1.输入的数据无法与文本文挡建立连接，即无法把信息写入文本文挡中。

2.当输入错误信息时，系统发出警告。

补救措施

1.提示无法建立连接。

2.提示输入数据错误。

系统维护设计

不需要另外再进行维护设计。

文挡编号:

WD-STUDENT-SRS-070509

版本号:

V1.0

详细设计说明书

项目名称学校学生学籍管理系统

项目负责人XXX

项目开发单位大连交通大学软件学院

2007年5月9日

一、引言

编写目的

背景

定义

参考资料

二、程序系统的结构

运行环境

系统组织结构三、程序设计说明程序描述

功能

性能

输入项

输出项

算法

流程逻辑

测试计划

一、引言

编写目的

本文档将要描述对小学的学生学籍管理系统的功能模块。

本文档的阅读者是项目策划，设计，评审人员，各科老师以及学生。

背景

本系统用Windows界面进入本系统，对操作人员的要求也不是很高，操作简单明了，可以直接通过键盘和鼠标来完成所有的功能:

包括输入，输出，查询，删除，修改以及文件的保存和调用。

进一步提高办学效益和现代化水平。

帮助广大教师提高工作效率，实现学生学籍信息管理工作流程的系统化、规范化和自动化。

本系统是以菜单及窗口的形式展现，选项清晰，按照用户所选择的各项功能进行处理。

能完美全面的完成用户的要求。

定义

STUDENT:

学生学籍管理

参考资料

《java课程设计》耿祥义，2003

《开发要求说明》

《系统功能说明书》

二、程序系统的结构

运行环境

设备:

硬件最低要求:

内存32MB以上，硬盘15MB以上。

支持软件:

操作系统:

Windows98/NT/2000/XP等能安装java2的操作。

系统组织结构

本系统大概可以分为两个模块:

授课教师使用模块和学生使用模块。

授课教师使用模块功能包括输入学生的资料，查询学生的资料，删除学生的资料，显示学生的资料，保存输入的资料，退出系统等功能。

三、程序设计说明

程序描述

本系统主要是对学生的学籍进行管理，通过创建一个学籍管理系统的总窗口，可以选择录入，修改，查询，删除等功能。

在这些功能上添加监视器，选择这些功能是就是触发了一个事件，这样能够进入到相应的界面进行操作。

选择录入时，可以在数据库中添加一条新的学生记录。

选择修改时，可以对于已有的学生记录除了对其学号进行修改外，其他信息都可以修改。

当选择查询时，可以输入相应的选择条件将满足其条件的学生记录找到。

选择删除的话，可以将相应的学生记录从数据库中删除掉

功能

1、执行System.java类的主要是一个窗口。

窗口上方时一个标签，是用来表达欢迎语的。

窗口下方是一个登录界面。

设置两个选择按钮，选择是管理员登陆或者操作员登录。

下方设置连个文本框输入用户名和密码，确认后进入系统。

2、ManagerSituation.java类创建的是一个操作员信息输入的界面。

其中包括3个文本条，

分别是ID，用户名，密码等。

在这页面的下端创建了两个按钮“录入”、“重置”。

这

两个按钮添加了监视器，单击录入的按钮就会将已填好的信息添加到数据库内，而单

击重置按钮就会将已填好的信息全部刷清，重新填写。

3、ManagerDelete.java类创建的是一个操作员信息删除的界面。

其中包括3个文本条，分

别是ID，用户名，密码等。

与ID文本条并列的是删除按钮，这个按钮因为添加了监

视器，所以当点击该按钮，计算机就会自动在数据库中查询与之前输入的ID相应的

那条记录，会弹出确认删除的对话框，单击“是”就会将该条信息从数据库中删除。

4、StudentSituation.java类创建的是一个学生信息添加的界面。

其中包括7个文本条，分

别是学号、姓名、父母姓名、联系电话、家庭住址、奖惩记载、学生简历等。

还有4个下拉列表按钮，分别是性别，出生日期，班级，入学年份等。

在这页面的下

端创建了1个按钮“添加”。

这个按钮添加了监视器，单击添加的按钮就会将已填好

的信息添加到数据库内。

5、StudentModify.java类创建的是一个学生信息修改的界面。

其中包括7个文本条，分别

是学号、姓名、父母姓名、联系电话、家庭住址、奖惩记载、学生简历等。

还有4个

下拉列表按钮，分别是性别，出生日期，班级，入学年份等。

在这页面的下端创建了

两个按钮“修改并保存”、“重置”。

这两个按钮添加了监视器，单击“修改并保存”

就会按照输入的学号将已对应的信息进行修改并保留在数据库内，而单击“重置”按

钮就会将已填好的信息全部刷清，重新填写。

6、StudentDelete.java类创建的是一个学生信息删除的界面。

其中包括7个文本条，分别

是学号、姓名、父母姓名、联系电话、家庭住址、奖惩记载、学生简历等。

还有4个

下拉列表按钮，分别是性别，出生日期，班级，入学年份等。

文本条下方有删除按钮，

这个按钮因为添加了监视器，所以当点击该按钮，计算机就会自动在数据库中查询与

之前输入的学号相应的那条记录，会弹出确认删除的对话框，单击“是”就会将该条

信息从数据库中删除。

7、StudentInquest.java类创建的是一个学生信息查询的界面。

其中包括2个文本条，分别

是学号、姓名。

还有1个下拉列表按钮，班级。

这些条件可以单独使用也可以联合使

用。

下拉列表按钮下面是查询按钮，这个按钮因为添加了监视器，所以当点击该按钮，

计算机就会自动在数据库中查询与之前输入的学号、姓名或者班级相应的记录，并且

将这个信息的内容显示在相应的文本条中。

8、LessonSituation.java类创建的是一个课程信息添加的界面。

其中包括2个文本条，分

别是课程号和课程名。

还有1个下拉列表按钮，上课年级。

在这页面的下端创建了1

个按钮“添加”。

这个按钮添加了监视器，单击添加的按钮就会将已填好的信息添加

到数据库内。

9、LessonModify.java类创建的是一个课程信息修改的界面。

其中包括2个文本条，分别

是课程号和课程名。

还有1个下拉列表按钮，上课年级。

在这页面的下端创建了两个

按钮“修改并保存”、“重置”。

这两个按钮添加了监视器，单击“修改并保存”就会

按照输入的学号将已对应的信息进行修改并保留在数据库内，而单击“重置”按钮就

会将已填好的信息全部刷清，重新填写。

10、LessonDelete.java类创建的是一个课程信息删除的界面。

其中包括2个文本条，分

别是课程号和课程名。

还有1个下拉列表按钮，上课年级。

文本条下方有删除按钮，

这个按钮因为添加了监视器，所以当点击该按钮，计算机就会自动在数据库中查询与

之前输入的学号相应的那条记录，会弹出确认删除的对话框，单击“是”就会将该条

信息从数据库中删除。

11、LessonInquest.java类创建的是一个课程信息查询的界面。

其中包括2个文本条，分

别是课程号和课程名。

还有1个下拉列表按钮，上课年级。

这些条件可以单独使用也

可以联合使用。

下拉列表按钮下面是查询按钮，这个按钮因为添加了监视器，所以当

点击该按钮，计算机就会自动在数据库中查询与之前输入的学号、姓名或者班级相应

的记录，并且将这个信息的内容显示在相应的文本条中。

12、ClassSituation.java类创建的是一个班级信息添加的界面。

其中包括2个文本条，分

别是班级名和班主任名。

在这页面的下端创建了1个按钮“添加”。

这个按钮添加了

监视器，单击添加的按钮就会将已填好的信息添加到数据库内。

13、ClassModify.java类创建的是一个班级信息修改的界面。

其中包括2个文本条，分

别是班级名和班主任名。

在这页面的下端创建了两个按钮“修改并保存”、“重置”。

这两个按钮添加了监视器，单击“修改并保存”就会按照输入的学号将已对应的信息

进行修改并保留在数据库内，而单击“重置”按钮就会将已填好的信息全部刷清，重

新填写。

14、ClassDelete.java类创建的是一个班级信息删除的界面。

2个文本条，分别是班级名

和班主任名。

文本条下方有删除按钮，这个按钮因为添加了监视器，所以当点击该按

钮，计算机就会自动在数据库中查询与之前输入的学号相应的那条记录，会弹出确认

删除的对话框，单击“是”就会将该条信息从数据库中删除。

15、ScoreSituation.java类创建的是一个学生成绩添加的界面。

页面上有一个文本条输

入学生学号。

在这页面的下端创建了1个按钮“提交”。

这个按钮添加了监视器，单

击添加的按钮就会将该学号的学生的成绩信息表显示出来。

包括一个输入成绩的文本

条和一个选择科目的下拉列表按钮。

在下方有一个“录入”按钮，这个按钮添加了监

视器，单击就会将已经填好的学生信息添加到数据库中。

16、ScoreInquest.java类创建的是一个学生成绩查询的界面。

其中包括3个文本条，分

别是学生号，姓名和课程号。

还有2个下拉列表按钮，分别是课程名和班级。

下拉列

表按钮下面是查询按钮，这个按钮因为添加了监视器，所以当点击该按钮，计算机就

会自动在数据库中查询与之前输入的信息向吻合的学生的成绩的记录，并且将这个信

息的内容显示在相应的文本条中。

17、ScoreDelete.java类创建的是一个学生成绩删除的界面。

其中包括3个文本条，分别

是学生号，姓名和课程号。

还有2个下拉列表按钮，分别是课程名和班级。

文本条下

方有删除按钮，这个按钮因为添加了监视器，所以当点击该按钮，计算机就会自动在

数据库中查询与之前输入的学号相应的那条记录，会弹出确认删除的对话框，单击

“是”就会将该条信息从数据库中删除。

性能

本模块对程序没有特殊要求。

输入项

本软件在输入上要求用户输入的都是字符类型。

输出项

对于用户选择的操作，软件会做出相应的反应，将信息反馈给用户。

算法

本程序没有采用特殊的算法。

流程逻辑

进入系统登陆

界面

选择用户身份

息

输入用户名、密码

否

用户名密码是否通过

过,

是

进入相应的使用者权限管理界面

测试计划

1.测试输入的数据是否与文本文挡建立连接，即无法把信息写入文本文挡中。

2.测试当输入错误信息时，系统是否报告错误。

文挡编号:

WD-STUDENT-SRS-070509

版本号:

V1.0

数据库设计说明书

项目名称学校学生学籍管理系统

项目负责人XXX

项目开发单位大连交通大学软件学院

2007年5月9日

一、引言

编写目的

背景

定义

参考资料

二、外部设计

标识符和状态

约定

专门指导三、结构设计

概念结构设计

逻辑结构设计

一、引言

编写目的

本文档将要描述对小学的学生学籍管理系统的功能模块。

本文档的阅读者是项目策划，设计，评审人员，各科老师以及学生。

背景

本系统用Windows界面进入本系统，对操作人员的要求也不是很高，操作简单明了，可以直接通过键盘和鼠标来完成所有的功能:

包括输入，输出，查询，删除，修改以及文件的保存和调用。

进一步提高办学效益和现代化水平。

帮助广大教师提高工作效率，实现学生学籍信息管理工作流程的系统化、规范化和自动化。

本系统是以菜单及窗口的形式展现，选项清晰，按照用户所选择的各项功能进行处理。

能完美全面的完