软件设计说明书应该怎么写？
软件设计说明书编写规范
一、编写目的
二、应用文档
三、要求及内容
2.1编写格式要求
2.2说明书内容
2.2.1说明书目的
2.2.2参考资料及文档
2.2.3设计原则
2.2.4接口描述
2.2.5功能描述
2.2.6接口协议
2.2.7编程协定
2.2.8数据结构
2.2.9逻辑结构
2.2.10程序流程
2.2.11源文件列表
2.2.12其他
2.3文档修订历史
四、编写文档注意事项
五、样例及模板文档
面向对象软件设计说明书模板
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 词汇索引
文章录入
其内容格式可参见如下：
一、软件概述（背景，功能，特点等）、
二、软件、硬件配置要求
三、软件功能
1、总体介绍
2、总体流程图
3、功能描述（以其中一个功能为例）
1） 功能1
详细介绍（包含的模块等）
模块1
详细介绍（包含的模块等）
实现方式
模块设计流程图
流程介绍
……
模块2
……
功能2
……
表述完毕后，还可进行总结性地描述或添加数据结构、参数表格的描述。
如有不明可留言详解！
《软件工程课程设计资料》百度网盘资源免费下载
链接:https://pan.baidu.com/s/13kMSLN5gQbxBoqggkGkZ-Q
?pwd=zxcv 提取码:zxcv软件工程课程设计资料|学生作品参考|Axure软件|Axure参考素材|2018-2019第一学期软件工程教室安排-分班级安排表.xls|05-软件工程课程设计评分标准.docx|02-软件工程课程设计-实践教学计划表.doc|01-软件工程课程设计参考文档模板.docx|我为拉勾网设计的移动端.docx|设计案例：“我的学习日志 ”产品需求说明书.docx|设计案例：“我的学习日志 ”产品需求说明书.doc|绝密原型档案（违章处理 App 1.06版本）.rp|qtfm.rp|Holiday.zip|holiday 原型.zip
SDE在欧洲又叫集成式项目支援环境（Integrated Project Support Environment，IPSE）。
软件开发环境的主要组成成分是软件工具。人机界面是软件开发环境与用户之间的一个统一的交互式对话系统，它是软件开发环境的重要质量标志。存储各种软件工具加工所产生的软件产品或半成品（如源代码、测试数据和各种文档资料等）的软件环境数据库是软件开发环境的核心。工具间的联系和相互理解都是通过存储在信息库中的共享数据得以实现的。
软件开发环境数据库是面向软件工作者的知识型信息数据库，其数据对象是多元化、带有智能性质的。软件开发数据库用来支撑各种软件工具，尤其是自动设计工具、编译程序等的主动或被动的工作。
较初级的SDE数据库一般包含通用子程序库、可重组的程序加工信息库、模块描述与接口信息库、软件测试与纠错依据信息库等；较完整的SDE数据库还应包括可行性与需求信息档案、阶段设计详细档案、测试驱动数据库、软件维护档案等。更进一步的要求是面向软件规划到实现、维护全过程的自动进行，这要求SDE数据库系统是具有智能的，其中比较基本的智能结果是软件编码的自动实现和优化、软件工程项目的多方面不同角度的自我分析与总结。这种智能结果还应主动地被重新改造、学习，以丰富SDE数据库的知识、信息和软件积累。这时候，软件开发环境在软件工程人员的恰当的外部控制或帮助下逐步向高度智能与自动化迈进。
软件实现的根据是计算机语言。时至今日，计算机语言发展为算法语言、数据库语言、智能模拟语言等多种门类，在几十种重要的算法语言中，C&C++语言日益成为广大计算机软件工作人员的亲密伙伴，这不仅因为它功能强大、构造灵活，更在于它提供了高度结构化的语法、简单而统一的软件构造方式，使得以它为主构造的SDE数据库的基础成分——子程序库的设计与建设显得异常的方便。
事实上，以C&C++为背景建立的SDE子程序库能为软件工作者提供比较有效、灵活、方便、友好的自动编码基础，尤其是C++的封装等特性，更适合大项目的开发管理和维护。
软件开发环境可按以下几种角度分类：
(1)按软件开发模型及开发方法分类，有支持瀑布模型、演化模型、螺旋模型、喷泉模型以及结构化方法、信息模型方法、面向对象方法等不同模型及方法的软件开发环境。
(2)按功能及结构特点分类，有单体型、协同型、分散型和并发型等多种类型的软件开发环境。
(3)按应用范围分类，有通用型和专用型软件开发环境。其中专用型软件开发环境与应用领域有关，故又软件开发方法(Software Development Method)是指软件开发过程所遵循的办法和步骤。软件开发活动的目的是有效地得到一些工作产物，也就是一个运行的系统及其支持文档，并且满足有关的质量要求。软件开发是一种非常复杂的脑力劳动，所以经常更多讨论的是软件开发方法学，指的是规则、方法和工具的集成，既支持开发，也支持以后的演变过程(交付运行后，系统还会变化，或是为了改错，或是为了功能的增减)。
关于组成软件开发和系统演化的活动有着各种模型(参见软件生存周期，软件开发模型，软件过程)，但是典型地都包含了以下的过程或活动：分析、设计、实现、确认(测试验收)、演化(维护)。
有些软件开发方法是专门针对某一开发阶段的，属于局部性的软件开发方法。特别是软件开发的实践表明，在开发的早期阶段多做努力，在后来的测试和维护阶段就会使费用较大地得以缩减。因此，针对分析和设计阶段的软件开发方法特别受到重视。其它阶段的方法，从程序设计发展的初期起就是研究的重点，已经发展得比较成熟(参见程序设计，维护过程)。除了分阶段的局部性软件开发方法之外，还有覆盖开发全过程的全局性方法，尤为软件开发方法学注意的重点。
对软件开发方法的一般要求：当提出一种软件开发方法时，应该考虑许多因素，包括：①覆盖开发全过程，并且便于在各阶段间的过渡；②便于在开发各阶段中有关人员之间的通信；③支持有效的解决问题的技术；④支持系统设计和开发的各种不同途径；⑤在开发过程中支持软件正确性的校验和验证；⑥便于在系统需求中列入设计、实际和性能的约束；⑦支持设计师和其他技术人员的智力劳动；⑧在系统的整个生存周期都支持它的演化；⑨受自动化工具的支持。此外，在开发的所有阶段，有关的软件产物都应该是可见和可控的；软件开发方法应该可教学、可转移，还应该是开放的，即可以容纳新的技术、管理方法和新工具，并且与已有的标准相适应可称为应用型软件开发环境。
⑷按开发阶段分类，有前端开发环境(支持系统规划、分析、设计等阶段的活动)、后端开发环境(支持编程、测试等阶段的活动)、软件维护环境和逆向工程环境等。此类环境往往可通过对功能较全的环境进行剪裁而得到。软件开发环境由工具集和集成机制两部分构成，工具集和集成机制间的关系犹如“插件”和“插槽”间的关系。
工具集：软件开发环境中的工具可包括：支持特定过程模型和开发方法的工具，如支持瀑布模型及数据流方法的分析工具、设计工具、编码工具、测试工具、维护工具，支持面向对象方法的OOA工具、OOD工具和OOP工具等；独立于模型和方法的工具，如界面辅助生成工具和文档出版工具；亦可包括管理类工具和针对特定领域的应用类工具。
集成机制：对工具的集成及用户软件的开发、维护及管理提供统一的支持。按功能可划分为环境信息库、过程控制及消息服务器、环境用户界面三个部分。
环境信息库：是软件开发环境的核心，用以储存与系统开发有关的信息并支持信息的交流与共享。库中储存两类信息，一类是开发过程中产生的有关被开发系统的信息，如分析文档、设计文档、测试报告等；另一类是环境提供的支持信息，如文档模板、系统配置、过程模型、可复用构件等。
过程控制和消息服务器：是实现过程集成及控制集成的基础。过程集成是按照具体软件开发过程的要求进行工具的选择与组合，控制集成并行工具之间的通信和协同工作。
环境用户界面：包括环境总界面和由它实行统一控制的各环境部件及工具的界面。统一的、具有一致视感(Look &Feel)的用户界面是软件开发环境的重要特征，是充分发挥环境的优越性、高效地使用工具并减轻用户的学习负担的保证。
较完善的软件开发环境通常具有如下功能：
(1)软件开发的一致性及完整性维护；
(2)配置管理及版本控制；
(3)数据的多种表示形式及其在不同形式之间自动转换；
(4)信息的自动检索及更新；
(5)项目控制和管理；
(6)对方法学的支持。
