项目-数据库设计说明手册
- 格式:doc
- 大小:173.50 KB
- 文档页数:29
数据库设计规范说明书数据库设计规范说明书1引⾔引⾔是对这份数据库设计说明书的概览,是为了帮助阅读者了解这份⽂档是如何编写的,并且应该如何阅读、理解和解释这份⽂档。
1.1编写⽬的说明数据库设计说明书是为哪份软件产品编写的,开发这个软件产品的意义、作⽤以及要达到的意图。
通过这份数据库设计说明书详尽准确描述该软件产品的数据库结构。
如果这份数据可设计说明书只是与整个系统的某⼀部分有关系,那么只定义数据库设计说明书中说明的那个部分或⼦系统。
1.2项⽬来源具体说明本软件开发项⽬的全部风险承担者,以及各⾃在本阶段所需要承担的主要风险,⾸先风险承担者包括:任务提出者:软件开发者:产品使⽤者:1.3⽂档约定描述编写⽂档时所采⽤的各种排版约定。
排版约定应包括:命名⽅法;提⽰⽅法;通配符号;等等。
1.4预期读者和阅读建议列举本数据库设计说明书所针对的各种不同的预期读者。
例如可能包括:开发⼈员;项⽬经理;测试⼈员;⽂档编写⼈员;并且描述了⽂档中其余部分的内容及其组织结构,并且针对每⼀类读者提出最合适的⽂档阅读建议。
1.5参考资料列举编写数据库设计规格说明书中⽤到的参考⽂献及资料,可能包括:本项⽬的合同书;a.上级机关⽂件有关本项⽬的批⽂;b.本项⽬已经批准的计划任务书;c.⽤户界⾯风格指导;d.开发本项⽬时所要⽤到的标准;e.系统规定需求说明;f.使⽤实例⽂档;g.属于本项⽬的其他已发表的⽂件;h.本数据库设计说明书中所引⽤⽂件、资料;i.相关软件产品数据库设计说明书等等;为了⽅便读者查阅,所有参考资料应该按⼀定顺序排列。
如果可能,每份资料都应该给出:a.标题名称;b.作者或合同签约者;c.⽂件编号或者版本号;d.发表⽇期或者签约⽇期;e.出版单位或者资料来源。
格式如下:[标识符]作者,⽂献名称,出版单位(或归属单位),⽇期1.6术语与缩写解释列出本⽂件中⽤到的专门术语和外⽂⾸字母组词的原词组。
2数据库命名规则完整并且清楚的说明本数据库的命名规则,如果本数据库的命名规则与机构的标准不⼀致的话,请作出解释。
沟 通 从 心 开 始REACHING OUT FROM THE HEART. . . . . . .项目编码:中国移动广东公司【培训管理系统】详细设计说明书(LLD)版本 <V 1.2 >保存期限:拟制 日期 审核 日期 批准日期声明本文件所有权和解释权归CMGD所有,未经CMGD书面许可,不得复制或向第三方公开。
修订历史记录目录1.引言 (4)1.1.目的 (4)1.2.文档范围 (4)1.3.缩略词 (4)1.4.参考资料 (4)2.系统介绍 (4)2.1.系统概述 (4)2.1.1.系统主界面介绍 (5)2.1.2. 资源管理 (5)2.1.3. 培训业务管理 (6)2.2.系统架构 (12)2.3.接口设计 (12)2.3.1向微学习推送调研接口 (12)2.3.2 从微学习获取调研接口 (12)2.3.3 提供给u平台调用的报名培训班列表 (13)2.3.4同步用户使用了BizService接口 (13)2.3.5同步组织使用了BizService接口 (13)2.3.6用户登录验证使用了portal接口 (13)2.3.7用户登录token验证使用了portal接口 (13)2.3.8短信发送使用了/SMSMeipWebService/SMSServer接口 (14)2.4.系统适用人员 (14)3.系统设计说明 (14)3.1.数据库说明 (14)3.2.系统架构说明 (15)3.2.1 系统文件结构说明 (15)3.2.2 数据库访问类MySQLHelper.php (16)3.2.3 培训班管理类TrainingClassDAL.php (20)3.2.4 程序执行流程说明 (28)4.场景 (31)4.1.培训需求调研 (31)4.2.制定培训计划 (32)4.3.培训报表查询 (33)1. 引言为进一步促进培训业务整合,实现面授、Elearning和微学习等模式一体化的管理和规范化培训项目开展,同时根据各级培训管理员在人力资源系统培训管理模块中使用反馈的优化建议,设计开发了本系统。
公路水路交通运输信息共享与服务系统一期工程(XX子系统)数据库设计说明书版本历史签字页目录第一章引言11.1标识11.2数据库概述11.3文档概述1第二章引用文件2第三章数据库级设计决策3第四章数据库详细设计4第五章运用设计65.1数据字典设计65.2安全设计6第六章用于数据库访问或操纵的软件配置项的详细设计7第七章需求的可追踪性10第八章注解11第九章附录12第一章引言1.1标识本条应包含本文档适用的数据库的完整标识,(若适用)包括标识号、标题、缩略词语、版本号、发行号。
1.2数据库概述本条应简述本文档适用的数据库的用途。
它应描述数据库的一般性质;概括它的开发、使用和维护的历史;标识项目的投资方、需方、用户、开发方和支持机构;标识当前和计划的运行现场;并列出其他有关文档。
1.3文档概述本条应概括本文档的用途与容,并描述与其使用有关的性或私密性要求。
第二章引用文件本章应列出本文档引用的所有文档的编号、标题、修订版本和日期。
也应标识不能通过正常的供货渠道获得的所有文档的来源。
第三章数据库级设计决策本章应根据需要分条给出数据库级设计决策,即数据库行为设计决策(从用户的角度看,该数据库如何满足它的需求而忽略部实现)和其他影响数据库进一步设计的决策。
如果所有这些决策在系统或CSCI需求中均是明确的,本章应如实述。
对应于指定为关键性需求(如安全性、性、私密性需求)的设计决策,应在单独的条中加以描述。
如果设计决策依赖于系统状态或方式,则应指出这种依赖性。
如果设计决策的部分或全部已在定制的或商用的数据库管理系统(DBMS)的文档中作了描述,本章可引用它们。
应给出或引用理解设计所需的设计约定。
数据库级设计决策的例子如下:a.关于该数据库应接受的查询或其他输入和它应产生的输出(显示、报告、消息、响应等)的设计决策,包括与其他系统、HWCI,CSCI和用户的接口(本文的5.x.d标识了本说明要考虑的主题)。
如果该信息的部分或全部已在接口设计说明(IDD)中给出,此处可引用。
DR-RD-020(V1.1)Xxx系统数据库设计说明书(内部资料请勿外传)编写:日期:检查:日期:审核:日期:批准:日期:XX公司版权所有不得复制XXX系统 (1)数据库设计说明书 (1)1引言 (2)1.1编写目的 (2)1.2术语表 (2)1.3参考资料 (3)2数据库环境说明 (3)3数据库的命名规则 (4)4逻辑设计 (4)5物理设计 (5)5.1表汇总 (5)5.2表[X]:[XXX表] (5)5.3视图的设计 (7)5.4存储过程、函数及触发器的设计 (7)6安全性设计 (7)6.1防止用户直接操作数据库的方法 (7)6.2用户帐号密码的加密方法 (8)6.3角色与权限 (8)7优化 (8)8数据库管理与维护说明 (8)一、引言1.1 编写目的例如:本文档是xx系统概要设计文档的组成部分,编写数据库设计文档的目的是:明确数据库的表名、字段名等数据信息,用来指导后期的数据库脚本的开发,本文档遵循《xx 数据库设计和开发规范》。
本文档的读者对象是需求人员、系统设计人员、开发人员、测试人员。
1.2 术语表1.3 参考资料列出有关资料的名称、作者、文件编号或版本等。
参考资料包括:a.需求说明书、架构设计说明书等;b.本项目的其他已发表的文件;二、需求规约提示:本部分完成此数据库系统业务描述和需求分析2.1 业务描述提示:本部分完成此数据库系统的业务描述,例如:(1)数据库系统创建的背景(2)数据库系统要解决的问题(3)数据库系统要完成的业务流程及工作内容(4)揭示该数据库的资源需求和设计约束2.2 需求分析提示:本部分完成此数据库系统的需求分析,例如:(1)分析该业务流程的内在联系(2)业务流程各个节点的依赖关系在数据上的反映(3)揭示创建此数据库系统的目的、目标、已知条件(4)将业务流程节点抽象成数据库对象三、数据库环境说明提示:(1)说明所采用的数据库系统,设计工具,编程工具等(2)详细配置例如:四、数据库的命名规则3.1 数据库对象命名规则提示:(1)说明本数据库的命名规则,例如:本数据库设计完全按照《xx数据库设计规范》命名。
计算机软件产品开发文件编制指南GB 8567-88 Guidelines for computer software product development documentation 中华人民共和国国家标准UDC681.3引言1 目的一项计算机软件的筹划、研制及实现,构成一个软件开发项目。
一个软件开发项目的进行,一般需要在人力和自动化资源等方面作重大的投资。
为了保证项目开发的成功,最经济地花费这些投资,并且便于运行和维护,在开发工作的每一阶段,都需要编制二定的文件。
这些文件连同计算机程序及数据一起,构成为计算机软件。
文件是计算机软件中不可缺少的组成部分,它的作用是:a.作为开发人员在一定阶段内的工作成果和结束标志;b.向管理人员提供软件开发过程中的进展和情况,把软件开发过程中的一些“不可见的”事物转换成“可见的”文字资料。
以便管理人员在各个阶段检查开发计划的实施进展,使之能够判断原定目标是否已达到,还将继续耗用资源的种类和数量;C.记录开发过程中的技术信息,便于协调以后的软件开发、使用和修改;d.提供对软件的有关运行、维护和培训的信息,便于管理人员、开发人员、操作人员和用户之间相互了解彼此的工作;e.向潜在用户报导软件的功能和性能,使他们能判定该软件能否服务于自己的需要。
换言之,本指南认为:文件的编制必须适应计算机软件整个生存周期的需要。
计算机软件所包含的文件有两类:一类是开发过程中填写的各种图表,可称之为工作表格;另一类则是应编制的技术资料或技术管理资料,可称之为文件。
本指南规定软件文件的编制形式,并提供对这些规定的解释。
本指南的目的是使得所编制的软件文件确实能够起到软件文件应该发挥的作用。
2 范围本指南是一份指导性文件。
本指甫建议,在一项计算机软件的开发过程中,一般地说,应该产生十四种文件。
这十四种文件是:可行性研究报告;项目开发计划;软件需求说明书;数据要求说明书;概要设计说明书;详细设计说明书;数据库设计说明书;用户手册;操作手册;模块开发卷宗;测试计划;测试分析报告;开发进度月报;项目开发总结报告。
数据库需求规格说明书数据库需求规格说明书1.引言本文档旨在详细描述数据库的需求,以指导数据库的设计与实现。
包括数据库的功能需求、性能需求、安全需求和可维护性需求等。
2.项目概述介绍该数据库项目的背景和目的,以及所涉及的系统环境和相关方。
3.功能需求3.1 数据库系统功能描述数据库所需的基本功能,包括数据的增加、删除、修改、查询,权限管理,事务管理等功能。
3.2 数据库结构详细描述数据库的关系模式、表结构和数据字典。
包括各个表的字段、类型、长度、约束等信息。
3.3 数据处理描述数据库需要支持的数据处理需求,如数据清洗、数据转换、数据导入导出等。
4.性能需求4.1 数据存储与访问描述数据库的存储需求,包括数据量预估、存储介质和存储结构等。
4.2 查询性能描述数据库查询的性能需求,包括查询响应时间、并发查询支持等。
4.3 事务处理性能描述数据库事务处理的性能需求,包括事务处理的并发能力、事务提交和回滚的速度等。
5.安全需求5.1 数据保密性描述数据库对数据保密的需求,包括数据加密、访问控制、权限管理等。
5.2 数据完整性描述数据库对数据完整性的需求,包括数据约束、数据验证等。
5.3 数据可用性描述数据库对数据可用性的需求,包括备份与恢复、容灾备份等。
6.可维护性需求6.1 数据库维护描述数据库的维护需求,包括备份、数据库优化、性能监控等。
6.2 系统升级描述数据库的系统升级需求,包括版本升级、数据迁移等。
6.3 文档和培训描述数据库的文档和培训需求,包括用户手册、技术文档、培训课程等。
7.附件本文档附带以下附件:- 数据库表结构图- 数据字典- 相关文档和资料8.法律名词及注释在本文中涉及的法律名词和术语,以及相关的注释说明。
数据库(顶层)设计说明文件编号:KJXXW-XXSJ-M002-V1.0版本号:V1.0受控状态:■受控□非受控保密级别:公司级编制人/编制时间:王攀坤2014年7月审核人/审核时间:批准人/批准时间:生效日期:新疆泰戈瑞信息技术有限责任公司发布变更记录(注:更改状态包括:C-创建、A-增加、M-修改、D-删除)2/ 16目录1.引言 (4)1.1标识 (4)1.2系统概述 (4)1.3文档概述 (4)2.引用文件 (5)3.数据库级设计决策 (6)4.数据库详细设计 (8)4.1数据库设计级别的名称 (8)5.用于数据库访问或操纵的软件配置项的详细设计 (11)5.1软件配置项的项目唯一标识符或软件配置项组的指定符 (11)6.需求的可追踪性 (14)7.注解 (15)附录 (16)3/ 161. 引言本章分为以下几条。
1.1 标识【内容】本条应包含本文档适用的系统和软件的完整标识,(若适用)包括标识号、标题、缩略词语、版本号和发行号。
【裁剪原则】此部分内容不允许裁剪掉。
1.2 系统概述本条应简述本文档适用的系统和软件的用途。
它应描述系统与软件的一般性质;概述系统开发、运行和维护的历史;标识项目的投资方、需方、用户、开发方和支持机构;标识当前和计划的运行现场;并列出其他有关文档。
1.3 文档概述【内容】本条应概述本文档的用途和内容,并描述与其使用有关的保密性和私密性的要求。
【裁剪原则】此部分内容不允许裁剪掉。
4/ 162. 引用文件【内容】本章应列出本文档引用的所有文档的编号、标题、修订版本和日期,本章也应标识不能通过正常的供货渠道获得的所有文档的来源。
【裁剪原则】此部分内容不允许裁剪掉。
5/ 163. 数据库级设计决策【内容】本章应根据需要分条给出数据库级设计决策,即数据库行为设计决策(从用户的角度看,该数据库如何满足它的需求而忽略内部实现)和其他影响数据库进一步设计的决策。
如果所有这些决策在系统或CSCI需求中均是明确的,本章应如实陈述。
标准的软件开发过程需要编写的文档软件开发的标准过程包括六个阶段,而六个阶段需要编写的各类文件达14种之多,在每个阶段需要编写哪些文件,以及这些文件的主要内容见下:1。
可行性与计划研究阶段(1)可行性研究报告:在可行性研究与计划阶段内,要确定该软件的开发目标和总的要求,要进行可行性分析、投资一收益分析、制订开发计划,并完成应编制的文件。
(2)项目开发计划:编制项目开发计划的目的是用文件的形式,把对于在开发过程中各项工作的负责人员、开发进度、所需经费预算、所需软、硬件条件等问题作出的安排记载下来,以便根据本计划开展和检查本项目的开发工作。
2。
需求分析阶段(1)软件需求说明书:软件需求说明书的编制是为了使用户和软件开发者双方对该软件的初始规定有一个共同的理解,使之成为整个开发工作的基础。
内容包括对功能的规定对性能的规定等.(2)数据要求说明书:数据要求说明书的编制目的是为了向整个开发时期提供关于被处理数据的描述和数据采集要求的技术信息。
(3)初步的用户手册:用户手册的编制是要使用非专门术语的语言,充分地描述该软件系统所具有的功能及基本的使用方法。
使用户(或潜在用户)通过本手册能够了解该软件的用途,并且能够确定在什么情况下,如何使用它。
3.设计阶段(1)概要设计说明书:概要设计说明书又可称系统设计说明书,这里所说的系统是指程序系统.编制的目的是说明对程序系统的设计考虑,包括程序系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计。
运行设计、数据结构设计和出错处理设计等,为程序的详细设计提供基础。
(2)详细设计说明书:详细设计说明书又可称程序设计说明书.编制目的是说明一个软件系统各个层次中的每一个程序(每个模块或子程序)的设计考虑,如果一个软件系统比较简单,层次很少,本文件可以不单独编写,有关内容合并入概要设计说明书。
(3)数据库设计说明书:数据库设计说明书的编制目的是对于设计中的数据库的所有标识、逻辑结构和物理结构作出具体的设计规定。
项目全称数据库设计说明书承建方全称7校本选课管理 ............................................................. 错误!未指定书签。
8考务管理 ..................................................................... 错误!未指定书签。
9成绩分析系统 ............................................................. 错误!未指定书签。
10试卷分析系统 ......................................................... 错误!未指定书签。
11公共资源库 ............................................................. 错误!未指定书签。
12校务办公系统 ......................................................... 错误!未指定书签。
13调查问卷系统 ......................................................... 错误!未指定书签。
14学籍管理系统 ......................................................... 错误!未指定书签。
15教案管理 ................................................................. 错误!未指定书签。
16教师成长档案袋 ..................................................... 错误!未指定书签。
17德育管理 ................................................................. 错误!未指定书签。
18学生成长档案袋 ..................................................... 错误!未指定书签。
19班级管理 ................................................................. 错误!未指定书签。
20工资管理 ................................................................. 错误!未指定书签。
21资产管理系统 ......................................................... 错误!未指定书签。
22师生艺术性博客 ..................................................... 错误!未指定书签。
简介1.1.目的本文档是为设计和开发人员提供的1.4.参考资料数据库环境和实体间相互关系。
1内网门户管理1.1统一门户系统模块功能描述:统一门户系统是所有数字校园业务应用系统的访问入口,通过与身份认证系统之间的信息交互,进行用户身份和权限的验证,根据登录用户实体:代理、数据对象、访问控制列表、上下文、加密、认证、区域信息、传输协议实体关系、实体属性ER关系图1.4业务基础信息管理模块功能描述:本模块主要实现对学校的组织机构的初始化、学年学期的维护等等基础设置,是系统其他模块能正常运行。
实体:学年(bd_schoolyear)、学期(bd_semester)、学校(bd_school)、部门(bd_dept)、年级(bd_grade)、班级(bd_eclass)、部门人员(bd_deptuser)、学段(bd_stagekind)实体关系、实体属性ER关系图2外网门户数据库图-1主键:id外键:索引:约束:强制外键约束 表创建脚本:索引:约束:强制外键约束 表创建脚本:所属业务模块:招生管理数据结构:详细参考数据库图-1数据库图-1 主键:id外键:索引:约束:强制外键约束表创建脚本:实体关系、实体属性ER关系图6约听评课详见:课程管理系统;7校本选课管理模块功能描述:校本课程是第用户简称的特色,有一百多门校本课程,有大量的校本课程资源并多次获奖。
选课管理主要解决三大问题:校本课程的管理与选课活动管理、学校校本课程的宣传以及与学生家长的互9成绩分析系统模块功能描述:本模块成通过对学生成绩的各类分析,找出教学中的薄弱环节,评价教师的教学水平。
成绩信息可以由教师在线录入或者按照特定模板的Excel 导入。
实体:单科标准设置(RA_COURSESTANDARD)、不参与统计学生设置(RA_EXCLUDEDSTUDENT)、单科标准设置(高)(RA_HCOURSESTANDARD)、学生成绩(高)(RA_HSSCORE)、总分课程设置(高)(RA_HTOTALSCORECOURSE)、总分标准设置(高)(RA_HTOTALSCORESTANDARD)、达标排名设置(初)(RA_RANKSTANDARD)、外校成绩明细(小、中)(RA_SCHSCOREITEM)、分数段设置(小、中)(RA_SCORESEGMENT)、分数项设置(小、中)(RA_SCORESEGMENTITEM)、模块功能描述:按照教育资源网统一的编目体系进行资源库编目。
建立学校完善的信息资源库,使得各类资源能够有一个统一的平台来管理,给教师提供一个分享教学资源和教学成果的平台,使教师快速、准确地检索到需要的资源,提高资源的利用率。
实体:资源(re_resource)、学科分类(re_knowledgepoint)、教材分类(re_materialscategory)、资源类型(re_resourcetype)、媒体格式(re_mediaformat)、自定义分类(re_customcategory)、相关资源(re_relatedresource)、下载记录(re_downloadrecord)、收藏记录(re_collectrecord)、资源评论(re_review)、资源_知识点(re_resource_knowledgepoint)、资源_自定义分类(re_resource_customcategory)、资源_教材分类(re_resource_materialscategory)、资源_类型(re_resource_resourcetype)实体关系、实体属性ER关系图13调查问卷系统模块功能描述:通过调查问卷应用帮助学校快速开展各种调查问卷活动,提供简洁的方法实现对在线调查问卷的创建、设计、预览、执行、结果统计,使学校问卷组织者可针对调查活动快速创建问卷,参与问卷调查的人登入系统后完成问卷,系统即可统计出问卷结果。
实体:调查问卷(qn_questionnaire)、问卷题目(qn_qnsubject)、选项(qn_option)、投票结果(qn_voteresult)、问题投票结果(qn_subjectvoteresult)、调查问卷_投票人(qn_questionnaire_voteuser)、调查问卷_调查对象(qn_questionnaire_investigateuser)实体关系、实体属性ER关系图14学籍管理系统14.2学籍变动管理(st_beadrollchange) 表名称:st_beadrollchange/学籍变动表存储:存储学生学籍变动信息所属业务模块:学籍管理14.3学生基本信息管理(st_sbaseinfo) 表名称:st_sbaseinfo/学生基本信息表存储:存储学生基本信息所属业务模块:学籍管理数据结构:详细参考数据库图-1数据库图-1 主键:id(用户标识)外键:索引:约束:强制外键约束14.5学生家庭成员管理(st_studentParents) 表名称:st_studentParents/学生家庭成员表存储:存储学生家庭成员所属业务模块:学生学籍管理数据结构:详细参考数据库图-1数据库图-1主键:id(用户标识)14.6学生急救信息管理(st_studentFirstaid) 表名称:st_studentFirstaid/学生急救信息表存储:存储学生急救信息所属业务模块:学生学籍管理数据结构:详细参考数据库图-1数据库图-1 主键:id(用户标识)外键:索引:约束:强制外键约束索引:约束:强制外键约束表创建脚本:索引:约束:强制外键约束 表创建脚本:(th_familyitem)、课题研究记录(th_issueitem)、缺勤信息记录(th_absenceitem)、公开课记录(th_pubcourseitem)、指导业绩记录(th_guideitem)、获奖记录(th_awarditem)、职称信息记录(th_titleitem)实体关系、实体属性ER关系图17德育管理17.1活动记录表(MD_ACTIVITYRECORD)表名称:MD_ACTIVITYRECORD/活动记录表存储:存储本系统活动记录的相关信息所属业务模块:德育管理数据结构:详细参考数据库图-1表名称:MD_HISTORYRECORD/历史活动记录表 存储:存储本系统历史活动记录的相关信息所属业务模块:德育管理数据结构:详细参考数据库图-1数据库图-1主键:id(评价配置信息标识)外键:索引:约束:强制外键约束表创建脚本:主键:id(家庭来访记录标识) 外键:索引:约束:强制外键约束表创建脚本:17.5预约单表(MD_MENTALRESERVATION) 表名称:MD_MENTALRESERVATION/预约单表 存储:存储本系统预约单的相关信息所属业务模块:德育管理数据结构:详细参考数据库图-1数据库图-1 主键:id(预约单标识)外键:索引:约束:强制外键约束表创建脚本:数据库图-1 主键:id(下载记录标识)外键:索引:约束:强制外键约束表创建脚本:17.7媒体资源表(RE_MEDIARESOURCE)17.8社团表(MD_STUDENTCLUB)表名称:MD_STUDENTCLUB/社团表存储:存储本系统社团的相关信息所属业务模块:德育管理数据结构:详细参考数据库图-1数据库图-1主键:id(社团标识)学生获奖情况(st_studentAwards)、学生职务信息(st_studentDuty)、学生好人好事(st_studentGooddeed)、学生个人作品(st_studentWork)实体关系、实体属性ER关系图19班级管理模块功能描述:本模块对班级进行活动评价和统计查看管理,教务管理老师可以新建活动并对班级进行评价,其他人可以在安全、事务等方面。