详细设计说明书(5)
详细设计说明书
详细设计说明书1.导言(Introduction)本章对该文档的目的、功能范围、术语、相关文档、参考资料、版本更新进行说明。
1.1 目的(Purpose)本文档的目旨在推动软件工程的规范化,使设计人员遵循统一的详细设计书写规范,节省制作文档的时间,降低系统实现的风险,做到系统设计资料的规范性与全面性,以利于系统的实现、测试、维护、版本升级等。
详细设计的详细程度,应达到可以编写程序的程度。
1.2 范围(Scope)本文档用于软件设计阶段的详细设计,它的上游(依据的基线)是《概要设计说明书》,它的下游是源程序清单及单元测试计划,并为单元测试报告提供测试依据。
该范围应覆盖《概要设计说明书》中的功能点列表、性能点列表、接口列表。
软件详细设计的范围是:各子系统的公用模块实现设计、专用模块实现设计、存储过程实现设计、触发器实现设计、外部接口实现设计、部门角色授权设计、其他详细设计等。
按照3层结构(B/A/S)的布局,详细设计应从下面3个方面进行。
数据库服务器上的面向数据的设计:数据字典物理设计、基本表物理设计、中间表物理设计(报表设计)、临时表物理设计、视图物理设计、存储过程物理设计、触发器物理设计。
应用服务器上的面向业务逻辑的设计:接口数据设计、中间件设计、数据通信传输设计、可视构件设计、非可视构件设计、角色授权设计、功能点设计(功能点列表设计)。
浏览器上的面向对象的设计:录入修改界面设计、浏览查询界面设计、登录注册界面设计、信息发布界面设计。
1.3 术语定义(Terms Glossary)术语定义,如表6-16所示。
表6-16 术语定义1.4 参考资料(References)[1] 《概要设计说明书》[2] 《需求分析说明书》[3] 《软件合同》[4] 命名规范[5] 程序设计规范[6] 界面设计规范1.5 相关文档(Related Documents)[1] 源程序清单[2] 单元测试计划及报告[3] 《用户使用手册》1.6 版本更新记录(V ersion Updated Rcord)版本更新记录,如表6-17所示。
详细设计说明书范例
3.2
3.3
3.4
3.5
3.6
3.7
3.8
3.9
3.10 01登岸模块 .........................................................................................................................................6 02治理模块 ....................................................(本文来自: 小草范文
数据库连接正常 数据库数据正常 输入的书号合理合法 输入的书号不合理 输入的书号不合法 数据库数据异样 数据库连接异样
3.2.3 相关信息获取模块 ? 功能
获取合法读者的借书记录 ? 输入项目
合法读者证号(整型常量);读者已借图书信息(引用型字符串) ? 输出项目
查询操作结果(BOOL值) ? 程序逻辑
对用户输入的响应: 合法输入,能够正常挪用子模块;
非法输入,系统可否分辨,并作出响应(提出警告);
子模块的异样状况,系统可否及时做出响应。
3.2借书模块 ? 功能
查验输入的读者证号 运行借书对话框
获取该读者的相关信息 查验输入的图书号 记录借书 ? 输入项目
读者证号、图书书号(用户输入) ? 输出项目
m_BookOutDlg CBookOutDlg 借书对话框 m_BookInDlg CBookInDlg 还书对话框 m_BookQuiryDlg CBookQuiryDlg 图书查询对话框 m_SysDlgCSysDlg系统操作对话框 ? 测试要点
数据库连接情形:正常情形,数据库文件缺少,外部系统异样。 系统设置获取:正常情形,外部系统异样。
详细设计说明书范本
详细设计说明书1.引言1.1编写目的本详细设计说明书是针对网络信息体系结构的课程作业而编写。
目的是对该项目进行详细设计,在概要设计的基础上进一步明确系统结构,详细地介绍系统的各个模块,为进行后面的实现和测试作准备。
本详细设计说明书的预期读者为本项目小组的成员以及对该系统感兴趣,在以后想对系统进行扩展和维护的人员。
1.2背景a.[待开发的系统的名称:Lyra Resource Platform;b.本项目的任务提出者: 赵东,成富,陈良,窦文敏开发者:赵东,成富,陈良,窦文敏用户:所有对该项目感兴趣,并想通过该项目的产品提高资源检索速度和质量,方便的进行资源检索,预览,上传及下载的用户。
2.系统的结构z ui:系统界面部分,负责接受用户输入,显示系统输出,负责其他模块功能的协调调用,并含有站内搜索功能,即在用户指定的已打开的ftp站点中搜索用户需要的资源。
ui 部分调用common部分的功能读取xml文件中保存的界面元素属性信息,用户最近访问过的10个ftp信息,用户选择的下载的ftp内容列表及其他需要通过xml文件保存的信息。
z client:实现ftp客户端的功能,ftp连接,ftp上传及下载:上传或下载用户指定的资源,并返回相应的信息。
z search:资源实时检索部分,根据用户输入的资源名称关键字,资源类型和选择的检索方式检索用户需要的资源,并验证资源的可用性,返回可用资源及其大小,速度等相关信息。
z preview:资源预览部分,显示用户选择的资源的部分内容,以使用户决定是否需要该资源。
preview部分调用common部分读取属性文件的内容亦显示预览资源内容的显示格式。
3.模块1(ui)设计说明3.1模块描述实现用户界面的包,含有11个文件51个类,是本系统中最复杂的代码。
3.2功能负责接受用户输入,显示系统输出,其他模块功能的协调调用,并含有站内搜索功能,即在用户指定的已打开的ftp站点中搜索用户需要的资源。
详细设计说明书
—软件工程详细设计说明书1.引言编写目的编写详细设计说明书的目的是为了使开发人员在完成概要设计说明书的基础上,完成概要设计的各项功能规定;为程序员写出实际的程序代码提供依据。
它是软件设计阶段所有任务和所有相关人员所需的参考资料。
预期的读者为系统的开发者、使用者和指导老师。
背景1.开发软件系统的名称:学生体质测试结果统计分析系统;2.任务提出者:;3.开发者:;4.》5.用户:浙江工业大学全体师生;6.本系统将使用MySQL作为数据库存储系统。
参考资料1.本小组成员撰写的《可行性分说明书》;2.本小组成员撰写的《需求分析说明书》;3.本小组成员撰写的《概要设计说明书》。
2. 系统的结构设计、根据学生体质测试结果统计分析系统的概要设计,本系统按照功能分解,可以分解为学生登录系统、教师登录系统和管理员登录系统。
三个系统又可以分为几个小系统,总的系统结构图,结构流程图如下:图总体系统结构图图结构流程图3.人机交互界面设计!系统的初始界面:图学生系统学生登录后界面:图$密码修改界面:图成绩查询界面:\图学生的重修申请界面:图学生提意见界面:图管理员系统》管理员登陆界面:图修改密码:》图信息导入与修改界面:图信息导入:图信息导入成功提示:~图信息修改——插入:图:信息修改——删除:图信息修改——更新:图科目修改界面——插入:!图科目修改界面——删除:图科目修改界面——插入:图@重修安排界面:图查看学生申请重修界面:…图查看相关教师信息:}图发布学生重修安排结果:图;查看学生对权限的申请:图图教师系统教师登陆界面:图密码修改界面:图密码修改界面:图查看重修情况:图查看学生建议界面:图图成绩录入界面:图4.模块设计.模块1(登录服务)功能学生、教师、管理员登录系统。
输入项账号、密码输出项产生SQL语言查询权限表,结果正确登录系统,失败给出相应成功失败提示。
流程逻辑图模块1(登录服务)的流程逻辑图接口硬件接口:主要就是TCP/IP层中的网络接口层软件接口:具体来说开发中可能用到的ADO的常用对象有以下几个:1.连接对象(Connection):用来连接数据库。
软件工程详细设计说明范文
软件工程详细设计说明范文(中英文实用版)Title: Example of a Detailed Software Engineering Design Document Title: 软件工程详细设计说明书范例Introduction:The detailed design document serves as a comprehensive guide for the development team, outlining the architecture, components, interfaces, and data flow of the software system.This document is an essential part of the software engineering process, ensuring that all team members have a clear understanding of the system"s design and functionality.介绍:详细设计说明书是开发团队的全面指南,概述了软件系统的架构、组件、接口和数据流。
这是软件工程过程中的一个重要文档,确保所有团队成员对系统的设计和功能有一个清晰的理解。
Architectural Design:The architectural design section provides an overview of the system"s overall structure, including the main components, their relationships, and the principles of operation.This section should clearly illustrate the system"s modularity, scalability, and maintainability.架构设计:架构设计部分概述了系统的整体结构,包括主要组件、它们的关系和操作原则。
(完整版)软件系统详细设计说明书模板
(完整版)软件系统详细设计说明书模板xxxxx系统详细设计说明书版本历史修改记录⽬录1引⾔ (5)1.1编写⽬的 (5)1.2背景 (5)1.3参考资料 (5)1.4术语定义及说明 (5)2设计概述 (5)2.1任务和⽬标 (5)2.1.1需求概述 (5)2.1.2运⾏环境概述 (5)2.1.3条件与限制 (6)2.1.4详细设计⽅法和⼯具 (6)3系统详细需求分析 (6)3.1详细需求分析 (6)3.2详细系统运⾏环境及限制条件分析接⼝需求分析 (6)4总体⽅案确认 (6)4.1系统总体结构确认 (6)4.2系统详细界⾯划分 (7)4.2.1应⽤系统与⽀撑系统的详细界⾯划分 (7) 4.2.2系统内部详细界⾯划分 (7)5系统详细设计 (7)5.1系统程序代码架构设计 (7)5.1.1UI(User Interface)⽤户界⾯表⽰层 (7)5.1.2BLL(Business Logic Layer)业务逻辑层 (8) 5.1.3DAL(Data Access Layer)数据访问层 (8) 5.1.4Common类库 (8)5.1.5Entity Class实体类 (8)5.2系统结构设计及⼦系统划分 (8)5.3系统功能模块详细设计 (9)5.3.1XX⼦系统 (9).1XX模块 (9)列表和分页 (9)创建XX (9).2XX模块 (9)XX列表 (9)XX修改 (9)5.3.2XX⼦系统 (9)5.3.6.1⽤户管理模块 (9)5.3.6.2⾓⾊管理模块 (14)5.3.6.3系统设置模块 (14)5.3.6.4系统登录注销模块 (14)5.4系统界⾯详细设计 (14)5.4.1外部界⾯设计 (14)5.4.2内部界⾯设计 (14)5.4.3⽤户界⾯设计 (14)6数据库系统设计 (14)6.1设计要求 (14)6.2信息模型设计 (14)6.3数据库设计 (14)6.3.1设计依据 (14)6.3.2数据库种类及特点 (15)6.3.3数据库逻辑结构 (15)6.3.4物理结构设计 (15)6.3.5数据库安全 (15)6.3.6数据字典 (15)7信息编码设计 (15)7.1代码结构设计 (15)7.2代码编制 (15)1引⾔1.1编写⽬的说明编写详细设计⽅案的主要⽬的。
详细设计说明书模板
详细设计说明书模板项目名称:项目版本:拟制:审核:批准:文件版本:年月日详细设计说明书1.引言1.1 编写目的说明编写详细设计说明书的目的,指明读者对象。
1.2 背景说明:a.待开发软件系统的名称;b.本项目的任务提出者、开发者和用户。
1.3 定义列出本文档中所用到的专门术语的定义和外文缩写词的原文。
1.4 参考资料列出有关的参考资料,如:a.本项目的经核准的计划任务书或合同、上级机关的批文;b.属于本项目的其他已发布的文件;c.本文档中各处引用到的文件资料,包括所要用到的软件开发标准。
列出这些文件的标题、文件编号、发表日期和出版单位,说明能够取得这些文件的来源。
2.总体设计2.1 需求概述概述本产品的功能需求、性能需求等。
2.2 软件结构用图表列出本程序系统内的每个程序(包括每个模块和子程序)的名称、标识符和它们之间的层次结构关系(用软件系统结构图表示)。
3.程序1(标识符)设计说明从本章开始,逐个地给出各个层次中的每个程序的设计考虑。
以下给出的提纲是针对一般情况的。
对于一个具体的模块,尤其是层次比较低的模块或子程序,其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同,在这种情况下,只要简单地说明这一点即可。
3.1 程序描述给出对该程序的简要描述,主要说明安排设计本程序的目的意义,并且,还要说明本程序的特点(如:是常驻内存还是非常驻内存?有无覆盖要求?是顺序处理还是并发处理?等等)。
3.2 功能说明该程序应具有的功能,可采用IPO图(即输入-处理-输出图)的形式。
3.3 性能说明对该程序的全部性能要求,包括对精度、灵活性、存储容量、运行时间、响应时间、处理时间和更新时间的要求。
3.4 输入项给出每一个输入项的特性,包括名称、标识、数据的类型、格式、数据值的有效范围、输入的方式、数量和频度、输入媒体(如键盘)、输入数据的来源和安全保密条件等等。
3.5 输出项给出每一个输出项的特性,包括名称、标识、数据的类型、格式、数据值的有效范围、输出的形式、数量和频度,输出媒体(如屏幕)、对输出图形及符号的说明、安全保密条件等等。
详细设计说明书
详细设计说明书篇一:最好软件详细设计说明书参考文档中大软件详细设计D0903-0302丁丁网上购书系统详细设计Version r.0.0.1修订历史目录1 2 3 4 5 6绪言及目标 ........................................................ ........................................................... ................. 3 范围 ........................................................ ........................................................... ............................. 3 定义及缩写 ........................................................ ............................................................................ 3 引用 ........................................................ ........................................................... ............................. 3 角色及职责 ........................................................ ........................................................... ................. 3 工具及环境 ........................................................ ........................................................... ................. 4 6.1 6.2 6.3 6.4 7研发硬件配置 ........................................................ ........................................................... ...... 4 研发语言及编译器 ........................................................ (4)软件支持工具 ........................................................ ........................................................... ...... 4 第三方工具 ........................................................ ........................................................... . (4)高层分析 ........................................................ ........................................................... ..................... 5 7.17.2 7.3 7.4数据模型视图 ........................................................ ........................................................... ...... 5 抽象类视图 ........................................................ ........................................................... .......... 6 时序图......................................................... ........................................................... ................. 6 用户界面架构 ........................................................ ............................... 错误!未定义书签。
详细设计说明书(模板)
详细设计说明书(模板)东软机密文件编号:D05-PDT073详细设计说明书模板版本:0.0.0-1.2.02009-6-30东软集团股份有限公司软件开发事业部(版权所有,翻版必究)文件修改控制东软机密文件编号:项目编号DDR顺序号第版分册名称:第册/共册项目名称(项目编号)详细设计说明书(软件开发事业部)东软集团股份有限公司修改记录目录1引言 (1)1.1 目的 (1)1.2 背景 (1)1.3 词汇表 (1)1.4 参考资料 (1)2系统结构 (1)2.1 需求概述 (1)2.2 总体设计 (2)3.系统详细设计说明 (2)3.1 包及类结构设计 (2)3.2 模块设计 (2)3.3 Message文件管理Module (2)3.4 LOG管理Module (2)3.5 配置文件管理Module (2)3.6 异常模块说明 (3)4.其他设计要求 (3)4.1 单元测试 (3)4.2 注释及代码风格 (3)4.3 尚未解决问题 (3)5附件说明 (3)编写指南:本模板力图给出软件详细设计阶段可能包括的基本信息。
如果某个章节在项目或当前阶段中无法描述,则可保留其标题,注明“不适用”;如果需要对本模板的个别章节详细描述,也可将其形成单独的文档,成为本文档附件。
若文档中的某个章节已经在其他项目文档中加以描述,可保留标题,注明“参见(文档编号)(文档名称)(条款)”。
形成正式文档后须删除斜体字内容。
1引言1.1目的说明编写这份详细设计说明书的目的,指出预期的读者。
1.2背景叙述该项软件开发的意图、应用目标、作用范围以及其他应向读者说明的有关该软件开发的背景材料。
1.3词汇表列出本软件详细设计中专门术语的定义、英文缩写词的原词组和意义、项目组内达成一致意见的专用词汇,同时要求继承全部的先前过程中定义过的词汇,一般不包括需求或概要设计中已经定义的部分,通过参见方式表示其他地方定义内容。
文档位置;以及对该词汇的其他叫法。
详细设计的内容包括
详细设计的内容包括详细设计,是软件工程中软件开发的一个步骤,就是对概要设计的一个细化,就是详细设计每个模块实现算法,所需的局部结构。
在详细设计阶段,主要是通过需求分析的结果,设计出满足用户需求的软件系统产品。
(1)程序流程图。
程序流程图又称为程序框图,是使用最广泛然而也是用得最混乱的一种描述程序逻辑结构的工具。
它用方框表示一个处理步骤,菱形表示一个逻辑条件,箭头表示控制流向。
其优点是:结构清晰,易于理解,易于修改。
缺点是:只能描述执行过程而不能描述有关的数据。
(2)盒图。
盒图是一种强制使用结构化构造的图示工具,也称为方框图。
其具有以下特点:功能域明确、不可能任意转移控制、很容易确定局部和全局数据的作用域、很容易表示嵌套关系及模板的层次关系。
(3)PAD图。
PAD是一种改进的图形描述方式,可以用来取代程序流程图,比程序流程图更直观,结构更清晰。
最大的优点是能够反映和描述自顶向下的历史和过程。
PAD提供了5种基本控制结构的图示,并允许递归使用。
PAD的特点有:使用PAD符号设计出的程序代码是结构化程序代码;PAD所描绘的程序结构十分清晰;用PAD图表现程序的逻辑易读、易懂和易记;容易将PAD图转换成高级语言源程序自动完成;即可以表示逻辑,也可用来描绘数据结构;支持自顶向下方法的使用。
(4)PDL。
PDL也可称为伪码或结构化语言,它用于描述模块内部的具体算法,以便开发人员之间比较精确地进行交流。
语法是开放式的,其外层语法是确定的,而内层语法则不确定。
外层语法描述控制结构,它用类似于一般编程语言控制结构的关键字表示,所以是确定的。
内层语法描述具体操作,考虑到不同软件系统的实际操作种类繁多,内层语法因而不确定,它可以按系统的具体情况和不同的设计层次灵活选用,实际上任意英语语句都可用来描述所需的具体操作。
用它来描述详细设计,工作量比画图小,又比较容易转换为真正的代码。
PDL的优点:可以作为注释直接插在源程序中;可以使用普通的文本编辑工具或文字处理工具产生和管理;已经有自动处理程序存在,而且可以自动由PDL生成程序代码。
软件详细设计文档模板(最全面)
文档编号
版本
A1
密级
商密A
项目名称
Xx系统
项目来源
Xxx系统
详细设计说明书
(内部资料请勿外传)
编写:
日期:
检查:
日期:
审核:
日期:
批准:
日期:
XX公司
版权所有不得复制
文档变更记录
序号
变更(+/-)说明
作者
版本号
日期
批准
1
2
1.
1.1
此文档的背景
1.2
说明写这份详细设计说明书的目的。
本详细设计说明书编写的目的是说明程序模块的设计考虑,包括程序描述、输入/输出、算法和流程逻辑等,为软件编程和系统维护提供基础。本说明书的预期读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员。
6.4.2
设计系统内部各功能模块间的调用关系和数据接口。
6.4.3
规定人机界面的内容、界面风格、调用方式等,包括所谓的表单设计、报表设计和用户需要的打印输出等设计。此部分内容可能比较多。
7.
7.1
7.2
- Development evnironment: programming lanuague, database
详细设计应用系统的各个构成模块完成的功能及其相互之间的关系,用IPO或结构图描述各模块的组成结构、算法、模块间的接口关系,以及需求、功能和模块三者之间的交叉参照关系。
每个模块的描述说明可参照以下格式:
模块编号:
模块名称:
输入:
处理:
算法描述:
输出:
其中处理和算法描述部分主要采用伪码或具体的程序语言完成。
即使IF,While是单语句,也要使用“{ }”来划分程序块。
详细设计说明书
详细设计说明书有限公司变更记录修改点说明的内容有如下几种:创建、修改(+修改说明)、删除(+删除说明)目录1 文档介绍(标题1、宋体、三号、加粗) ............................. 错误!未定义书签。
1.1. 文档目的(标题2、宋体、小三、加粗) (1)1.2. 文档范围 (1)1.3. 读者对象 (1)1.4. 参考文献 (1)1.5. 术语与缩写解释.............................................. 错误!未定义书签。
1.6. 原型图例说明 (2)1.7. 系统设计编号规则 (2)1.7.1. 功能点编号规则 (2)1.7.2. 表格中的项目编号规则 (2)2 系统概述 (3)2.1 设计约束 (3)2.2 设计策略 (3)2.3 系统总体结构 (4)2.4 模块命名规则 (4)2.5 模块汇总表 (4)3 子系统总体设计 (5)3.1 FUNC_01子系统英文简称:子系统1名称 (5)3.1.1 数据模型(标题3、宋体、四号、加粗) (5)3.1.2 模块关系图 (5)3.2 FUNC_02子系统英文简称:子系统2名称 (5)3.2.1 数据模型 (5)3.2.2 模块关系图 (6)4 子系统模块详细设计 (6)4.1 FUNC_XXMW功能块 (6)4.1.1 FUNC_XXMW_XX 功能分类 (6)5 开发环境的配置 (8)6 运行环境的配置 (9)7 测试环境的配置 (9)详细设计说明书1前言1.1.文档目的提示:描述文档目的(正文,宋体,五号,非加粗)1.2.文档范围提示:描述文档适用的业务范畴1.3.读者对象提示:文档的使用对象1.4.参考文献提示:列出本文档的所有参考文献(可以是非正式出版物),格式如下:[标识符] 作者,文献名称,出版单位(或归属单位),日期例如:[AAA] 作者,《立项建议书》,机构名称,日期[SPP-PROC-SD] SEPG,系统设计规范,机构名称,日期1.5.名称术语提示:文档中所有表格字体统一为宋体、小五、非加粗1.6.原型图说明提示:设计原型的工具不做统一规定,但是一个系统的原型图例样式、界面风格要保持一致,要在此章节进行必要的约定和说明。
详细设计说明书编写规范
详细设计说明书编写规范1.文档结构-引言:简要介绍软件系统的背景和目的。
-系统概述:概括性地描述软件系统的功能和特点。
-模块设计:对系统中各个模块的设计进行详细说明。
-数据结构设计:描述系统中各个数据结构的设计。
-接口设计:详细描述系统中各个模块之间的接口设计。
-流程设计:描述系统中的各个流程的设计。
2.内容准确性-设计说明书应该准确地描述各个模块、数据结构和接口的设计。
-避免使用模糊和不明确的语言,确保文档所描述的内容一目了然。
-在设计过程中充分考虑到系统的可靠性、安全性和扩展性等方面的要求。
3.可读性和可理解性-使用清晰、简洁的语言,避免使用过于专业术语或过分简化的语句。
-使用图表、流程图等辅助工具来展示设计方案,使读者更容易理解。
-对于复杂的设计思路,可以进行分步详解,确保读者能够逐步理解。
4.格式规范-使用统一的字体、字号和行间距,使文档整体风格统一-使用标题、段落和编号等,使文档结构清晰、易读。
-对于代码、变量名等关键词,使用特定的格式或颜色标注,以便于阅读和查找。
5.补充说明-针对关键的设计决策,如算法选择、技术选型、数据结构的优缺点等,要进行适当的说明和分析。
-如有必要,可以附上相关的流程图、数据流图、类图等具体的设计图示,以辅助读者理解。
-如果存在已实施的系统或已有的模块,可以提供相关的代码片段或函数说明,以便于后续的参考和修改。
总之,详细设计说明书是软件开发过程中的重要文档,需要准确、清晰、易读、结构良好,并包含必要的图表和文档辅助说明。
只有符合规范的详细设计说明书才能更好地指导开发人员进行编码工作,从而保证软件系统的质量和可靠性。
附录5:详细设计说明书(GB8567——88)(1)
详细设计说明书(八号楼宿舍管理系统)1引言1.1编写目的在宿舍管理系统项目的前一阶段,也就是需求分析阶段中,已经将系统用户对本系统的需求做了详细的阐述,这些用户需求已经在上一阶段中对宿舍管理、管理员使用的实地调研中获得,并在需求规格说明书中得到详尽得叙述及阐明。
本阶段已在系统的需求分析的基础上,对宿舍管理系统做概要设计。
主要解决了实现该系统需求的程序模块设计问题。
包括如何把该系统划分成若干个模块、决定各个模块之间的接口、模块之间传递的信息,以及数据结构、模块结构的设计等。
在以下的概要设计报告中将对在本阶段中对系统所做的所有概要设计进行详细的说明。
在下一阶段的详细设计中,程序设计员可参考此概要设计报告,在概要设计对机票预定系统所做的模块结构设计的基础上,对系统进行详细设计。
在以后的软件测试以及软件维护阶段也可参考此说明书,以便于了解在概要设计过程中所完成的各模块设计结构,或在修改时找出在本阶段设计的不足或错误。
1.2背景本项目(宿舍管理系统)是由宝鸡文理学院委托,由305宿舍小组负责开发。
系统基于宿舍管理系统做出优化,实现了宿舍的人员管理、宿舍的人员安全管理、宿舍的卫生管理、宿舍的电源管理几大主要功能,为宿舍管的人员提供了极大的便利。
1.3定义1.3.1专业用语SQL SERVER: 系统服务器所使用的数据库管理系统(DBMS)。
SQL: 一种用于访问查询数据库的语言。
事务流:数据进入模块后可能有多种路径进行处理。
主键:数据库表中的关键域。
值互不相同。
外部主键:数据库表中与其他表主键关联的域。
ROLLBACK: 数据库的错误恢复机制。
1.3.2缩写系统:若未特别指出,统指本机票预定系统。
SQL: Structured Query Language(结构化查询语言)。
ATM: Asynchronous Transfer Mode (异步传输模式)。
1.4参考资料以下列出在概要设计过程中所使用到的有关资料:1、宿舍管理系统项目计划任务书《》软件开发小组2010/092、学生宿舍管理系统项目开发计划《》软件开发小组2018/113、需求规格说明书《》软件开发小组1999/034、用户操作手册(初稿)《》软件开发小组1999/045、软件工程及其应用周苏、王文等天津科学技术出版社1992/016、软件工程张海藩清华大学出版社1990/117、Computer Network A.S.Tanenbaun Prentice Hall 1996/01文档所采用的标准是参照《软件工程导论》沈美明著的“计算机软件开发文档编写指南”。
软件详细设计文档模板(最全面)
研发生产中心文档编号版本A1密级商密A 项目名称Xx系统项目来源Xxx系统详细设计说明书(内部资料请勿外传)编检审批XX公司版权所有不得复制文档变更记录期: 期: 期: 期:目录1. 引言 (5)1.1 编写目的和范围 (5)1.2 术语表 (5)1.3 参考资料 (5)1.4 使用的文字处理和绘图工具 (5)2. 全局数据结构说明 (7)2.1 常量 (7)2.2 变量 (8)2.3 数据结构 (8)3. 模块设计 (9)3.1 用例图 (9)3.2 功能设计说明 (10)3.2.1 模块1 (10)3.2.2 模块2 (11)4. 接口设计 (12)4.1 内部接口 (12)4.2 外部接口 (12)4.2.1 接口说明 (12)4.2.2 调用方式 (12)5. 数据库设计 (12)6. 系统安全保密设计 (12)6.1 说明 (12)6.2 设计 (12)6.2.1 数据传输部分 (12)6.2.2 IP 过滤分部 (13)6.2.3 身份验证部分 (13)7. 系统性能设计 (13)8. 系统出错处理 (13)1. 引言1.1背景此文档的背景1.2编写目的和范围说明写这份详细设计说明书的目的。
本详细设计说明书编写的目的是说明程序模块的设计考虑,包括程序描述、输入/输出、算法和流程逻辑等,为软件编程和系统维护提供基础。
本说明书的预期读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员。
1.3术语表定义系统或产品中涉及的重要术语,为读者在阅读文档时提供必要的参考信息1.4参考资料列出有关资料的名称、作者、文件编号或版本等。
参考资料包括:a.需求说明书、架构设计说明书等;b本项目的其他已发表的文件;c.引用文件、资料、软件开发标准等。
1.5使用的文字处理和绘图工具文字处理软件:[编写设计文档使用的文字处理软件,如RedOffice ] 绘图工具:[使用的UML工具,女口Rose Jude、Visio]2. 设计概述2.1 任务和目标2.1.1 需求概述2.1.2 运行环境概述2.1.3 条件与限制2.1.4 详细设计方法和工具3. 系统详细需求分析主要对系统级的需求进行分析。
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
详细设计说明书
1引言
1.1编写目的
1.2背景
说明:
a.工资发放系统
1.3定义
1.4参考资料
CBC 数据库开发
2程序系统的结构
见----流程图
3程序1(标识符)设计说明
从本章开始,逐个地给出各个层次中的每个程序的设计考虑。
以下给出的提纲是针对一般情况的。
对于一个具体的模块,尤其是层次比较低的模块或子程序,其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同,在这种情况下,只要简单地说明这一点即可。
3.1程序描述
3.2功能
见—流程图
3.3性能
该系统灵活性很高~~响应时间不超过5秒
3.4输人项
对每一个输入项的特性,包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。
数量和频度、输入媒体、输入数据的来源和安全保密条件等等。
3.5输出项
对每一个输出项的特性,包括名称、标识、数据的类型和格式,数据值的有效范围,输出的形式、数量和频度,输出媒体、对输出图形及符号的说明、安全保密条件等等。
3.6算法
该程序用到数据库存储模式中一些简单的加减运算
3.7流程逻辑
---见外部流程图
3.11限制条件
数据库版本为SQL server2000
3.12测试计划
将对程序进行多次调试
3.13尚未解决的问题
权限管理。