概要设计说明书

目录

1 简介

1.1 目的

这部分要描述文档的目的。应该指明读者。

1.2 范围

1.2.1 软件名称

对软件命名

1.2.2 软件功能

解释软件产品将完成或不完成的功能（可以直接描述也可以参考相关文档）

1.2.3 软件应用

描述软件的应用领域（可直接描述也可以参考其他软件文档）

2 第0层设计描述

2.1 软件系统上下文定义

本节描述待开发软件系统与外部实体的关系，可以使用系统结构图来描述系统结构和交互关系。

外部实体属性描述只限于软件设计和描述相关的属性。考虑到描述的完整性，可参考相关软件实体文档，如OS程序员手册。

2.2 设计思路(可选)

2.2.1 设计可选方案

对本软件系统的几种设计方案进行分析、比较，并确定所采用的方案。

2.2.2 设计约束

1. 遵循标准

描述本软件所遵循的标准、规范

2. 硬件限制

描述本软件系统实现的硬件限制

3. 技术限制

描述本软件的技术限制

2.2.3 其他

描述其他有关的设计考虑

3 第一层设计描述

3.1 系统结构

如果本文档是针对增强开发/小特性的设计，继承了原有的系统结构，那么应拷贝原有的系统结构说明，如系统结构图和相应的文字说明，然后在一层设计中明显标识出新增功能在原有系统结构中的位置（属于原来哪一个模块的新增功能，与原有各模块之间有什么交互）。在后续的业务流程说明、模块分解描述、依赖性描述和接口描述中，如果与本次增强开发/小特性无关的，可以不再重复描述，如果有关联的，应该拷贝原有的设计说明，在此基础上再说明更改的内容。

3.1.1 系统结构描述

这里要描述软件系统的总体结构，可以使用结构图、层次分解图或包图来描述，并应说明系统结构划分的原则（例如，基于标准、协议所规定的体系结构，来自于分析模型的结果，或者基于原有体系结构的结果）。对于使用分析模型的体系结构，应说明分析类的职责及相互关系。

3.1.2 业务流程说明

描述系统架构模块/分析类之间的动态交互，来说明用例模型中的典型用例场景，以体现系统功能是如何实现的。建议采用Sequence图、Collaboration图等来描述。

3.2 分解描述

本节描述系统中的子系统和模块。

3.2.1 模块/子系统1描述

不要直接写“模块/子系统1”，用简短的词语命名模块/子系统。

按照以下格式描述：

1. 简介

2. 功能列表

3.2.2 数据设计

本节描述系统中的数据结构。

外部数据实体不必描述。

1. 数据实体1描述

按照以下格式描述：

标识：

类型：

目的：

3.3 依赖性描述

本节描述系统中的子系统，数据结构，模块，进程等设计实体间的关系。

依赖关系描述可以使用文字，结构图，（交互）事务图。

3.4 接口描述

本节描述软件系统中设计实体(如子系统，模块，进程）的接口.

I接口描述可以使用接口文件，参数表。

对于外部实体只有同被描述软件相关的接口才需描述。

接口可以是函数调用、事件、消息、信号等。

3.4.1 模块/子系统1的接口描述

对每个接口按照以下格式描述：

名称：（接口名称）

说明：（对接口的简短说明）

定义:（接口原型定义，说明接口类型及相关参数）

4 第二层设计描述

L1中定义的每个模块的进一步设计在下面的章节进行描述。对层次比较多的模块，可以增加设计层次，最终要说明对应于最小分解模块的具体设计类（包括其public属性和public方法）。

对每个模块重复使用下述的格式。

4.1 模块1名称

不要直接写 “模块1名称”，用简短的词语命名模块。

如果本文档是针对增强开发/小特性的设计，继承了原有的二层模块结构，那么应拷贝原有的模块结构说明，如包图/类图和相应的文字说明，然后在二层设计中明显标识出新增功能在原有模块结构中的位置（属于原来哪一个子模块/设计类的新增功能，与原有各子模块/设计类之间有什么交互）。在后续的功能实现说明和设计类定义中，如果与本次增强开发/小特性无关的，可以不描述，如果有关联的，应该拷贝原有的设计说明，在此基础上再说明更改的内容。 对更改的设计类应该给出类的完整定义，再标识出更改的属性和方法。

4.1.1 模块设计描述

描述模块分解，例如每个子模块的功能定义。定义出具体的设计类，用类图来描述其相互关系，并说明所采用的设计模式。

对每个类重复使用下述的格式进行描述。

1.类名

按下面的格式对每个设计类进行说明。

1）CI标识

说明该类的配置项标识(用于需求跟踪，配置项的命名方式在CMP中已定义。一般为：产品名_模块名_类名，如果在类的命名中未包括前面两部分)。

2）简介

简单介绍该类的功能。

3）类定义（Optional）

如果该类在前面没有定义，使用类图、伪代码描述该类的类定义，需说明该类的所有public属性和public方法。

4.1.2 功能实现说明

使用Sequence图、Collaboration图等来说明这些设计类之间如何交互，实现本模块的典型功能。

5 数据库设计（可选）

本节列出所有的数据存储类的实体(表、存储过程、触发器等)，详细描述实体的内容和并列出全部属性。对每个属性，详细描述其数据库、数据大小、特定约束。实体的所有约束及实体间的关系也要注明。

5.1 实体定义

5.1.1 分解描述

阐述设计思路及约束规则。

详细定义每个关键数据表、视图中的各个字段属性、存储要求、完整性约束、功能、注意事项，静态数据表可考虑定义初始配置记录。

5.1.2 内部依赖性描述

使用E-R图描述实体间的关联依赖关系，分析对存取空间、性能、完整性的要求。

5.2 行为定义

5.2.1 分解描述

根据功能或其他方式对存储过程/触发器进行归类，便于进一步细化和分解，并说明每类存储过程/触发器主要功能。

详细定义每个存储过程(触发器)的功能、输入输出参数、返回值、返回的记录集、依赖的数据表和存储过程，以及一些特殊要求（比如需要启用事务等）。

5.2.2 外部依赖性描述

描述与其它模块之间的依赖关系。

5.2.3 内部依赖性描述

描述存储过程间、存储过程和数据表/视图间依赖关系。

6 组件视图

6.1 系统运行组件

使用Component图、deployment图来描述系统的运行组件（EXE文件、DLL等），及其网络部署情况。

6.2 文件组织形式

描述源代码文件的目录结构（文件夹中各个目录下应存放什么文件）。

7 进程视图

本节描述将系统分解为轻量级进程（单个控制线程）和重量级进程（成组的轻量级进程）的过程。本节按照各个通信或交互的进程组来加以组织。说明进程之间的主要通信模式，例如消息传递、中断和会合。

参考资料清单：

请罗列本文档所参考的有关参考文献和相关文档，格式如下：

作者＋书名（或杂志、文献、文档）＋出版社（或期号、卷号、公司文档编号）＋出版日期 起止页码。

例如：

[1] D. B. Leeson, “A Simple Model of Feedback Oscillator Noise Spectrum,” Proc. IEEE, pp329-330, February 1966 （英文文章格式）

[2] D. Wolaver, Phase-Locked Loop Circuit Design, Prentice Hall, New Jersey,1991 （英文书籍格式）

[3] 王阳元，奚雪梅等，“薄膜SOI/CMOS SPICE电路模拟”，电子学报，vol.22，No.5，1994 （中文文章格式）

[4] 郑筠，《MOS存储系统及技术》，科学出版社，1990 （中文书籍格式）

[5] XXX，SDXXX用户手册 V1.1，基础部文档室，2001/4/26

---

详细设计模板

目录

1 概述

1.1 目标

应包含以下几个方面的内容：

1、该文档所描述的模块；

2、该文档所针对的读者；

1.2 范围

概述本文档所包含的内容

2 模块1详细设计

2.1 类1

2.1.1 简介

详细描述CLASS1的职责和功能；必要时，可描述本类与相关类之间的静态/动态关系。

2.1.2 类图

提供类的结构图

2.1.3 状态设计

可用状态图来描述类的状态信息

2.1.4 属性

可先定义相关的数据结构。.

可见性	属性名称	类型	说明（对属性的简短描述）

2.1.5 方法

下面针对每个方法进行说明。

1. 方法1

（1）方法描述

Prototype	方法的声明，包含可见性
函数原型
Description	描述本方法的功能
功能描述
Calls调用函数	被本函数调用的函数清单（非系统函数）
Called By被调用函数	调用本函数的函数清单（非系统函数）, 可选
Input输入参数	描述每个输入参数的含义、内存管理原则
Output输出参数	描述每个输出参数的含义、内存管理原则
Return返回值	描述返回值的含义
Exception抛出异常	描述可能抛出的异常

（2）Implementation Description实现描述

使用伪代码、流程图等来描述本方法的详细实现。这部分是详细设计的重点。

3 模块2详细设计

3.1 类1

3.1.1 简介

详细描述CLASS1的职责和功能；必要时，可描述本类与相关类之间的静态/动态关系。

3.1.2 类图

提供类的结构图

3.1.3 状态设计

可用状态图来描述类的状态信息

3.1.4 属性

可先定义相关的数据结构。.

可见性	属性名称	类型	说明（对属性的简短描述）

3.1.5 方法

下面针对每个方法进行说明。

2. 方法1

（1）方法描述

Prototype	方法的声明，包含可见性
函数原型
Description	描述本方法的功能
功能描述
Calls调用函数	被本函数调用的函数清单（非系统函数）
Called By被调用函数	调用本函数的函数清单（非系统函数）, 可选
Input输入参数	描述每个输入参数的含义、内存管理原则
Output输出参数	描述每个输出参数的含义、内存管理原则
Return返回值	描述返回值的含义
Exception抛出异常	描述可能抛出的异常

（2）Implementation Description实现描述

使用伪代码、流程图等来描述本方法的详细实现。这部分是详细设计的重点。

4 数据库详细设计(可选)

描述存储过程、触发器等的详细实现

4.1 存储过程1/触发器1的名称

（1）Descriptions语法

Prototype	原型描述
原型
Description	描述实现的功能
功能描述
使用的数据库对象
Input输入参数	描述每个输入参数的含义
Output输出参数	描述每个输出参数的含义
Return返回值	描述返回值的含义

（2）Implementation Description实现描述

Pseudo codes could be used to depict the definitions.

使用伪代码来描述详细实现。这部分是详细设计的重点。

5 错误处理

5.1 系统错误

描述象内存分配失败，任务创建失败等错误是如何被处理的。

5.2 接口错误

描述将要产生并给外部实体用的错误码

5.3 协议错误

描述在协议中没有描述的情况如何处理。（可选）

---

软件设计说明

目录

1　范围

1.1　标识

本条应描述本文档所适用的系统、接口实体和接口的完整标识，适用时，包括其标识号、名称、缩略名、版本号和发布号。

1.2　系统概述

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

1.3　文档概述

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

2　引用文档

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

3　CSCI级设计决策

本章应根据需要分条给出CSCI级设计决策，即CSCI行为设计的决策（忽略其内部实现，从用户角度出发描述系统将怎样运转以满足需求）和其他影响组成该CSCI的软件单元的选择与设计的决策。如果在需求中所有这些决策是明确的，或者这些决策要推迟到CSCI的软件单元的设计时指出，则本章应如实陈述。针对关键性需求（例如对安全性或保密性关键的需求）作出的设计决策，应在专门的章条申加以叙述。如果设计决策依赖于系统状态或方式，则应指明这一依赖性。本条应给出或引用理解这些设计所需的设计约定。CSCI级设计决策的例子如下：

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

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

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

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

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

4　CSCI体系结构设计

本章应分为以下几条描述CSCI体系结构设计。如果设计的全部或部分依赖于系统的状态或方式，此依赖性应予指明。如果设计信息在多于一个条中出现，它只需被提供一次，而在其他条中引用。本条应提供或引用为了理解设计所需要的设计约定。

4.1　CSCI部件

本条应描述：

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

注：软件单元是CSCI设计中的一个元素；例如，CSCI的一个主要分支、该主要分支的一个组成部分，一个类、对象、模块、函数、例程或数据库。软件单元可以出现在层次结构的不同层上，且又可以由其他软件单元组成。在设计中，软件单元与实现它们的代码和数据实体（例程，过程，数据库，数据文件等），或与包含这些实体的计算机文件之间，可以有、也可以没有一对一的对应关系。一个数据库可被处理为一个CSCI也可被处理为一个软件单元。SDD可以采用与所使用设计方法相一致的任何名字来称呼软件单元。

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

) 每个软件单元的用途，指明分配给它的CSCI需求和CSCI级设计决策(需求的分配也可在6a)中提供）。

d) 每个软件单元的开发状态／类型（如新开发、按原样重用已有的设计或软件、再工程的已有的设计或软件、为重用而要开发的软件等，为构建版N计划的软件）。针对现有的设计或软件，本说明应提供标识信息，例如名字、版本、文档引用、库等。

e)CSCI（若适用，针对每个软件单元）计划使用的计算机硬件资源（例如处理机能力，内存能力，输入／输出设备能力，辅存能力以及通信／网络设备能力）。本说明应覆盖CSCI的资源使用需求中、影响该CSCI的系统级资源分配中、以及在软件开发计划(SDP)的资源使用测量策划中包含的全部计算机硬件资源。如果针对指定计算机硬件资源的所有使用数据都在同一处提供，例如在SDD中提供，那么本条可直接引用。对每个计算机硬件资源，应包括如下信息：

1) 得到满足的CSC[需求或系统级资源分配；

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

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

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

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

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

4.2　执行方案

本条应说明软件单元间的执行方案，可采用图表和描述，来说明软件单元间的动态关系，即CSCI运行期间软件单元间的相互作用情况，（若适用）应包括执行控制流程、数据流、动态控制序列、状态转换图、时序图、单元间的优先关系、中断处理、时序／排序关系、例外处理、并发执行、

动态分配与去除分配、对象／进程/任务的动态创建／删除、以及动态行为的其他方面。

4.3　接口设计

4.3.1　接口标识和接口图

本条应说明赋予每个接口的项目唯一的标识符，（若适用）应通过名称、编号、版本及文档引用来标识接口实体（软件单元、系统、配置项、用户等）。该标识应说明哪些实体具有周定的接口特性（从而把接口需求分配给这些接口实体）；说明哪些实体正在开发或修改（这些实体已有各自的接口需求）。（若适用）应通过接口图来描述这些接口。

4.3.2　（接口的项目唯一的标识符）

本条（从4.3.2开始）应通过项目唯一的标识符来标识接口，应简要地标识接口实体，根据需要可分条描述单方或双方接口实体的特性。如果一指定的接口实体未包含在本SDD中（例如，一个外部系统），而描述接口实体需要提到其接口特性时，这些特性应作为假设予以陈述、或以“当[未涵盖的实体]这样做时，[所指定的实体]将……”的形式描述。本条可引用其他文档（例如数据字典、协议标准、用户接口标准）代替在此所描述的信息。本设计说明应包括以下内容（若适用），以任何适合于所提供的信息的顺序提供，并应从接口实体角度说明这些特性之间的区别（例如关于数据元素的大小、频率或其他特性的不同期望值）：

a) 接口实体分配给接口的优先级。

b) 要实现的接口类型（例如实时数据传输、数据的存储和检索等）。

c) 接口实体将提供、存储、发送、访问、接收的各个数据元素的特征，例如：

1) 名称／标识符：

a．项目唯一的标识符；

b．非技术（自然语言）名称；

c．数据元素名称；

d．技术名称（如在代码或数据库中的变量名或字段名）：

e．缩略名或同义名。

2) 教据类型（字母、数字、整数等）。

3) 大小与格式（如：字符串的长度和标点符号）。

4) 计量单位（如：m等）。

5) 可能值的范围或枚举(如：0-99)。

6) 准确性（正确程度）和精度（有效数位数）。

7)优先级、定时、频率、容量、序列以及其他约束条件（例如数据元素是否可以被更新、业务规则是否适用）。

8) 保密性约束。

9) 来源（建立／发送的实体）和接受者（使用／接收的实体）。

d) 接口实体将提供、存储、发送、访问、接收的数据元素组合体（记录、消息、文件、数组、显示、报表等）的特征，例如：

1) 名称／标识符：

a．项目唯一的标识符； l

b．非技术（自然语言）名称； ：

c．技术名称（如在代码或数据库中的记录名或数据结构名）：

d．缩略名或同义名。

2) 数据元素组合体中的数据元素及其结构（编号、顺序和分组情况）。

3) 介质（例如磁盘）以及介质上数据元素／数据组合体的结构。

4) 显示和其他输出的视听特性（例如颜色、布局、字体、图标和其他显示元素、峰呜声和亮度）。

5) 数据组合体之间的关系，如排序／存取特性。

6) 优先级、定时、频率、容量、序列及其他约束，例如数据组合体是否可被更新、业务规则是否适用。

7) 保密性约束。

8) 来源（建立，发送的实体）和接受者（使用接受的实体）。

e) 接口实体用于接口的通信方法的特征。如：

1) 项目唯一的标识符；

2) 通信链接／带宽／频率／介质及其特征；

3) 消息格式；

4) 流控制（如：序列编号和缓冲区分配）；

5) 数据传输率、周期或非周期、传输间隔；

6) 路由、寻址及命名约定；

7) 传输服务，包括：优先级和等级：

8) 安全性／保密性考虑，如：加密、用户鉴别、隔离和审核。

f) 接口实体用于接口的协议的特征，如：

1) 项目唯一的标识符；

2) 协议的优先级别／层次；

3) 打包，包括分段与重组、路由和寻址；

4) 合法性检查、错误控制和恢复过程；

5) 同步，包括连接的建立、保持和终止；

6) 状态、标识和其他报告特性。

f) 其他特征，例如接口实体的物理兼容性（尺寸、公差、负荷、电压和接插件的兼容性等）。

5　CSCI软件详细设计

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

本条应通过项目唯一的标识符来标识软件单元，并对该单元进行说明。（若适用）该说明应包括下列信息。本条也可以指定一组软件单元，然后再分小条对它们分别进行标识和说明，包含其他软件单元的软件单元可引用那些软件单元的说明，而无需在此重复。

a) （若有）单元设计决策，例如所使用的算法[如果此前尚未选定）。

b) 该软件单元设计中的任何约束、限定或非常规特征。

c) 如果使用的编程语言不同于该CSCI所指定的语言，则应指出并说明使用它的理由。

d) 如果该软件单元包含过程性命令或由过程性命令组成(例如数据库管理系统(DBMS)中用于定义表单和报表的菜单选择，用于数据库访问和操纵的在线DBMS查询，用于代码自动生成的图形用户接口(GUI)构造器的输入，操作系统的命令或Shell脚本），应列出这些过程性命令，并引用解释它们的用户手册或其他文档。

e) 如果该软件单元包含、接收或输出数据，（若适用）应对它的输入、输出及其他数据元素和数据元素组合体进行说明。本文档的4.3.X条提供了（若适用）应包括的主题。软件单元的局部数据应与软件单元的输入或输出数据分开来描述。如果该软件单元是一个数据库，应引用相应的数据库设计说明(DBDD)：接口特性可以在这里提供、也可以引用第4章或相应的接口设计说明(IDD)。

f) 如果该软件单元包含逻辑，则给出该软件单元所用到的逻辑，（若适用）应包括：

1) 该软件单元执行启动时，其内部起作用的条件。

2) 将控制传递给其他软件单元的条件。

3) 对每个输入的响应以及响应时间，包括数据转换、重命名以及数据传输操作。

4) 在软件单元运行期间的操作顺序和动态控制序列，包括：

a．顺序控制的方法；

b．该方法的逻辑和输入条件，例如时序变异、优先级分配等；

c．进出内存的数据传输；

d.对离散输入信号的感知，以及该软件单元内中断操作之间的时序关系。

6　需求的可追踪性

本章应包含：

a．从本SDD所标识的每个软件单元，到分配给他的CSCI需求的可追踪性。

b．从每个CSCI需求，到分配这些需求的软件单元的可追溯性。

7　注释

本章应包括有助于了解文档的所有信息（例如：背景、术语、缩略语或公式）

---

软件用户手册

目录

1 范围

1.1 标识

a) 本文档的标题：；

b) 本文档的标识：；

c) 本文档的版本号：；

d) 本文档对应的软件名称及版本：。

1.2 系统概述

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

1.3 文档概述

注：本节概述该文档的用途和内容，并描述与其使用有关的保密性或私密性要求。

2 引用文档

注：本章应列出引用文档的编号、标题、编写单位、修订版及日期

GJB 438B-2009 军用软件开发文档通用要求

[AAA] 作者，《XXX书》，机构名称，日期

3 软件综述

3.1 软件应用

本条应简要说明软件预期的用途，并应描述对软件使用所期望的能力、运行改进和受益情况。

3.2 软件清单

系统运行所提供软件如表 31：

表 31软件内容清单

序号	文件名称	版本号/发行号	备注
1	Windows XP	Windows XP 2002	出厂前安装

3.3 软件环境

本条应描述用户安装并运行该软件所需的硬件、软件、手工操作和其他的资源。(若适用)包括以下方面:

a) 应提供的计算机设备，包括需要的内存数量、辅存数量及外围设备(如打印机和其他的输入/输出设备):

b) 应提供的通信设备:

c) 应提供的其他软件，例如操作系统、数据库、数据文件、实用程序和其他的支持系统:

1) 应提供的表格、规程或其他的手工操作:

2) 应提供的其他设施、设备或资源。

3.4 软件组织和操作概述

本条应从用户的角度出发，简要描述软件的组织与操作。(若适用)描述应包括:

a) 从用户的角度，概述软件逻辑部件和每个部件的用途操作。

b) 用户可能期望的性能特性，例如:

1) 可接受的输入的类型、数量、速率:

2) 软件产生的输出类型、数量、准确性和速率:

3) 典型的响应时间和影响它的因素;

4) 典型的处理时间和影响它的因索;

5) 限制，例如可追踪的事件数目:

6) 预期的错误率:

7) 预期的可靠性。

c) 该软件执行的功能与接口系统、组织或位置之间的关系。

d) 为管理软件而能够采取的监控措施(例如口令〕

3.5 意外事故及运行的备用状态和方式

(若适用)本条应说明在紧急时刻以及在不同运行状态和方式下用户处理软件的差异。

3.6 保密性

本条应概述与本软件相关的保密性考虑，适用时还应包括对软件或文档进行非授权复制的警告信息。

3.7 帮助和问题报告

本条应标识联系方式、获得帮助和报告软件使用中遇到的问题所应遵循的规程。

4 软件入门

4.1 软件的首次用户

4.1.1 熟悉设备

4.1.2 访问控制

在实际的应用中，对综合控制宽带传输分系统的涉密要求比较严格，所以用户在使用计算机时，管理员必须设置计算机的访问密码，并定期作出修改，以保证计算机信息的安全性。密码修改方法具体操作方法如下：

4.1.3 安装和设置

可参照章节3.3.3.1章节3.3.3.1的具体操作方法。

4.2 启动

4.3 停止和挂起

5 使用指南

5.1 能力

5.2 约定

5.3 处理规程

5.3.1 软件的使用

本条的标题应标识出被描述的功能、菜单、事务或其他的过程。(若适用)本条应描述并给出以以下方面的选项与实例，包括:菜单、图标、数据项表、用户输入、可能影响软件与用户的接口的其他软硬件的输入、输出、诊断或错误消息、报警、以及能提供联机描述或使用说明信息的帮助工具。给出的信息格式应适合于软件的特性。描述应使用一致的风格，例如对菜单的描述应保持一致，对事务描述应保持一致。

5.4 有关的处理

本条应标识并描述任何关于未被用户直接调用，并且在5.3中也未描述的由软件执行的批处理、脱机处理或后台处理，并应说明支持这种处理的用户的责任。

5.5 数据备份

本条应描述创建和保留备份数据的规程，这些备份数据在发生错误、缺陷、误动作或事故时可

以用来代替主要的数据拷贝。

5.6 错误、故障和紧急情况下的恢复

本条应给出从发生错误或故障中重启或恢复的详细规程，以及确保紧急事件下运行连续性的详细规程。

5.6.1 错误信息列表

1) 创建数据库失败：可能原因为数据库未安装或者数据库安装时出现问题；

2) 通信服务器软件无法运行：可能原因没有创建本软件的数据库；

3) 输入的用户名、密码后不能进入软件界面：可能原因安装数据库时，没有选择gb2312编码格式。

5.6.2 常见问题处理

5.6.3 数据恢复

5.7 消息

本条应列出完成用户功能时可能发生的所有错误消息、诊断消息等，或引用列出这些消息的附录，并应标识和描述每一条消息的含义以及消息出现后要采取的动作。

5.8 快速参考指南

合适时，本条应为使用该软件提供或引用快速参考卡或页。(若适用)快速参考指南应概括常用的功能键、控制序列、格式、命令或软件使用的其他方面。

6 注释

注：本章应包含有助于理解本文档的一般信息（例如背景信息、词汇表、原理）。本章应包含为理解本文档需要的术语和定义，所有缩略语和它们在文档中的含义的字母序列表。