一个软件工程设计示例3.详细设计说明书

详细设计说明书密级文档编号第版分册名称第册/共册校级（公共课）学生成绩管理系统详细设计说明书100版中南大学（某专业某年级某人）详细设计说明书总页数正文附录生效日期编制审核批准详细设计说明书1引言311编写目的312项目背景313定义314参考资料32总体设计421需求概述422软件结构43程序描述431数据库模块932成绩录入模块1433统计打印模块204接口设计2241外部接口2242内部接口235数据库设计23详细设计说明书1引言11编写目的为明确软件需求、安排项目规划与进度、组织软件开发与测试，撰写本文档。本文档供项目经理、设计人员、开发人员参考。12项目背景A项目的委托单位中南大学开发单位李明主管部门中南大学信息学院B该软件系统与其他1本软件系统的名称校级（公共课）学生成绩管理系统2该软件系统同其他系统或其他机构的基本的相互来往关系该系统基于IE浏览器，版本为60及以上，支持WINDOWS系列平台。13定义定义关键词如下HTTPHYPERTEXTTRANSFERPROTOCOL（超文本传输协议）IISINTERNET信息服务HTMLHYPERTEXTMARKUPLANGUAGE超文本标记语言ASPACTIVESERVERPAGESODBC开放数据库连接ADO活动存储对象IPOINPUTPROCESSOUTPUT输入、处理、输出CGICOMMONGATEWAYINTERFACE公用网关接口技术详细设计说明书14参考资料GB/T11457软件工程术语GB/T85661995计算机软件开发规范GB8567计算机软件产品开发文件编制指南国简标准软件2总体设计21需求概述校级（公共课）学生成绩管理系统分3个模块数据库模块、成绩录入模块和统计打印模块。数据库模块需要实现如建库、增加、插入、删除、修改、合并、查询等基本操作。成绩录入模块需要实现功能如下录入方式（顺序、非顺序）自动查错、灵活的输入（权交互）对特殊情况的标志及处理、统计打印全校补考成绩。统计各任课老师所教各班的考试成绩（平均、分段）。统计打印需要实现功能如下统计打印一个班考试成绩（上中、中下、下中、下末）统计打印一个班汇总成绩（上、下）统计打印全校考试成绩（分段、平均），统计打印全校汇总统计打印各班补考成绩。22软件结构系统构成图如下1数据库模块详细设计说明书管理员建立增加插入删除修改合并查询数据库2成绩录入模块非顺序灵活的输入（权交互）对特殊情况的标志及处理顺序录入方式3打印统计模块自动查错详细设计说明书统计打印班考试成绩（上中、中下、下中、下末）班汇总成绩（上、下）全校考试成绩（分段、平均）全校汇总成绩各班补考成绩221登录模块子模块名称子模块标识符父模块名称验证用户名密码L1登录模块判断用户类别并跳转L2登录模块222数据库模块子模块名称子模块标识符父模块名称添加课程添加教师添加学生添加操作添加管理员M1数据库模块删除学生删除管理员删除教师删除操作删除课程M2数据库模块修改管理员信息修改教师信息修改操作修改课程信息M3数据库模块查看操作查看管理员信息M4数据库模块详细设计说明书查看教师信息查看课程信息223成绩录入模块子模块名称子模块标识父模块名称个人信息操作T1数据库端考试成绩统计给定平时成绩学生成绩操作计算总成绩T2数据库端文档管理查看学生上交的文档T3数据库端224统计打印模块子模块名称子模块标识符父模块名称批改出成绩S1成绩录入端对成绩进行排序S2成绩录入端查看平均成绩查看查看总成绩S3成绩录入端流程图为详细设计说明书系统判别用户名和密码输入用户名和密码显示出错信息进入数据库模块进入成绩录入模块进入统计打印模块NOYES根据要做的操作判断进入哪个模块传输数据M1M2M3M4T1T2T3S1S2S33程序描述【逐个模块给出以下的说明】详细设计说明书31数据库模块311功能用户在登录界面输入用户名和密码，系统验证是否正确，并根据用户名判断用户类别，并跳转到相应的子模块；312性能项目名称输入处理输出数据来源权限设置1管理员输入用户名和密码身份验证根据用户要进行的操作判定下一步进入的模块管理员输入管理员操作313全局数据变量名称标识符类型使用方式访问方式描述数据库连接CONNSQLCONNECTION产生数据库连接操作动作只读在WEBCONFIG中定义连接字符串数据库命令CMDSQLCOMMAND产生数据库操作动作读写在每个页面定义数据适配器DASQLDATAADAPTER产生填充数据集的操作动作读写在每个页面定义数据集DSDATASET存放数据读写在每个页面定义数据表格DGDATAGRID显示数据读写根据页面需要定义数据读取DRDATAREADER读取数据只读在每个页面定义314局部数据变量名称标识符类型使用方式访问方式描述标识TAGINT仅使用只读标志函数过程中的状态,根据页面需详细设计说明书要定义标识TAG1INT仅使用只读标志函数过程中的状态,根据页面需要定义数据视图DVDATAVIEW仅使用只读为数据表格提供数据，根据页面需要定义父结点IDINTIDSTRING仅使用只读根据页面需要定义链接地址URLTOPICSTRING仅使用只读根据页面需要定义树结点对象TMPNDTREENODE仅使用只读根据页面需要定义DROPDOWNLIST对象MYCONTROL1DROPDOWNLIST仅使用只读控制DATAGRID中绑定的DROPDOWNLIST根据页面需要定义DROPDOWNLIST对象MYCONTROL2DROPDOWNLIST仅使用只读控制DATAGRID中绑定的DROPDOWNLIST根据页面需要定义DROPDOWNLIST对象MYCONTROL3DROPDOWNLIST仅使用只读控制DATAGRID中绑定的DROPDOWNLIST根据页面需要定义用户名UIDSTRING仅使用只读DATAGRID中绑定列中用户名的值根据页面需要定义课程COURSESTRING仅使用只读DATAGRID中绑定的DROPDOWNLIST所选取课程的值，根据页面需要定义年级GRADESTRING仅使用只读DATAGRID中绑定的DROPDOWNLIST所选取年级的值，根据页面需要定义班级CLASSSTRING仅使用只读DATAGRID中绑定的DROPDOWNLIST所选取班级的值，根据页面需要定义课程号NUMBERSTRING仅使用只读DATAGRID中绑定列中课程号的值根据页面需要定义详细设计说明书315存储过程名称使用参数描述CHOOSEIDUID从索引表中读取相应用户的信息DELETE_COURSETABLENUMBER删除课程表中相应教师的信息DELETE_INDEXTABLEUID从索引表中删除相应用户的信息INSERT_ADMINTABLEUIDPASSWORDPRIORITY从索引表中添加用户的信息INSERT_COURSETABLECOURSENUMBERCOURSENAME从课程表中添加课程信息INSERT_STUDENTUIDPASSWORDNAMEPRIORITYGRADECLASS从索引表中添加学生信息NSERT_STUDENTTABLEUIDCOURSENO从学生表，考试表中添加学生所学课程号INSERT_TEACHERUIDPASSWORDNAMEPRIORITYCOURSEGRADECLASS从索引表,教师表中添加教师信息SEARCHNAMEUIDPRIORITY从索引表中查询相应的用户信息SEARCH_ADMINTABLENAMEUID从索引表中查询相应的管理员信息SEARCH_COURSECOURSENONAME从课程表中查询相应的课程信息详细设计说明书SEARCH_TEACHERNAMEUID从教师表，索引表中查询相应的教师信息SELECT_ADMINTABLE无从索引表中读取管理员的信息SELECT_ALLUID从索引表中读取相应用户的信息SELECT_COURSE无从课程表中读取课程的信息SELECT_STUDENT无从索引表中读取学生的信息SELECT_TEACHER无从索引表，教师表中读取教师的信息UPDATE_ALLUID1UID2PASSWORDNAMESEXGRADECLASS更新索引表中用户的信息UPDATE_COURSETABLENUMBERNAME更新课程表中课程的信息UPDATE_STUDENTUIDGRADECLASS更新索引表中学生的信息UPDATE_TEACHERUIDCOURSEGRADECLASS更新教师表中教师的信息详细设计说明书316关系图详细设计说明书317限制条件只有身份为管理员的用户可以进入，不能跳过登录页面直接进入。318测试要点1、驱动模块和承接模块2、前置条件3、测试用例输入和预期结果32成绩录入模块321功能详细设计说明书成绩录入模块需要实现功能如下录入方式（顺序、非顺序）自动查错、灵活的输入（权交互）对特殊情况的标志及处理、统计打印全校补考成绩。统计各任课老师所教各班的考试成绩（平均、分段）。321性能3211添加操作项目名称输入（全部由院系输入）处理输出数据来源权限设置1添加教师姓名，性别，用户名，密码权限将教师信息添加到数据库输出教师添加成功界面管理员输入教师能够更改自己的信息2添加课程课程号，课程名将课程信息添加到数据库输出课程信息添加成功界面管理员输入3添加学生姓名，性别，年级，班级将学生信息添加到数据库输出学生信息添加成功界面管理员输入4添加管理员姓名，性别，用户名，密码权限将管理员信息添加到数据库输出管理员信息添加成功界面管理员输入管理员可以修改自己的信息3212删除操作项目名称输入（全部由院系输入）处理输出数据来源权限设置1删除教师用户名将教师信息从数据库消除输出教师删除成功界面管理员输入管理员操作2删除课程课程号将课程信息从数据库消除输出课程删除成功界面管理员输入管理员操作3删除学生学号将学生信息删除到数据库输出学生信息删除成功界面管理员输入管理员操作4删除管理员用户名，密码将管理员信息删除到数据库输出管理员信息删除成功界面管理员输入管理员操作详细设计说明书3213修改操作项目名称修改（全部由院系输入）处理输出数据来源权限设置1修改教师信息所教课程的课程名，年级，班级将修改后的教师信息保存到在数据库中输出教师信息修改成功界面管理员输入管理员操作，教师能够更改自己的信息1修改课程信息课程号，课程名将修改后的课程信息保存到在数据库中输出课程信息修改成功界面管理员输入管理员操作1修改管理员信息姓名，性别，用户名，密码将修改后的管理员信息保存到在数据库中输出管理员信息修改成功界面管理员输入管理员能够更改自己的信息3214查看操作项目名称查看（全部由院系输入）处理输出数据来源权限设置1查看教师信息在总表中查询按教师用户名查询教师基本信息；查看教师在数据库中的信息教师在数据库中的信息，除密码。管理员输入管理员操作1查看课程信息在课程表中查询按课程号查询查看课程在数据库中的信息输出课程号，课程名，所任老师，管理员输入管理员操作1查看管理员信息在总表中查询按用户名查询查看管理员在数据库中的信息管理员姓名，性别，用户名，权限管理员输入管理员操作323全局数据变量名称标识符类型使用方式访问方式描述数据库连接SQLCONNECTIONSQLCONNECTION产生数据库连接操作动作只读在WEBCONFIG中定义连接字符串数据库命令SQLCOMMSQLCOMMAND产生数据库操作动作读写在每个页面定义详细设计说明书AND数据适配器SQLDATAADAPTERSQLDATAADAPTER产生填充数据集的操作动作读写在每个页面定义数据集DATASETDATASET存放数据读写在每个页面定义数据表格DATAGRIDDATAGRID显示数据读写根据页面需要定义数据读取SQLDATAREADERDATAREADER读取数据只读在每个页面定义324局部数据变量名称标识符类型使用方式访问方式描述考试次数DROPDOWNLISTHOMEWORKDROPDOWNLISTDROPDOWNLIST仅使用只读绑定学生考试次数课程DROPDOWNLISTCOURSEDROPDOWNLISTDROPDOWNLIST仅使用只读绑定学生所能够选择的科目用户名USERIDSTRING仅使用只读DATAGRID中绑定列中用户名的值根据页面需要定义考试次数SELECTEDHOMEWORKSTRING仅使用只读DATAGRID中绑定的DROPDOWNLIST所选取课程的值，根据页面需要定义年级GRADESTRING仅使用只读DATAGRID中绑定的DROPDOWNLIST所选取年级的值，根据页面需要定义班级CLASSSTRING仅使用只读DATAGRID中绑定的DROPDOWNLIST所选取班级的值，根据页面需要定义课程号SELECTEDCOURSESTRING仅使用只读DATAGRID中绑定列中课程号的值根据页面需要定义详细设计说明书平时成绩比例DISCIPLINEPERCENTAGEINT仅使用可读写平时成绩比例期末成绩比例FINALPERCENTAGEINT仅使用可读写期末成绩比例成绩（单次）HOMEWORKSCOREINT仅使用可读写单次成绩325存储过程名称参数使用说明CHECKCOURSETEACHERIDVARCHAR12返回教师的课程CHECKRIGHTUSERIDVARCHAR12返回教师所管辖的年级和班级DOWNLOADHOMEWORKINT,TEACHERIDVARCHAR12,COURSENUMBERINT更新学生考试情况DOWNLOADSTUDENTHOMEWORKINT,TEACHERIDVARCHAR12,STUDENTIDVARCHAR12,COURSENUMBERINT检查单个学生考试情况SELECTALLCOURSE返回所有课程SELECTALLSTUDENTHOMEWORKHOMEWORKINT,USERIDVARCHAR12,COURSENUMBERINT查询所有学生的某次考试成绩SELECTALLSTUDENTSCOREUSERIDVARCHAR12,COURSENUMBERINT返回所有学生的总成绩信息SELECTCOURSEGRADEINT返回该年级的所有课程SELECTDOWNLOADTEACHERIDVARCHAR12,HOMEWORKINT,COURSENUMBERINT返回教师能够下载的所有考试的连接SELECTSTUDENTHOMEWORKUSERIDVARCHAR12,返回某个学生的某次考试成详细设计说明书HOMEWORKINT,TEACHERIDVARCHAR12,COURSENUMBERINT绩UPDATESTUDENTAVERAGEUSERIDVARCHAR12,TEACHERIDVARCHAR12计算某个学生的平均成绩UPDATESTUDENTHOMEWORKUSERIDVARCHAR12,HOMEWORKINT,HOMEWORKSCOREINT,TEACHERIDVARCHAR12,COURSENUMBERINT给学生的某次考试打分UPDATESTUDENTSCOREUSERIDVARCHAR12,DISCIPLINESCOREINT,FINALSCOREINT,TEACHERIDVARCHAR12给学生评定平时成绩和期末成绩UPDATESTUDENTTOTALSCOREHOMEWORKPERINT,DISCIPLINEPERINT,FINALPERINT,COURSENUMBERINT,TEACHERIDVARCHAR12计算学生总成绩326限制条件只有身份为教师的用户可以进入，不能跳过登录界面直接进入327测试要点1、驱动模块和承接模块2、前置条件3、测试用例输入和预期结果详细设计说明书33统计打印模块331功能统计打印需要实现功能如下统计打印一个班考试成绩（上中、中下、下中、下末）统计打印一个班汇总成绩（上、下）统计打印全校考试成绩（分段、平均），统计打印全校汇总统计打印各班补考成绩。332性能3321个人信息操作项目名称输入（全部由院系输入）处理输出数据来源权限设置1修改个人信息用户名，密码，姓名，性别，所授课程修改个人在数据中的信息输出教师修改成功界面教师输入教师操作3322学生成绩批改操作项目名称输入（全部由院系输入）处理输出数据来源权限设置1学生考试计分考试分数批改学生相应的考试成绩输出考试批改成功界面教师输入教师操作3323学生成绩排序操作项目名称输入（全部由院系输入）处理输出数据来源权限设置1考试成绩统计考试分数老师评改出考试成绩输出考试成绩教师输入教师操作详细设计说明书2给定平均成绩各科成绩分数电脑计算出平均成绩某科考试成绩相应学分然后再算出总合，然后再除以考试科目数输出平均考试成绩教师输入教师操作3计算总成绩各科考试成绩电脑计算出总成绩某科考试成绩相应学分然后再算出总合输出总成绩系统输入教师操作3324文档管理项目名称输入（全部由院系输入）处理输出数据来源权限设置1查看学生成绩文档查看命令连接到相应科目的子文件夹输出所有学生文档教师输入教师操作333全局变量名称标识符类型使用方式访问方式描述数据库连接CONNSQLCONNECTION产生数据库连接操作动作只读在WEBCONFIG中定义连接字符串数据库命令CMDSQLCOMMAND产生数据库操作动作读写在每个页面定义数据适配器DASQLDATAADAPTER产生填充数据集的操作动作读写在每个页面定义数据集DSDATASET存放数据读写在每个页面定义数据表格DGDATAGRID显示数据读写根据页面需要定义数据读取DRDATAREADER读取数据只读在每个页面定义SESSION对象SESSION“USERID“SESSION仅使用只读控制页面运行顺序详细设计说明书334局部数据变量名称标识符类型使用方式访问方式描述DIRECTORYINFO对象DIRECTORYOPERATORDIRECTOR