18-系统设计说明书

XXX项目18系统设计说明书编制单位：XXX有限公司编制时间：2020年4月20日XXX项目系统设计说明书目录1 引言 11.1 编写目的 11.2 术语和缩略语 11.3 参考资料 12 环境与工具 23 总体设计 23.1 设计原则 33.2 设计依据 33.3 系统总体架构 33.4 系统功能结构 43.5 设计策略与方法 53.6 系统功能大纲 63.7 系统部署结构 64 子系统/模块设计 74.1 子系统/子模块1 74.2 子系统/子模块2 94.3 子系统/子模块XXX 95 数据库设计 95.1 数据库的命名规则 95.2 数据库概念模型 95.3 表设计 105.4 存储过程/包设计 116 接口设计 146.1 外部接口设计 146.2 内部接口设计 147 系统非功能设计 147.1 性能设计 157.2 界面设计 157.3 安全设计 16引言编写目的 〔说明编写系统设计说明书的目的，指出预期读者。〕示例：本文档是XXX公司的软件设计师根据本公司已编写的有关需求，在分别与软件使用者和软件开发工程师进行了较为深入地探讨和分析的基础上编写的，主要目的是用于指导《XXX项目》的软件开发、测试及未来维护工作。本文档预期读者为软件设计决策人员、开发人员、测试人员等。……术语和缩略语〔说明本文档的术语和缩略语，并加以解释。〕示例：生命周期模型：描述软件开发的组织方式、步骤的模型，称为软件生命周期模型。QA：质量保证(QualityAssurance)；CM:配置管理(ConfigurationManagement)；……参考资料〔列出与本文档有关的参考资料。〕示例：《初步设计方案》；《需求规格说明书》；……环境与工具〔描述本系统中所涉及的软、硬件运行环境和系统设计工具。〕示例：1、系统运行环境硬件环境:CPU：P43.0G以上；内存：1GB以上；硬盘：硬盘80G。软件环境:数据库：Oracle10g；应用服务器：Tomcat5.5应用服务器软件；JDK版本：JDK1.4操作系统：WindowsXP及以上2、系统设计工具数据库设计的工具：PowerDesigner……总体设计〔描述总体设计中设计原则、设计依据、系统总体架构、系统功能结构、设计策略与方法、系统功能大纲、系统部署结构等。〕设计原则〔描述总体设计中的原则。〕示例：1.整体性与开放性的原则，在本项目系统设计时应当充分考虑各业务系统之间的关系，整体设计规划本项目系统，注重各种信息资源的有机整合，既考虑整体性，同时也要具有一定的开放性。2.可扩展性和易维护性的原则，在设计时应具有一定的前瞻性，充分考虑系统升级、扩容、扩充和维护的可行性；并针对本系统涉及用户多、业务繁杂的特点，充分考虑如何大幅度提高业务处理的响应速度以及统计汇总的速度和精度……设计依据〔描述总体设计中的依据标准。〕示例：《计算机软件文档编制规范》GB-T8567-2006；……系统总体架构〔给出系统总体结构图并进行简要说明。〕示例：图3-1XX如图3-1所示中间业务处理层通过API接口与业务对象BO与数据代理DP连接实现对数据库的查询操作和外部系统和通用服务的连接。讲查询结果按功能模块处理后，通过API接口交给应用界面显示给用户。……系统功能结构〔详细描述总体设计中系统功能的各个模块以及子模块的结构，并附系统功能结构图。〕示例：根据本项目的建设需求，对学生职业生涯培养系统、平板互动教学平台、课题互动平台、课件制作平台以及试卷题库管理生成系统的建设系统，每个系统下面具有子功能我的生涯规划、认识专业、生涯规划管理员操作、课程建立、微课堂、学生统计、学生管理、课程管理、白板互动、课堂作业、互动活动、教材与编目管理、教学进度管理、主备文档模板管理评课、在线组卷、私人题库、发布测验、答题情况等具体结构如图3-2图3-2XX设计策略与方法〔描述系统设计为满足系统架构所需使用的策略和方法。〕示例：扩展策略：首先采用了B/S开发架构，便于将来维护，同时也便于与其他相关系统互通。具体业务中增加了底层的数据维护功能，便于业务自身的扩展。折衷策略：本系统在习惯性和统一规范管理之间采取一定的折衷处理，考虑到学校老师习惯等原因，在操作界面上和操作流程上重点考虑接近现实流程。本系统在性能和安全上进行折衷处理，保证性能的前提下，重点以系统安全为主。设计方法：经过系统分析，设计中采用原形法，针对相同类似功能采用原形与设计重用，具体设计过程中采用面向对象设计。……系统功能大纲〔以列表的形式描述系统功能的编号、名称和功能概要。〕示例：表3-1模块编号模块/功能名称功能概要MC学生职业生涯培养系统主模块MC01我的生涯规划在“我的生涯规划”“自我分析”页面，学生可根据自己的性格、兴趣、价值观和能力等等方面，进行自我分析；在“长期目标”页面，学生可对自己的职业目标和专业目标进行规划，填写目标内容后；在“我的榜样人物”页面，学生可添加多个自己的榜样人物，并且可以随时对榜样人物进行添加、修改、删除等操作；在“短期目标”页面，学生可根据高一/高二/高三目标进行归纳，包括目标内容、学业发展计划、综合素质提高计划、身心发展计划和其他成长足迹等；在“生涯规划书”页面，学生可对自己的生涯规划书进行编辑和导出MC02认识专业在“认识专业”页面，可对相关专业进行分类搜索，点击“专业名称”可查看该专业详细内容；点击“开设院校”可查看该专业开设院校。。MC03生涯规划管理操作管理员进入生涯规划，可对全校学生所创建的生涯规划进行搜索、查看、导出等操作，其他操作均与学生一致。………………系统部署结构〔描述系统服务器的总体部署情况。〕示例：图3-3XXXXX系统采用的是集中式的模式，集中部属在中心集群上面。数据库分两类，运算数据库和生产数据库，数据库集群上共有4个生产集群与4个运算集群。……子系统/模块设计子系统/子模块1〔根据本项目的需求列出本系统的各模块功能设计，包含功能概要、业务规模、界面设计、关键SQL语句等。〕示例：4.1.1功能概要功能概要说明：我的生涯规划，是学生可根据自己的性格、兴趣、价值观和能力等等方面，进行自我分析；在“长期目标”页面，学生可对自己的职业目标和专业目标进行规划。4.1.2业务规模学校学生可以每半学期记录制定一次自己的生涯规划。4.1.3界面设计图4-1界面构造：标签、BUTTON按钮、列表控件、翻页控件进入操作：学生职业生涯培养系统——我的生涯规划——自我分析、长期目标、我的榜样人物、短期目标体和生涯规划书登陆后初始状态：默认为我的生涯规划界面页面切换后状态：显示上次输入值退出操作：切换模块、退出系统、关闭浏览器4.1.4关键SQL语句SELECTEHR_HEAT_MAIN.HEAD_IDASHEAD_ID,(selectr.shortnamefrompub_depart_attachrwherer.depart_code=EHR_HEAT_MAIN.ORG_ID)ASORG_ID,EHR_HEAT_MAIN.YEAR_MONASYEAR_MON,to_char(EHR_HEAT_MAIN.ADD_TIME,'yyyy-mm-dd')ASADD_TIME,(selectt.user_namefrompub_manage_usertwheret.user_idcode=EHR_HEAT_MAIN.ADD_OPR_ID)ASADD_OPR_ID,to_char(EHR_HEAT_MAIN.LAST_CHG_TIME,'yyyy-mm-dd')ASLAST_CHG_TIME,EHR_HEAT_MAIN.LAST_CHG_OPR_IDASLAST_CHG_OPR_IDFROMEHR_HEAT_MAIN子系统/子模块2……子系统/子模块XXX……数据库设计数据库的命名规则〔阐述此数据库设计说明书的数据库命名规则。〕示例：5.1数据库（database）命名规则数据库名长度：不超过INFORMIX规定长度(十八位)；采用英文形式，规则如XXX；数据库名由两部分组成：系统名+DB；系统名由英文单词构成，每个单词首字母大写，单词可采取缩写形式；附表提供的词根表作为构词的唯一依据。……数据库概念模型〔用ER图表示数据库的概念模型。〕示例：图5-1用户通过登录本系统进行线上咨询，查询、信息修改、意见反馈等操作，后台收到修改信息，对用户信息进行核实，根据修改信息的结果，进行再次确认，并把结果录入档案中。登录本系统易于档案进行工作量统计档案管理和各种工作登记等。表设计示例：1）tc"表格BACKS_REASON_ALL的列清单"\l4表BACKS_REASON_ALL的列清单表5-1代码数据类型注释DD_IDVARCHAR2(20)DD_CODEVARCHAR2(20)DD_DESCVARCHAR2(100)DD_STATUSVARCHAR2(2)2）tc"表格BACKS_REASON_DOC的列清单"\l4表BACKS_REASON_DOC的列清单表5-2XX代码数据类型注释DD_IDVARCHAR2(20)DD_CODEVARCHAR2(20)DD_DESCVARCHAR2(100)DD_STATUSVARCHAR2(2)3)tc"表格BACKS_REASON_DOC的列清单"\l4表XXX的列清单存储过程/包设计〔阐述数据库存储过程的设计，列出各个存储过程对应的数据库SQL语句〕示例:1.GenNewEhrNo表5-3XX名称GenNewEhrNoSqlcreateorreplaceprocedureGenNewEhrNoisrow_dataehr_cli_registry%rowtype;cursorcur_ehrCliRegisselect*fromehr_cli_registrywhereadd_time>to_date('21-05-200610:05:00','DD-MM-YYYYHH24:MI:SS')orderbyss_id,status,add_time;temp_departCodevarchar2(50);temp_ehrTypevarchar2(10);v_generatorIdvarchar2(20);temp_countinteger;temp_count2integer;temp_indexinteger;str_indexvarchar2(20);temp_newnovarchar2(30);beginopencur_ehrCliReg;loopfetchcur_ehrCliRegintorow_data;exitwhencur_ehrCliReg%notfound;selectcount(*)intotemp_count2frompub_depart_info_sswheres.depart_code=row_data.ss_id;iftemp_count2=1thenselects.depart_indexintotemp_departCodefrompub_depart_info_sswheres.depart_code=row_data.ss_id;ifrow_data.status='00'thentemp_ehrType:='B';elsifrow_data.status='02'thentemp_ehrType:='A';elsifrow_data.status='01'thentemp_ehrType:='C';endif;selectcount(*)intotemp_countfromehr_newno_generatorgwhereg.depart_code=temp_departCodeandg.ehr_type=temp_ehrType;iftemp_count=1thenselectggg.currindexintotemp_indexfromehr_newno_generatorgggwhereggg.depart_code=temp_departCodeandggg.ehr_type=temp_ehrType;temp_index:=temp_index+1;updateehr_newno_generatorggsetgg.currindex=temp_indexwheregg.depart_code=temp_departCodeandgg.ehr_type=temp_ehrType;elseselectehr_reg_seq.nextvalintov_generatorIdfromdual;insertintoehr_newno_generator(generator_id,ehr_type,depart_code,currindex)values(v_generatorId,temp_ehrType,temp_departCode,1);temp_index:=1;endif;str_index:=to_char(temp_index);temp_newno:=temp_departCode||substr('000000',0,6-length(str_index))||str_index||'-'||temp_ehrType;updateehr_cli_registryehrsetehr.ehr_newno=temp_newnowhereehr.ehr_id=row_data.ehr_id;endif;endloop;closecur_ehrCliReg;endGenNewEhrNo;接口设计外部接口设计〔描述本系统的外部硬件接口设计，包括接口形式、输入输出参数、传输频率等。〕示例：表6-1编号系统接口形式输入参数出口参数调用频率1学生职业生涯培养Key系统USB端口InputOutput500次/天内部接口设计〔描述本系统的内部硬件接口设计，包括接口形式、输入输出参数以及调用频率状况等。〕示例：表6-2XX编号系统接口形式输入参数出口参数调用频率1登陆方式接口HCI用户名、密码用户ID、角色、机构500次/天系统非功能设计〔详细描述系统的非功能性设计，包含并不限于以下内容。〕性能设计〔从整体描述软件在性能上需要达到的要求。〕示例：1、易用性统一的界面风格：方便用户习惯操作。优化页面数据下载方式，适应不同带宽的网络访问。（拨号、宽带、GPRS访问）清晰友好的在线帮助：使操作人员在短时间内掌握系统的使用，并可以随时获取在线的指导。离线应用：由于