教学管理系统《详细设计说明书》.doc

1 案卷号案卷号 003003 日期日期2009.09.15 教学管理系统 详细设计说明书详细设计说明书 作 者： XXXXXX 完成日期： 2009.09.15 签 收 人： XXXX 签收日期： 2009.09.15 修改情况记录： 版本号修改人修订日期备注 V1.0.0 V1.0.1 V1.0.2 V1.0.3 2 1 引言引言.2 1.1 编写目的2 1.2 背景2 1.3 定义2 1.4 参考资料2 2 程序系统的结构程序系统的结构.2 3 程序程序 1（标识符）设计说明（标识符）设计说明2 3.1 程序描述3 3.2 功能3 3.3 性能3 3.4 输人项3 3.5 输出项3 3.6 算法3 3.7 流程逻辑3 3.8 接口3 3.9 存储分配4 3.10 注释设计4 3.11 限制条件4 3.12 测试计划4 3.13 尚未解决的问题4 4 程序程序 2（标识符）设计说明（标识符）设计说明4 3 详细设计说明书详细设计说明书 1 引言引言 1.1 编写目的编写目的 供编码设计人员使用，列出具体的功能模块。严格按照功能模块开发。 1.2 背景背景 说明： a 软件系统的名称：教学管理系统； b 本项目的任务提出者：XXXX c 开发者：XXXX d 用户：XXXXX e 运行该程序系统的计算中心。 1.3 定义定义 列出本文件中用到专门术语的定义和外文首字母组词的原词组。 1.4 参考资料参考资料 列出有关的参考资料，如： a 本项目的经核准的计划任务书或合同、上级机关的批文； b 属于本项目的其他已发表的文件； c 本文件中各处引用到的文件资料，包括所要用到的软件开发标准。列出这些文件 的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。 2 程序系统的结构程序系统的结构 用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的名称、标识 符和它们之间的层次结构关系。 使用的技术：SSHA 包层次 common.dao 4 CommonDAO.java /通用 DAO CommonDAOImpl.java BaseBiz.java /基本业务 common.util PageResult.java /分页信息 MyRequestProcessor.java /请求处理器,处理中文 edu.entity /全部实体类 IClassBiz.java /班级业务接口 IStudentBiz.java /学员业务接口 IDisciplineBiz.java /纪律业务接口 IOperateBiz.java /上机业务接口 IAttendBiz.java /考勤业务接口 IExamBiz.java /考务业务接口 IRightBiz.java /权限业务接口 .impl ClassBizImpl.java /班级业务实现类 StudentBizImpl.java /学员业务实现类 DisciplineBizImpl.java /纪律业务实现类 OperateBizImpl.java /上机业务实现类 AttendBizImpl.java /考勤业务实现类 ExamBizImpl.java /考务业务实现类 RightBizImpl.java /权限业务实现类 edu.form ClassForm.java /班级 FORM StudentForm.java /学员 FORM DisciplineForm.java /纪律 FORM OperateForm.java /上机 FORM AttendForm.java /考勤 FORM ExamForm.java /考务 FORM RightForm.java /权限 FORM edu.action ClassAction.java /班级 StudentAction.java /学员 DisciplineAction.java /纪律 OperateAction.java /上机 AttendAction.java /考勤 ExamAction.java /考务 RightAction.java /权限 5 界面命名： addStu.jsp添加学员 discipline.jsp学员的课堂表现 updateClass.jsp修改班级信息 updateStuInfo.jsp修改学员信息 missClassSearch.jsp学员缺课查询 dayTestEnter.jsp每日测试 dayTestSeach.jsp每日测试查看 operatRate.jsp上机完成率查看 operatRateSet.jsp上机完成率标准设置 operatRateEnter.jsp上机完成率录入 operatRateSearch.jsp上机成绩的查看 buildClass.jsp开班 graduTestEnter.jsp结业考试成绩导入 endClassSet.jsp结课班级设置 seachEndClass.jsp查询结课班级 attenRate.jsp班级出勤率查询 attenInfoEnter.jsp考勤信息录入 attenInfoSeach.jsp考勤详细信息查询 3 程序程序 1（标识符）设计说明（标识符）设计说明 从本章开始，逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对 一般情况的。对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内 容往往与它所隶属的上一层 模块的对应条目的内容相同，在这种情况下，只要简单地说明 这一点即可。 3.1 程序描述程序描述 给出对该程序的简要描述，主要说明安排设计本程序的目的意义，并且，还要说明本 程序的特点（如 是常驻内存还是非常驻？是否子程序？是可重人的还是不可重人的？有无 覆盖要求？是顺序处理还是并发处理等） 。 3.2 功能功能 说明该程序应具有的功能，可采用 IPO 图（即输入一处理一输出图）的形式。 6 3.3 性能性能 说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要求。 3.4 输人项输人项 给出对每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范 围、输入的方式。数量和频度、输入媒体、输入数据的来源和安全保密条件等等。 3.5 输出项输出项 给出对每一个输出项的特性，包括名称、标识、数据的类型和格式，数据值的有效范 围，输出的形式、数量和频度，输出媒体、对输出图形及符号的说明、安全保密条件等等。 3.6 算法算法 详细说明本程序所选用的算法，具体的计算公式和计算步骤。 3.7 流程逻辑流程逻辑 用图表（例如流程图、判定表等）辅以必要的说明来表示本程序的逻辑流程。 3.8 接口接口 用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序， 说明参数赋值和调用方式，说明与本程序相直接关联的数据结构（数据库、数据文卷） 。 3.9 存储分配存储分配 根据需要，说明本程序的存储分配。 3.10 注释设计注释设计 说明准备在本程序中安排的注释，如： a 加在模块首部的注释； b 加在各分枝点处的注释； c 对各变量的功能、范围、缺省条件等所加的注释； d 对使用的逻辑所加的注释等等。 7 3.11 限制条件限制条件 说明本程序运行中所受到的限制条件。 3.12 测试计划测试计划 说明对本程序进行单体测试的计划，包括对测试的技术要求、输入数据、预期结果、 进度安排、人员职责、设备条件驱动程序及桩模块等的规定。 3.13 尚未解决的问题尚未解决的问题 说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。 4 程序程序 2（标识符）设计说明（标识符）设计说明 项目编码 编号userID 角色号role_id 姓名userName 编号gradeID 学期编号termID 内部班级编号priGradeNO 班级类型gradeType 周课时数weekClassCount 开课日期beginDate 开班人数StartNumber 结课人数EndNumber 在读人数ReadingNumber 班级状态gradeState 结课日期endDate 考试日期examDate 结课状态endState 总部编号genNO 纪律编号showID 编号stuID 课堂状态showState 纪律日期showDate 学期编号termID 学期名称termName 每日测试编号testID 8 编号stuID 每日测试日期testDate 成绩testScore 编号operateID 编号 2stuID 上机成绩operateScore 上机日期operateDate 编号graduScoreID 编号 2stuID 结业考试日期graduScoreDate 上机成绩operateScore 笔试成绩paperScore 编号attendID 编号 2stuID 考勤状态 1attendState1 考勤状态 2attendState2 日期attendDate 编号stuID 编号 2gradeID 姓名stuName 姓名拼音stuPinyin 学历schoolRecord 性别gender 内部学号priStuNO 总部学号genStuNO 身份证号idCard 毕业学校graduSchool 专业special 工作状态workState 工作单位workUnit 学员状态stuState 工作种类workType 证书certificate 联系电话phone 通信地址postAddr