详细设计说明书规范
详细设计说明书
详细设计说明书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.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
用户是否合法
用户名或密码输入错误进入系统
开始
设备信息、设备状态信息
调用查询模块、新
设备数据录入
进入系统
响应操作消息和内筒
终止
开始
维修设备信息,数据调用设备基础信息模块
进入系统
响应操作消息
终止
开始
输入用户原密码、新密码以
及确认密码
终止
两次密码输入不一致判断新密码是否与确认密码一致
操作成功
开始
根据提示依次输入相应信息调用用户信息管理模块
进入相应界面
响应操作信息
终止。
软件设计文档国家标准 详细设计说明书(GB8567——88)
1引言 (2)1.1编写目的 (2)1.2背景 (2)1.3定义 (2)1.4参考资料 (2)2程序系统的结构 (2)3程序1(标识符)设计说明 (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存储分配 (4)3.10注释设计 (4)3.11限制条件 (4)3.12测试计划 (4)3.13尚未解决的问题 (4)4程序2(标识符)设计说明 (4)详细设计说明书1引言1.1编写目的说明编写这份详细设计说明书的目的,指出预期的读者。
1.2背景说明:a.待开发软件系统的名称;b.本项目的任务提出者、开发者、用户和运行该程序系统的计算中心。
1.3定义列出本文件中用到专门术语的定义和外文首字母组词的原词组。
1.4参考资料列出有关的参考资料,如:a.本项目的经核准的计划任务书或合同、上级机关的批文;b.属于本项目的其他已发表的文件;c.本文件中各处引用到的文件资料,包括所要用到的软件开发标准。
列出这些文件的标题、文件编号、发表日期和出版单位,说明能够取得这些文件的来源。
2程序系统的结构用一系列图表列出本程序系统内的每个程序(包括每个模块和子程序)的名称、标识符和它们之间的层次结构关系。
3程序1(标识符)设计说明从本章开始,逐个地给出各个层次中的每个程序的设计考虑。
以下给出的提纲是针对一般情况的。
对于一个具体的模块,尤其是层次比较低的模块或子程序,其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同,在这种情况下,只要简单地说明这一点即可。
3.1程序描述给出对该程序的简要描述,主要说明安排设计本程序的目的意义,并且,还要说明本程序的特点(如是常驻内存还是非常驻?是否子程序?是可重人的还是不可重人的?有无覆盖要求?是顺序处理还是并发处理等)。
3.2功能说明该程序应具有的功能,可采用IPO图(即输入一处理一输出图)的形式。
详细设计说明书模板
详细设计说明书模板项目名称:项目版本:拟制:审核:批准:文件版本:年月日详细设计说明书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 输出项给出每一个输出项的特性,包括名称、标识、数据的类型、格式、数据值的有效范围、输出的形式、数量和频度,输出媒体(如屏幕)、对输出图形及符号的说明、安全保密条件等等。
详细设计说明书编写规范
详细设计说明书编写规范1.文档结构-引言:简要介绍软件系统的背景和目的。
-系统概述:概括性地描述软件系统的功能和特点。
-模块设计:对系统中各个模块的设计进行详细说明。
-数据结构设计:描述系统中各个数据结构的设计。
-接口设计:详细描述系统中各个模块之间的接口设计。
-流程设计:描述系统中的各个流程的设计。
2.内容准确性-设计说明书应该准确地描述各个模块、数据结构和接口的设计。
-避免使用模糊和不明确的语言,确保文档所描述的内容一目了然。
-在设计过程中充分考虑到系统的可靠性、安全性和扩展性等方面的要求。
3.可读性和可理解性-使用清晰、简洁的语言,避免使用过于专业术语或过分简化的语句。
-使用图表、流程图等辅助工具来展示设计方案,使读者更容易理解。
-对于复杂的设计思路,可以进行分步详解,确保读者能够逐步理解。
4.格式规范-使用统一的字体、字号和行间距,使文档整体风格统一-使用标题、段落和编号等,使文档结构清晰、易读。
-对于代码、变量名等关键词,使用特定的格式或颜色标注,以便于阅读和查找。
5.补充说明-针对关键的设计决策,如算法选择、技术选型、数据结构的优缺点等,要进行适当的说明和分析。
-如有必要,可以附上相关的流程图、数据流图、类图等具体的设计图示,以辅助读者理解。
-如果存在已实施的系统或已有的模块,可以提供相关的代码片段或函数说明,以便于后续的参考和修改。
总之,详细设计说明书是软件开发过程中的重要文档,需要准确、清晰、易读、结构良好,并包含必要的图表和文档辅助说明。
只有符合规范的详细设计说明书才能更好地指导开发人员进行编码工作,从而保证软件系统的质量和可靠性。
设计说明书格式要求
设计说明书要求一、说明书篇幅:不少于5000字。
二、包括下述几部分(一)、封面:包括题目,学院名称,姓名,学号。
题目:能概括整个说明书最重要的内容,恰当、简明、引人注目(严格控制在20字以内)。
(二)、摘要(中文):说明书第一页为中文摘要(100字左右),应说明本设计的目的、内容、成果或结论。
相应注明本文的关键词3至4个。
(三)、目录:应是说明书的提纲,也是说明书组成部分的小标题,应将文内的章节标题依次排列,标题应简明扼要。
(四)、设计说明书包括以下内容:1.前言:是对整篇设计说明书的一个简短开场白,介绍研究背景、相关定义等。
2.正文:正文是说明书的核心内容,详细描述该设计的具体细节。
本设计包括工艺设计、物料横算2部分。
3.结语:是对前面设计的内容作系统的分析,给出一个总结,并提出设计的优缺点等。
4.附件:2张A4图纸。
一张总工艺图,一张工厂平面设计图。
(五)、参考文献:综述中列出的参考文献必须是与论文有密切关系的重要文献,要求10个以上。
参考文献按在正文中出现的先后次序列表于文后;具体格式要求见后。
三、说明书格式:(一)题目、署名及层次格式、文字、字数要求:1、文稿采用A4幅面word文档;中文标题为三号黑体,如有副标题,另起一行,字体为四号宋体;正文为小四号仿宋体;英文字体为Times NewRoman,标题字号为三号,字母全部大写;如有副标题,另起一行,首字母大写,正文为小四号字体;文稿应加注页码。
2、摘要和关键词(五号、黑体)写在题目后、正文前,摘要和关键词的内容部分为五号仿宋体。
3、说明书的层次,统一要求采用:1 *******1.1 *******(占一行或接排。
当接排时,标题后要加标点。
一级标题采用四号黑体,二级标题采用小四号黑体,三级标题采用小四号宋体加粗)1.1.1 *******1.1.1.1*******(二)文稿和图稿其它要求:1、正确阐述技术内容。
名词术语应符合国家有关标准、规范。
软件详细设计规格说明书
《软件详细设计规格说明书》格式一、引言1.为明确实验室设备管理系统的系统结构、安排项目规划与进度、制定详细测试计划、组织软件开发与测试,特撰写本文当。
本文档供项目经理、设计人员、开发人员参考。
2.项目背景任务提出者:学校实验室管理人员开发者:本小组的实验设计用户:学校实验室管理人。
3.参考资料。
《软件工程概论》李存珠李宣东编著南京大学计算机系出版 2001年8月《PowerBuilder9.0数据库项目案例导航》陈磊郭斌李翔北京清华大学出版社《软件工程实用教程》郭宁编著北京人民邮电出版社2006二、任务概述1、软件目标。
该阶段目的在于明确系统的数据结构和软件结构,此外总设计还将给出内部软件和外部系统部件之间的接口定义。
各个软件模块的功能说明,数据结构的细节以及具体的装配要求。
2、需求概述。
3、设计条件与限制。
软件设计应当表现出层次结构,它应巧妙地利用各个软件部件之间的控制关系。
设计应当是模块化的,即该软件应当从逻辑上被划分成多个部件,分别实现各种特定功能和子功能。
设计最终应当给出具体的模块,这些模块就具有独立的功能特性。
应当应用在软件需求分析期间得到的信息,采取循环反复的方法来获得设计。
三、软件设计1、软件处理流程描述。
2、软件总体结构设计。
3、模块功能设计。
(1)功能:系统功能操作系统:1)用户登陆管理:用户输入用户名以及密码,登陆用户界面2)系统维护管理:对日常的系统进行维护设备管理员系统:1)设备查询管理:管理员输入设备类别以及购买时间段查询设备信息。
2)设备维修管理:管理员输入设备维修信息并生成维修信息表。
3)设备购买管理:管理员输入设备购买信息并生成申请表,送给上级领导请求批准购买新设备。
新设备购入后进行设备登记并生成新设备信息表。
4)设备报废管理:管理员输入设备报废信息并生成报废信息表。
上级领导操作系统:1)审核管理:上级领导阅读上交的申请表并确定是否同意购买新设备,将信息返还给管理员,管理员根据领导的意思决定是否购买设备。
毕业(设计说明书)撰写基本要求
(设计说明书)撰写基本要求一篇完整的或设计说明书通常由题目(标题)、摘要、目次页()、引言(前言)、正文、结论、、致谢、附录等几部分构成。
XX(一)的结构1.题目XX题目即标题,它的主要作用是概括整个的中心内容。
因此,题目要确切、简短、精炼、传神.XX2.反映的纲要。
应列出通篇**组成部分的大小标题,分别层次,逐项标注页码,并包括注明、致谢、附录、图纸、等附属部分的页次,以便读者查找.3.摘要摘要是的高度概括,是全文的缩影,是长篇不可缺少的组成部分.要求用中、英文分别书写,一篇中文摘要不宜超过200~300字,外文摘要不宜超过250个实词.结尾要注明3~5个关键词.4.前言前言相当于的开头,是三段式的第一段(后二段是本论和结论)。
前言与摘要写法不完全相同,摘要要写得高度概括、简略,前言可以稍加具体一些,文字以1000字左右为宜。
前言一般应包括以下几个内容:①为什么要写这篇,要解决什么问题,主要观点是什么。
XX②对本研究主题范围内已有的评述(包括与课题相关的历史的回顾,资料来源,性质及运用情况等)。
③说明本所要解决的问题,所采用的研究手段、方式、方法。
明确研究工作的界限和规模。
④概括本课题研究所取得的成果及意义.XX5.正文的正文是对自己的研究工作详细的表述。
应包括以下内容:(1)理论分析部分XX详细说明所用的分析方法和计算方法、实验方法等基本情况,指出所应用的分析方法、计算方法、实验方法等哪些是已有的,哪些是经过自己改进的,哪些是自己创造的,以便指导教师审查和纠正,这一部分所占篇幅不宜过多,应以简练、明了的文字概括表述。
XX(2)课题研究的方法与手段XX分别以下面几种方法说明:XXA.用实验方法研究课题,应具体说明实验用的装置、仪器、原材料的性能等是否标准,并应将所有装置、仪器、原材料做出检验和标定。
对实验的过程和操作方法,力求叙述得简明扼要,对实验结果的记录、分析,对人所共知的或细节性的内容不必过分详述。
详细设计说明书示例
金审工程应用系统工程管理软件系统详细设计说明书审计署信息化建设办公室北京中软国际信息技术有限公司2006年 9 月北京中软国际信息技术有限公司第1页共 162 页第 2 页共 162 页北京中软国际信息技术有限公司目录第一章引言 (9)1。
1编写目的 (9)1.2背景 (9)1。
3定义 (9)1.3。
1 专门术语 (9)1。
3.2 缩略词 (10)1.4参考资料 (10)第二章总体设计 (11)2.1需求规定 (11)2.1.1 对功能的规定 (11)2.1.2 输入/输出要求 (12)2.1.3 故障处理要求 (12)2.2其它专门要求 (12)2。
3支持软件 (13)2.3.1 基础平台 (13)2。
3。
2 基础服务 (14)2.4接口 (17)2。
5控制 (17)2.6基本设计概念和处理流程 (18)2。
6.1 设计原则 (18)2。
6.2 软件目的 (18)2.6。
3 技术架构 (18)2.6.4 软件系统整体流程 (18)2。
6。
5 部署模型 (18)第三章功能系统设计 (19)北京中软国际信息技术有限公司第 3 页共 162 页3.1项目管理 (19)3。
1。
1 结构 (19)3。
1.2 对象关系与类结构 (20)3。
1.3 功能需求与程序的关系 (20)3。
1。
4 资源注册 (20)3。
1.5 权限设计 (21)3。
1。
6 人工处理过程 (21)3.1.7 类设计 (21)3.1.8 接口 (22)3.1.9 存储分配 (23)3.1。
10 注释设计 (23)3.1。
11 限制条件 (23)3.1.12 测试计划 (23)3。
1。
13 尚未解决的问题 (23)3.2合同管理............................................................................................................ 错误!未定义书签。
详细设计说明书
卓越电信后付费AR缴费管理系统详细设计说明书2011.111 Detailed Design详细设计1.1类名 com.yctc.ar.data.bean.Cashbox 1.1.1Class Diagram类图1.1.2Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)private cashierId float操作员IDprivate initMoney float初始化金额private moneyAdd float调增的金额private moneyPaid float缴费的金额private moneyUp float上缴的金额private state boolean钱箱状态(0关闭;1开启)1.1.3 Methods方法各种set和get方法。
1.2类名 com.yctc.ar.data.been.Staff 1.2.1 Class Diagram类图1.2.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)private city String城市private dept String职位private id String职员ID private name String职员姓名private password String职员密码private post String岗位Private Releld Int角色1.2.3 Methods方法各种set和get方法。
1.3类名 com.yctc.ar.data.been.CashboxForm 1.3.1 Class Diagram类图1.3.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)private cashierId Float操作员IDprivate initMoney Float初始化金额private moneyAdd Float调增的金额private moneyPaid Float缴费的金额private moneyUp Float上缴的金额private password String主管密码private superiorID String主管IDprivate totalMoney String总金额private way Boolean调账方式(调增、调减)1.3.3 Methods方法无1.4类名 er 1.4.1 class diagram类图1.4.2 Attributes 属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)private account Float用户账户金额private balance Float余额private credit Float信用private deposit Float押金金额private idNumber String用户IDprivate oweMoney Float欠费金额private password String用户密码private telephone String用户手机号private userName String用户姓名1.4.3 Methods 方法各种get 和set方法1.5类名 erForm 1.5.1 class diagram类图1.5.2 Attributes 属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)private account Float用户账户金额private balance Float余额private credit Float信用private deposit Float押金金额private dueOfPay Float应缴最低金额private factOfFee Float实际缴费金额private idNumber String用户ID private oweMoney Float欠费金额private password String用户密码private remark String备注private telephone String用户手机号private userName String用户姓名private wayOfPay String缴费方式1.5.3 Methods 方法无1.6类名 com.yctc.ar.data.bean.DrawbackForm 1.6.1class diagram 类图1.6.2 Attributes 属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)private bussinessCIs String业务类型private drawbackCIs String回退类型private drawbackMoney Float回退金额private drawbackReason String回退原因private dueOfLeastPay Float应缴最低金额private endTime Date截止日期private isAddTime Boolean是否按时间查询(是、否)private queryContent String查询内容private queryWay String查询方式private remark String备注private startTime Date开始日期private userList Arraylist用户信息列表1.6.3 Methods 方法无1.7类名 com.yctc.ar.data.bean.MulQueryForm 1.7.1 class diagram 类图1.7.2Attribute 属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)private businessCIs String业务类型private endtime String截止日期private isAddTime Boolean是否按时间查询(是、否)private payLogList Arraylist缴费日志信息private queryContent String查询内容private queryWay String查询方式private serialNumber Int流水号private startTime Date开始日期private telephone String手机号码1.7.3 Methods 方法无1.8.1 class diagram 类图1.8.2 Attributes 属性Visibility 可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)private adjustCIs String调账方式private adjustMoney Float调账金额private adjustReason String调账原因private remark String备注private user User用户信息1.8.3 Methods 方法无1.9.1 class diagram 类图1.9.2 Attributes 属性Visibility 可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)private cityList List城市列表private deptList List部门列表private postList List职位列表private role String角色private staffList List职员列表1.9.3 Methds 方法各种get和set方法1.10类名 com.yctc.ar.data.dao.ICashboxDAO 1.10.1 Class Diagram类图1.10.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)private cashboxDAO ICashboxDAO数据处理层的单例对象1.10.3 Methods方法1) addAndTurnOverMoney ()Method Descriptions方法描述Prototype 函数原型public boolean addAndTurnOverMoney ()Description 功能描述调增或上缴金额Calls 调用函数无Called By 被调用函数无Input 输入参数CashboxOutput 输出参数isSuccessReturn 返回值boolean类型值Exception 抛出异常无2) public boolean addAndTurnOverMoney();3) closeCashbox()Method Descriptions方法描述Prototype 函数原型public boolean closeCashbox ()Description 功能描述关闭钱箱Calls 调用函数无4)public boolean close Cashbox();5) getInstance()public Cashbox getInstance(); openCashbox()1)Method Descriptions方法描述2)public boolean openCashbox() queryCashboxDetails()Method Descriptions方法描述Public Cashbox querCashboxDetails();1.11类名 com.yctc.ar.service.cashbox.CashboxService 1.11.1 Class Diagram类图1.11.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)private cashboxDAO ICashboxDAO数据处理层的单例对象Private staffDAO ISfaffDAO数据处理层的单例对象1.11.3 Methods方法addAndTurnOverMoney ()Method Descriptions方法描述Prototype 函数原型public boolean addAndTurnOverMoney ()Description 功能描述调增或上缴金额Calls 调用函数无Called By 被调用函数无Input 输入参数cashboxOutput 输出参数isSuccessReturn 返回值boolean类型值Exception 抛出异常无public boolean addAndTurnOverMoney(){//1.通过IStaffDAO类的对象获取该用户信息并完成身份验证判断//2.通过ICashboxDAO类的对象调用//3.addAndTurnOverMoney方法完成调增和上缴操//作//4.成功返回true失败返回fault}closeCashbox()1).Method Descriptions方法描述Prototype 函数原型public boolean closeCashbox ()Description 功能描述关闭钱箱Calls 调用函数无Called By 被调用函数无Input 输入参数cashboxOutput 输出参数isSuccessReturn 返回值boolean类型值Exception 抛出异常无2)public boolean close Cashbox(){//1. 通过IStaffDAO类的对象获取该信息并完成身份验证判断//2. 通过ICashbox类的对象调用//3. closeCashbox方法完成关闭钱箱操作//4. 成功返回true失败返回fault}openCashbox()1)Method Descriptions方法描述Prototype 函数原型public boolean openCashbox ()Description 功能描述打开钱箱Calls 调用函数无Called By 被调用函数无Input 输入参数cashboxOutput 输出参数无Return 返回值isSuccessException 抛出异常无2)public boolean openCashbox(){//1.通过IStaffDAO类的对象获取该用户信息并完成身份验证判断//2.通过ICashbox类的对象调用//3. openCashbox方法完成打开钱箱操作//4. 成功返回true失败返回fault}1.12类名com.yctc.ar.web.cashbox.action.CashboxOpen Action1.12.1 Class Diagram类图1.12.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)private cashboxService ICashboxService业务逻辑层的单例对象1.12.3 Methods方法Public String exec(){// 1.通过cashboxService对象调用openCashbox方法打开钱箱}1.13类名com.yctc.ar.web.cashbox.action. Cashbox CloseAction1.13.1 Class Diagram类图1.13.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)private cashboxService ICashboxService业务逻辑层的单例对象1.13.3 Methods方法Public String exec(){//1. 通过cashboxService对象调用//2. closeCashbox方法打开钱箱}1.14类名com.yctc.ar.web.cashbox.action.CashboxAdjust Action1.14.1 Class Diagram类图1.14.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)private cashboxService ICashboxService业务逻辑层的单例对象1.14.3 Methods方法Public String exec(){//1. 通过cashboxService对象调用//2. addAndTurnOverMoney方法打开钱箱}1.15类名 com.yctc.ar.data.dao.AdjustDAO1.15.1 Class Diagram类图1.15.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)无无无无1.15.3 Methods方法public boolen adjustMinusDeposit (User user){//1 调减用户押金}public boolen adjustMinusBlance (User user){//1 调减用户预存款}public boolen adjustPlusBlance (User user){//1 调增用户押金}public boolen adjustPlusDeposit (User user){//1 调增用户预存款}public User getInstance(User user){//1 获取用户信息}1.16类名 com.yctc.ar.service.adjust.AdjustService 1.16.1 Class Diagram类图1.16.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)Private adjustDAO AdjustDAO数据处理层的单例对象1.16.3 Methods方法public boolen adjustMinusDeposit (User user){//1 通过数据处理层的单利对象调减用户押金}public boolen adjustMinusBlance (User user){//1 通过数据处理层的单利对象调减用户预存款}public boolen adjustPlusBlance (User user){//1 通过数据处理层的单利对象调增用户押金}public boolen adjustPlusDeposit (User user){//1 通过数据处理层的单利对象调增用户预存款}public User getInstance(User user){//1 通过数据处理层的单利对象获取用户信息}1.17类名 com.yctc.ar.web.adjust.action.AdjustAction 1.17.1 Class Diagram类图1.17.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)Private adjustService AdjustService业务逻辑层的单例对象1.17.3 Methods方法Public String exec(){//1 调用业务逻辑层对象完成调帐操作,//2 成功返回SUCCESS 错误返回ERROR}1.18类名 com.yctc.ar.service.pay.PaymentService 1.18.1 Class Diagram类图1.18.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)private paymentDAO IpaymentDAO数据处理层单例对象Private userDAO UserDAO数据处理层单例对象Private paymentLogDAO PaymentLogDAO数据处理层单例对象private cashboxLogDAO CashboxLogDAO数据处理层单例对象1.18.3 Methods方法Public Boolean doDeposit(){//1 修改用户余额//2 修改缴费金额//3 添加用户缴费日志//4 添加钱箱日志}Public Boolean doPayment{//1 修改用户余额//2 修改缴费金额//3 添加用户缴费日志//4 添加钱箱日志}1.19类名 com.yctc.ar.data.dao.PaymentDAO 1.19.1 Class Diagram类图1.19.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)无无无无1.19.3 Methods方法Public Boolean doDeposit(){//1 修改用户余额}Public Boolean doPayment{//1 修改用户余额}1.20类名 com.yctc.ar.web.pay.action.PaymentAction 1.20.1 Class Diagram类图1.20.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)private paymentService PaymentService业务逻辑层单例对象1.20.3 Methods方法Public String exec(){//1 调用业务逻辑层对象进行处理//2 成功返回success 错误返回error}1.21类名 com.yctc.ar.web.pay.action.DepositAction 1.21.1 Class Diagram类图1.21.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)private paymentService PaymentService业务逻辑层单例对象1.21.3 Methods方法Public String exec(){//1 调用业务逻辑层对象进行处理//2 成功返回success 错误返回error}1.22类名 com.yctc.ar.data.dao.MuiQueryDAO 1.22.1 Class Diagram类图1.22.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)无无无无1.22.3 Methods方法Public PayLog getInstance(){//1 获取单个对象}Public List<PayLog> query(){//1 获取记录列表}Public list<PayLog> queryBySerialNumber(){//1 通过流水号查找日志}Public list<PayLog> queryByTelephone(){//1 通过手机号获取日志记录列表}1.23类名 com.yctc.ar.service.query.MulQueryService 1.23.1 Class Diagram类图1.23.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)private muiQueryDAO MuiQueryDAO数据访问层单例对象1.23.3 Methods方法Public PayLog getInstance(){//1 获取单个对象}Public List<PayLog> query(){//1 查询满足条件的记录总个数//2 计算出总分页个数//3 获取指定页数的日志记录列表}Public list<PayLog> queryBySerialNumber(){//1 通过流水号查找日志}Public list<PayLog> queryByTelephone(){//1 查询满足条件的记录总个数//2 计算出总分页个数//3 获取指定页数的日志记录列表}1.24类名 com.yctc.ar.web.query.action. MulQueryAction 1.24.1 Class Diagram类图1.24.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)private muiQueryService MuiQueryService业务逻辑层单例对象1.24.3 Methods方法Public String exec(){//1 调用业务逻辑层获取列表}1.25类名 com.yctc.ar.data.dao.ManageDAO1.25.1 Class Diagram类图1.25.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)无无无无1.25.3 Methods方法public Boolean addNewstaff(Staff staff){//1 tb_staff表增加一条记录}public Boolean creatrCity(City city){//1 tb_city表增加一条记录}public Boolean createDept(Dept dept){//1 tb_dept表增加一条记录}Public List<City> findCityList(){}Public list<Dept> findDeptsByCity(City){}6)Public list<Staff> findeStaffsByDept(Dept){}1.26类名 com.yctc.ar.service.manage.ManageService 1.26.1 Class Diagram类图1.26.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)pricate manageDAO ManageDAO数据访问层单体实例1.26.3 Methods方法public Boolean addNewstaff(Staff staff){//1 tb_staff表增加一条记录}public Boolean creatrCity(City city){//1 tb_city表增加一条记录}public Boolean createDept(Dept dept){//1 tb_dept表增加一条记录}Public List<City> findCityList(){}Public list<Dept> findDeptsByCity(City){}Public list<Staff> findeStaffsByDept(Dept){}1.27类名 com.yctc.ar.web.manage.action.ManageAction 1.27.1 Class Diagram类图1.27.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明(对属性的简短描述)pricate manageService ManageService业务逻辑层单体实例1.27.3 Methods方法Public Sting exec(){//1 调用业务逻辑层并返回结果}(注:可编辑下载,若有不当之处,请指正,谢谢!)。
详细设计说明书规范
详细设计说明书规范详细设计说明书规范⽬录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 输⼊项描述每个输⼊项的特性,包括:名称、标识、数据的类型和格式、数据值的有效范围、输出的形式、数量和频度、输⼊媒体、输⼊数据的来源和安全保密条件等。
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 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 尚未解决的问题
说明本模块在设计中尚未解决而设计者认为在软件完成了之前应解决问题。