软件系统详细设计说明书

软件系统详细设计说明

书

文档编制序号：[KK8UY-LL9IO69-TTO6M3-MTOL89-FTT688]

XXXXX系统

详细设计说明书

文件状态：文件标

[V]草稿识：

[]正式发当前版

布本：

[]正在修作

改者：

完成日

期：

版本历史

版本/状态作者参与者起止日期备注

开始编写

修改记录

日期修订版修改章修改描述作者

本节

目录

1引言

1.1编写目的

说明编写详细设计方案的主要目的。

说明书编制的目的是说明一个软件系统各个层次中的每个程序（每个模块或

子程序）和数据库系统的设计考虑,为程序员编码提供依据。

如果一个软件系统比较简单,层次很少,本文件可以不单独编写,和概要设

计说明书中不重复部分合并编写。

方案重点是模块的执行流程和数据库系统详细设计的描述。

1.2背景

应包含以下几个方面的内容:

A.待开发软件系统名称;

B.该系统基本概念,如该系统的类型、从属地位等;

C.开发项目组名称。

1.3参考资料

列出详细设计报告引用的文献或资料,资料的作者、标题、出版单位和出

版日期等信息,必要时说明如何得到这些资料。

1.4术语定义及说明

列出本文档中用到的可能会引起混淆的专门术语、定义和缩写词的原文。

2设计概述

2.1任务和目标

说明详细设计的任务及详细设计所要达到的目标。

2.1.1需求概述

对所开发软件的概要描述,包括主要的业务需求、输入、输出、主要功

能、性能等,尤其需要描述系统性能需求。

2.1.2运行环境概述

对本系统所依赖于运行的硬件,包括操作系统、数据库系统、中间件、接

口软件、可能的性能监控与分析等软件环境的描述,及配置要求。

2.1.3条件与限制

详细描述系统所受的内部和外部条件的约束和限制说明。包括业务和技术

方面的条件与限制以及进度、管理等方面的限制。

2.1.4详细设计方法和工具

简要说明详细设计所采用的方法和使用的工具。如HIPO图方法、IDEF

(I2DEF)方法、E—R图,数据流程图、业务流程图、选用的CASE工具等,尽量

采用标准规范和辅助工具。

3系统详细需求分析

主要对系统级的需求进行分析。首先应对需求分析提出的企业需求进一步确

认,并对由于情况变化而带来的需求变化进行较为详细的分析。

3.1详细需求分析

包括:

详细功能需求分析

详细性能需求分析

详细资源需求分析

详细系统运行环境及限制条件分析

3.2详细系统运行环境及限制条件分析接口需求分析

包括:

系统接口需求分析

现有硬、软件资源接口需求分析

引进硬、软件资源接口需求分析

4总体方案确认

着重解决系统总体结构确认及界面划分问题。

4.1系统总体结构确认

对系统组成、逻辑结构及层次进行确认,对应用系统、支撑系统及各自实

现的功能进行确认,细化集成设计及系统工作流程,特别要注意因软件的引进

造成的系统本身结构和公司其他系统的结构变化。包括:

系统组成、逻辑结构及层次确认

应用系统结构确认

支撑系统结构确认

系统集成确认

系统工作流程确认

4.2系统详细界面划分

4.2.1应用系统与支撑系统的详细界面划分

应用系统与支撑系统之间的界面包括系统主服务器与其他服务器的服务范围

及访问方式,网络及数据库对应用系统的支撑方式,全局数据的管理与存取方

式等。

4.2.2系统内部详细界面划分

系统各功能之间的界面包括覆盖范围,模块间功能调用涉及到的系统模块

及方法,全局数据格式,系统性能要求等。

5系统详细设计

5.1系统程序代码架构设计

系统采用三层架构模型，将应用系统划分为用户界面表示层、业务逻辑层、

数据访问层，以及EntityClass实体类、Common类库组成，各层的关系如下图

所示：

5.1.1UI(UserInterface)用户界面表示层

负责与用户进行交互，显示、接受数据，与此同时，做一些简单逻辑处理，

如：输入数据有效性判断、显示各种异常、处理Dataset记录集数据。它只与

BLL(BusinessLogicLayer)业务逻辑层、EntityClass实体类两个项目发生关

联，可能与Common类库发生关联。

5.1.2BLL(BusinessLogicLayer)业务逻辑层

是整个系统的核心，它承担了所有的逻辑判断，实现了程序的功能，它是灵

活的。BLL层既是调用者，又是被调用者，因此，要适当的进行设计达到解耦的

效果。BLL层只关联DAL层和实体类，可能关联Common类库。虽然BLL层被U层调

用，但是BLL层无需关心UI层的情况。数据库中每个表都对应一个BLL类，为了

达到解耦效果，BLL类不能直接调用其他表的DAL类，可以BLL类之间相互调用。

5.1.3DAL(DataAccessLayer)数据访问层

提供数据访问的接口，没有任何逻辑。在接口中对数据库操作语句进行组合

装配。DAL层一般关联Common类库中的最底层，最基础的数据库类(比如：链接

数据库），必须关联EntityClass实体类项目。DAL层只是数据库的管理者，但

不是访问者，不直接与数据库发生关联。数据库中每个表都对应一个DAL层的接

口（访问控制）类。

5.1.4Common类库

用于存放公用的类。最常用的就是数据库访问类，比如：链接字符串，数据

库引擎类。它直接与数据库进行机械式的交换，无任何逻辑。

5.1.5EntityClass实体类

相当于加强的数据结构，实现了对数据的封装。数据库中每个表都对应一个

实体类，表的字段就是实体类的属性，类型一一对应。UI、BLL、DAL这三层的

交互主要就是通过实体类作为参数，并Return回信息。

5.2系统结构设计及子系统划分

根据业务和功能，将系统的逻辑结构划分为XX子系统、XX子系等6个子系

统，如下图所示：

各个子系统按照功能角度分解，划分出若干不同的功能模块，如下面各图所

示：

5.3系统功能模块详细设计

按结构化设计方法,在系统功能逐层分解的基础上,对系统各功能模块或子

系统进行设计。此为详细设计的主要部分之一。

用层次图描述系统的总体结构、功能分解及各个模块之间的相互调用关系

和信息交互,用IPO图或其他方法描述各模块完成的功能。以上建议采用HIPO

图进行功能分解与模块描述,更高的要求建议采用IDEFO方法进行功能模型设

计。

详细设计应用系统的各个构成模块完成的功能及其相互之间的关系,用

IPO或结构图描述各模块的组成结构、算法、模块间的接口关系,以及需求、功

能和模块三者之间的交叉参照关系。

每个模块的描述说明可参照以下格式:

模块编号:

模块名称:

输入:

处理:

算法描述:

输出:

其中处理和算法描述部分主要采用伪码或具体的程序语言完成。

对详细设计更高的要求建议用IDEFO图进行各功能模块的设计。

如果对软件需进行二次开发（包括功能扩展、功能改造、用户界面改造

等），则相应的设计工作应该设立子课题完成。

注意：算法描述主要是说明BLL层的代码逻辑，UI层只做简单的输入验证和

界面显示功能。

5.3.1XX子系统

.1XX模块

列表和分页

创建XX

.2XX模块

XX列表

XX修改

5.3.2XX子系统

5.3.6.1用户管理模块

模块描述：管理系统用户，包括添加用户并赋予角色、修改用户资料和角

色、删除用户。

主要功能：添加用户、修改用户、删除用户、列表和分页。

5.3.6.1.1列表和分页

1、流程图

省略

2、输入项

分页索引页面传参数页面加载时为1

3、输出项

1）列表详细记录；

2）当前页码；

3）分页总数；

4）记录总数。

4、算法描述

系统管理用户数据量不大，而且该功能使用频率不高，可以不用优化分页，

直接获取用户表全部记录，建议UI层使用gridview控件，调用GetAllListO绑

定控件，利用gridview自带分页功能，显示分页按钮、当前页、分页总数、记

录总数、

5.3.6.1.2添加用户

1、流程图

2、输入项

用户IDstring必填

姓名string必填

用户密码string必填

确认密码string必填

联系电话string

E-mailstring

状态char

用户角色IDstring

3、输出项

1）成功，UI提示添加用户完成;

2）失败，UI提示具体信息。

4、算法描述

1）前端js判断必填项的输入和二次密码是否相同，角色可以不选；

2）BLL须验证必填项，用户名是唯一的不能重复；

3）加密密码使用（stringString,stringKey）,Key="XXXXXXXX”；

4）用户信息保存至表System_admin_info,Addmodel）；

5）分拆角色ID字符串并循环字符串数组，信息保存至表

Diet_admin_vs_roles,Addmodel）o

5.3.6.1.3修改用户

1、流程图

2、输入项

用户IDstring页面传参数

姓名string必填

用户密码string必填

确认密码string必填

联系电话string

E-mailstring

状态char

用户角色IDstring

3、输出项

1）成功，UI提示修改用户完成；

2）失败，UI提示具体信息。

4、算法描述

1）前端js判断必填项的输入和二次密码是否相同，角色可以不选；

2）加密密码使用Encrypt（stringString,stringKey）,Key=

“LinLiYan”；

3）根据用户ID删除表Dict_admin_vs_rol.es的记录

DeleteByAdminlD（stringadmin_id）；

4）分拆角色ID字符串并循环字符串数组，信息保存至该表Addmodel）。

5.3.6.1.4删除用户

1、流程图

2、输入项

用户IDstring页面传参数

3、输出项

1、成功，UI提示删除用户完成，刷新列表;

2、失败，UI提示具体信息。

3、算法描述

1)根据用户ID删除表System_admin_info的记录Delete(string

admin_id)；

2)根据用户ID删除表Dict_admin_vs_roles的记录

DeleteByAdminlD(stringadmin_id)。

5.3.6.2角色管理模块

5.3.6.3系统设置模块

5.3.6.4系统登录注销模块

5.4系统界面详细设计

系统界面说明应用系统软件的各种接口。整个系统的其他接口（如系统硬件

接口、通讯接口等）在相应的部分说明。

5.4.1外部界面设计

根据系统界面划分进行系统外部界面设计,对系统的所有外部接口（包

括功能和数据接口）进行设计。

5.4.2内部界面设计

设计系统内部各功能模块间的调用关系和数据接口。

5.4.3用户界面设计

规定人机界面的内容、界面风格、调用方式等,包括所谓的表单设计、报

表设计和用户需要的打印输出等设计。此部分内容可能比较多。

6数据库系统设计

此数据库设计可单独成册，尤其对大型的数据库应用系统,即有一个单独的

《数据库设计说明书》。

6.1设计要求

6.2信息模型设计

确定系统信息的类型（实体或视图），确定系统信息实体的属性、关键字及

实体之间的联系,详细描述数据库和结构设计,数据元素及属性定义,数据关

系模式,数据约束和限制。

6.3数据库设计

6.3.1设计依据

说明数据被访问的频度和流量,最大数据存储量,数据增长量,存储时间

等数据库设计依据。

6.3.2数据库种类及特点

说明系统内应用的数据库种类、各自的特点、数量及如何实现互联,数据

如何传递。

6.3.3数据库逻辑结构

说明数据库概念模式向逻辑模式转换所采用的方法论及工具,完成数据库

概念模式向逻辑模式的转换。详细列出所使用的数据结构中每个数据项、记录

和文件的标识、定义、长度及它们之间的相互关系。此节内容为数据库设计的

主要部分。

6.3.4物理结构设计

列出所使用的数据结构中每个数据项的存储要求、访问方法、存取单位

和存取物理关系等。建立系统程序员视图,包括:

数据在内存中的安排,包括对索引区、缓冲区的设计;

所使用的外存设备及外存空间的组织,包括索引区、数据块的组织与划分;

访问数据的方式方法。

6.3.5数据库安全

说明数据的共享方式,如何保证数据的安全性及保密性。

6.3.6数据字典

编写详细的数据字典。对数据库设计中涉及到的各种项目,如数据项、

记录、系、文卷模式、子模式等一般要建立起数据字典,以说明它们的标识

符、同义名及有关信息。

7信息编码设计

7.1代码结构设计

确认信息分类编码总体方案,进行分类代码结构设计。

7.2代码编制

按代码结构编制信息代码

提高中小学教学质量在于课堂

中小学课堂教学作为一种教育人的生命活动，是人生中一段重要的生

命经历。对此，全国著名特级教师窦桂梅深有感触“课堂是一个值得我们

好好经营的地方，是我们人生修炼的道场。课堂就是一本人生的大书，赢

在课堂，就是赢得人生。”我们还要理直气壮地说课堂是学校的血脉、教

师的根基、学生的跑道，教学质量不能输在课堂，精彩人生不能输在课

堂。全面提高中小学教学质量就要赢在课堂，这是奠基、这是底线、这是

焦点、这是根本。

当下，我们认真审视和考量中小学课堂教学，不难发现教师教得苦、

学生学得累、质量难得好的现象还是比较普遍，主要困境如下：

一是教学理念转变不到位。课改的核心理念是为了每一位学生的发

展，以人为本。但在课堂教学现状中我讲你听、我写你记、我考你背仍然

流通。考点为中心，考题为中心，考试为中心仍然盛行。穿新鞋，走老路

只管教，不管学重考试，轻能力仍然存在。

二是教学目的窄化、不明确。我们的教师应该是既传学习之道，更传

做人之道既授课堂学业，更授立身基业既解攻书之惑，更解成长之惑。现

实中有些老师则是将“传道授业解惑”直接演绎为知识传授、解题训练，

考试高分是教学的唯一目的或最为重要的目的。

三是教学目标落实不清楚。课程改革提出教学三维目标，即知识与技

能，过程与方法，情感、态度与价值观。

四是教学内容封闭不科学。当今的教学改革关注自然、关注社会、关

注生活、关注热点。选拔考试突出考能力、考素养、考思辨。令人担忧的

是有些老师在教材使用上拘泥教材，内容选择上应付考试，直接导致教师

走进苦海，学生跳进题海。

五是教学方式单一不管用。课程改革倡导“自主、合作、探究”的学

习方式，走进新课改，对话教学、问题教学、探究教学效果显著。

六是教学效率偏低不高效。有的课堂"互动"只停留在形式上，假互

动、无效热闹充斥课堂。自主、合作、探究或是牵强附会，或是徒有虚

名，或是无病呻吟。表面上看起来课堂比较活跃，，实际上浪费了时间，

浪费了精力，效率低下。

七是教学主体忽视不全面。一部分课堂教学，仍然存在着学生的主体

作用被忽视的现象。有些教师的教学基点过高，视野狭窄，盯住尖子，以

牺牲时间、精力抢抓分数为代价，造成恶性循环。

八是教学手段简单不恰当。有些教师既不板书课题，也不板书主要内

容。看不见老师的循循善诱，听不到老师的画龙点睛。只是照本宣科、点

击鼠标、呈现菜单，一个问题接一个问题闪现，然后呈现答案，呼啦一

片，课就结束了。

一要赢在理念驱动。教学理念，是指在教学实践中形成的关于教学工

作的思想、观念，以及对某些问题的理性认识，它对于教学工作、教学行

为具有指导、引领的作用。正确的教学理念会给教学活动指明方向和道

路，并提高课堂教学水平。新课程改革反复强调理念是思想的先导、行为

的指南。顾明远先生一语道出真谛：“任何教育行为都应以教育理念为指

导，教育教学理念贯穿于教育教学的全过程，很难想象缺乏理念或理念单

一的教育教学过程，将会带来怎样的后果。”中小学课堂教学实践证明：

先进的教学理念有助于激发学生的学习兴趣，有助于培育学生的学科素

养，有助于打造学科的高效课堂，有助于提升课堂的教学质量。

二要赢在目标导学。新课程倡导的三维教学目标是课堂教学导引、导

入、导学的根本。目标导学是课堂教学的起点，也是课堂教学的归宿。价

值观强调个人价值与社会价值的统一；科学的价值与人文价值的统一。课

堂教学的实施其三维目标缺一不可、互为整体，在具体教学过程中应该有

机融入、自然渗透，决不可人为割裂，穿鞋戴帽，顾此失彼。

三要赢在兴趣培养。苏霍姆林斯基说过：“在每一个年轻的心灵里，

存放着求知好学、渴望知识的火药。就看你能不能点燃这火药。”可见，

激发学生的兴趣就是点燃渴望知识的导火索。兴趣，是学生学习一切知识

的精神与力量源泉。但兴趣是不能强求的，要顺其自然、因势利导，想方

设法地着力培养。兴趣的培养，要触发学生的学习责任感和内驱力，需要

不断地强化知识积累。因为知识储备是兴趣爱好的基础，知识越丰富的

人，兴趣也越广泛。知识贫乏的人，兴趣也会是贫乏的。一般来说，人都

会因为兴趣而执着于某一项活动，并在最后取得或小或大的成功。有了浓

厚的兴趣、有了学习的动力，就会有丰富的想象力，就会有合理的联想

力，从而促使学习成为一种享受、一种快乐。

学习兴趣的教学，是一座冰山。美国教育家哈曼说得精辟：“那些不

设法勾起学生求知欲的教学，正如同锤打着一块冰冷的生铁。”

四要赢在教材探究。教材是学生自主学习的重要资源和工具，它不仅

决定课堂教学的内容，而且提供了教学活动的基本线索和学习方法。教师

把握教材，要经过解读、深究、理解、活用。根据认识过程的普遍规律和

教学过程中学生的认知特点，学生系统掌握知识，常常是从对教材的感知

开始，感知越丰富，观念越清晰，形成概念和理解知识就越容易，同时教

材也使学生在学习过程中获得的知识更加系统化、规范化。新课程倡导教

师用教材教，而不是教教材的教育理念日渐深入人心。教师要研读教材，

为教学明晰方向；吃透教材，为教学正确定位；把握教材，为教学夯实基

础；用好教材，为教学质量负责；整合教材，为教学活动充电；活化教

材，为教学生命奠基。教材无非是个例子，教师要牵引学生通过对教材的

学习、感悟、理解，转换为自主、合作、探究的学习方式，获得真知，提

升素养。正如著名心理学家皮亚杰所说：“一切真理都要学生自己获得，

或者由他重新发现，而不是简单地传递给他。”

五要赢在角色转换。传统的教师把自己置于课堂的中心，居高临下，

以知识权威者的身份说话，从而使课堂教学成了教师的“个人秀”。在教

学中，有些教师孤芳自赏，忠实于知识的传授，疏忽了对学生的能力培

养；关注于自己的表演，忽视了学生的参与互动；沉浸于应试的教学，忽

略了学生的全面发展。在这样的课堂中，教师几乎“垄断”了课堂里的所

有话语。

七要赢在教法活用。教学有法，教无定法。没有最好的方法，只有比

较适宜的方法。课堂教学模式不是成不变的，而是在不断发展变化的。新

课程鼓励教师根据教学内容和学生实际，正确选