校友录系统-软件设计说明(sdd)

don1990830 贡献于2013-07-05

作者 sn  创建于2013-06-29 14:28:19   修改者  修改于2013-07-03 12:13:31字数4324

文档摘要:本条应简述本文档适用的系统和软件的用途。它应描述系统与软件的一般性质;概述系统开发、运行和维护的历史;标识项目的投资方、需方、用户、开发方和支持机构;标识当前和计划的运行现场;并列出其他有关文档。
关键词:

目录 文档编号: 项目编号: WEB校友录系统 软件设计说明(SDD) V 1.0 拟 制 人 PDD项目小组 审 核 人______________________ 批 准 人______________________ 北京师范大学珠海分校 信息技术学院 2013年7月3日 北京师范大学珠海分校信息技术学院 目录 目录 目录 ii 1. 引言 1 1.1. 标识* 1 1.2. 系统概述* 1 1.3. 文档概述* 1 1.4. 基线 1 2. 引用文件* 3 3. CSCI级设计决策* 5 4. CSCI体系结构设计* 7 4.1. 体系结构 7 4.1.1. 程序(模块)划分* 7 4.1.2. 程序(模块)层次结构关系* 9 4.2. 全局数据结构说明* 11 4.2.1. 常量* 11 4.2.2. 变量* 12 4.2.3. 数据结构* 12 4.3. CSCI部件* 12 4.4. 执行概念* 13 4.5. 接口设计* 13 4.5.1. 接口标识与接口图* 13 4.5.2. 4.5.x(接口的项目唯一标识符) 13 5. CSCI详细设计* 15 5.1. 5.x(软件配置项的项目唯一标识符或软件配置项组的指定符) 15 6. 需求的可追踪性* 17 7. 注解* 19 附录 20 北京师范大学珠海分校信息技术学院 第7章 注解* 1. 引言 1.1. 标识* 本条应包含本文档适用的系统和软件的完整标识。(若适用)包括标识号、标题、缩略词语、版本号、发行号。 1.2. 系统概述* 本条应简述本文档适用的系统和软件的用途。它应描述系统与软件的一般性质;概述系统开发、运行和维护的历史;标识项目的投资方、需方、用户、开发方和支持机构;标识当前和计划的运行现场;并列出其他有关文档。 1.3. 文档概述* 本条应概述本文档的用途与内容,并描述与其使用有关的保密性或私密性要求。 1.4. 基线 说明编写本系统设计说明书所依据的设计基线。 北京师范大学珠海分校信息技术学院 第7章 注解* 2. 引用文件* 本章应列出本文档引用的所有文档的编号、标题、修订版本和日期。本章也应标识不能通过正常的供货渠道获得的所有文档的来源。 北京师范大学珠海分校信息技术学院 第7章 注解* 3. CSCI级设计决策* l 数据库建立,参考数据库设计说明(DBDD) l 使用AOP技术通知 l 使用拦截器 l 面向对象设计 l 面向接口编程 北京师范大学珠海分校信息技术学院 第7章 注解* 4. CSCI体系结构设计* 本章应分条描述CSCI体系结构设计。如果设计的部分或全部依赖于系统状态或方式,则应指出这种依赖性。如果设计信息在多条中出现,则可只描述一次,而在其他条引用。应给出或引用为理解这些设计所需的设计约定。 4.1. 体系结构 4.1.1. 程序(模块)划分* 用一系列图表列出本CSCI内的每个程序(包括每个模块和子程序)的名称、标识符、功能及其所包含的源标准名。//画UML类图 登录类图: 留言板类图: 主菜单类图: 北京师范大学珠海分校信息技术学院 第7章 注解* 相册类图: l 读取删除 l 上传 调查问卷类图: 北京师范大学珠海分校信息技术学院 第7章 注解* 4.1.2. 程序(模块)层次结构关系* 用一系列图表列出本CSCI内的每个程序(包括每个模块和子程序)之间的层次结构与调用关系。//画顺序图 北京师范大学珠海分校信息技术学院 第7章 注解* 相册: 北京师范大学珠海分校信息技术学院 第7章 注解* 4.2. 全局数据结构说明* 本章说明本程序系统中使用的全局数据常量、变量和数据结构。 北京师范大学珠海分校信息技术学院 第7章 注解* 4.2.1. 常量* 包括数据文件名称及其所在目录,功能说明,具体常量说明等。 l 0是普通用户 l 1是班级管理员 4.2.2. 变量* 包括数据文件名称及其所在目录,功能说明,具体变量说明等。 l Jsp页面: stuname 用户名称 用于验证用户身份,在student_table中取数据等 password 用户密码 用于验证用户身份 l 后台代码: 参考数据库字段来命名。 4.2.3. 数据结构* 包括数据结构名称,功能说明,具体数据结构说明(定义、注释、取值…)等。 l 参考DBDD文档中表数据的结构。 4.3. CSCI部件* l 参考4.1.1和4.1.2的UML类图和顺序图,可以清晰的看到类的属性等和调用方法。 北京师范大学珠海分校信息技术学院 第7章 注解* 4.4. 执行概念* 北京师范大学珠海分校信息技术学院 第7章 注解* 4.5. 接口设计* 本条应分条描述软件配置项的接口特性,既包括软件配置项之间的接口,也包括与外部实体,如系统、配置项及用户之间的接口。如果这些信息的部分或全部已在接口设计说明(IDD)、本文的第5章或其他地方说明的话,可在此处引用。 4.5.1. 接口标识与接口图* 本条应陈述赋予每个接口的项目唯一标识符,(若适用)并用名字、编号、版本和文档引用等标识接口实体(软件配置项、系统、配置项、用户等)。接口标识应说明哪些实体具有固定接口特性(从而把接口需求强加给接口实体),哪些实体正在开发或修改(因而已把接口需求分配给它们)。(若适用)应该提供一个或多个接口图以描述这些接口。 l 注意:Mainlistservice接口中有很多对数据库操作的方法,里面有一个验证普通用户还是管理员用户的方法,从而达到控制该用户的权限。 4.5.2. 4.5.x(接口的项目唯一标识符) 本条(从4.5.2开始编号)应用项目唯一标识符标识接口,应简要标识接口实体,并且应根据需要划分为几条描述接口实体的单方或双方的接口特性。如果一给定的接口实体本文没有提到(例如,一个外部系统),但是其接口特性需要在本SDD描述的接口实体时提到,则这些特性应以假设、或“当[未提到实体]这样做时,[提到的实体]将……”的形式描述。本条可引用其他文档(例如数据字典、协议标准、用户接口标准)代替本条的描述信息。本设计说明应包括以下内容,(若适用)它们可按适合于要提供的信息的任何次序给出,并且应从接口实体角度指出这些特性之间的区别(例如数据元素的大小、频率或其他特性的不同期望)。 a. 由接口实体分配给接口的优先级; b. 要实现的接口的类型(例如实时数据传输、数据的存储与检索等); c. 接口实体将提供、存储、发送、访问、接收的单个数据元素的特性,例如: 1) 名称/标识符; a) 项目唯一标识符; b) 非技术(自然语言)名称; 北京师范大学珠海分校信息技术学院 第7章 注解* c) 标准数据元素名称; d) 缩写名或同义名; 2) 数据类型(字母数字、整数等); 3) 大小与格式(例如字符串的长度与标点符号); 4) 计量单位(如米、元、纳秒等); 5) 范围或可能值的枚举(如0^-99); 6) 准确度(正确程度)与精度(有效数位数); 7) 优先级、时序、频率、容量、序列和其他约束,如数据元素是否可被更新,业务规则是否适用; 8) 保密性与私密性约束; 9) 来源(设置/发送实体)与接收者(使用/接收实体)。 d. 接口实体将提供、存储、发送、访问、接收的数据元素集合体(记录、消息、文件、数组、显示、报表等)的特性,例如: 1) 名称/标识符; a) 项目唯一标识符; b) 非技术(自然语言)名称; c) 技术名称(如代码或数据库中的记录或数据结构名); d) 缩写名或同义名; 2) 数据元素集合体中的数据元素及其结构(编号、次序、分组); 3) 媒体(如盘)及媒体上数据元素/集合体的结构; 4) 显示和其他输出的视听特性(如颜色、布局、字体、图标及其他显示元素、蜂鸣声、亮度等); 5) 数据集合体之间的关系,如排序/访问特性; 6) 优先级、时序、频率、容量、序列和其他约束,如数据集合体是否可被更新,业务规则是否适用; 7) 保密性与私密性约束; 8) 来源(设置/发送实体)与接收者(使用/接收实体)。 e. 接口实体为该接口使用通信方法的特性,例如: 1) 项目唯一标识符; 2) 通信链路/带宽/频率/媒体及其特性; 3) 消息格式化; 4) 流控制(如序列编号与缓冲区分配); 5) 数据传输率、周期或非周期和传送间隔; 6) 路由、寻址及命名约定; 7) 传输服务,包括优先级与等级; 8) 安全性/保密性/私密性考虑,如加密、用户鉴别、隔离、审核等。 f. 接口实体为该接口使用协议的特性,例如: 1) 项目唯一标识符; 2) 协议的优先级/层; 3) 分组,包括分段与重组、路由及寻址; 4) 合法性检查、错误控制、恢复过程; 5) 同步,包括连接的建立、保持、终止; 6) 状态、标识和其他报告特性。 g. 其他特性,如接口实体的物理兼容性(尺寸、容限、负荷、电压、接插件的兼容性等)。 北京师范大学珠海分校信息技术学院 第7章 注解* 5. CSCI详细设计* 本章应分条描述CSCI的每个软件配置项。如果设计的部分或全部依赖于系统状态或方式,则应指出这种依赖性。如果该设计信息在多条中出现,则可只描述一次,而在其他条引用。应给出或引用为理解这些设计所需的设计约定。软件配置项的接口特性可在此处描述,也可在第4章或接口设计说明(IDD)中描述。数据库软件配置项,或用于操作/访问数据库的软件配置项,可在此处描述,也可在数据库(顶层)设计说明(DBDD)中描述。 5.1. 5.x(软件配置项的项目唯一标识符或软件配置项组的指定符) 本条应用项目唯一标识符标识软件配置项并描述它。(若适用)描述应包括以下信息。作为一种变通,本条也可以指定一组软件配置项,并分条标识和描述它们。包含其他软件配置项的软件配置项可以引用那些软件配置项的说明,而无需在此重复。 a. (若有)配置项设计决策,诸如(如果以前未选)要使用的算法; b. 软件配置项设计中的约束、限制或非常规特征; c. 如果要使用的编程语言不同于该CSCI所指定的语言.应该指出,并说明使用它的理由; d. 如果软件配置项由过程式命令组成或包含过程式命令(如数据库管理系统(DBMS)中用于定义表单与报表的菜单选择、用于数据库访问与操纵的联机DBMS查询、用于自动代码生成的图形用户接口(GUI)构造器的输入、操作系统的命令或shell脚本),应有过程式命令列表和解释它们的用户手册或其他文档的引用; e. 如果软件配置项包含、接收或输出数据,(若适用)应有对其输入、输出和其他数据元素以及数据元素集合体的说明。(若适用)本文的4.5.x提供要包含主题的列表。软件配置项的局部数据应与软件配置项的输入或输出数据分开来描述。如果该软件配置项是一个数据库,应引用相应的数据库(顶层)设计说明(DBDD);接口特性可在此处提供,也可引用本文第4章或相应接口设计说明。 f. 如果软件配置项包含逻辑,给出其要使用的逻辑,(若适用)包括: 1) 该软件配置项执行启动时,其内部起作用的条件; 2) 把控制交给其他软件配置项的条件; 3) 对每个输入的响应及响应时间,包括数据转换、重命名和数据传送操作; 4) 该软件配置项运行期间的操作序列和动态控制序列,包括: a) 序列控制方法; b) 该方法的逻辑与输入条件,如计时偏差、优先级赋值; c) 数据在内存中的进出; d) 离散输入信号的感知,以及在软件配置项内中断操作之间的时序关系; 5) 异常与错误处理。 北京师范大学珠海分校信息技术学院 第7章 注解* 6. 需求的可追踪性* 本章应包括: a. 从本SDD中标识的每个软件配置项到分配给它的CSCI需求的可追踪性(亦可在4.1中提供); b. 从每个CSCI需求到它被分配给的软件配置项的可追踪性。 北京师范大学珠海分校信息技术学院 第7章 注解* 7. 注解* 本章应包含有助于理解本文档的一般信息(例如背景信息、词汇表、原理)。本章应包含为理解本文档需要的术语和定义,所有缩略语和它们在文档中的含义的字母序列表。 北京师范大学珠海分校信息技术学院 第7章 注解* 附录 附录可用来提供那些为便于文档维护而单独出版的信息(例如图表、分类数据)。为便于处理,附录可单独装订成册。附录应按字母顺序(A, B等)编排。 北京师范大学珠海分校信息技术学院

下载文档到电脑,查找使用更方便

文档的实际排版效果,会与网站的显示效果略有不同!!

需要 5 金币 [ 分享文档获得金币 ] 2 人已下载

下载文档