详细设计说明书规范

合集下载

详细设计说明书

详细设计说明书

详细设计说明书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所示。

详细设计说明书

详细设计说明书

作 者
贾彬 贾彬
2006.10.30
V 2.2
添加了密码登陆功能。
贾彬
2006.11.02
V 2.3
1.精简了一部分代码并对保存到文件做了 处理使得被保存的文件变成乱码提高安全 性。 2.针对保存的改变载入部分也做了相应的 处理。 1.改善了打印模块的功能,增加了按编号 打印工资表,信息表和全体工程的工资表 ,信息表。 2.将打印的信息直接输出到.doc文件方便 用户打印使用。 3.在打印功能中还加入了可选的打印预览
2.1程序描述 2.1程序描述
该函数的主要是完成系统软件测试工程师信息的 输入。 输入。
2.2功能 2.2功能
主函数的功能主要是完成软件测试工程师信息的输入。 主函数的功能主要是完成软件测试工程师信息的输入。在提示 用户输入信息中,提示用户输入的数值或字符串。 用户输入信息中,提示用户输入的数值或字符串。同时对用户 的输入进行合法性值域判断, 的输入进行合法性值域判断,如果用户输入错误则提示用户重 新输入。最多存储10000个软件测试工程师的信息。 10000个软件测试工程师的信息 新输入。最多存储10000个软件测试工程师的信息。
1.5输出项目 1.5输出项目
主函数在运行结束后返回到操作系统。 主函数在运行结束后返回到操作系统。 正常退出返回0 异常退出返回1 正常退出返回0。异常退出返回1。
1.6算法 1.6算法
显示供用户选择的菜单,提示用户选择, 显示供用户选择的菜单,提示用户选择,接收用户选 根据用户选择调用相应的功能函数。 择,根据用户选择调用相应的功能函数。
6.各函数调用关系 6.各函数调用关系
menu InitData WhichChoose InputEngineerInformation DeleteEngineerInformation SearchEngineerInformation ModifyEngineerInformation CalculateEngineerSalary 主函数main 主函数main EngineerInfomationSave EngineerInformationNoSort EngineerInformationNameSort EngineerInformationWorkYearSort OutputEngineerInfomation DeleteEngineer EngineerInfomationReport EngineerInformationReload SystemOver

详细设计说明书

详细设计说明书

神鹰舞者开发文档详细设计说明书山东海天软件学院神鹰舞者2011.09第九届齐鲁大学生软件设计大赛参赛作品团队成员:刘少东,涂芬,杨飏,李雪,廖志鹏目录1引言 (3)1.1编写目的 (3)1.2背景 (3)1.3定义 (4)1.4参考资料 (4)2程序系统的结构 (4)2.1需求概述 (5)2.2软件结构 (5)3程序描述 (9)3.1功能 (9)3.2性能 (9)3.3输入项目 (9)3.4输出项目 (9)3.5存储分配 (9)3.6限制条件 (11)1引言1.1编写目的本说明书是神鹰舞者游戏的详细设计说明书,用以描述手机游戏功能的具体实现,详细设计阶段的目标是确定应该怎样具体地实现该系统,也就是,经过这个阶段的设计工作,应该得出对目标系统的精确描述,从而在编码阶段可以把这个描述直接翻译成用某种程序设计语言书写的程序。

详细设计的结果基本上决定了最终程序代码的质量。

详细设计要求逻辑模块正确,处理过程简明易懂。

在确定功能结构图的同时,进一步确定每一模块的具体实现方法、物理模型等。

预期读者:软件开发人员。

1.2背景iPhone,Android自上市以来,凭借其精致的屏幕显示效果、灵敏的触摸、强大的游戏功能,多点触控等全新的人机操作体验,使其迅速成为手机市场的宠儿,大量的iPhone,Android追随者应运而生,所以,我们决定开发这款手机游戏。

此款软件背景以舞者的灵感发展而来,可以是玩家自己选择歌曲可以自己选择衣服和头饰可以自己选择舞蹈场景,于此软件可以给出相应的分数,让玩家尽显舞者的风范和魅力。

此软件产品与其他任何软件无连接关系,是一项独立的软件,全部内容自含。

软件开发的使用者为随身携带iPhone/Android的人群,开发意图是为用户在闲暇时间提供娱乐。

我们开发的这款游戏充分体现了iPhone/iPod touch/Android的特点,让用户在闲暇时间能够获得较好的休闲娱乐体验,尽情享受手指在屏幕滑动的乐趣!a.开发的软件系统的名称:神鹰舞者b. 本项目的委托单位:第九届齐鲁软件设计大赛组委会本项目的任务提出者:本组所有成员本项目的任务开发者:本组所有成员本项目用户:iPhone或iPod touch或Android用户本项目开发日期:2011年7月13日—2011年9月15日c. 版本信息:本软件为独立的开发软件,是由山东海天软件学院神鹰舞者队开发,与其他任何软件没有连结关系。

详细设计说明书范例

详细设计说明书范例
3.1
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系统操作对话框 ? 测试要点
数据库连接情形:正常情形,数据库文件缺少,外部系统异样。 系统设置获取:正常情形,外部系统异样。

详细设计说明书的编写

详细设计说明书的编写
第七章 详细设计 说明书的编写
软件学院
学习目标
❖ 一、了解详细设计的任务和步骤 ❖ 二、详细设计说明书的内容要求和编写指南 ❖ 三、掌握用CASE工具绘制算法/流程图的
方法
7.1 详细设计概述
❖ 在概要设计阶段,应设计系统的物理实现方案、软 件的整体结构和存储数据结构。通过这个阶段的工 作将划分出组成系统的物理元素——程序、文件、 数据库、人工过程和文档等等,每个物理元素仍然
3.输出项
给出每一个输出项的特性,包括名称、标识、数据 的类型和格式,数据值的有效范围,输出的形式、 数量和频度,输出媒体、对输出图形及符号的说明、 安全保密条件等等。
4.算法
详细说明本程序所选用的算法,具体的计算公式和 计算表等)辅以必要的说明 来表示本程序的逻辑流程。
详细设计阶段的目标及任务
❖ 详细设计阶段的任务是:
①为每个模块确定采用的算法。选择合适的工具表达算 法,写出模块的详细过程性描述。
②确定每个模块使用的数据结构。 ③确定模块接口的细节,包括外部接口,用户界面,系
统内部其他模块的接口以及模块输入数据、输出数据和 局部数据的全部细节。在详细设计结束后,应该把上述 内容写入详细设计说明书,并且通过复审形成正式文档, 并交付给下一阶段(编码阶段)作为工作的依据。 ④为每个模块设计出一组测试计划。
1.程序描述
给出对该程序的简要描述,主要说明安排设计本程 序的目的、意义,并且还要说明本程序的特点(如, 是常驻内存还是非常驻?是否子程序?是可重入的还 是不可重入的?有无覆盖要求?是/顷序处理还是并 发处理等)。有时也可在功能项里进行描述。
2.输入项
给出每一个输入项的特性,包括名称、标识、数据 的类型和格式、数据值的有效范围、输入的方式、 数量和频度、输入媒体、输人数据的来源和安全保 密条件等等。

详细设计说明书

详细设计说明书

—软件工程详细设计说明书1.引言编写目的编写详细设计说明书的目的是为了使开发人员在完成概要设计说明书的基础上,完成概要设计的各项功能规定;为程序员写出实际的程序代码提供依据。

它是软件设计阶段所有任务和所有相关人员所需的参考资料。

预期的读者为系统的开发者、使用者和指导老师。

背景1.开发软件系统的名称:学生体质测试结果统计分析系统;2.任务提出者:;3.开发者:;4.》5.用户:浙江工业大学全体师生;6.本系统将使用MySQL作为数据库存储系统。

参考资料1.本小组成员撰写的《可行性分说明书》;2.本小组成员撰写的《需求分析说明书》;3.本小组成员撰写的《概要设计说明书》。

2. 系统的结构设计、根据学生体质测试结果统计分析系统的概要设计,本系统按照功能分解,可以分解为学生登录系统、教师登录系统和管理员登录系统。

三个系统又可以分为几个小系统,总的系统结构图,结构流程图如下:图总体系统结构图图结构流程图3.人机交互界面设计!系统的初始界面:图学生系统学生登录后界面:图$密码修改界面:图成绩查询界面:\图学生的重修申请界面:图学生提意见界面:图管理员系统》管理员登陆界面:图修改密码:》图信息导入与修改界面:图信息导入:图信息导入成功提示:~图信息修改——插入:图:信息修改——删除:图信息修改——更新:图科目修改界面——插入:!图科目修改界面——删除:图科目修改界面——插入:图@重修安排界面:图查看学生申请重修界面:…图查看相关教师信息:}图发布学生重修安排结果:图;查看学生对权限的申请:图图教师系统教师登陆界面:图密码修改界面:图密码修改界面:图查看重修情况:图查看学生建议界面:图图成绩录入界面:图4.模块设计.模块1(登录服务)功能学生、教师、管理员登录系统。

输入项账号、密码输出项产生SQL语言查询权限表,结果正确登录系统,失败给出相应成功失败提示。

流程逻辑图模块1(登录服务)的流程逻辑图接口硬件接口:主要就是TCP/IP层中的网络接口层软件接口:具体来说开发中可能用到的ADO的常用对象有以下几个:1.连接对象(Connection):用来连接数据库。

软件开发规范之五_详细设计说明书

软件开发规范之五_详细设计说明书

五、详细设计说明书五、详细设计说明书1.引言 (1)1.1编写目的 (1)1.2项目背景 (1)1.3定义 (2)1.4参考资料 (2)2.总体设计 (2)2.1需求概述 (2)2.2软件结构 (2)3.程序描述 (2)3.1功能 (3)3.2性能 (3)3.3输入项目 (3)3.4输出项目 (3)3.5算法 (3)3.6程序逻辑 (3)3.7接口 (3)3.8存储分配 (3)3.9限制条件 (3)3.10测试要点 (3)1.引言1.1编写目的【阐明编写详细设计说明书的目的,指明读者对象。

】1.2项目背景【应包括项目的来源和主管部门等。

】五、详细设计说明书1.3定义【列出文档中所用到的专门术语的定义和缩写词的原文。

】1.4参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,可包括:a.项目的计划任务书、合同或批文;b.项目开发计划;c.需求规格说明书;d.概要设计说明书;e.测试计划(初稿);f. 用户操作手册(初稿);g.文档中所引用的其他资料、软件开发标准或规范。

】2.总体设计2.1需求概述2.2软件结构【如给出软件系统的结构图。

】3.程序描述【逐个模块给出以下的说明:】五、详细设计说明书3.1功能3.2性能3.3输入项目3.4输出项目3.5算法【模块所选用的算法。

】3.6程序逻辑【详细描述模块实现的算法,可采用:a.标准流程图;b.PDL 语言;c.N-S图;d.PA D;e.判定表等描述算法的图表。

】3.7接口3.8存储分配3.9限制条件3.10测试要点【给出测试模块的主要测试要求。

】。

详细设计说明书

详细设计说明书

详细设计说明书
设备管理系统
登录
权限管理
设备管理维修管理用户管理密码管理添加设备维护设备信息设备现值录入维修信息维护维修信息录入用户信息维护用户信息修改自身密码
开始
输入用户名和密码
调用权限认证系统
终止Y
N
用户是否合法
用户名或密码输入错误进入系统
开始
设备信息、设备状态信息
调用查询模块、新
设备数据录入
进入系统
响应操作消息和内筒
终止
开始
维修设备信息,数据调用设备基础信息模块
进入系统
响应操作消息
终止
开始
输入用户原密码、新密码以
及确认密码
终止
两次密码输入不一致判断新密码是否与确认密码一致
操作成功
开始
根据提示依次输入相应信息调用用户信息管理模块
进入相应界面
响应操作信息
终止。

  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

详细设计说明书规范
目录
1.引言 (3)
1.1编写目的 (3)
1.2项目背景 (3)
1.3术语说明 (3)
1.4参考资料 (3)
2.软件结构 (4)
2.1 需求概述 (4)
2.2 软件结构 (4)
3.程序设计说明 (5)
3.1模块描述 (5)
3.2 功能 (5)
3.3 性能 (5)
3.4 输入项 (5)
3.5 输出项 (6)
3.6 算法 (6)
3.7 程序逻辑 (6)
3.8 接口 (7)
3.9 存储分配 (7)
3.10注释设计 (7)
3.11限制条件 (8)
3.12 测试要点 (8)
1.13尚未解决的问题 (8)
1.引言
1.1 编写目的
∙ 说明编写详细设计说明书的目的;
∙ 指名详细设计说明书的读者对象。

1.2 项目背景
∙ 对开发软件的名称;
∙ 列出项目的任务提出者、开发者、以及与本项目开展工作直接有关的人员和用户。

1.3 术语说明
∙ 列出本文档中所用到的专门术语的定义和英文缩写词的原文。

1.4 参考资料
列举编写软件详细设计说明时所参考的资料,主要包
括:
∙ 项目经核准的计划任务书、合同或批文;
∙ 引用的软件开发标准或规范;
∙ 项目开发计划;
∙ 需求规格说明;
∙ 概要规格说明书;
∙ 测试计划(初稿);
∙ 用户操作手册(初稿);
∙ 文档中引用的其它资料等。

对每一项应该给出详细的信息,包括标题、作者、版本号、发表日期、出版单位或资料来源。

2.软件结构
2.1 需求概述
建树本软件的主要功能。

2.2 软件结构
用一系列图标列出本软件系统内的每个程序(包括每个模块和子程序)的名称、标识符,以及他们之间的层次结构关系。

图标常采用系统流程图的层次结构来
表示。

3.程序设计说明
3.1模块描述
将概要设计中的功能模块进行细化,形成若干个可编程的子模块,可用图标形式给出其结构。

对各模块给出说明。

3.2 功能
说明各模块具有的功能,可采用IPO图的形式进行描述。

3.3 性能
说明对模块全部性能的要求,包括对精度、灵活性和时间特性的要求。

3.4 输入项
描述每个输入项的特性,包括:名称、标识、数据的
类型和格式、数据值的有效范围、输出的形式、数量和频度、输入媒体、输入数据的来源和安全保密条件等。

3.5 输出项
描述每一个输出项的特征,包括:名称、标识、数据的类型和格式、数据值的有效范围、输出的形式、数量和频度、输出媒体、对输出图形及符号的说明、安全保密条件等。

3.6 算法
详细说明模块所选用的算法,具体的计算公式和计算步骤。

3.7 程序逻辑
采用图表的方式详细说明模块实现的算法,描述算法的图表主要有:
∙ 程序流程图;
∙ PDL(Program Design Language)程序设计语言;
∙ N-S图;
∙ PAD(Problem Analysis Diagram)问题分析图;
∙ 判定表。

3.8 接口
用图的形式说明本模块所隶属的上一层模块及隶属
于本模块的下一层模块,说明参数赋值和调用的方式,说明与本模块直接关联的数据结构(数据库、数据文卷)。

3.9 存储分配
根据需要、说明模块的存储分配。

3.10注释设计
说明准备本模块中添加的注释,如:
∙ 加在模块首部的注释;
∙ 加在各分支点处的注释;
∙ 对各变量的功能、范围、缺省条件等所加的注释;
∙ 对使用的逻辑所加的注释等。

3.11限制条件
说明本模块运行中所受到的限制条件。

3.12 测试要点
给出对本模块进行单元测试的主要测试要求,包括对测试的技术要求、输入数据、预期结果等的规定。

1.13 尚未解决的问题
说明本模块在设计中尚未解决而设计者认为在软件完成了之前应解决问题。

相关文档
最新文档