软件详细设计说明书

1. 软件详细设计说明书

面向对象软件设计说明书模板 


1 概述 

1.1 系统简述 

对系统要完成什么，所面向的用户以及系统运行的环境的简短描述，这部分主要来源于需求说明书的开始部分。 

1.2 软件设计目标 

这部分论述整个系统的设计目标，明确地说明哪些功能是系统决定实现而哪些时不准备实现的。同时，对于非功能性的需求例如性能、可用性等，亦需提及。需求规格说明书对于这部分的内容来说是很重要的参考，看看其中明确了的功能性以及非功能性的需求。 

这部分必须说清楚设计的全貌如何，务必使读者看后知道将实现的系统有什么特点和功能。在随后的文档部分，将解释设计是怎么来实现这些的。 

1.3 参考资料 

列出本文档中所引用的参考资料。（至少要引用需求规格说明书） 

1.4 修订版本记录 

列出本文档修改的历史纪录。必须指明修改的内容、日期以及修改人。 

2 术语表 

对本文档中所使用的各种术语进行说明。如果一些术语在需求规格说明书中已经说明过了，此处不用再重复，可以指引读者参考需求说明。 



3 用例 

此处要求系统用用例图表述（UML），对每个用例（正常处理的情况）要有中文叙述。 


4 设计概述 

4.1 简述 

这部分要求突出整个设计所采用的方法（是面向对象设计还是结构化设计）、系统的体系结构（例如客户/服务器结构）以及使用到的相应技术和工具（例如OMT、Rose） 

4.2 系统结构设计 

这部分要求提供高层系统结构的描述，使用方框图来显示主要的组件及组件间的交互。最好是把逻辑结构同物理结构分离，对前者进行描述。别忘了说明图中用到的俗语和符号。 

4.2.1 顶层系统结构 

4.2.2 子系统1结构 

4.2.3 子系统2结构 

4.3 系统界面 


各种提供给用户的界面以及外部系统在此处要予以说明。如果在需求规格说明书中已经对用户界面有了叙述，此处不用再重复，可以指引读者参考需求说明。如果系统提供了对其它系统的接口，比如说从其它软件系统导入/导出数据，必须在此说明。 

4.4 约束和假定 

描述系统设计中最主要的约束，这些是由客户强制要求并在需求说明书写明的。说明系统是如何来适应这些约束的。 

另外如果本系统跟其它外部系统交互或者依赖其它外部系统提供一些功能辅助，那么系统可能还受到其它的约束。这种情况下，要求清楚地描述与本系统有交互的软件类型（比如某某某数据库软件，某某某EMail软件）以及这样导致的约束（比如只允许纯文本的Email）。 

实现的语言和平台也会对系统有约束，同样在此予以说明。 

对于因选择具体的设计实现而导致对系统的约束，简要地描述你的想法思路，经过怎么样的权衡，为什么要采取这样的设计等等。 


5 对象模型 

5.1 系统对象模型 


提供整个系统的对象模型，如果模型过大，按照可行的标准把它划分成小块，例如可以把客户端和服务器端的对象模型分开成两个图表述。 

对象图应该包含什么呢？ 

在其中应该包含所有的系统对象。这些对象都是从理解需求后得到的。要明确哪些应该、哪些不应该被放进图中。 

所有对象之间的关联必须被确定并且必须指明联系的基数（一对一、一对多还是多对多，0..1，*，1..*）。聚合和继承关系必须清楚地确定下来。每个图必须附有简单的说明。 

可能经过多次反复之后才能得到系统的正确的对象模型。 


6 对象描述 


在这个部分叙述每个对象的细节，它的属性、它的方法。在这之前必须从逻辑上对对象进行组织。你可能需要用结构图把对象按子系统划分好。 

为每个对象做一个条目。在系统对象模型中简要的描述它的用途、约束（如只能有一个实例），列出它的属性和方法。如果对象是存储在持久的数据容器中，标明它是持久对象，否则说明它是个临时对象（transient object）。 

对每个对象的每个属性详细说明：名字、类型，如果属性不是很直观或者有约束（例如，每个对象的该属性必须有一个唯一的值或者值域是有限正整数等）。 

对每个对象的每个方法详细说明：方法名，返回类型，返回值，参数，用途以及使用的算法的简要说明（如果不是特别简单的话）。如果对变量或者返回值由什么假定的话，Pre-conditions和Post-conditions必须在此说明。列出它或者被它调用的方法需要访问或者修改的属性。最后，提供可以验证实现方法的测试案例。 


6.1 子系统1中的对象 

6.1.1 对象：对象1 

用途： 
约束： 
持久性： 

6.1.1.1 属性描述： 

1. 属性：属性1 
类型： 
描述： 
约束： 

2. 属性：属性2 

6.1.1.2 方法描述： 

1. 方法：方法1 
返回类型： 
参数： 
返回值： 
Pre-Condition： 

Post-Condition： 
读取/修改的属性： 
调用的方法： 

处理逻辑： 

测试例：用什么参数调用该方法，期望的输出是什么…… 


7 动态模型 

这部分的作用是描述系统如何响应各种事件。例如，可以建立系统的行为模型。一般使用顺序图和状态图。 

确定不同的场景（Scenario）是第一步，不需要确定所有可能的场景，但是必须至少要覆盖典型的系统用例。不要自己去想当然地创造场景，通常的策略是描述那些客户可以感受得到的场景。 

7.1 场景（Scenarios） 

对每个场景做一则条目，包括以下内容： 
场景名：给它一个可以望文生义的名字 
场景描述：简要叙述场景是干什么的以及发生的动作的顺序。 
顺序图：描述各种事件及事件发生的相对时间顺序。 


7.1.1 场景：场景1 
描述： 
动作1 
动作2 


7.2 状态图 

这部分的内容包括系统动态模型重要的部分的状态图。可能你想为每个对象画一个状态图，但事实上会导致太多不期望的细节信息，只需要确定系统中一些重要的对象并为之提供状态图即可。 

7.2.1 状态图1： 


8 非功能性需求 
在这个部分，必须说明如何处理需求文档中指定的非功能性需求。尽可能客观地评估系统应付每一个非功能性的需求的能力程度。如果某些非功能性需求没有完全在设计的系统中实现，请务必在此说明。另外，你也需要对系统将来的进化作一个估计并描述本设计如何使系统能够适应这些可预见的变化。 


9 辅助文档 

提供能帮助理解设计的相应文档。 


10 词汇索引 


文章录入

2. 软件概要设计说明书怎么写

通用的软件概要设计说明书国家有标准。例如概要设计说明书（GB8567-88）包括如下内容：
1引言
1.1编写目的 
1.2背景 
1.3定义 
1.4参考资料 
2总体设计 
2.1需求规定 
2.2运行环境 
2.3基本设计概念和处理流程 
2.4结构 
2.5功能器求与程序的关系 
2.6人工处理过程 
2.7尚未问决的问题 
3接口设计 
3.1用户接口 
3.2外部接口 
3.3内部接口 
4运行设计 
4.1运行模块组合 
4.2运行控制 
4.3运行时间 
5系统数据结构设计 
5.1逻辑结构设计要点 
5.2物理结构设计要点 
5.3数据结构与程序的关系 
6系统出错处理设计 
6.1出错信息 
6.2补救措施 
6.3系统维护设计 

根据具体项目内容可以有所微调。

3. 软件使用手册怎么写

4/4 分步阅读引言，编写目的，编写本使用说明的目的是充分叙述本软件所能实现的功能及其运行环境，以便使用者了解本软件的使用范围和使用方法！ 2/4软件概述，说明本软件的用途。1． 本软件开发目的；2． 基本原理；3． 基本功能。 3/4软件使用过程，怎么安装，如何安装，安装的过程，截图操作写出具体步骤。 4/4软件维护过程，遇到问题如何出错及纠正方法，专用维护程序等等。 注意事项具体明了，整体简单易操作就行，大家多看得懂。

4. 软件使用说明书如何写（包含哪些内容）？有没有模板的

有的，网上可以搜到挺多，我不知道怎么提供给你下载，这个你可以参考参考。
软件使用说明书模板 
1. 引言
1.1编写目的【阐明编写手册的目的。指明读者对象。】
1.2项目背景【说明项目来源、委托单位、开发单位及主管部门】
1.3 定义【列出手册中使用的专门术语的定义和缩写词的原意】
1.4参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，
可包括：a.项目的计划任务书、合同或批文；b.项目开发计划；C. 需求规格说
明书；d.概要设计说明书；e。详细设计说明书；f.测试计划；g。手册中引用
的其他资料、采用的软件工程标准或软件工程规范。】

2. 软件概述
2.1目标
2.2功能
2.3 性能
a.数据精确度【包括输入、输出及处理数据的精度】
b.时间特性【如响应时间、处理时间、数据传输时间等。】
c.灵活性【在操作方式、运行环境需做某些变更时软件的适应能力。】

3. 运行环境
3.1硬件【列出软件系统运行时所需的硬件最小配置，如a. 计算机型号、主存容量；b.
外存储器、媒体、记录格式、设备型号及数量；c。输入、输出设备；d.数据传输设
备及数据转换设备的型号及数量。】
3.2支持软件【如：a。操作系统名称及版本号；b. 语言编译系统或汇编系统的名称及版
本号；C。数据库管理系统的名称及版本号；d.其他必要的支持软件。】

4. 使用说明
4.1安装和初始化【给出程序的存储形式、操作命令、反馈信息及其含意、表明安装完成
的测试实例以及安装所需的软件工具等。】
4.2输入【给出输入数据或参数的要求。】
4.2.1数据背景【说明数据来源、存储媒体、出现频度、限制和质量管理等。】
4.2.2数据格式【如：a。长度；b.格式基准；C，标号；d.顺序；e。分隔符；f.
词汇表；g. 省略和重复；h.控制。】
4.2.3输入举例
4.3输出【给出每项输出数据的说明】
4.3.l数据背景【说明输出数据的去向使用频度、存放媒体及质量管理等。】
4.3.2数据格式【详细阐明每一输出数据的格式，如：首部、主体和尾部的具体形式。】
4.3.3举例
4.4出错和恢复【给出：a。出错信息及其含意；b.用户应采取的措施，如修改、恢复、
再启动.】
4.5求助查询【说明如何操作】

5. 运行说明
5.1运行表【列出每种可能的运行情况，说明其运行目的。】
5.2运行步骤【按顺序说明每种运行的步骤，应包括：】
5.2.1运行控制
5.2.2操作信息
a. 运行目的；b.操作要求；C。启动方法; d.预计运行时间；e。操作命令格
式及格式说明；f.其他事项。
5.2.3输入／输出文件【给出建立或更新文件的有关信息，如：】
a.文件的名称及编号；b.记录媒体；C。存留的目录；d.文件的支配
【说明确定保留文件或废弃文件的准则，分发文件的对象，占用硬件的优先
级及保密控制等.】
5.2.4启动或恢复过程
6. 非常规过程
【提供应急或非常规操作的必要信息及操作步骤，如出错处理操作、向后备系统切换操作以
及维护人员须知的操作和注意事项。】

7. 操作命令一览表
【按字母顺序逐个列出全部操作命令的格式、功能及参数说明。】

8. 程序文件（或命令文件）和数据文件一览表
【按文件名字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。】

9. 用户操作举例

5. 如何定义软件产品说明书

产品说明书是指以文体的方式对某产品进行相对的详细表述，使人认识、了解到某产品。其基本特点有真实性、科学性、条理性、通俗性和实用性。
介绍产品的特征、性能、使用方法、保养维护、注意事项等内容的核心所在。常见主体有以下内容：概述 、指标 、结构、特点 、方法 、配套、事项 、保养、责任。
对于软件产品说明书来说，介绍产品的使用流程、期间可能遇到的问题、如何解决，这些都是很关键的信息。
而对于软件产品来说，快速的更新迭代，在线产品说明书可能更适合这种快节奏。
而优雅快捷的在线产品手册制作平台Baklib能帮你快速搭建产品手册，自带的网页展示效果、多种模版可选、多端操作、多人协同功能使操作极为便捷。可以图文并茂的通过需求分类详细介绍你的产品。

会打字就能用，快捷易上手，不需要任何学习基础，还有很多功能如果需要可以去了解一下
制作流程
1、创建站点

Baklib站点创建页面

2.添加内容，添加具体的产品手册内容。

Baklib内容创建页面

3.站点信息设置，
设置站点的名称、logo、主题样式等，生成个性精美的产品手册。

Baklib站点信息设置页面

4.效果展示如图，制作出来的是一个单独的网站，可以将网站链接分享到各个平台，只需要点开链接就能看到产品手册，一目了然，并且可以通过搜索关键词找到所需内容。


Baklib企业产品手册示例
会打字就能用，快捷易上手，不需要任何学习基础，还有很多功能如果需要可以去了解一下
CND加速HTTPS认证让网页更流畅安全
支持SEO收录
支持多种设备同步在线编写存储
支持访问权限设置（公开、私密、密码访问）
多人协同合作，跨平台多端操作便捷
多种可选主题模版一键设置
实用性和展示性并重，最重要的是
所有基础功能永久免费！！！
开通一些特需的额外功能才会收费，最近好像在做活动，特别划算。
附上一个简单教程可以参考一下 网页链接

6. 软件使用说明书如何写（包含哪些内容）？有没有模板的

有的，网上可以搜到挺多，我不知道怎么提供给你下载，这个你可以参考参考。
软件使用说明书模板
1.
引言
1.1编写目的【阐明编写手册的目的。指明读者对象。】
1.2项目背景【说明项目来源、委托单位、开发单位及主管部门】
1.3
定义【列出手册中使用的专门术语的定义和缩写词的原意】
1.4参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，
可包括：a.项目的计划任务书、合同或批文；b.项目开发计划；C.
需求规格说
明书；d.概要设计说明书；e。详细设计说明书；f.测试计划；g。手册中引用
的其他资料、采用的软件工程标准或软件工程规范。】
2.
软件概述
2.1目标
2.2功能
2.3
性能
a.数据精确度【包括输入、输出及处理数据的精度】
b.时间特性【如响应时间、处理时间、数据传输时间等。】
c.灵活性【在操作方式、运行环境需做某些变更时软件的适应能力。】
3.
运行环境
3.1硬件【列出软件系统运行时所需的硬件最小配置，如a.
计算机型号、主存容量；b.
外存储器、媒体、记录格式、设备型号及数量；c。输入、输出设备；d.数据传输设
备及数据转换设备的型号及数量。】
3.2支持软件【如：a。操作系统名称及版本号；b.
语言编译系统或汇编系统的名称及版
本号；C。数据库管理系统的名称及版本号；d.其他必要的支持软件。】
4.
使用说明
4.1安装和初始化【给出程序的存储形式、操作命令、反馈信息及其含意、表明安装完成
的测试实例以及安装所需的软件工具等。】
4.2输入【给出输入数据或参数的要求。】
4.2.1数据背景【说明数据来源、存储媒体、出现频度、限制和质量管理等。】
4.2.2数据格式【如：a。长度；b.格式基准；C，标号；d.顺序；e。分隔符；f.
词汇表；g.
省略和重复；h.控制。】
4.2.3输入举例
4.3输出【给出每项输出数据的说明】
4.3.l数据背景【说明输出数据的去向使用频度、存放媒体及质量管理等。】
4.3.2数据格式【详细阐明每一输出数据的格式，如：首部、主体和尾部的具体形式。】
4.3.3举例
4.4出错和恢复【给出：a。出错信息及其含意；b.用户应采取的措施，如修改、恢复、
再启动.】
4.5求助查询【说明如何操作】
5.
运行说明
5.1运行表【列出每种可能的运行情况，说明其运行目的。】
5.2运行步骤【按顺序说明每种运行的步骤，应包括：】
5.2.1运行控制
5.2.2操作信息
a.
运行目的；b.操作要求；C。启动方法;
d.预计运行时间；e。操作命令格
式及格式说明；f.其他事项。
5.2.3输入／输出文件【给出建立或更新文件的有关信息，如：】
a.文件的名称及编号；b.记录媒体；C。存留的目录；d.文件的支配
【说明确定保留文件或废弃文件的准则，分发文件的对象，占用硬件的优先
级及保密控制等.】
5.2.4启动或恢复过程
6.
非常规过程
【提供应急或非常规操作的必要信息及操作步骤，如出错处理操作、向后备系统切换操作以
及维护人员须知的操作和注意事项。】
7.
操作命令一览表
【按字母顺序逐个列出全部操作命令的格式、功能及参数说明。】
8.
程序文件（或命令文件）和数据文件一览表
【按文件名字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。】
9.
用户操作举例

7. 软件说明文档的作用

电脑软件：计算机系统中的程序及其文档