软件设计说明编写指南438B

密级：_________

（软件项目名称）

软件设计说明

标识: __________________________

版本： _________________________

页数： _________________________

拟制: _________________________

SQA审核：______________________ 审核： _________________________

批准： _________________________

拟制部门： ______________________

中国人民------------------------

XXXXXXXXXX 研究所

解放军--------------------------

修改文档历史记录:

日期版本说明修改人

1 范围 (1)

1.1 标识 (1)

1.2 系统概述 (1)

1.3 文档概述 (1)

2 引用文档 (1)

3 CSCI 级设计决策 (1)

4 CSCI 体系结构设计 (2)

4.1 CSCI 部件 (2)

4.1.1 CSCI 结构 (3)

4.1.2 CSC 描述 (3)

4.1.2.1 CSC 名称和项目唯一标识号 (3)

4.1.3 系统状态和模式 (4)

4.2 执行方案 (4)

4.2.1 CSC 数据流与控制流图 (5)

4.2.2 系统状态与模式的数据流与控制流 (5)

4.3 接口设计 (6)

4.3.1 接口设计准则 (6)

4.3.2 接口标识和接口图 (6)

4.3.X （接口的项目唯一的标识符） (7)

5 CSCI 详细设计 (10)

5.X （软件单元的项目唯一的标识符，或者一组软件单元的标志符）10

6 需求可追踪性 (12)

7 注释 (12)

1范围

1.1标识

【本条应描述本文档所适用的系统和软件的完整标识，适用时，包括其标识号、名称、缩略名、版本号及发布号。】

1.2系统概述

【本条应概述本文档所适用的系统和软件的用途。它还应描述系统与软件的一般特性；概述系统开发、运行和维护的历史；标识项目的需方、用户、开发方和保障机构等；标识当前和计划的运行现场；列出其它有关文档。】

1.3文档概述

【本条应概述本文档的用途和内容，并描述与它的使用有关的保密性方面的要求。】

例：

本文档描述XXXX系统软件的概要设计和详细设计，其内容和格式遵循GJB438B-2009的

要求。本文档可作为设计评审的基础，编码的依据，软件测试的基准。

2引用文档

【本章应列出引用文档的编号、标题、编写单位、修订版本及日期。还应标识不能通过正常采购活动得到的文档的来源。】

例：

3 CSCI级设计决策

【本章应根据需要分条给出CSCI级设计决策，即CSCI行为设计的决策（忽略其内部

实现，从用户角度出发描述系统将怎样运转以满足需求）和其它影响组成该CSCI的软件单

元的选择与设计的决策。如果在需求中所有这些决策是明确的，或者这些决策要推迟到CSCI 的软件单元的设计时指出，则本章应如实陈述。针对关键性需求（例如对安全性或保密性关键的需求）作出的设计决策，应在专门的章节中加以叙述。如果设计决策依赖于系统状态或方式，则应指明这一依赖性。本条应给出或引用理解这些设计所需的设计约定。CSCI级设

计决策的例子如下：

a）关于CSCI将接收的输入和将产生的输出的设计决策，包括与其它系统、HWCI、CSCI 和用户的接口（本文档的4.3.X条指出本说明要考虑的主题）。如果这一信息的全部或部分已在接口设计说明（IDDs ）中给出，则可以直接引用。

b）有关响应每个输入或条件的CSCI行为的设计决策，包括CSCI要执行的动作、响应时间和其它性能特性，模型化的物理系统的说明，选定的方程式/算法/规则，以及对不允许的输入或条件进行的处理。

c）有关数据库/数据文件如何呈现给用户的设计决策（本文档的 4.3.X节标识了本说明要考虑的主题）。如果这一信息的全部或部分在数据库设计说明（DBDD ）中给出，则可直接引用。

d）为满足安全性和保密性需求所选择的方法。

e）为满足需求所做的其它CSCI级设计决策，例如为提供所需的灵活性、可用性和可维护性所选择的

方法。】

示例1:

从两种技术解决方案中选出一种：XXXXXX 。

输入响应设计决策：对于待处理目标，收到目标侦测设备送来的待处理目标后，利用目

标识别库识别确定目标的敌我属性，并进行威胁目标报告。

安全性设计方法：在原系统的基础上，增加安全内核，实现身份认证和密码保护。

可用性设计方法：利用双机热备份，24小时不停机，实现系统的可用性。

4 CSCI体系结构设计

【本章应分为以下几条描述CSCI体系结构设计。如果设计的全部或部分依赖于系统的

状态或方式，此依赖性应予指明。如果设计信息在多于一个条中出现，它只需被提供一次，而在其它条中引用。本条应提供或引用为了理解设计所需要的设计约定。】

4.1 CSCI 部件

【本条应描述：

a）构成该CSCI的所有软件单元。应赋予每个软件单元一个项目唯一的标识符。

注：软件单元是CSCI设计中的一个元素；例如，CSCI的一个主要分支、该主要分支的一个组成部分，一个类、对象、模块、函数、例程或数据库。软件单元可以出现在层次结构的不同层

上，且又可以由其它软件单元组成。在设计中，软件单元与实现它们的代码和数据实体（例

程，过程，数据库，数据文件等），或

与包含这些实体的计算机文件之间，可以有、也可以没有一对一的对应关系。

一个数据库可被处理为一个CSCI也可被处理为一个软件单元。SDD可以采用

与所使用设计方法相一致的任何名字来称呼软件单元。

b）软件单元的静态（如，由…组成）关系。根据所选择的软件设计方法学，可以给出多种关系（例如，采用面向对象的设计方法时，本条既可给出类和对象结构，也可给出CSCI的模块和过程结

构）。

c）每个软件单元的用途，指明分配给它的CSCI需求和CSCI级设计决策（需求的分配也可在

6 a）中提供）。

d）每个软件单元的开发状态/类型（如新开发、按原样重用已有的设计或软件、再工程的已有的设计或软件、为重用而要开发的软件等，为构建版N计划的软件）。针对

现有的设计或软件，本说明应提供标识信息，例如名字、版本、文档引用、库等。

e）CSCI （若适用，针对每个软件单元）计划使用的计算机硬件资源（例如处理机能力，内存能力，输入/输出设备能力，辅存能力以及通信/网络设备能力）。本说明应覆盖

CSCI

的资源使用需求中、影响该CSCI的系统级资源分配中、以及在软件开发计划（SDP）的资源使用测量策划的中包含的全部计算机硬件资源。如果针对给定计算

机硬件资源的所有使用数据都在同一处提供，例如在SDD中提供，那么本条可直接

引用。对每个计算机硬件资源，应包括如下信息：

1）得到满足的CSCI需求或系统级资源分配；

2）使用数据基于的假设和条件（例如，典型用法、最坏情况用法、特定事件的假定）

3）影响使用的特殊考虑（例如，虚存、覆盖、多处理器的使用情况，操作系统、库软件的开销或其它实现开销影响）；

4）所使用的测度的单位（例如，处理器能力的百分比、周期/秒、内存字节数、千字节/秒）；

5）进行评估或测量的级别（例如，软件单元，CSCI或者可执行程序）。

f）标识实现每个软件单元的软件放置在哪个程序库中。】

示例：

4.1.1 CSCI 结构

4.1.2 CSC 描述

4.121 CSC名称和项目唯一标识号注：从4.1.2.1开始，按照4.1.1图中的CSC层次关系进行编号。

表2 （CSC名称）描述

CSC名称CSC标识

CSC用途

下一级

CSC组成

设计决策

CSC分配需求设计需求设计约束开发类型/状态

注：

a. 如该CSC不包含下一级CSC可标注为“无”，否则逐个说明下一级的CSC名称。

b. “分配需求”为需求规格说明分配给CSC的功能、性能、安全、保密等方面需求，

可引用需求文档相关描述或名称标识；

c. “设计需求”是从设计者的角度描述该CSC为实现分配需求而使用的关键算法、模

目标侃别耳决幣

ftSKflcsci

甜X忖标识别与腹靖处狸敕件功能也块结

型、容错处理等方面需求；

d. “设计约束”是从设计者的角度描述实现该CSC所受到的软、硬件环境的限制，女口

数据范围、字长限制等；

e. “开发类型/状态”是指新开发、按原样重用已有的设计或软件、再工程的已有的设

计或软件、为重用而要开发的软件、为构建版N计划的软件等。

f. 女口CSC由下一级CSC组成，分配需求、设计需求、设计约束内容可引用下一级CSC

软件著作权设计说明书范本资料

软件著作权-说明书范本（二）设计说明书中国版权保护中心接收登记的文档包含两种：操作说明书或设计说明书。设计说明书适合没有界面的嵌入式软件，插件软件，后台运行软件以及游戏软件。一般包含结构图，软件流程图，函数说明，模块说明，数据接口，出错设计等。操作说明书适合管理类软件，有操作界面，一般应包含登录界面，主界面，功能界面截图，截图之间有相应的文字说明，能全面展示软件的主要功能。格式要求：一、说明书应提交前、后各连续30页，不足60页的，应当全部提交。二、说明书页眉应标注软件的名称和版本号，应当与申请表中名称完全一致，页眉右上应标注页码，说明书每页不少于30行，有图除外，另外截图应该清晰完整。范例如下：设计说明书

一、引言目的编写详细设计说明书是软件开发过程必不可少的部分，其目的是为了使开发人员在完成概要设计说明书的基础上完成概要设计规定的各项模块的具体实现的设计工作。二、软件总体设计 2.1软件需求概括本软件采用传统的软件开发生命周期的方法，采用自顶向下，逐步求精的结构化的软件设计方法。本软件主要有以下几方面的功能 (1)连接设备 (2)提取数据 (3)保存数据 (4)删除仪器数据 (5)查看历史数据定义本项目定义为一个典型的多点互动探伤软件。它将实现多点设备和系统程序的无缝对接，以实现多点互动功能。 2.2需求概述 1.要求利用PQLib硬件商提供的SDK开发出对应的触摸屏系统。 2.系统要显示图片，并实现图片相关所有的多点操作，包括放大，缩小，旋转，平移的功能。 3.要提供美观的图片菜单，在菜单中要提供必要的图片简介信息。 4.系统图片的维护更新要方便。 2.3条件与限制系统开发的条件是普通PC以及相对应的系统，本次开发所用的系统是WINDOW SERVER2003以及ADOBE FlashCS4。由于硬件开发商提供的开发文档不是很详尽，这对系统开发产生了一定限制影响。总体设计 2.4总体结构和模块接口设计系统整体结构框架如图

(国内标准)GB-软件开发主要文档编写规范

231 GB 8567－88软件开发主要文档编写规范本附录中列出了《计算机软件产品开发文件编制指南》GB 8567－88中主要软件文档的编写说明，供编写时参考。这些文档主要是：可行性研究报告、项目开发计划、软件需求说明书、概要设计说明书、详细设计说明书、模块开发卷宗、测试计划、测试分析报告、项目开发总结报告。一、可行性研究报告 l 引言 1.1 编写目的说明：说明本可行性研究报告的编写目的，指出预期的读者。 1.2 背景说明： a ．所建议开发的软件系统的名称。 b ．本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络。 c ．该软件系统同其他系统或其他机构的基本的相互来往关系。 1.3 定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4 参考资料列出用得着的参考资料，如： a ．本项目的经核准的计划任务书或合同、上级机关的批文。 b ．属干本项目的其他已发表的文件。 c. 本文件中各处引用的文件、资料，包括所需用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 2 可行性研究的前提说明对建议开发项目进行可行性研究的前提，如要求、目标、条件、假定和限制等。 2.1 要求说明对所建议开发软件的基本要求，如： a ．功能。 b ．性能。 c ．输出如报告、文件或数据，对每项输出要说明其特征，如用途、产生频度、接口以及分发对象。 d. 输入说明。系统的输入包括数据的来源、类型、数量、数据的组织以及提供的频度。 e ．处理流程和数据流程。用图表的方式表示出最基本的数据流程和处理流程，并输之以叙述。 f. 在安全与保密方面的要求。 g. 同本系统相连接的其他系统。 h. 完成期限。 2.2 目标说明所建议系统的主要开发目标，如： a. 人力与设备费用的减少。 b. 处理速度的提高。 c. 控制精度或生产能力的提高。

软件开发文档规范

附2: 软件文档编写向导文档分类项目包括如下几类文档：项目管理文档。包括：《软件项目计划》、《项目进度报告》、《项目开发总结报告》软件开发文档。包括：《需求规格说明》、《概要设计说明》、《详细设计说明》、《测试计划》、《软件测试分析报告》。产品文档。包括：《用户操作手册》《演示文件》。软件项目计划（Software Project Plan）一?引言 1?编写目的（阐明编写软件计划的目的，指出读者对象。） 2?项目背景（可包括：（1 ）项目委托单位、开发单位和主管部门；（2）该软件系统与其他系统的关系。） 3?定义（列出本文档中用到的专门术语的定义和缩略词的原文。） 4?参考资料（可包括：文档所引用的资料、规范等；列出资料的作者、标题、编号、发表日期、出版单位或资料来源。）二?项目概述 1.工作内容（简要说明项目的各项主要工作，介绍所开发软件的功能性能等?若不编写可行性研究报告，则应在本节给出较详细的介绍。） 2.条件与限制（阐明为完成项目应具备的条件开发单位已具备的条件以及尚需创造的条件?必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。） 3.产品（1）程序（列出应交付的程序名称使用的语言及存储形式。）（2）文档（列出应交付的文档。）（3 ）运行环境（应包括硬件环境软件环境。） 4?服务（阐明开发单位可向用户提供的服务?如人员培训安装保修维护和其他运行支持。 5.验收标准

三.实施计划 1.任务分解（任务的划分及各项任务的负责人。） 2?进度（按阶段完成的项目，用图表说明开始时间完成时间。） 3?预算 4?关键问题（说明可能影响项目的关键问题，如设备条件技术难点或其他风险因素，并说明对策。）四.人员组织及分工五.交付期限六.专题计划要点（如测试计划等。）项目开发进度报告一.报告时间及所处的开发阶段二.给出进度 1.本周的主要活动 2.实际进展与计划比较三.所用工时（按不同层次人员分别计时。）四.所有机时五.工作遇到的问题及采取的对策六.本周完成的成果七.下周的工作计划八.特殊问题项目开发总结报告一.引言 1.编写目的（阐明编写总结报告的目的，指明读者对象。） 2.项目背景（说明项目的来源、委托单位、开发单位及主管部门。） 3.定义（列出报告中用到的专门术语定义和缩写词的原意。） 4.参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1 ）项目开发计划；（2 ）需求规格说明书；（3 ）概要设计说明书；（4 ）详细设计说明

(完整版)软件详细设计说明书模板

软件详细设计说明书 v1.0 200X年月XX日修订历史记录

编制审查审核批准文档评审负责人：参加评审人员：

目录 1引言 (4) 1.1编写目的 (4) 1.2背景 (4) 1.3定义 (4) 1.4设计依据 (4) 2软件系统结构 (4) 2.1功能需求 (4) 2.2子模块划分 (4) 2.3子模块间关系 (4) 3公共数据结构 (4) 4程序设计说明 (5) 4.1程序1设计说明 (5) 4.1.1程序描述 (5) 4.1.2功能 (5) 4.1.3性能 (5) 4.1.4输入 (5) 4.1.5输出 (5) 4.1.6算法 (5) 4.1.7流程 (5) 4.2程序2设计说明 (5) 5模块重用说明 (5)

1引言 1.1编写目的〖说明编写这份软件详细设计说明书的目的〗 1.2背景〖说明待开发软件（子）系统的名称和此软件（子）系统所属大系统的名称；说明任务的来源（开发背景和市场背景）等；该软件（子）系统与大系统中其他子系统的关系。〗 1.3定义〖列出本文档中所用到的专门术语的定义和缩写词的原意〗 1.4设计依据〖列出本文档所引用的有关设计依据（标题、文件编号、版本号、作者、发布日期、出版单位），包括本项目内部已编写的有效文档、出版刊物和国家标准或规范〗2软件系统结构 2.1功能需求 2.2子模块划分〖说明本软件系统(或模块)的实现，即其内部的子模块划分（给出程序的名称和标识符）。建议以图形说明。〗 1.XXXXXXXX 2.XXXXXXXX 3.XXXXXXXX 4.XXXXXXXX 5.XXXXXXXX 6.XXXXXXXX 2.3子模块间关系〖说明各子模块间的控制、顺序等耦合关系。〗 3公共数据结构〖给出本软件系统使用的每一个公共数据结构的类型定义、存储方式，公共数据结构内各元素项的类型定义、初始取值、可能取值的范围及相应的物理含义。建议以类似Ｃ语言的数据说明格式来描述。〗

软件开发软件产品开发文件编制指南

附录五国家标准《计算机软件产品开发文件编制指南》国家标准《计算机软件产品开发文件编制指南》（GB 8567—88）是一份指导性文件。它建议在软件的开发过程申编下述14个文件：可行性研究报告、项目开发计划、软件需求说明书、数据要求说明书、总体设计说明书、详细设计说明、数据库设计说明书、用户手册、操作手册、模块开发卷、测试计划、测试分析报告、开发进度表、项目开发总结。该指南给出了这14个文件的编制提示，它同时也是这14个文件编写质量的检验准则。下面详细介绍这14种文件的编写目的与内容要求。 l、可行性研究报告可行性研究报告的目的是：说明该软件开发项目的实现在技术上、经济上和社会条上的可行性，论述为了合理地达到开发目标而可能选择的各种方案，说明并论证所选定的方案。可行性研究报告的编写内容见表l。表l 可行性研究报告 2、项目开发计划编制项目开发计划的目的是用文件的形式，并在开发过程中各项工作的

负责人员、开发进度、经费预算、所需软硬件条件等问题做出的安排记录下来，以便根据本计划开展和检查项目的开发工作。编制内容要求如表2所示。表 2 项目开发计划 3、软件需求说明书软件需求说明书的编制是为了使用户和软件开发人员双方对该软件的初始规定有一个共同的理解，使之成为整个软件开发工作的基础。其内容要求见表3。表3 软件需求说明书 4、数据要求说明书数据要求说明书的编制目的是为了向整个软件开发时期提供关于被处理数据的描述和数据采集要求的技术信息，其内容要求列于表4中。表4 数据要求说明书

5、概要设计说明书概要设计说明书又称为总体设计说明书，编制目的是说明对项目系统的设计考虑，包括基本处理流程、组织结构、模块结构、功能配置、接口设计、运行设计、系统配置、数据结构设计和出错处理设计等，为程序的详细设计提供基础。其内容要求见表5。表5 概要设计说明书 6、详细设计说明书详细设计说明书又称为程序设计说明，编制目的是说明一个软件系统各个层次中的每一个程序（模块）的设计考虑。如果软件系统比较简单，层次少，本文件可以不单独编写，有关内容可并入概要设计说明书。详细设计说明书的内容要求见表6。表6 详细设计说明书 7、数据库设计说明书

软件详细设计说明书模板

New Project 1: 详细设计说明书

1. 前言 2. 摘要 3. 系统详细需求分析 3.1. 详细需求分析 3.1.1. 详细功能需求分析 3.1.2. 详细性能需求分析 3.1.3. 详细信息需求分析 3.1. 4. 详细资源需求分析 3.1.5. 详细组织需求分析 3.1.6. 详细系统运行环境及限制条件需求分析3.1.7. 信息要求 3.1.8. 性能要求 3.2. 接口需求分析 3.2.1. 系统接口需求分析 3.2.2. 现有软、硬件资源接口需求分析

3.2.3. 引进软、硬件资源接口需求分析 4. 总体方案设计 4.1. 系统总体结构 4.1.1. 系统组成、逻辑结构 4.1.2. 应用系统结构 4.1.3. 支撑系统结构 4.1.4. 系统集成 4.1. 5. 系统工作流程 4.2. 分系统详细界面划分 4.2.1. 应用分系统与支撑分系统的详细界面划分 4.2.2. 应用分系统之间的界面划分 5. 应用分系统详细设计 5.1. XX分系统详细需求分析 5.1.1. 功能详细需求分析 5.1.2. 性能详细需求分析

5.1.3. 信息详细需求分析 5.1.4. 限制条件详细分析 5.2. XX分系统结构设计及子系统划分5.3. XX分系统功能详细设计 5.4. 分系统界面设计 5.4.1. 外部界面设计 5.4.2. 内部界面设计 5.4.3. 用户界面设计 6. 数据库系统设计 6.1. 设计要求 6.2. 信息模型设计 6.3. 数据库设计 6.3.1. 数据访问频度和流量 6.3.2. 数据库选型 6.3.3. 异构数据库的连接与数据传递方式

软件设计说明书范本

编号∶______ 版本∶______ 软件详细设计说明书项目名称：xxxxxxxxxxxx子系统委托单位：承办单位：编写: xxxxxx 2002 年05 月01 日校对: xxxxxx 2002 年05 月10 日审核: xxxxxx 2002 年05 月15 日批准: xxxxxx 2002 年05 月25 日

目录 1.引言 (3) 1.1目的 (3) 1.2背景 (3) 1.3参考资料 (3) 2.总体设计 (4) 2.1软件描述 (4) 2.2设计方法 (4) 2.3软件结构 (4) 2.4模块设计说明 (10) 2.4．1总控模块 (10) 2.4．2所长室模块 (10) 2.4.3综合室模块 (18) 2.4.5 机械一室模块 (27) 2.4.6 机械二室模块 (31) 2.4.7 化工一室模块 (36) 2.4.7化工二室模块 (40) 2.4.8电器室模块 (40) 2.4.9轻工室模块 (40) 2.4.10统计汇总模块 (41) 2.4.11领导查询模块 (41) 2.4.12公共查询模块 (42)

1.引言 1.1目的编写详细设计说明书是软件开发过程必不可少的部分，其目的是为了使开发人员在完成概要设计说明书的基础上完成概要设计规定的各项模块的具体实现的设计工作。 1.2背景一、软件名称检测信息系统质量监督检验子模块二、相关单位委托单位∶技术检测中心承办单位∶石油大学(华东) 主管部门∶技术检测中心信息中心 1.3参考资料 1、<<石油工业应用软件工程规范>> SY/T 5232-1999 2、实用软件工程郑人杰清华大学出版社

ISO软件开发全套文档~软件开发过程控制程序

北京易游无限科技公司 https://www.360docs.net/doc/cb18218248.html, EUWX/QP 0714 软件开发过程控制控制程序授控状态：版号：A/O 分发号：持有人： 2007年8月6日发布2007年8月6日实施

易游无限科技发布易游无限科技程序文件文件编号CSI/QP 0714 版号A/0 标题: 软件开发过程控制程序页码共5页第1页

为保证软件产品及其文档可维护，软件开发过程得到有效控制，特制定本程序。 2适用范围本程序文件适用于本公司有合同的所有软件开发过程的控制活动。 3定义 3．1需求分析：（引用GB/T11457-1995的2.404）研究用户要求以得到系统或软件需求定义的过程。 3．2概要设计：（引用GB/T11457-1995的2.343）分析各种设计方案和定义软件体系结构的过程。典型的概要设计包括计算机程序组成成分和数据的定义及构造、界面的定义，并提出时间和规模方面的估计。 3．3详细设计：（引用GB/T11457-1995的2.147）推敲并扩充概要设计，以获得关于处理逻辑、数据结构和数据定义的更加详尽的描述，直到设计完善到足以能实现的地步。 3．4设计实现：（引用GB/T11457-1995的2.229）把设计翻译成代码，然后对此代码排除隐错的过程。它是程序的一种机器可执行形式，或者能被自动地翻译成机器可执行的形式的某种形式的程序。 4职责 4．1项目负责人：负责制订《项目计划》、协调项目内外各方的关系、控制项目进度并保证项目计划的实施和完成。 4．2需求分析员：作为开发方的代表，负责沟通用户和开发人员的认识和见解，明确及准确地编写《软件需求说明书》和初步的《系统指南》。 4．3系统设计员：负责把软件需求变换成可表示的可实现的软件形式，为设计实现提供可行的依据。并在设计过程中要负责编写《概要设计说明书》、《数据库设计说明书》、《详细设计说明书》，完成《系统指南》的编写。 4．4程序员：按设计要求把软件的详细设计变换成可执行的源程序，进行调试。完成相应的文档，编写《用户操作手册》。 4．5测试人员：负责制定测试计划，设计测试方案，测试用例，并实施测试。 4．6配置管理人员负责对开发库中软件配置项的管理和维护。 4工作程序软件开发过程主要分为项目计划、需求分析、概要设计、详细设计、设计实现、内部测试和系统测试7个阶段。易游无限科技程序文件文件编号CSI/QP 0714 版号A/0 标题: 软件开发过程控制程序页码共5页第2页

软件技术文档编写规范

目录第一章引言 1 §1.1 目的 1 §1.2 文档约定 1 §1.3 预期读者和阅读建议 1 §1.4 产品的范围 1 §1.5 参考文献 1 第二章综合描叙 1 §2.1 产品的前景 1 §2.2 产品的功能 1 §2.3 用户类和特征 2 §2.4 运行环境 2 §2.5 设计和实现上的限制 2 §2.6 假设和依赖 2 第三章外部接口需求 2 §3.1 用户界面 2 §3.2 硬件接口 3 §3.3 软件接口 3 §3.4 通信接口 3 第四章系统特性 3 §4.1 说明和优先级 3 §4.2 激励响应序列 3 §4.3 功能需求 3 第五章其他非功能需求 3 §5.1 性能需求 3 §5.2 安全设施需求 4 §5.3 安全性需求 4 §5.4 软件质量属性 4 §5.5 业务规则 4 §5.6 用户文档 4 第六章其他需求 4 §6.1 词汇表 4 §6.2 分析模型 4 §6.3 待确定问题列表 5 第1章引言引言提出了对软件需求规格说明的纵览，这有助于读者理解文档如何编写并且如何阅读和解释。 §1.1 目的对产品进行定义，在该文档中详尽说明了这个产品的软件需求，包括修正或发行版本号。如果这个软件需求规格说明只与整个系统的一部分有关系，那么就只定义文档中说明的部分或子系统。 §1.2 文档约定

描述编写文档时所采用的标准或排版约定，包括正文风格、提示区或重要符号。例如，说明了高层需求的优先级是否可以被其所有细化的需求所继承，或者每个需求陈述是否都有其自身的优先级。 §1.3 预期读者和阅读建议列举了软件需求规格说明所针对的不同读者，例如开发人员、项目经理、营销人员、用户、测试人员或文档的编写人员。描述了文档中剩余部分的内容及其组织结构。提出了最适合于每一类型读者阅读文档的建议。 §1.4 产品的范围提供了对指定的软件及其目的的简短描述，包括利益和目标。把软件与企业目标或业务策略相联系。可以参考项目视图和范围文档而不是将其内容复制到这里。 §1.5 参考文献列举了编写软件需求规格说明时所参考的资料或其它资源。这可能包括用户界面风格指导、合同、标准、系统需求规格说明、使用实例文档，或相关产品的软件需求规格说明。在这里应该给出详细的信息，包括标题名称、作者、版本号、日期、出版单位或资料来源，以方便读者查阅这些文献。如： a．本项目的经核准的计划任务书或合同、上级机关的批文； b．属于本项目的其他已发表的文件； c．本文件中各处引用的文件、资料、包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。第2章综合描叙这一部分概述了正在定义的产品以及它所运行的环境、使用产品的用户和已知的限制、假设和依赖。 §2.1 产品的前景描述了软件需求规格说明中所定义的产品的背景和起源。说明了该产品是否是产品系列中的下一成员，是否是成熟产品所改进的下一代产品、是否是现有应用程序的替代品，或者是否是一个新型的、自含型产品。如果软件需求规格说明定义了大系统的一个组成部分，那么就要说明这部分软件是怎样与整个系统相关联的，并且要定义出两者之间的接口。 §2.2 产品的功能概述了产品所具有的主要功能。其详细内容将在 d 中描述，所以在此只需要概略地总结，例如用列表的方法给出。很好地组织产品的功能，使每个读者都易于理解。用图形表示主要的需求分组以及它们之间的联系，例如数据流程图的顶层图或类图，都是有用的。 §2.3 用户类和特征确定你觉得可能使用该产品的不同用户类并描述它们相关的特征（见第7 章）。有一些需求可能只与特定的用户类相关。将该产品的重要用户类与那些不太重要的用户类区分开。 §2.4 运行环境描述了软件的运行环境，包括硬件平台、操作系统和版本，还有其它的软件组件或与其共存的应用程序。

参考模板 - 软件详细设计规格说明书

附录D:图书管理系统软件设计规格说明书图书管理系统软件详细设计规格说明书 1．引言 1.1编写目的软件设计的任务是将软件需求变换成为软件的具体设计方案。概要设计根据软件需求导出软件的体系结构；详细设计给出软件模块的内部过程描述。该文档是设计结果的详细描述，也是程序员编写程序的功能依据。 1.2项目背景开发软件名称：图书管理系统。项目开发者：××学院计算机科学系“图书管理系统”开发小组： ×××(×号，组长)，×××(×号)，…… 用户单位：××学院 1.3 定义图书管理系统对于现代图书馆而言，是能否发挥其教学科研的作用的至关重要技术平台。对于读者和图书管理员来说，是能否方便快速获取信息的关键。所以，图书管理系统应该能够为用户提供充足的信息和快捷方便的操作手段。 1.4 参考资料 ?钱乐秋等，《软件工程》，青还大学出版社； ?张害藩，《软件工程导论》（第四版），清华大学出版社； ?王珊等，《数据库原理及设计》，清华大学出版社； ?赵池龙等，《软件工程实践教程》，电子工业出版社。 2．详细设计 2.1软件结构块层次图

图书管理系统书籍管理读者管理借阅管理书籍信息管理出版社管理书籍类别管理注销管理读者类别管理读者信息管理还书管理借书管理续借管理过期罚款管理图书丢失管理 2.2 模块详细设计此处给出各用例的程序实现流程图，也可用下面的描述显示表述（注，建议用程序流程图）借书管理： A.输入读者编号；提示超期未还的借阅记录； B.输入图书编号； If 选择“确定” then If 读者状态无效或改书“已”注销或已借书数>=可借书数then 给出相应提示； Else 添加一条借书记录； “图书信息表”中“现有库存量”-1; “读者信息表”中“已借书数量”＋1; 提示执行情况； Endif 清空读者、图书编号等输入数据； Endif If 选择“重新输入”then 清空读者、图书编号等输入数据； Endif If 选择“退出”then 返回上一级界面； Endif 返回A.等待输入下一条；

软件概要设计说明书范例

XX概要设计说明书

文档修改记录

填写说明 1. 系统结构的定义本体系对整个软件系统按如下结构方式进行划分：系统子系统模块子模块其中：（1）“系统子系统”划分属于“系统设计”，在系统设计说明书中予以描述。（2）“子系统模块”划分属于“概要设计”，在本说明书中予以描述。（3）“模块子模块”划分属于“详细设计”，在详细设计说明书中予以描述。如果系统相对简单，可以省略“子模块”这一层次。 2. 如果填写了系统设计说明书，则在本说明书中略过“系统子系统”划分的相关内容（即第2章）。 3. 如果系统相对简单，不需要做“系统子系统”划分，这种情况下，取消填写系统设计说明书，只须填写本说明书，直接套用“子系统模块”划分（即第3章）进行“系统模块”划分（把其中“子系统”一词替换为“系统”），并删除本说明书中“系统子系统”划分的相关内容（第2章）。

目录 1. 简介 ................................................................ 错误!未定义书签。 . 背景和目的.................................................... 错误!未定义书签。 . 范围.......................................................... 错误!未定义书签。 . 术语和缩略语.................................................. 错误!未定义书签。 2. 系统总体设计 ........................................................ 错误!未定义书签。 . 任务概述...................................................... 错误!未定义书签。目标 .................................................... 错误!未定义书签。需求概述 ................................................ 错误!未定义书签。 . 设计概述...................................................... 错误!未定义书签。总体约束 ................................................ 错误!未定义书签。系统外部接口 ............................................ 错误!未定义书签。设计方案概述 ............................................ 错误!未定义书签。 . 系统架构设计.................................................. 错误!未定义书签。系统的逻辑架构设计 ...................................... 错误!未定义书签。系统的物理架构设计 ...................................... 错误!未定义书签。 . 子系统定义.................................................... 错误!未定义书签。子系统列表 .............................................. 错误!未定义书签。子系统间关系 ............................................ 错误!未定义书签。 3. 子系统1设计 ........................................................ 错误!未定义书签。 . 任务概述...................................................... 错误!未定义书签。目标 .................................................... 错误!未定义书签。需求概述 ................................................ 错误!未定义书签。 . 设计概述...................................................... 错误!未定义书签。总体约束 ................................................ 错误!未定义书签。子系统外部接口 .......................................... 错误!未定义书签。设计方案概述 ............................................ 错误!未定义书签。 . 子系统架构设计................................................ 错误!未定义书签。 . 模块定义...................................................... 错误!未定义书签。

软件文档编写指南

《计算机软件文档编写指南》一．计算机软件文档由封面、目录、正文、注释和附录组成。封面格式：密级：编号：文档名称：项目名称：编制：审核：批准： ×××××××××××××研究所年月日

二．计算机软件文档包括： 1）软件开发计划 2）软件需求规格说明 3）接口需求规格说明 4）接口设计文档 5）软件设计文档 6）软件产品规格说明 7）版本说明文档 8）软件测试计划 9）软件测试说明 10）软件测试报告 11）计算机系统操作员手册 12）软件用户手册 13）软件程序员手册 14）计算机资源综合保障文件软件开发计划一．引言 1．编写目的（阐明编写软件计划的目的，指出读者对象。） 2．项目背景（可包括：（1）项目委托单位、开发单位和主管部门；（2）该软件系统与其他系统的关系。） 3．定义（列出本文档中用到的专门术语的定义和缩略词的原文。） 4．参考资料（可包括：（1）项目经核准的计划任务书、合同或上级机关的批文；（2）文档所引用的资料、规范等；列出资料的作者、标题、编号、发表日期、出版单位或资料来源。）二．项目概述 1.工作内容（简要说明项目的各项主要工作,介绍所开发软件的功能性能等. 若不编写可行性研究报告,则应在本节给出较详细的介绍。) 2.条件与限制（阐明为完成项目应具备的条件开发单位已具备的条件以及尚需创造的条件. 必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。） 3.产品（1）程序（列出应交付的程序名称使用的语言及存储形式。）（2）文档（列出应交付的文档。）（3）运行环境（应包括硬件环境软件环境。） 4．服务（阐明开发单位可向用户提供的服务. 如人员培训安装保修维护和其他运行支持。）

范例-软件设计说明书(详细部分)

软件设计说明

目录 1围 (1) 1.1标识 (1) 1.2系统概述 (1) 1.3文档概述 (1) 2引用文档 (1) 3CSCI 级设计决策 (1) 4CSCI 体系结构设计 (2) 4.1CSCI部件 (2) 4.2执行方案 (3) 4.3接口设计 (3) 4.3.1接口标识和接口图 (3) 4.3.x （接口的项目唯一标识符） (4) 5CSCI 详细设计 (6) 5.X （软件单元的项目唯一标识符，或者一组软件单元的标志符） (6) 6需求可追踪性 (9) 7注解 (11) 附录A (11)

软件设计说明 1围 1.1标识要求：本节应包含这个文档所适用的系统和软件的完全标识，（若适用）应包括标识号、名称、缩略名、版本号及发布号。 1.2系统概述要求： 1）本节主要描述本文档适用的系统和软件的用途； 2）概述系统开发、运行和维护的历史； 3）标识项目的投资方、需方、用户、开发方和保障机构； 4）标识当前和计划的运行现场； 5）列出其它有关文档。 1.3文档概述本节应概述本文档的用途和容，描述与它的使用有关的性或私密性考虑。 2引用文档列出引用的所有文档，包括文档的编号、标题、修订版本和日期。 3CSCI 级设计决策要求：本章应根据需要分节给出CSCI 级设计决策，即CSCI 行为设计的决策（忽略其部实现，从用户角度出发描述系统将怎样运转以满足需求）和其它影响组成该CSCI 的软件单元的选择与设计的决策。如果在需求中所有这些决策是明确的，或者这些决策要推迟到CSCI 的软件单元的设计时指出，则本章应如实述。针对关键性需求（例如对安全性、性、私密性等需求）作出的设计决策，应在专门的章节中加以叙述。 CSCI 级设计决策的例子如下： 1）关于CSCI 将接收的输入和将产生的输出的设计决策，包括与其它系统、HWCI、CSCI 和用户的接口（本文档的4.3.x 节指出本说明要考虑的主题）； 2）有关响应每个输入或条件的CSCI 行为的设计决策，包括CSCI 要执行的动作、响应时间和其它性能特性，模型化的物理系统的说明，选定的方程式/算法/规则，以及对不允许的输入或条件进行的处理； 3）有关数据库/数据文件如何呈现给用户的设计决策（本文档的4.3.x 节标识了本说明

ISO软件开发全套文档-配置管理计划编写指南

产品/项目系统名称配置管理计划北京XXXX有限公司 200 年××月 1引言 1.1编写目的

编写的目的主要在于对所开发的软件系统规定各种必要的配置管理条款，以保证所开发出的软件能满足用户需求。 1.2背景 a.开发的软件系统的名称列出本软件系统的中文全称、英文全称及英文表示简称。 b.开发的软件系统的最终用户或适用的领域； c.项目来源、主管部门等 1.3定义列出本文件中涉及的专门术语定义和外文缩写的原词组。 1.4参考资料列出涉及的参考资料。 2 管理描述软件配置管理的机构、任务、职责和有关的接口控制。 2.1 机构描述软件生存周期中各阶段中软件配置管理的功能和负责软件配置管理的机构。说明项目和自项目与其他有关项目之间的关系。指出在软件生存周期各阶段中的软件开发或维护机构与配置控制组的关系。 2.2 任务描述在软件生存周期中各阶段的配置管理任务以及要进行的评审和检查工作，并指出各阶段的阶段产品应存放在哪一类软件库中（软件开发库、软件受控制库或软件产品库）。 2.3 职责指出负责各项软件配置管理任务（如配置标识、配置控制、配置状态记录以及配置的评审与检查）的机构的职责；指出上述机构与软件质量保证机构、软件开发单位、项目承办单位、项目委托单位以及用户等机构的关系。说明软件生存周期各个阶段的评审、检查和审批过程中的用户职责以及相关的开发与维护活动。指出与项目开发有关的各机构的代表的软件配置管理职责。指出与其他特殊职责，例如为满足软件配置管理要求所必要的批准要求。 2.4 定义软件配置项（SCI）包括： 1．系统约定 2．软件项目计划 3．软件需求文档 4．用户手册 5．设计文档

软件体系结构设计说明书(模板)

软件体系结构设计说明书 1.文档简介 [本节主要是描述软件体系结构设计说明书的目的、范围、相关术语、参考资料和本文档的摘要性介绍。软件体系结构设计属于高层设计文档，是符合现代软件工程要求的概要设计。] 1.1 目的 [软件体系结构设计说明书，将从设计的角度对系统进行综合的描述，使用不同的视图来描述其不同方面。在本小节中，将对该文档的结构进行简要的说明，明确该文档针对的读者群，指导他们正确的地使用该文档。] 1.2 范围 [说明该文档所涉及的内容范围，以及将影响的内容。] 1.3 定义、首字母缩写词和缩略语 [与其它文档一样，该文档也需要将本文档中所涉及的所有术语、缩略语进行详细的定义。还有一种可简明的做法，就是维护在一个项目词汇表中，这样就可以避免在每个文档中都重复很多内容。] 1.4参考资料 [在这一小节中，应完整地列出该文档引用的所有文档。对于每个引用的文档都应该给出标题、标识号、日期以及来源，为阅读者查找这些文档提供足够详细的信息。] 1.5 概述 [在本小节中，主要是说明软件体系结构设计说明书各个部分所包含的主要内容，就像一个文章摘要一样。同时也应该对文档的组织方式进行解释。] 2. 体系结构表示方式 [本节说明软件体系结构在当前系统中的作用及其表示方式。它将列举其所必需的用例视图、逻辑视图、进程视图、部署视图或实施视图，并分别说明这些视图包含哪些类型的模型元素。]

3. 软件体系结构的目标和约束 [本节说明对软件体系结构具有某种重要影响的软件需求和用户目标，例如，系统安全性、保密性、第三方组件的使用、可移植性、发布和重新使用。它还要记录可能适用的特殊约束：设计与实施策略、开发工具、团队结构、时间表、遗留系统等。] 4.用例视图 [本节使用用例分析技术所生成的系统用例模型，描述其中的一些用例或场景。在该模型中纳入用例或场景，应该是系统中最重要、最核心的功能部分。] [另外，在本节中还应该选择一个主要的用例，对其进行描述与解释，以帮助读者了解软件的实际工作方式，解释不同的设计模型元素如何帮助系统实现。] 5. 逻辑视图 [逻辑视图主要是反映系统本质的问题领域类模型，在逻辑视图中将列出组成系统的子系统、包。而对每个子系统、包分解成为一个个类，并说明这些关键的实体类的职责、关系、操作、属性。这也是OO思想的体现，以类、类与类之间的协作、包、包与包之间的协作模型来表达系统的逻辑组织结构。] 5.1概述 [在本小节中，列出逻辑视图的顶层图，该图将反映系统由哪些包组成，每个包之间的关系与协作，以及包的层次结构。使得读者对整个软件体系结构有一个整体的了解。] 5.2影响软件体系结构的重要设计包 [在本小节中，将从逻辑视图中选择有重要意义的设计包，每个设计包有一个小节来描述，说明这些包的名称、简要的说明、该包中的主要类和相关的类图。对于包中的重要的类，还应该说明其名称、简要说明、主要职责、操作、属性等。] 6. 进程视图 [本节主要描述该软件体系结构下，系统运行态的情况。描述系统在执行时，包括哪些进程（包括线程、进程、进程组），以及它们之间是如何进行通信的、如何进行消息传递、接口如何。并且来说明如何进行组织。]

软件设计说明书嵌入式软件范例

一、XXXXX-XXX 热压机自动控制系统软件的设计 LCD—液晶显示器，因其具有微功耗、平板化等一系列显著特点而广泛应用于仪器仪表、计算机显示终端、各类电子显示装置等各个方面。LCD的后工序生产工艺包括COG、COF、FOG、FOB，XXX-XXX 热压机正是为FOG段工艺而开发设计的。 XXXXX-XXX热压机自动控制动系统软件（以下简称XXX系统）是由PLC、气动元件和电动元件组成，其特点是通过传感器采集外部信号，输入到PLC内部进行计算处理，以控制外部执行元件，使之完成一系统的机构动作，达到生产所需的工艺要求。㈠ XXX 系统的性能和结构 XXX 系统主要由PLC、GOT（触摸屏）、伺服电机、气缸电磁阀、电磁继电器、光电传感器、磁性传感器、温度处理器、温度传感器以及各种按钮组成。 1、XXX 系统的主要性能和技术参数 ●主机电源：Vac-----220VAC/50HZ ●传感器电源：Vdd-----+24V ● PLC接口：40位输入、32位输出、1个RS232通信串口 ●工作温度：－10℃～+55℃ ●存储温度：－20℃～+60℃ 2、XXX 系统的内部地址 XXX 系统的内部地址及主要功能部件： ●输入继电器— X ●输出继电器— Y ●辅助继电器— M ●定时器— T ●计数器— C ●数据寄存器— D ●变址寄存器— Z 3、XXX 系统的外部引线功能定义 XXX 系统共有82根引脚，具体定义如下：㈡指令描述 XXX 系统主要有如下指令：㈢人机界面（GOT） 1、参数设置

人机界面(GOT)可用于参数设置和数据的显示(如图所示) 2、手动操作人机界面亦可制作手动调试所需的各种按键，以替代繁琐的按钮(如图) 3、生产信息人机界面还可用于显示生产时的各种数据以及PLC内部的信息，比如外部引脚的通断信息、生产时产生的报警信息等(如下图) ㈣ XXX 系统的接口及编程 1、硬件接口 XXX系统与电脑的接口可以有两种方式：直接控制方式和间接控制方式。直接控制方式就是将PLC的RS232接口直接与电脑的RS232接口对接(如图1-1)；间接控制方式就是将PLC的RS232接口与触摸屏的RS232接口对接，然后将电脑的RS232接口与触摸屏的RS422接口对接，然后对该外设进行间接操作而实现控制(如图1-2)。 2、程式流程方框图 A、系统回原点流程图 B

GB 16680-1996 软件文档管理指南

GB/16680－1996软件文档管理指南 1 范围本标准为那些对软件或基于软件的产品的开发负有职责的管理者提供软件文档的管理指南。本标准的目的在于协助管理者在他们的机构中产生有效的文档。本标准涉及策略、标准、规程、资源和计划，管理者必须关注这些内容，以便有效地管理软件文档。本标准期望应用于各种类型的软件，从简单的程序到复杂的软件系统。并期望覆盖各种类型的软件文档，作用于软件生存期的各个阶段。不论项目的大小，软件文档管理的原则是一致的。对于小项目，可以不采用本标准中规定的有关细节。管理者可剪裁这些内容以满足他们的特殊需要。本标准是针对文档编制管理而提出的，不涉及软件文档的内容和编排。 2 引用标准下列标准所包含的条文，通过在本标准中引用而构成为本标准的条文。本标准出版时，所示版本均为有效，所有标准都会被修订，使用本标准的各方应探讨使用下列标准最新版本的可能性。 GB 8566-88 计算机软件开发规范 GB 8567-88 计算机软件产品开发文件编制指南 GB/T 11457-1995 软件工程术语 3 定义本标准采用下列定义，其他定义见 GB/T 11457 。 3.1 文档 document 一种数据媒体和其上所记录的数据。它具有永久性并可以由人或机器阅读。通常仅用于描述人工可读的内容。例如，技术文件、设计文件、版本说明文件。 3.2 文档（集）；文档编制 documentation 一个或多个相关文档的集合。 3.3 文档计划 documentation plan 一个描述文档编制工作方法的管理用文档。该计划主要描述要编制什么类型的文档，这些文档的内容是什么，何时编写，由谁编写，如何编写，以及什么是影响期望结果的可用资源和外界因素。 3.4 文档等级 level of documentation 对所需文档的一个说明，它指出文档的范围、内容、格式及质量，可以根据项目、费用、预期用途、作用范围或其他因素选择文档等级。 3.5 软件产品 software product 软件开发过程的结果，并推出供用户使用的软件实体。 4 软件文档的作用 a) 管理依据； b) 任务之间联系的凭证； c) 质量保证； d) 培训与参考； e) 软件维护支持； f) 历史档案。 4.1 管理依据在软件开过过程中，管理者必须了解开发进度、存在的问题和预期目标。每一阶段计划安排的定期报告提供了项目的可见性。定期报告还提醒各级管理者注意该部门对项目承担的

软件文档管理指南(可编辑修改版).

软件文档管理指南范围本标准为那些对软件或基于软件的产品的开发负有职责的管理者提供软件文档的管理指南。本标准的目的在于协助管理者在他们的机构中产生有效的文档。本标准涉及策略、标准、规程、资源和计划，管理者必须关注这些内容，以便有效地管理软件文档。本标准期望应用于各种类型的软件，从简单的程序到复杂的软件系统。并期望覆盖各种类型的软件文档，作用于软件生存期的各个阶段。不论项目的大小，软件文档管理的原则是一致的。对于小项目，可以不采用本标准中规定的有关细节。管理者可剪裁这些内容以满足他们的特殊需要。本标准是针对文档编制管理而提出的，不涉及软件文档的内容和编排。引用标准下列标准所包含的条文，通过在本标准中引用而构成为本标准的条文。本标准出版时，所示版本均为有效，所有标准都会被修订，使用本标准的各方应探讨使用下列标准最新版本的可能性。计算机软件开发规范计算机软件产品开发文件编制指南软件工程术语定义本标准采用下列定义，其他定义见。文档一种数据媒体和其上所记录的数据。它具有永久性并可以由人或机器阅读。通常仅用于描述人工可读的内容。例如，技术文件、设计文件、版本说明文件。文档（集）；文档编制一个或多个相关文档的集合。文档计划一个描述文档编制工作方法的管理用文档。该计划主要描述要编制什么类型的文档，这些文档的内容是什么，何时编写，由谁编写，如何编写，以及什么是影响期望结果的可用资源和外界因素。文档等级对所需文档的一个说明，它指出文档的范围、内容、格式及质量，可以根据项目、费用、预期用途、作用范围或其他因素选择文档等级。软件产品软件开发过程的结果，并推出供用户使用的软件实体。软件文档的作用 ) 管理依据； ) 任务之间联系的凭证； ) 质量保证； ) 培训与参考；