程序设计说明书怎么写 设计说明书怎么写,应该注意什么

概要设计说明书又可称系统设计说明书，这里所说的系统是指程序系统。

编制的目的是说明对程序 系统的设计考虑，包括程序系统的基本处。流程、程序系统的组织结构、模块划分、功能分配、接口设计。

运行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。编制概要设计说明书的内容，要求如下： 11.1引言 11.1. 1编写目的 11.1.2背景 11.1.3定义 11.1.4参考资料 11.2总体设计 11.2.1需求规定 11.2.2运行环境 11.2.3基本设计概念和处理流程 11. 2. 4”结构 11.2.5功能需求与程序的关系 11. 2. 6人工处理过程 11.2.7尚未解决的问题 11.3接口设计 11.31用户接口 11.32外部接口 11.3 3内部接口 11.4运行设计 11. 4. 1运行模块组合 11.4.2运行控制 11.4.3运行时间 11.5系统论据结构设计 11. 5. 1逻辑结构设计要点 11. 5. 2物理结构设计要点 11.5.3数据结构与程序的关系 11. 6系统出错处理设计 11. 6. 1出错信息 11.6.2补救措施 11.6 3系统维护设计 概要设计说明书的编写提示（参考件） E.1引言 E.1.1编写目的 说明编写这份概要设计说明书的目的，指出预期的读者。

E.1.2背景 说明： a.待开发软件系统的名称； b.列出此项目的任务提出者、开发者、用户以及将运行该软件的计算站（中心）。E.1.3定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。

E.1.4参考资料 列出有关的参考文件，如： a.本项目的经核准的计划任务书或合同，上级机关的批文； b.属于本项目的其他已发表文件； c.本文件中各处引用的文件、资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。

E.2总体设计 E.2.1需求规定 说明对本系统的主要的输入输出项目、处理的功能性能要求，详细的说明可参见附录C。E.2.2运行环境 简要地说明对本系统的运行环境（包括硬件环境和支持环境）的规定，详细说明参见附录C。

E.2.3基本设计概念和处理流程 说明本系统的基本设计概念和处理流程，尽量使用图表的形式。E.2.4结构 用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系.E.2.5功能器求与程序的关系 本条用一张如下的矩阵图说明各项功能需求的实现同各块程序的分配关系：E.2.6人工处理过程 说明在本软件系统的工作过程中不得不包含的人工处理过程（如果有的话）。

E.2.7尚未问决的问题 说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。E.3 接口设计 E.3.1用户接口 说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。

E.3.2外部接口 说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接 口关系。E.3.3内部接口 说明本系统之内的各个系统元素之间的接口的安排。

E.4运行设计 E.4.1运行模块组合 说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合，说明每种运行所历经的内部模块和支持软件。E.4.2运行控制 说明每一种外界的运行控制的方式方法和操作步骤。

E.4.3运行时间 说明每种运行模块组合将占用各种资源的时间。E.5系统数据结构设计 E.5.1逻辑结构设计要点 给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。

E.5.2物理结构设计要点 给出本系统内所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系（索引、设备、存储区域）、设计考虑和保密条件。E.5.3数据结构与程序的关系 说明各个数据结构与访问这些数据结构的形式：E.6系统出错处理设计 E.6.1出错信息 用一览表的方式说朗每种可能的出错或故障情况出现时，系统输出信息的形式、含意及处理方法。

E.6.2补救措施 说明故障出现后可能采取的变通措施，包括： a.后备技术说明准备采用的后备技术，当原始系统数据万一丢失时启用的副本的建立和启动的技术，例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术； b.降效技术说明准备采用的后备技术，使用另一个效率稍低的系统或方法来求得所需结果的某些部分，例如一个自动系统的降效技术可以是手工操作和数据的人工记录； c.恢复及再启动技术说明将使用的恢复再启动技术，使软件从故障点恢复执行或使软件从头开始重新运行的方法。 E.6.3系统维护设计 说明为了系统维护的方便而在程序内部设计中作出的安排，包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。

各个程序之间的对应关系，可采用如下的矩阵图的形式；。

程序说明书包括如下七个内容：

1.程序名称；包括反映程序功能的文字名称和标识符。

2.程序所属的系统、子系统或模块的名称。

3.编写程序所需使用的语言。

4.输入的方式和格式：当程序有多种输入时，分别对每种输入方式与格式做出具体而细致

的说明。

5.输出的方式与格式：当程序有多种内容按不同方式输出时，分别说明不同内容按不同方

式输出时的格式。

6.程序处理过程说明：包括程序中使用的计算公式，数学模型和控制方法等。

7.程序运行环境说明：对程序运行所需要的输入输出设备的类型和数量，计算机的内存及

硬盘容量，支持程序运行的操作系统等内容进行说明。

由于种种原因，在实际工作中不太重视程序说明书的编写工作。这既不利于程序的设计工作，更不利于对程序的修改和维护工作。因为系统投入运行后，需要经常根据情况的变化进行调整和修改，如果没有完善的文档资料，维护、修改就很难进行。

原发布者：鑫淼图文

概要设计说明书1.1.引言1.1.1编写目的本文档详细说明公文流转系统的总体设计思想和设计方法，以及如何实现公文流转系统中各信息数据流的处理流程，供详细设计人员参考。1.1.2项目背景本文档为公司公文流转标准系统设计，同时作为软件开发文档的标准模式初稿，供系统设计人员参审。1.1.3定义本文档将引用下面的定义，在此加以说明：公文，泛指工作中使用的各种文体的办公文件，如合同、申请、报告、报表文件、请假、计划、通知、汇报、通报等。流转，指公文被处理的过程，如拟稿、批示、传递、打印等。数据库，指存储特定信息的计算机文件，是信息保存的静态形式，可以是计算机软件系统特指的数据库，也可以是特指的表或查询。后台处理，指不需要人工干预的、自动根据操作规则进行的数据处理过程。人工输入，指通过鼠标或键盘将文字信息输入给软件或将控制命令传递给软件的过程。复制，指将数据完全不变地保存到另外一个数据库中。其他定义符合计算机中的标准定义。1.1.4参考资料公文管理方法软件工程规范数据库管理系统（SQL）技术手册1.2.任务概述1.2.1目标本文档设计目标是，通过对公文流转过程的逻辑描述，说明如何实现计算机网络的公文流转处理，作为详细设计的必备参考资料。1.2.2运行环境本文档描述的处理过程依赖以下平台：.0中文版MicrosoftSQLServer6.5Windows95,InternetExploer4.01.2.3需求概述公文流转系统的需求主要包括以

中北大学

微机原理与汇编语言

课 程 设 计 说 明 书

学生姓名： 学 号：

学 院：

专 业： 计算机科学与技术

题 目：

成绩

指导教师 乔志伟、陈够喜、徐志永

2011 年6月9日

1. 引言（大标题黑体四号字）

该题目的意义等 （小四号字宋体，1.5倍行距）

2.需求分析

该题目的需求分析（小四号字宋体，1.5倍行距）

3.总体设计

该题目的设计方案与系统构成，主要由文字组成，在必要时，可以添加一些图或者表格。

4. 详细设计（这一部分每个人应该是不同的）

用文字说明自己具体负责模块的实现过程和实现原理以及设计的程序的流程图，必要时可以添加说明性的图形或表格。

必须要写出，为什么这样做来，也就是说，必须在掌握的基础上编写程序。

5. 软件测试

说明自己模块的测试过程和测试原理。如果是组长，则要说明总体的测试情况。给出测试报告。

6. 程序清单

给出自己设计模块的程序清单。

7. 参考资料

说明自己在课程设计中参考的文献资料，参考资料的格式如下：

[1] 作者1，作者2 . 图书名称 . 出版社 . 出版社地点 . 出版年. 参考页码范围

装订次序：

1.课程设计说明书封面 2.任务书封面 3.任务书 4. 设计说明书正文

main()

{ int x,a=1,b=2,c=3,d=4;

x=(a<b)? a:b; x=(x<c)? x:c; x=(d>x)? x:d;

printf("%dn",x);

}

输出结果是：

1

逻辑表达式？语句1：语句2 的意思是如果表达式为真，那么执行语句1；如果表达式为假，那么执行语句2

x=(a<b)?a:b；如果a<b的话，那么x=a，否则x=b；因为1<2成立，所以x=a，即x=1

x=(x<c)?x:c，如果x<c的话，那么x=x，否则x=c；因为2<3成立，所以x=x，即x=1;

x=(d>x)?x:d，如果d>x的话，那么x=x，否则x=d；因为4>1成立，所以x=x，即x=1;

所以printf("%dn",x)的结果是输出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） 对每个场景做一则条目，包括以下内容： 场景名：给它一个可以望文生义的名字 场景描述：简要叙述场景是干什么的以及发生的动作的顺序。

顺序图：描述各种事件及事件发生的。

有的，网上可以搜到挺多，我不知道怎么提供给你下载，这个你可以参考参考。

软件使用说明书模板

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. 用户操作举例