软件开发项目-文档编写标准化--详细设计说明书

详细设计说明书

1 引言
1.1 编写目的:阐明编写详细设计说明书的目的,指明读者对象。
1.2 项目背景:应包括项目的来源和主管部门等。
1.3 定义:列出本文档中所用到的专门术语的定义和缩写词的愿意。
1.4 参考资料:
  ● 列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源
  ●项目经核准的计划任务书、合同或上级机关的批文;项目开发计划;需求规格说明书;概要设计说明书;测试计划(初稿);用户操作手册
  ● 文档所引用的资料、软件开发的标准或规范。
2 总体设计
2.1 需求概述
2.2 软件结构:如给出软件系统的结构图。
3 程序描述
3.1 逐个模块给出以下说明:
  ● 功能
  ● 性能
  ● 输入项目
  ● 输出项目
3.2 算法:模块所选用的算法。
3.3 程序逻辑:详细描述模块实现的算法,可采用:标准流程图;PDL语言;N-S图;判定表等描述算法的图表。
3.4 接口
  ● 存储分配
  ● 限制条件
3.5测试要点:给出测试模块的主要测试要求。

 
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
"产品名称 "密级 " " " " "产品版本 "共 XX页 " "Rev.00 " " 软件项目设计方案 "拟制人 "xx "日期: "xx " ": " " " " "评审人 "xxx "日期: "xx " ": " " " " "批准人 "xx "日期: "xx " ": " " " " 修订记录 "日期 "版本 "修改章节 "修改描述 "作者 " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " 目录 1 引言 4 1.1 编写目的 4 1.2 背景 4 1.3 参考资料 4 1.4 术语定义及说明 4 2 设计概述 4 2.1 任务和目标 4 3 系统详细需求分析 5 3.1 详细需求分析 5 3.2 详细系统运行环境及限制条件分析接口需求分析 5 4 总体方案确认 5 4.1 系统总体结构确认 5 4.2 系统详细界面划分 6 5 系统详细设计 6 5.1 系统结构设计及子系统划分 6 5.2 系统功能模块详细设计 6 5.3 系统界面详细设计 6 6 数据库系统设计 7 6.1 设计要求 7 6.2 信息模型设计 7 6.3 数据库设计 7 7 信息编码设计 8 7.1 代码结构设计 8 7.2 代码编制 8 XXXX设计方案说明书 引言 1 编写目的 说明编写详细设计方案的主要目的。 说明书编制的目的是说明一个软件系统各个层次中的每个程序(每个模块或子程序) 和数据库系统的设计考虑,为程序员编码提供依据。 如果一个软件系统比较简单,层次很少,本文件可以不单独编写,和概要设计说明书 中不重复部分合并编写。 方案重点是模块的执行流程和数据库系统详细设计的描述。 2 背景 应包含以下几个方面的内容: A. 待开发软件系统名称; B. 该系统基本概念, 如该系统的类型、从属地位等; C. 开发项目组名称。 3 参考资料 列出详细设计报告引用的文献或资料,资料的作者、标题、出版单位和出版日期等 信息,必要时说明如何得到这些资料。 4 术语定义及说明 列出本文档中用到的可能会引起混淆的专门术语、定义和缩写词的原文。 设计概述 1 任务和目标 说明详细设计任务详细设计所要达到的目标 。 1 需求概述 对所开发软件的概要描述, 包括主要的业务需求、输入、 输出、主要功能、性能等,尤其需要描述系统性能需求。 2 运行环境概述 对本系统所依赖于运行的硬件,包括操作系统、数据库系统、中间件、接口软件、 可能的性能监控与分析等软件环境的描述,及配置要求。 3 条件与限制 详细描述系统所受的内部和外部条件的约束和限制说明。包括业务和技术方面的条 件与限制以及进度、管理等方面的限制。 4 详细设计方法和工具 简要说明详细设计所采用的方法和使用的工具。如HIPO图方法、IDEF(I2DEF)方 法、E-R图,数据流程图、业务流程图、选用的CASE工具等,尽量采用标准规范和辅助 工具。 系统详细需求分析 主要对系统级的需求进行分析。首先应对需求分析提出的企业需求进一步确认,并对 由于情况变化而带来的需求变化进行较为详细的分析。 1 详细需求分析 包括: 详细功能需求分析 详细性能需求分析 详细资源需求分析 详细系统运行环境及限制条件分析 2 详细系统运行环境及限制条件分析接口需求分析 包括: 系统接口需求分析 现有硬、软件资源接口需求分析 引进硬、软件资源接口需求分析 总体方案确认 着重解决系统总体结构确认及界面划分问题。 1 系统总体结构确认 对系统组成、逻辑结构及层次进行确认,对应用系统、支撑系统及各自实现的功能 进行确认,细化集成设计及系统工作流程,特别要注意因软件的引进造成的系统本身结 构和公司其他系统的结构变化。包括: 系统组成、逻辑结构及层次确认 应用系统结构确认 支撑系统结构确认 系统集成确认 系统工作流程确认 2 系统详细界面划分 1 应用系统与支撑系统的详细界面划分 应用系统与支撑系统之间的界面包括系统主服务器与其他服务器的服务范围及访问方 式,网络及数据库对应用系统的支撑方式,全局数据的管理与存取方式等。 2 系统内部详细界面划分 系统各功能之间的界面包括覆盖范围,模块间功能调用涉及到的系统模块及方法, 全局数据格式,系统性能要求等。 系统详细设计 1 系统结构设计及子系统划分 对系统的组成及逻辑结构进行设计前确认。 划分系统功能模块或子系统(如果有或者有必要,特别是大型的软件系统)。 2 系统功能模块详细设计 按结构化设计方法,在系统功能逐层分解的基础上,对系统各功能模块或子系统进行 设计。此为详细设计的主要部分之一。 用层次图描述系统的总体结构、功能分解及各个模块之间的相互调用关系和信息交 互,用IPO图或其他方法描述各模块完成的功能。 以上建议
项目名称 软件概要设计说明书 版本:V1.0 文 档 编 号 保 密 等 级 作 者 最后修改日期 审 核 人 最后审批日期 批 准 人 最后批准日期 修订记录 日期 版本 修订说明 修订人 目 录 1 引言 1 1.1 编写目的 1 1.1.1 作用 1 1.1.2 预期读者 1 1.2 编写背景 1 1.2.1 系统名称及版本号 1 1.2.2 任务提出者 1 1.2.3 任务承接者及实施者 1 1.2.4 使用者 1 1.2.5 与其它系统的关系 1 1.3 文档结构 1 1.4 电子文档编写工具 1 1.5 定义说明与符号规定 2 1.6 参考资料 2 2 系统概述 2 2.1 系统目标 2 2.2 设计原则 3 2.3 运行环境 3 2.3.1 硬件平台 3 2.3.2 软件平台 3 2.3.3 网络体系结构 3 2.4 应用软件整体结构概述 3 2.5 关键技术 4 3 数据库设计 4 4 代码设计 4 5 功能概述 4 5.1 功能模块命名原则 4 5.2 功能层次图 4 5.3 功能简介 4 5.4 外部接口 4 6 用户界面设计 4 6.1 基本原则 4 6.2 设计概述 4 7 出错处理 5 7.1 出错信息设计 5 7.2 异常情况处理 5 引言 编写目的 作用 【说明】《软件概要设计说明书》是在《软件需求规格说明书》的基础上,通过我方与用户方反复沟通形成的。它必须充分反映《软件需求规格说明书》中的用户需求,如有改动必须征得用户的认可。它将作为项目验收时重要的的标准和依据。 从另一方面讲,它又是开发人员在下一阶段进行系统详细设计的纲领性文件,也是考核系统总体质量的重要技术文档。 预期读者 【说明】本文档的阅读对象是软件开发人员、业务规范设计人员、软件测试人员、系统安装人员及用户代表。 编写背景 系统名称及版本号 【说明】形如“北京市地方税务局管理信息系统V3.0”。其中,版本号的格式为“XX.XX”,X为阿拉伯数字,左“0”可省略。 任务提出者 【说明】指《工作说明书》中规定的我方领导机构或项目负责人。 任务承接者及实施者 【说明】指承担概要设计的负责人及工作人员名单。 使用者 【说明】适应对象和范围。主要指预期读者,也供有关领导审阅。 与其它系统的关系 【说明】在用户现有的及预期的整个应用系统中,给本系统准确定位。用示意图及相应的文字予以说明文档结构 【说明】章节划分原则、内容的取舍、重点的确定等。 电子文档编写工具 【说明】工具名、版本号、操作系统平台。使用多种工具时,应分别说明。形如: Microsoft Word 97 for Windows 95 Power-Designor 6.0 for Windows 95 PhotoShop 4.0 for Windows 95 Visio或Power Point 定义说明与符号规定 【说明】包括对专用术语及缩略语的解释、所用到的图(E-R图/功能层次图)中图符的表示与解释、屏幕界面中图标与按钮的表示与含义等。如在E-R图中,表示两个实体之间的关系时,我们定义了以下图符(部分举例): 终结符 基数(自左至右) 1 多 终结符 基数 存在性 说明(自左至右) 1 强制 必须存在且只能存在1个 多 强制 必须存在1个或多个 1 任选 可能存在1个,或没有 多 任选 可能存在1个或多个,或没有 参考资料 【说明】格式:作者,[版本号,]资料来源,日期 [,起止页号]。其中,《质量保证计划》与《需求规格说明书》是必选的参考资料。 系统概述 系统目标 【说明开发意图、应用目标(总目标、分期目标)、作用范围、预期效益等。 设计原则 【说明设计原则应包括: 质量管理应贯穿于整个设计之全过程。 对质量保证的承诺应落实到全体人员。 实际执行的过程中,必须符合项目自身的特点,体现个性差异,切实做到有的放矢。 运行环境 硬件平台 【说明】指出本系统对硬件设备的需求、我们选型的原则和依据、推荐的型号与配置、性能综述、技术优势、特殊约定等。 软件平台 【说明】使用操作系统的名称、生产厂家、版本号等。 使用数据库的名称、生产厂家、版本号等。如使用了多种数据库,则要说明如何 实现互连。 其它支撑软件:指出开发与运行时需要的工具软件的情况,如4GL等。 对于选用的各类软件,均应着重说清其技术特点、与国内外同类产品的比较,明 确阐述我方选择的理由。 网络体系结构 【说明】写明网络设计原则、技术要求、产品选型、拓扑结构、基本部件与配件、传输介质、接口情况、通信协议、约束条件、结构化综合布线方案等。 画出网络结构图。图中应标出各类服务器与客户机、网管机、路由器、网关等的数量与分布;应反映出局域网、广域网及其互连的情况;如使用国内的公用数据网或Internet,也须具体标出。 用文字说明各个服务器/客户机的作用、配置与具体位置。例如:Oracle数据库服务 器1台,位于局信息中心,用于支撑征管业务信息处理、领导决策辅助支持、各征管业务科室的信息采集、查询及统计工作。它安装在IBM RS6000小型机上,操作系统是AIX 3.2。 说明拟采取的网络保护技术,如防火墙等。 应用软件整体结构概述 【说明说明本系统的各层模块、公用模块的划分原则。 如果系统复杂而开发者又有比较多的技术积累,应说明其分层构造(如组件层、构件层与应用子系统层)。 对于大的系统,应画出体系结构图并予以说明。 关键技术 【说明】本系统采用了哪些关键技术,如算法、中间件、构件等。 指出使用了那些主要工具。 解释作出上述选择的理由。 说明这些关键技术在整体结构中的位置及内外接口。 数据库设计说明】单独成册,见《数据库设计说明书模板》 代码设计说明】 给出系统设计中的代码的设计内容,代码设计包括系统代码(硬码)、系统代码(软码)、业务代码以及标准化代码等。对于硬码的引用需要在数据库设计的PDM中注明,对于其他代码的引用需要在数据字典或数据库设计中注明。 功能概述 功能模块命名原则 【说明】指出本系统的各层模块/公用模块的划分原则、命名原则、编号原则。并且需要指出在概要设计中的功能模块编号与《软件需求规格说明书》中的业务需求编号及性能需求编号之间的对应关系。 功能层次图 【说明】指明在输入信息转变为输出信息的过程中,为了满足用户的业务需求,应用软件必须完成的基本动作。采用自然语言叙述+树状功能图描绘的方式。由此确定系统最终的菜单结构。 功能简介 【说明】用一览表或框图的形式扼要说明每个模块的编号、名称和基本功能。用矩阵形式标明《软件需求规格说明书》中列出的各项功能需求与模块之间的对应关系。 外部接口 用户界面设计 基本原则 【说明】指出基本风格、屏幕总体布局和输入/输出的常规手段。 设计概述 【说明】本节的内容也可以归入附录“设计与编程规范、惯例及约定”中,而不在这里 叙述。 一般地讲,界面设计应包括以下几项: □屏幕环境设置 □字型与字体 □颜色 □提示 □菜单(Menu) □按钮(Command Button) □图标 □列表框 □常用键 □Data Windows生成标准 □窗口定义 □日期类型 (特别要注意解决“千年虫”问题) □界面语言 □其它 出错处理 出错信息设计说明】扑捉出错信息、分析定位、提示信息。 异常情况处理 【说明】错误处理方案与帮助手段。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值