配色: 字号:
10-研发部文档格式与规范
2023-06-24 | 阅:  转:  |  分享 
  




Xxxx 公司研究所文档规范































公司

年月







目录

1.引言............................................................................................................ 2

2.文档内容规范 ................................................................................................ 3

《系统可行性研究报告》编写内容规范.................................................................. 4

《产品研制规范》编写内容规范 .......................................................................... 6

《软件需求说明书》编写内容规范 ...................................................................... 12

《硬件总体设计方案》编写内容规范.................................................................... 16

《软件概要设计说明书》编写内容规范(面向过程) ............................................... 20

《软件概要设计说明书》编写规范(面向对象) ..................................................... 22

《系统调试方案》编写内容规范 ......................................................................... 26

《单板设计规范》编写内容规范 ......................................................................... 27

《软件模块设计方案》编写内容规范.................................................................... 30

《自测方案》编写内容规范 ............................................................................... 31

《自测报告》编写内容规范 ............................................................................... 32

《单板设计说明》编写内容规范 ......................................................................... 33

《软件模块设计说明》编写内容规范.................................................................... 36

《可编程器件设计说明》编写内容规范................................................................. 38

《单板调试说明》编写内容规范 ......................................................................... 39

《软件模块调试说明》编写内容规范.................................................................... 40

《系统调试说明》编写内容规范 ......................................................................... 41

《系统测试方案》编写内容规范 ......................................................................... 42

《可靠性试验方案》编写内容规范 ...................................................................... 43

《系统测试规程》编写内容规范 ......................................................................... 48

《系统测试报告》编写内容规范 ......................................................................... 49

《可靠性报告》编写内容规范 ............................................................................ 52

《项目开发总结报告》编写内容规范.................................................................... 54

3.文档编写格式要求 ......................................................................................... 54

4.附录........................................................................................................... 57

附录1:软件设计IPO图..................................................................................... 57

附录2:技术文件的封面样式.............................................................................. 60

1





1. 引 言

为了控制 文档质量, 参照公司有关企业标准, 对产品各阶段有关文档规范进行了完

善和补充。各文档所对应的开发阶段如下表所示。

项目各阶段文档清单



阶段

项目

论证



文档种类 /名称

1.项目可行性研究任务书

2.项目可行性研究报告

3.可行性研究评审报告

4.立项申请报告

5.研制任务书评审报告

1.产品研制规范

2.总体设计方案

3.硬件总体设计方案

4.软件需求说明书;

5.软件概要设计说明书(面向过程、面向对象) ;

6.数据要求和数据库设计说明书;

7.系统测试方案;

8.硬件测试方案;

9.软件测试方案;

10.自测方案

11.分系统设计方案;

12.软件模块设计方案;

13.产品分系统、单元及单板命名;

14.单元 /单板设计规范;

15.系统可靠性设计说明;

16.可靠性试验方案;

17.整机工艺、结构设计方案;

18.项目开发手册。



1.软件模块设计,包括

2.软件模块详细设计说明(包括程序流程图或 SDL 图) ;

3.软件模块测试说明、测试报告;

4.程序代码,编译文件、运行文件及程序配置清单;

5.软件模块自测报告;

6.电源的技术文件,包括

——电源设计说明;

——电源原理图、 PCB 图、材料清单;

——电源调试说明

——电源测试说明;

——电源测试报告;

7.其它技术文件,包括

——母板(背板)设计说明、原理图、 PCB 图、材料清单;

——系统内、外连接线的说明;

——外购件、外协件技术要求;

(接续页)

2

系统

设计



工程

研制





(接上页)

工程

研制







8.单元 /单板的技术文件,包括

——单元 /单板设计说明;

——单元 /单板软件设计说明;

——可编程器件(或 DSP)设计说明;

——单元 /单板调试说明;

——单元 /单板测试规程;

——原理图和 PCB 图、材料清单;

——单板软件程序代码、编译文件、运行文件、程序配置、单板软件清单;

——测试报告;

9. 结构设计文件,包括

——单元结构设计说明;

——装配图和零件图、装配材料清单;

——整件明细表;

——专用件、标准件、外购件、通(借)用件汇总表;

10.工艺设计文件,包括

——单板及部件的工艺设计;

——线缆及布线工艺设计;

——线缆清单;

11.包装设计文件,包括

——包装设计说明;

——包装工艺说明;

——包装结构图;

——包装材料清单;

12.自测报告

——单板自测报告;

——模块自测报告;

——系统自测报告

13.系统调试文件,包括

——系统调试说明;

——系统调试报告;

14. 系统测试文件,包括

——系统测试说明;

——系统测试规程;

——软件测试规程;

——系统测试报告;

15.集成测试文件,包括

——集成测试规程;

——集成测试报告;

16.可靠性报告;

17. 系统配置说明;

18. 工程说明和用户资料,包括

——用户手册(包括技术手册、安装手册、操作维护手册) ;

——工程规范;

19. 样机评审报告;

20. 转产任务书。

21. 项目开发总结报告



注:文档规范可随时提出修改意见,经研究所批准后执行

2. 文 档 内 容 规范

3



《系统可行性研究报告》编写内容规范

《系统可行性研究报告》是在产品调研阶段里,由研究所组织,系统设计部负责、产品

设计部门和市场体系各部门配合协助,对产品的市场需求、技术发展、技术生产能力、经济

效益、市场定位、整机功能特性等进行可行性研究的报告。《可行性研究报告》作为产品立

项开发的主要依据,具体编写内容如下。

1.前言

描述产品相关的基本情况。

2.适用范围(市场定位)

给出产品的用户范围。

3.市场情况分析

根据国家建设和社会需要,通过对市场和用户的调查研究,科学地预测国内外产品的

发展状况和发展趋势,给出预期的市场容量及我们可以达到的市场占有率,并预测产品的

生命周期。

4.现有产品及相关厂家情况

应详细说明相关厂家产品的技术特点,性能指标(包括可信性指标),优缺点、成本、

价格、服务及竞争力情况。

5.技术能力及生产能力分析

指出公司开发此产品的相关技术和人才积累情况,开发和生产难度,现有生产线所需

改造的投入和生产能力分析。

6、产品开发目标及特征

产品开发目标包括产品功能、性能和可信性要求,产品设计所应遵循的主要国际、国

内和行业标准,产品鉴定的权威机构。

7、确定零版本特性

确定提供给用户使用的零版本(或开局版本)特性,主要包括产品软硬件功能、性能

和可信性要求。

8、研制周期初步分析

初步估计产品研制各阶段时间要求。

9、资源要求初步分析

初步分析产品研制各阶段人力、财力(资金)、物力(开发工具、工作场地)等资源

要求。

10、产品成本与价格初步估计

4



产品成本需综合考虑开发成本、元材料成本、生产成本、销售成本和维护成本。产品

价格包括目前市场平均价格、市场价格走势、主要竞争对手的成本与价格、用户的期望价格

(可接受价格)等。

11、产品经济效益初步分析

根据对产品市场、技术、生产能力、成本、价格等因素的分析,在财务部门的协助下,

估计投资此项产品开发所能获得的经济效益,包括产品的毛利润率、净利润率、净资产回报

率、收回投资的时间等。

12、投资风险及建议

给出投资此项产品开发的风险,包括市场风险、技术风险及其他可能的风险及对策,对

是否投资此项产品开发作出建议。

5



《产品研制规范》编写内容规范

《产品研制规范》 作为市场与开发的接口文档, 主要从高层次来描述系统所要解决的

问题,描述用户需要怎样的产品或服务,并对实现需求目标所需采取的措施和计划进行描

述。可作为软硬件总体设计的依据,具体编写内容如下。

1.范 围

本 规 范 规 定 了 XX( 产 品 型 号 ) XX( 产 品 名 称 ) 的 功 能 需 求 、 可 信 性 需 求 、

可 生 产 性 需 求 以 及 设 计 与 开 发 验 证 方 案 、 设 计 与 开 发 确 认 方 案 、 进 度 、 成 本

估 计 等 方 面 的 要 求 <可 按 产 品 特 点 增 删 >。

本 规 范 适 用 于 XX( 产 品 型 号 )XX( 产 品 名 称 )的 开 发 研 制 工 作 。

2.引 用 标 准

<按 引 用 标 准 要 求 ,逐 条 列 出 在 本 规 范 中 引 用 的 所 有 标 准 的 代 号 和 名 称 。 >

3.定 义 和 缩 略 语

<逐 条 列 出 本 规 范 中 所 涉 及 定 义 的 名 称 和 含 义 。 >

本 标 准 应 用 了 以 下 缩 略 语 :

<逐 项 列 出 本 规 范 中 所 涉 及 的 缩 略 语 及 其 对 应 的 汉 语 含 义 >



第一篇功能需求

4.功 能 和 指 标

<分 条 逐 项 详 细 描 述 本 产 品 应 完 成 的 功 能 、指 标 和 主 要 参 数 。预 计 可 以 扩

展 的 功 能 或 可 能 及 所 需 的 资 源 和 资 源 分 配 的 可 行 性 。 >

5.功 能 排 序 及 权数 表

<列 出 产 品 功 能 的 轻 重 缓 急 排 序 及 权 数 表 。 必 要 时 列 出 第 一 阶 段 必 须 完 成

的 A 类 功 能

及 为 完 成 B、 C、 … 类 功 能 要 留 出 的 资 源 和 接 口 ; 第 二 阶 段 必 须 补 充 完 成 的 B

类 功 能 以 及 为 完 成 C、 … 类 功 能 要 留 出 的 资 源 和 接 口 。 >

6.功 能 分 解 结 构

6



<说 明 产 品 功 能 工 作 分 解 结 构 ( work break down structure ) , 对 应 的 分

系 统 、 单 元 名 称 及 该 应 分 配 的 相 应 功 能 、 性 能 参 数 和 指 标 要 求 , 并 用 功 能 方

框 图 表 达 相 互 之 间 的 关 系 。 >



7.接 口 要 求

<列 出 产 品 外 部 接 口 的 要 求 , 内 部 各 分 系 统 、 单 元 之 间 硬 件 接 口 信 号 方 式

和 要 求 等 。 >



第二篇 软件需求 (视情况单列 )

8.软 件 需 求

8.1 软 件 功 能 需 求

< 详细说明系统软件应实现的功能和各项指标, 软件的使用范围。 说明软件模块的划分,

实现的功能需求,以及按照功能排序划分完成的阶段要求。

用框图 /数据流图等来表述各软件模块之间的关系和数据关系。 >

8.2 运 行 环 境

硬 件 环 境

< 即硬件平台,说明该软件系统所需的硬件环境及其性能。 >

软 件 环 境

< 即软件平台,说明软件应支持的操作系统、数据库系统及其它软件等。 >

8.3 性 能 需 求

数 据 存 储 要 求 ( 可 选 )

< 确定软件对数据的存储要求,如处理的记录数和处理数据的最大容量等。 >

时 间 特 性 ( 可 选 )

< 时间特性主要指响应时间、更新处理时间、数据转换与传输时间(误码率) 、运行时

间等。 >

8.4 接 口

用 户 接 口

< 如用户界面、操作系统要求等。 >

7



硬 件 接 口

< 说明本系统同其他系统或子系统之间的硬件接口要求, 以及各软件操作的硬件端口的

寄存器、控制字和操作方式等要求。 >

软 件 接 口

< 说明本系统同其他系统或各分系统之间的软件接口和数据、协议等要求。 >

8.5 可 靠 性 需 求

余 量 需 求

< 在需求分析时,对于影响安全性的关键软件,应留有足够余量。这些余量包括:存储

量,输入、输出通道的吞吐能力以及处理时间等。 >

故 障 处 理

< 列出可能出现的故障以及对故障采取的处理要求。 >

不 允 许 发 生 的 事 件

< 明确列出所有在软件运行过程中绝对不允许发生的事件, 如关键判别式决不允许误判

等,以作为设计约束。 >

安 全 和 保 密

< 确定该软件安全措施和保密要求。如用户权限、使用范围等 >

8.6 其 他 需 求 ( 可 选 )

< 如可用性、可维护、可移植性的需求等。 >

9.软 件 数 据 需 求

9.1 数 据 需 求

静 态 数 据

< 列出所有作为控制或参考用公用的静态数据元素,包括数据元素名、类型、值域、度

量单位等。 >

动 态 数 据

< 列出动态输入、输出公用的数据元素(包括在常规运行中或联机操作中要改变的数

据) ,包括数据元素名、类型、值域、度量单位等。 >

数 据 约 束 ( 可 选 )

< 说明对数据的调用或使用系统时所受到的限制(如文件、记录和数据元素的最大容量

或最多个数) ,在设计和开发中将被确定为临界值的那些约束。 >

9.1 数 据 采 集 ( 可 选 )

< 描述采集和传输方式要求,包括采集和传输的数据格式,以及传输媒体和输入、输出

8



时间特性。 >

9.2 数 据 库 描 述

< 详细描述数据库中用到的各种数据元素及特征等。 >



第三篇 可信性需求

10.环 境 需 求

<说明产品应承受的温、湿度、盐雾、霉菌等环境条件。 >

11.可 靠 性 需 求

<说明产品的 MTBF 目标和使用寿命,产品的致命故障时间间隔要求;产品的电应力条

件,产品的功耗,极限环境条件下机器内部温度上限要求,产品的环境防护设计要求;产品

的振动、运输要求;元器件的选择和使用要求;降额要求等。 >

12.EMC 需 求

<说 明 产 品 的 抗 静 电 放 电 (ESD) 要 求 ; 浪 涌 、 电 快 速 瞬 变 脉 冲 群 ( EFT ) 、

电 压 瞬 时 跌 落 要 求 ; 射 频 电 磁 场 辐 射 抗 扰 性 要 求 ; 无 线 电 干 扰 发 射 和 敏 感 度

要 求 等 。 >

13.安 全 性 要 求

<说 明 产 品 安 全 防 护 方 面 的 要 求 >

14.测 试 性 要 求

<说 明 产 品 的 生 产 线 测 试 、 现 场 测 试 、 返 修 测 试 的 项 目 要 求 ; 系 统 具 有 的

机 内 测 试 ( BIT ) 项 目 要 求 和 测 试 覆 盖 率 等 。 >

15.维 修 性 要 求

<产 品 故 障 的 平 均 维 修 时 间 (MTTF) 和 产 品 的 最 大 维 修 时 间 、 返 修 率 的 要

求 。 >



第四篇 可生产性需求

16.结 构 要 求

<说明设备的总体机械结构,安装、维护和扩容或调整设备数量的灵活性,实现硬模块

化方面的要求;整机、单元和组件的外形尺寸须符合的国家或部颁标准的要求;产品结构中

应采用的标准结构件的要求和说明;产品机械结构应具有的强度和刚度要求;设备防振、抗

震能力的要求;人机界面及人机工程的要求。 >

17.工 艺 要 求

<列出产品安全性设计的工艺要求,如防机械损伤、阻燃性等;结构设计确保使用常规

9



的装配工具和工艺即可对所要装配的部件实现装配的要求; PCB 设计满足波峰焊和表面贴技

术的工艺要求;整机、单元和组件的外形尺寸、工艺要求及其它重要参数。 >

18.外 观 要 求

<说明设备表面处理(电镀、涂复)的环境适应性要求和表面处理的质量要求;机柜 (机

架 )外观色彩方面的要求。 >

19.布 线 及 连 接

<说 明 接 插 件 连 接 、 插 入 或 拔 出 、 定 位 和 锁 紧 装 置 的 要 求 ; 电 缆 排 放 位 置

的 要 求 。 >



第五篇 标准化综合要求

<提出新产品在研制过程中应贯彻执行的国家标准、行业标准和企业标准;对产品的设

计提出通用化、 系列化、 模块化设计的要求; 对元器件的优选原则, 对超出范围选用的规定;

产品外协件、外购件方面的要求。 >



第六篇 关键技术

20.关 键 技 术 薄 弱环 节

<说 明 产 品 设 计 中 的 关 键 技 术 以 及 对 应 的 解 决 方 案 , 通 过 的 途 径 ; 尚 存 在

的 不 确 定 的 技 术 难 度 和 对 此 处 理 的 约 定 , 以 及 其 它 方 面 的 解 决 要 求 。 >



第六篇 设计与开发进度

21.项 目 分 解

<把 产 品 的 研 制 开 发 分 解 为 若 干 工 作 项 目 , 列 出 完 成 它 们 必 须 的 先 后 工 作

关 系 。 >

22.完 成 时 间

<规 定 每 一 工 作 项 目 完 成 的 时 间 范 围 ; 制 定 产 品 开 发 过 程 的 统 筹 图 ( PERT ) 、

GANTT 图 。 >

23.关 键 路 线 及 节点

<列 出 产 品 开 发 的 关 键 路 线 、 开 发 的 关 键 节 点 及 完 成 时 间 。 >



10



第七篇 验证和确认

24.设 计 与 开 发 验证 方 案

〈为验证设计输出满足设计输入的要求。制订产品设计功能的验证方案。 >

25.设 计 与 开 发 确认 方 案

<为 确 认 最 终 产 品 /服 务 能 满 足 顾 客 在 预 定 条 件 下 的 需 求 , 制 定 产 品 的 确 认

方 案 , 使 用 方 风 险 β , 生 产 方 风 险 α 。 >



第八篇成本要求

26.成 本 要 求

<把产品分解为若干项目,分配每一项目的固定成本(开发成本包括:人工工时、测试

试验工时、 有条件时再算入设备折旧极管理费用等) 及变动成本的可能值 (或加上误差范围) ,

需要的资源(人、财、物、时间)及费用。 >





11



《软件需求说明书》编写内容规范

对纯软件开发和比较大型软件开发,要求根据软件特点,独立于《产品研制规范》专

门进行软件需求分析,从高层次来描述系统所要解决的问题,描述用户需要怎样的产品或

服务,并对实现需求目标所需采取的措施和计划进行描述。可作为软件总体设计的依据,

具体编写内容如下。

1.前言

1.1目的

阐明编写需求分析的目的,指明用户对象。(系统分析员、开发人员、测试人员)

1.2项目背景

a.该软件系统与其他系统的关系。

b.项目的开发单位及人员。

1.3参考资料

列举出相关参考资料。



2.项目概述

2.1目标

叙述该项软件开发的意图、应用目标、作用范围。解释被开发软件与其他有关软件之

间的关系。如果所定义的产品是一个更大的系统的一个组成部分,则应说明本产品与该系

统中其他个组成部分之间的关系,为此可使用一张方框图来说明该系统的组成和本产品同

其他各部分的联系和接口。

2.2运行环境

2.2.1硬件设备要求(宿主机、目标机),要描述软件系统所需的硬件设备的能力要求,如处

理器的数量,内存容量,存储媒体的数量,输入,输出设备的数量,通信网络结构,网络的

线路速度及通讯协议等。

2.2.2软件环境要求,要列出支持软件,包括要用到的操作系统、数据库系统、编译(或汇编)

程序、测试支持软件等。

2.3用户特性

列出本软件的最终使用者的特点,充分说明操作人员、维护人员的教育水平和技术专

长,以及本软件的预期使用频度。

2.4条件与限制

2.4.1某些既成事实的限制(硬件、软件等)

2.4.2整个大环境的情况

2.4.3某些规定的限制

12





3.性能需求

3.1 数据存储要求

确定软件的存储容量要求,如处理的记录数和处理数据的最大容量等。

3.2管理能力的要求

3.3时间特性

如响应时间、更新处理时间、数据转换与传输时间(误码率)、运行时间等。

3.4适应性

在操作方式、运行环境、与其他软件接口以及开发计划等发生变化时,应具有的适应

能力。



4.功能需求

4.1功能划分

描述整个软件在职能上应做什么,应满足哪些功能要求

4.2功能描述

详细描述每一条功能,用文字、图形、逻辑或数学方法描述。



5.数据需求

对数据进行描述时可把数据分为静态数据和动态数据。所谓静态数据,指在运行过程中

主要作为参考的数据,他们在很长的一段时间内不会变化,一般不随运行而改变。所谓动态

数据,包括所有在运行中要发生变化的数据以及在运行中要输入、输出的数据。

5.1静态数据

列出所有作为控制或参考用的静态数据元素。

5.2动态数据

列出动态输入数据元素(包括在常规运行中或联机操作中要改变的数据)。

5.3数据约束

列出若要进一步扩充数据或更充分地使用数据,而对数据要求提出的限制(如文件、

记录和数据元素的最大容量或最多个数),特别应强调在设计和开发中被确定为临界的那

些约束。

5.4 数据库描述

说明为满足上述数据要求,数据库应满足的功能、性能、可靠性要求。



6.数据采集(根据具体软件可选)

6.1要求和范围

13



6.1.1输入源:说明数据来自操作员,还是其他分系统或输入装置。

6.1.2接受者:应区分出如下种类,输入到系统,经处理后基本上无变化再输出的数据。输入

到系统,但不再输出的数据。由程序生成后输出的数据。

6.1.3临界值:指出数据元素的范围,如一个转折点,临界值等。

6.1.4量纲:对数值量,应规定数据元素的增量,度量单位,测量单位的零点和值域;对于非

数字量值,要用符号表示一些法定的值及他们之间的关系。

6.1.5换算因子:给出经模拟转换或数字转换处理的实测量的换算因子。

6.1.6数据更新频度:对同步数据,应给出输入,输出的更新频度,对异步数据,也要给出频

度平均值或变化的某种度量。

6.2数据采集和传递方式:

详细描述采集过程,包括数据格式,传输媒体和输入输出时间特性。



7.接口需求

7.1用户接口

如屏幕格式、报表格式、菜单格式、输入输出时间等。

7.2硬件接口

说明该软件同硬件之间的配合关系等。

7.3软件接口

说明该软件同其他软件之间的接口、数据通信协议等。



8.可靠性需求

8.1余量需求

在需求分析时,应给安全关键软件留有足够余量,这些余量包括:存储量,输入输出通

道的吞吐能力以及处理时间等。例如,对整个计算机系统而言,推荐的存储量,输入输出通

道的吞吐能力及处理时间余量不少于20%。

8.3故障处理要求

列出可能的软件、硬件故障以及对各项性能而言所产生的后果和对故障处理的要求

8.4不允许发生的事件

明确列出所有在软件运行过程中绝对不允许发生的事件,如关键判别式决不允许误判

等,以作为设计约束。

8.5可靠性指标的验证(可选)

对有可靠性指标的软件,在确定了软件的功能性需求后,应考虑该软件的可靠性指标是

否能达到以及是否能够验证。如果可靠性指标不能达到或者不能验证,那么,需求分析人员

应向上级主管部门汇报,以期得到其他的解决方法;如果软件的可靠性指标既能达到又能验

14



证,那么,需求分析人员应同用户密切配合,确定软件的功能剖面,并制定软件可靠性测试

计划。



9.其他需求

如可使用性、可维护、可移植性,开发平台的需求等。



15



《硬件总体设计方案》编写内容规范

《硬件总体设计方案》阐述系统硬件总体要求,指导硬件开发和测试开展工作,具体

编写内容如下。

1.前言

1.1设计依据

列举出硬件的设计依据,包括《产品研制规范》等。

1.2设计目标

说明硬件设计应达到的目标,包括兼容性、可扩展性和可维护性等

1.3基本原理

简要说明硬件设计的基本原理。

1.4相关标准

2.系统硬件总体构成(若是改进版,着重说明变化部分)

2.1系统总体框架

用图表形式描述系统总体框架,并简要说明各部分的联系。

2.2硬件功能方框图

以功能模块图给出硬件联系并简要说明划分理由。

2.3硬件单板联系图

以单板为模块给出系统联系图,简要说明与功能模块的对应关系,并简要说明单板划分

理由。

2.4系统硬件各组件结构排列图

给出系统各组件结构排列图,并给出排列的理由。

3.硬件单板功能及特性描述(若是改进版,着重说明变化部分)

就每块单板按以下顺序说明:

3.1单板详细功能及方框图

3.2单板的特性描述和指标说明

指明主要信号在单板的特性,单板各种指标的说明。如:CPU处理速度要求(MIPS),

通信系统的传输带宽、误码率,CPU升级路径,功耗等。

3.3单板与系统的配合要求

指出各单板与系统的配合,如:时序配合、驱动能力、阻抗匹配等。

3.4单板主要器件推介

对单板用到的主要器件进行较为详细的介绍,并指出其用法要点。

3.5实现要求

对关键电路的实现进行要求,如某一部分须用EPLD/FPGA实现,或用推荐电路等。

16



4.母板信号连接图

用图表列出母板的信号说明和接口的信号说明(即各单板的出线信号详细说明)。

5.配置说明

给出系统硬件各种应用场合的配置说明。

6.系统硬件关键技术说明

指明系统实现需注意的关键技术、难点和薄弱环节,并给出解决方案,指导开发人员

设计。

7.结构与工艺

应明确结构件主要外形尺寸,参照标准,热设计,电磁兼容设计,可达性设计(即便于

安装,维护的要求)及安全(防漏电损伤,机械损伤)设计等要求。对于需特殊处理的工艺

指出其要求。

8.可信性设计要点说明

8.1可信性管理项目

8.1.1可信性计划

给出分阶段可信性计划、目标、通过准则。

8.1.2对转承方、供应方(外购、外协件)的控制办法

要求明确外购件的使用条件要求、可靠性参数,外协件的厂家质量水平。

8.1.3故障等级分类

要详细描述一级、二级故障现象;三四级中出现频率高的也应描述。

8.2可信性设计项目

8.2.1任务可靠性模型

包括:可靠性框图和数学模型。

要求:层次划分至单板,要考虑冗余部分的工作模式。

8.2.2可靠性分配

将系统可靠性指标MTBF分配到各组成部分(单板),以要求开发人员设计中能实

现。

分配方法:相似法、比例法、专家评分法。

8.2.3元器件控制选择准则

参照公司《元器件优选手册》(目前在编制中)以附录的方式列出本项目(产品)元器

件优选清单(包括本文档3. 4推荐的单板主要器件、通用器件,还应包括导线、电缆)。

明确开发人员选用优选器件的最小比例或选用非优选器件的最大比例。

8.2.4明确设计应遵循的准则

8.2.4.1降额设计

根据《系统需求分析》中可靠性要求,确定本产品通用元器件降额等级与要求,具体

17



参见公司企业标准 《元器件降额准则》,对于特殊要求的器件可作补充说明。

8.2.4.2冗余设计

详述冗余部分的可靠性要求、工作方式,及其故障检测、备份转换机制的可靠性保证

措施。

8.2.4.3热设计

对产品进行热分析和热预计,对产品内部最高温升进行控制,确定系统散热方式,对结

构、单板提出热设计要求。

8.2.4.4 ESD、EMC设计

1)明确接地措施。

2)有静电要求的应加醒目的防静电标志,应明确设计、加工、运输、安装、使用过程中的

防静电要求。

3)考虑系统、单板设计时的滤波措施:对电源进出端加滤波网络,对独立模块的电源加滤

波;等。

4)指出那些信号需考虑屏蔽措施;CMOS电路使用时所采用的防拴锁措施。

8.2.4.5耐环境设计

1)明确防振动、冲击措施,保证整机能满足有关要求(如运输要求);

2)明确“三防”(防潮、防盐雾、防霉菌)措施,保证整机满足工作环境要求。

8.2.6可测试性设计

根据测试要求和故障监测要求,进行机内测试设备(BITE)和外部测试设备(ETE)

的权衡,确定机内测试设备的性能要求。

8.2.6.1确定系统的机内测试(BIT)的故障检测和故障隔离的要求。

a)确定系统可能有的故障和使用BIT时的故障检测率;

b)确定BIT的故障隔离要求,应使系统BIT对系统或设备进行初始检测并将故障隔离

到可替换单元。

8.2.6.2确定系统BIT的可靠性要求

机内测试设备可靠性一般要优于被测设备一个数量级,即BIT电路和装置的故障率不得

超过被测设备故障率的10%。

8.2.6.3初步确定各子系统(模块)的BIT

根据BIT的故障检测隔离的要求和可靠性要求,初步确定各子系统(模块)的BIT,并

将系统的故障检测和隔离要求划分到各子系统(模块)中去。

8.2.6.4 生产测试的要求

生产测试主要由自制测试设备和在线测试设备完成,自制测试设备主要是用来进行单板

功能测试和整机测试,而在线测试主要是发现单板上的元器件错误和元器件安装错误。

在总体方案设计中,应提出自制测试设备和在线测试的可测性要求。

18



a)总体方案中确定的子系统、模块或单板中应有通讯接口。

b)为子模块和单板所确定的软件和硬件接口应尽量统一和标准。

c)应尽量使用有自检和自环等自测试功能的元器件。

d)在总体方案中为子模块和单板的自测试功能子程序分配或预留一定的命令编码。

e)为在线测试可行和方便,单板上的元器件(特别是SMT器件)应留有测试点,或

者采用具有边界扫描测试(BST)功能的IC。

8.2.6.5测试点的选定

确定一些用于系统、单板或模块故障检测、故障隔离和原位调整与校准的测试点,以便

于开发调试、生产线测试和维护中测试设备的接入,进行定量测试、性能测试和参数调整及

校准。

设备测试点的选用按以下要求:

a)应能通过选择的测试点接入外部设备来控制设备的运行和检测设备的运行状态。

b)选用测试点应能方便地通过设备插头或测试插头连接到测试设备上。

c)测试点应具有一定的安全性,测试点必须得到保护,以免外部非正常信号(如高

电压等)接入影响设备工作或损坏设备。

d)不同类型的测试点应相互隔离,如:高电压大电流的测试点和低电平信号的测试

点要隔离,模拟电路和数字电路的测试点应分开等。

8.2.7其它可信性设计准则

视产品特点,明确其它应采取的可信性设计准则,如安全设计、防错设计、标记设计

等。

9.计划与安排

9.1资源要求

说明硬件开发、测试所需要的人员,开发工具或软件,测试仪器或仪表,每一资源要求

的日程表及持续时间等。

9.2组织计划

描述硬件实施建议的组织结构。

9.3阶段性开发进度表

制定指导性的阶段开发进度表,对每一阶段的内容详细描述。须明确系统、开发、测

试部项目人员各自工作阶段目标(里程碑),相互配合要求及检查点。



19



《软件概要设计说明书》编写内容规范(面向过程)

《软件总体设计》阐述系统软件总体要求,指导软件开发和测试开展工作,根据软件

类型分为面向过程和面向对象进行叙述,具体编写内容如下。

1前言

1.1设计依据

列举本软件的设计依据,包括《软件需求分析》、各种标准规范等。

1.2设计目标

说明本软件设计应达到的目标,包括扩充性、移植性、兼容性等。

1.3设计原则

说明本软件设计应遵循的原则。



2总体结构设计

2.1总体结构设计描述

先按层次描述软件的总体结构,概述每层应完成的功能;然后用软件总体结构层次图形

象地描述软件的总体结构。

2.2各层结构设计描述

详细描述该层软件的结构及其完成的功能,用软件结构层次图来描述该层软件的结构。

3.功能模块设计(若是改进版,着重说明变化部分)

3.1功能模块的划分

确定整个软件系统中每个功能由哪些模块组成,用模块IPO图来描述这些模块之间的控

制关系。

3.2各功能模块设计描述

详细描述该功能模块的功能,与其它模块之间的相互关系,该模块的接口说明(输入、

输出)。

4.数据结构设计

4.1数据划分

确定数据处理的原则,即哪些数据由文件系统存储处理,哪些数据由数据库系统存储处

理。

4.2文件系统的数据结构设计(可选)

确定数据在文件系统中的存储格式、存储容量、存取方法等。

4.3数据库系统的数据结构设计(可选)

确定数据库系统的类型(关系数据库、层次数据库等),数据库的模式、子模式结构定

义;定义各数据库的结构及相互之间的关系。

4.4数据可靠性设计

确定数据的完整性、安全性、冗余性策略。

20





5.软件要素设计

5.1软件开发系统

5.1.1明确具体软件开发系统(操作系统、数据库系统、界面开发工具等)的配置、资源要求

和限制,描述软件开发系统所提供的技术开发要素,如任务、线程、消息队列、事件、信号

量、软件异步中断等。

5.1.2模块命名规则、编程语言及注释规则

5.2各软件要素说明

软件要素是模块功能实现的载体,详细说明实现模块功能所需的各个要素。

6.可靠性设计

6.1设计约束条件

确定限制设计实现的某些约束条件。

6.2可靠性模型

明确本软件系统所采用的可靠性模型。

6.3可靠性指标

说明本设计应能达到的可靠性要求。

6.4可测试性





7.软件处理流程

7.1总体处理过程及数据流图

说明软件的总体处理过程,并用数据流图表示该处理过程。

7.2模块处理过程及数据流图

说明各模块的处理过程,并用数据流图表示该处理过程。

8.软件计划与进度安排

8.1环境资源

说明软件开发所需要的人、硬件和软件。每种资源要从资源的描述、对资源要求的日程

表以及对资源应用的持续时间三方面说明。

8.2成本估算

从所需的资源数量和时间来初步估算软件的开发成本。

8.3开发进度表

制定指导性的阶段开发进度(包括总体设计在内)。

对各模块可测试性提出要求



21



《软件概要设计说明书》编写规范(面向对象)

1.前言

1.1设计依据

列举本软件的设计依据,包括《软件需求分析》、各种标准规范等。

1.2设计目标

说明本软件设计应达到的目标,包括扩充性、移植性、兼容性等。

1.3设计原则

说明本软件设计应遵循的原则。



2系统设计

2.1系统层次结构设计描述

系统层次设计要完成系统总体结构在水平方向的层次划分和在垂直方向的条块划分。从

水平方向来看,系统的层次反映了系统的各个不同的抽象级别。从垂直方向来看,系统的条

块代表了系统的各个对外服务。用结构层次图形象地描述软件的总体结构,并概述每层应完

成的功能(即提供的服务)。

2.1.1详细描述各层软件的结构及其完成的功能。

2.1.2......

2.2系统数据存储设计描述

系统数据存储方式的设计要确定系统中各种数据的存储方式,包括内存数据结构、文件、

数据库等。

2.3系统资源访问设计描述

系统资源访问设计要确定系统中需要使用的各种类型的资源,并且要确定访问这些资源

的控制机制和安全性机制。

2.4网络与分布设计描述

网络与分布设计要确定系统在支撑网络结构上是如何进行分布处理的。设计中要对网络

流量、分布单元的处理能力和系统的总体效率作综合的考虑。

2.5并发性设计描述

并发性设计要确定系统中的并发单元,确定各并发单元的实现方式和并发控制策略。设

计时要考虑并发可能产生的效果。

2.6对象互操作方式设计描述

对象互操作方式设计要确定对象之间的消息传递方式,如过程驱动、事件驱动和并发驱

动等。在分布系统环境下,还要确定远程对象的交互方式。

2.7其它设计描述



22



3.对象分析与设计

3.1基于图形的对象描述

Yourdon提出的OOA方法包括五个步骤:

(1)确定对象

(2)确定结构

(3)定义主题

(4)定义属性和实例联系

(5)定义操作和消息联系

通过上述五个步骤得到结构化的图文档,所生成的OOA模型自顶向下包括五个层次:

●主题层(主题是一组类与对象)

●类与对象层

●结构层(一般化/特殊化结构:类间的继承关系;全体/部分关系:一个对象

怎样由其它对象组成)

●属性层(属性:与实例有关的信息)

●服务层(服务:类上的操作)

其具体操作方法和符号表示见相关书籍。(可参见《软件工程》杨文龙等编著,电子工

业出版社,1997年11月)

3.2基于文本的对象描述

对于所有的对象建议采用下面的提纲进行描述:

1.对象名

2.父类对象名

3.3属性描述

2.1属性名

2.2属性内容描述

2.3属性数据类型/结构

3.4对象的外部输入

3.5对象的外部输出

3.6操作描述

3.6.1操作名

3.6.2操作接口描述

3.6.3操作过程描述

3.6.4执行结果

3.6.5约束条件和极限值

3.6.7实例联系

23



3.6.8消息联系

3.7事件-响应对象交互(EROI)图

EROI图是标识和描述对象相互通信的有效工具

EROI极其有助于标识和描述对象之间的相互通信和协作关系。对每个事件,EROI图表

明了由哪个对象来识别事件的发生、产生什么消息、其它那些对象接受这些消息,并产生

什么响应。EROI图是事件-响应模型和OOA模型的集成。对于具体化系统的动态行为,它

是一个非常有用的工具。可以对于每个系统事件,给出其EROI图,并附上系统如何识别事

件发生,以及如何生成合适的响应的文本描述。





4软件要素设计

4.1软件开发系统

4.1.1明确具体软件开发系统(操作系统、数据库系统、界面开发工具等)的配置、资源要求

和限制,描述软件开发系统所提供的技术开发要素,如任务、线程、消息队列、事件、信号

量、软件异步中断等。

4.1.2模块命名规则、编程语言及注释规则

4.2各软件要素说明

软件要素是模块功能实现的载体,详细说明实现模块功能所需的各个要素。

...

5可靠性设计

5.1设计约束条件

确定限制设计实现的某些约束条件。

5.2可靠性模型

明确本软件系统所采用的可靠性模型。

5.3可靠性指标

说明本设计应能达到的可靠性要求。

EROI图详细规格可参阅相应资料。

5.4可测试性





6.软件计划与进度安排

6.1环境资源

说明软件开发所需要的人、硬件和软件。每种资源要从资源的描述、对资源要求的日程

表以及对资源应用的持续时间三方面说明。

6.2成本估算

从所需的资源数量和时间来初步估算软件的开发成本。

对各模块可测试性提出要求

24



6.3开发进度表

制定指导性的阶段开发进度(包括总体设计在内)。



25



《系统调试方案》编写内容规范

《系统调试方案》包括硬件和软件的系统调试方案,用于指导开发人员系统调试工作,

具体编写内容如下。

1.概述

1.1简述系统的主要构成及基本原理

1.2简述系统调试基本思路和方法

2.调试子任务的划分

按时间循序或功能相关性将几个模块或单板组合成一个子任务,要简要说明如此划分的

理由。若有可能确定子任务负责人。

3.调试方法

按子任务划分结果,就每个调试子任务分别叙述以下内容。

3. 1按功能或特性描述调试的基本原理和方法。

3.2按功能或特性描述调试的循序和步骤。

3.3给出调试要点和注意事项。

3.4若需软硬件配合,给出配合要求。

2.资源与计划

4.1就每个调试子任务分别给出所需具备的调试环境或资源配置,如:调试母板,单板或模

块所需达到的功能或特性要求,仪器、仪表,软硬件开发工具等。

4.2按照系统总体进度要求细化各调试子任务进度和目标要求。

26



《单板设计规范》编写内容规范

《单板设计规范》是开发第一阶段所出文档。开发人员根据系统部《硬件总体设计》

和《产品研制规范》中对单板的要求,提出具体的实现方法、资源和进度安排,具体编写内

容如下。

1.概述

简述单板在系统中所处的位置,所需完成的功能、特性和指标。

2.实现方案

2. 1 给出二种以上可供选择的实现方案及几种方案的优缺点比较,若仅提供一种方案,陈述

仅有此唯一方案的理由。

2. 2 给出方案中主要电路及元器件选定理由。

3.原理框图

分别就每种方案以功能块或主要芯片为单元, 画出各单元之间的逻辑连接关系, 包

括支撑整个电路的主要信号线或引出线。

4.基本原理

详细介绍各单元电路的基本工作原理, 及整个电路的工作过程。 若有必要提供相应

的时序图,逻辑图,信号关系,输入输出关系等。

5.单板与系统接口说明

5. 1 引出线信号表及符号定义:

1〕内容包括印制板插头或插座,与外部连接的各个通信电缆连接或插头座等的引出线

信号表,以及各个引出线的符号定义。

2〕以表格形式给出引出线信号名称,并在表格后面对引出线信号定义作出说明,表格

中的引出线信号名称应与原理图中完全相同。

5. 2 引出信号线电特性要求

对于关键或主要信号线进行电特性描述,如:信号电平、信号频率、驱动能力、输入 /

输出阻抗等。

5. 3 引出信号线时序与系统配合要求

5. 4 软件接口说明

应基本能使软件人员能根据“软件接口说明”进行编程。说明包括:

地址空间分配(包括 ROM 地址, RAM 地址, I/O 地址)

各可编程芯片的接口地址和各功能的软件操作步骤。

各可编程芯片的方式控制字,状态字,命令字等的格式说明。

6.电 源 和 接 地

6. 1 电源

27



说 明 提 供 给 单 板 的 电 源 的 波 动 范 围 ,每 种 电 源 的 入 口 地 址 ,对 单 板 的 功 耗

的 要 求 。

6. 2 接地

说明提供给单元 /单板的接地线的种类,接地入口和对地线相应的特别要求。



7.关 键 技 术

说 明 单 元 /单 板 必 须 采 用 的 一 些 关 键 技 术 , 并 用 框 图 画 出 所 用 的 器 件 和 外

围 电 路 , 相 应 的 信 号 要 求 等 。

对 单 元 /单 板 规 定 必 须 采 用 的 器 件 或 接 口 技 术 、 保 护 电 路 的 要 求 , 用 原 理

图 或 框 图 画 出 相 应 的 电 路 , 以 及 技 术 要 求 。

对不能完全确定的关键技术和指标分配,给出推荐的框图和应用



8.可 信 性 设 计 说明

8. 1 单板的任务可靠性模型

包括任务可靠性框图和数学模型。

8. 2 可靠性指标

根据单板元器件清单和可靠性模型通过可靠性预计得到的近似可靠性指标,应与《硬件

总体设计》中分配到单板的可靠性指标相一致。

8. 3 可信性设计准则的遵循

8. 3. 1 降额设计

说明元器件是否按《硬件总体设计》的要求进行了降额,没有降额的应明确理由。

8. 3. 2 冗余设计(若有必要)

说明本板采用冗余设计的方案。

8. 3. 3 热设计

说明为达到《硬件总体设计》热设计中的要求,本板所需采取的措施。

8. 3. 4 ESD、 EMC 设计

说明采取 ESD、 EMC 设计的组成部分、具体措施。

8. 3. 5 耐环境设计

说明所采取的防振动、冲击、环境污染措施。

8. 3. 6 可测试性设计

说明落实《硬件总体设计》设计中可测试性要求的情况。

8. 3. 7 其它可信性设计

说明所需采取的其它可信性设计技术,如安全、防错等。

28



9.工 艺 需 求

图示说明单板的外形尺寸、测试孔、指示灯位置及定义等,对单板的可生产性设计,可

达性等工艺要求。



10.资 源 与 进 度

10. 1 给出单板设计与调试所需资源,如:调试母板,为调试所需的配合电路或单板,仪器、

仪表,软硬件开发工具等。

10. 2 按照系统总体进度要求细化出本板进度和目标要求。

29







《软件模块设计方案》编写内容规范

《软件模块设计方案》是软件模块开发第一阶段所出文档。软件开发人员根据系统部

《软件总体设计》和《软件需求说明书》中对软件模块的要求,提出具体的实现方法、资源

和进度安排,具体编写内容如下。

1.概述

1.1背景

1.2定义

1.3参考资料

2.模块系统的组织结构

2.1该模块的地位和作用

该模块与上下级模块、同级相关模块的关系,该模块的作用。

2.2该模块的组成

说明组成该模块的子模块

3.模块设计说明

3.1模块描述

3.2功能

3.3性能

3.4输入项

3.5输出项

3.6算法

3.7流程逻辑

3.8接口(包括与硬件的接口)

3.9存储分配

3.10注释设计

3.11限制条件

3.12尚未解决的问题

4.可靠性设计说明

根据《软件总体设计》中对可靠性的要求,具体落实本模块的可靠性。

4.资源与进度

4.1说明本模块所需要的硬件环境、软件工具、其他软件的配合要求。

5. 2按照软件系统总体进度要求细化出本模块进度和目标要求。







30







《自测方案》编写内容规范

《自测方案》包括《单板自测方案》、《模块自测方案》和《系统自测方案》,主要描述

开发人员自测的总体思路,简要叙述自测方法、资源和进度安排,此工作可在测试人员的协

助下完成。具体编写内容如下。



1.概述

1.1自测任务描述

简述单板/模块名称、版本号、功能特性、与其它单板/模块的联系。

1.2自测环境

为达到自测目的所需要提供的软硬件环境。

1.3测试的总体思路



2.自测内容及测试通过准则

分功能或特性对自测内容一一描述,并确定测试通过准则。



3.测试方法

描述测试方法、测试用例或测试手段,用软件测试工具进行测试的要写出测试工具名称

及其提供的功能。



4.测试资源与进度安排

5.1测试资源

为达到自测目的所需要提供的软硬件环境、测试仪表或工具。

5.2预期的时间进度安排

根据总体进度要求确定自测进度和目标要求,要注意测试时间上的安排是否合理以及是

否需要相关人员的配合。

31



《自测报告》编写内容规范

《自测报告》包括《单板自测报告》、《模块自测报告》和《系统自测报告》,主要描述

开发人员提交测试前的自测结果,此工作可在测试人员的协助下完成。具体编写内容如下。

1.概述

1.1自测项目名称、版本号、测试人。

1.2测试环境

软硬件的配置、版本、组网和其他需要说明的情况。



2.测试记录及分析

2.1详细记录自测中发现的问题以及是如何改正的。

2.2测试过程中是否全部按照《自测方案》中所给定的测试用例来进行测试,是否有遗漏。

2.3测试结论

根据《自测方案》中测试通过准则的要求给出是否通过自测的结论。



3.测试总结

总结已解决问题的方法和经验,分析自测活动中一些失败的经验和教训,为今后的系统

设计、开发和测试工作提出建议。



32



《单板设计说明》编写内容规范

《单板设计说明》是单板开发调试阶段基本完成后所出文档。详细说明单板开发调试

阶段所做的工作,具体编写内容如下。

1.设计输入

内容包括设计目标,功能要求,实现方案,主要电路及元器件选定理由,与同类产

品比较有哪些优点和不足等。

2.原理框图

以功能块或主要芯片为单元,画出各单元之间的逻辑连接关系,包括支撑整个电路

的主要信号线或引出线。

3.基本原理

详细介绍各单元电路的基本工作原理,及整个电路的工作过程。包括相应的时序图,

逻辑图,信号关系,输入输出关系等。

4.软件接口说明

说明主要包括:

地址空间分配(包括ROM地址,RAM地址,I/O地址)

各可编程芯片的接口地址和各功能的软件操作步骤。

各可编程芯片的方式控制字,状态字,命令字等的格式说明。

5.主要器件介绍

内容包括主要、专用及特殊器件(包括LATTICE,FPGA等可编程器件)的特点,

功能,引脚说明,时序图等。采用LATTICE,FPGA等可编程器件,底层电路由编程工

程师编写的电路为准。但必须符合电路设计人员的设计思想和功能,时序要求。由电路

设计工程师与编程工程师相互核实认可,最终由编程人员编写《可编程器件设计》,与

《单板详细设计》两者合订成册,但标题封面各自分开。

6.引出线信号表及符号定义

内容包括印制板插头或插座,与外部连接的各个通信电缆连接或插头座等的引出

线信号表,以及各个引出线的符号定义。

以表格形式给出引出线信号名称,并在表格后面对引出线信号定义作出说明,表

格中的引出线信号名称应与原理图中完全相同。

7.可信性设计说明

7.1单板的任务可靠性模型

包括任务可靠性框图和数学模型。

7.2可靠性指标

根据单板元器件清单和可靠性模型通过可靠性预计得到的近似可靠性指标应与《硬件

33



总体设计》中分配到单板的可靠性指标相一致。

7. 3 元器件选用

详细说明所用元器件的可靠性参数(包括质量等级) ,及占《产品器件优选清单》的比

例构成 。

可与《材料单》 (本文档第 10 条)合二为一。

7. 4 可信性设计准则的遵循

7. 4. 1 降额设计

说明元器件是否按总体方案的要求进行了降额,没有降额的应明确理由。

7. 4. 2 容差设计

对于以模拟电路为主的功能模块,必须以附录形式给出容差设计结果,建议使

用《田口设计》方法,参见可靠性园地中有关介绍。

7. 4. 3 冗余设计

详细说明所采用的冗余设计对提高可靠性的效果。

7. 4. 4 热设计

说明所采用的热设计的效果(如温度分布情况,器件最高壳温) 。

7. 4. 5 ESD、 EMC 设计

说明采取 ESD、 EMC 设计的组成部分、具体措施与效果。

7. 4. 6 耐环境设计

说明所采取的防振动、冲击、环境污染措施。

7. 4. 7 可测试性设计

说明设计中遵循《可测试性设计规范》的情况。

7. 4. 8 其它可信性设计

说明所采取的其它可信性设计技术,如安全、联锁、防错等。



8. 电源与接地





9. 成 本 预 计

根 据 使 用 的 元 器 件 和 数 量 列 表 预 计 单 板 的 硬 件 成 本 。



10.材料单

按标准格式列出。参 WP5.12

除单板的料单外,产品还应有一份〈 〈装配料单〉 〉以便供应部采购单板外的其他

说明单板的电源要求和地线的安排

34



元器件。〈〈装配料单〉〉的格式同单板料单。





35



《软件模块设计说明》编写内容规范

《软件模块设计说明》是软件模块开发调试阶段基本完成后所出文档。详细说明模块

开发调试阶段所做的工作,具体编写内容如下。

1.引言

1. 1 范围:本文档包含的内容及有关文档的说明。

1. 2 参考资料:与本文档相关的文档以及参考书籍。

1. 3 术语、缩略词:可略过



2.概述

2. 1 该模块的地位和作用:该模块与上下级模块、同级相关模块的关系,该模块的作用。

2. 2 该模块完成的功能:详细说明该模块完成软件系统中相应的功能。

2. 3 该模块的组成:说明组成该模块的子模块。



3.数据说明

3. 1 常量说明

3. 2 变量说明:全局变量和重要的局部变量说明。

3. 3 数据类型说明:包括类型说明、对象类的层次结构说明等。

3. 4 数据库说明:结构定义、数据量等(视各模块的具体情况可选) 。

3. 5 其他说明:需要的大量内存说明、重要算法说明、通信协议格式说明、任务和消息队列

说明、进程和线程说明等(视各模块的具体情况可选) 。



4. 模块说明 (不包含子模块则选用 )

4. 1 原型定义

4. 2 输入、输出和错误代码说明 (输出包括参数输出、消息队列和事件等 )

4. 3 调用关系

4. 4 流程图



5.模块结构图 (包含子模块则选用 )

以层次图的形式说明模块和子模块的关系



6.需说明的其他事项(视各模块的具体情况可选)

6. 1 以相对路径给出源文件目录组织

6. 2 以表格形式列出各文件包含的子模块

36

6.3其他



7.子模块说明(包含子模块则选用)

7.X 子模块X

7.X.1原型定义

7.X.2输入、输出和错误代码说明(输出包括参数输出、消息队列和事件等)

7.X.3调用关系

7.X.4功能

7.X.5流程图



注:子模块大小为<200行



37



《可编程器件设计说明》编写内容规范

1.电路说明,包括功能模块说明。

2.详细完整的电原理图,按A3 REDUCED A4打印。

3.采用的可编程器件的名称,封装形式。

4.清晰完整的出脚说明。

5.各可编程文件具体文件名,存档磁媒体存放路径,备份文件磁媒体存放路径。

38



《单板调试说明》编写内容规范

《单板调试说明》是单板开发调试工作的总结,主要为中试转产工作提供说明文档,也

可作为相关开发人员和测试人员的参考文档,具体编写内容如下。

1.概述

给出单板名称、版本号、作者,其在系统中的位置和作用,完成的基本功能。



2.调试环境

调试所需要的软硬件环境,包括:

a.是否需要调试母板或自制调试设备。

b.所需配合的其他单板或系统要求。

c.所需调试的仪器仪表。



3.调试项目或调试点

3.1按功能或特性列出调试项目,对先后循序有要求的给出调试的先后循序。

3.2按调试项目描述调试的基本原理、方法和步骤。

3.3给出调试或检测点的参数和调试注意事项。

3.4若需软硬件配合,给出配合要求。

3.5描述调试通过的标准。



4.调试过程中典型故障及解决办法

4.1给出开发调试过程中出现的典型故障,分析故障原因,给出解决办法。

4.2对开发调试过程进行总结,给出那些部分已调试过,那些部分尚未调试需在系统调试阶

段调试。提出下一版本的改进目标和措施。



5.其他需要说明的事项

39



《软件模块调试说明》编写内容规范

《软件模块调试说明》是软件模块开发调试工作的总结,主要为软件系统调试工作提供

说明文档,也可作为相关开发人员和测试人员的参考文档,具体编写内容如下。

1.概述

给出模块名称、版本号、作者;该模块与上下级模块、同级相关模块的关系,该模块的

作用和功能。



2.调试环境

调试所需要的软硬件环境。



3.调试说明

3.1按功能或特性列出调试项目或调试点。

3. 2调试活动简述

对调试过程进行简要说明。

3.3调试总结

模块中所有的流程及程序分支是否在调试中都已走到,在具有多进程、多线程以及分布

分布式处理等环境中的资源共享和访问冲突控制等方面的细节是否调试过,针对《模块流程

框图》详细记录下所有已调试过的部分以及未调试的部分,那些部分尚需在系统调试阶段调

试。



4.其他需要说明的事项

40



《系统调试说明》编写内容规范

《系统调试说明》是系统开发调试工作的总结,主要为中试转产和后期开发工作提供说

明文档,也可作为相关开发人员和测试人员的参考文档,具体编写内容如下。

1.概述

简述系统名称、系统的主要构成及基本特性。



2.调试环境

调试所需要的软硬件环境,包括:

a.系统配置(包括单板名称、版本号),组网或应用方式,系统与单板的软件版本。

b.调试中所需的仪器仪表。



3.调试方法与步骤

3.1调试项目或调试点

3.1.1按功能或特性列出调试项目,对先后循序有要求的给出调试的先后循序。

3.1.2按调试项目描述调试的基本思路。

3.1.3给出调试或检测点的参数,软件设置要求和调试注意事项。

3.1.4描述调试通过的标准。

3.2调试过程描述

3.2.1对系统上电与软件加载过程进行描述,系统和单板自检状态正常与异常描述。

3.2.2详细描述各调试项目的调试过程。



4.调试过程中典型故障及解决办法

4.1给出系统调试过程中出现的典型故障,分析故障原因,给出解决办法。

4.2对系统调试过程进行总结,给出那些部分已调试过,那些部分尚未调试需在下一阶段或

版本调试。提出下一版本的改进目标和措施。



5.其他需要说明的事项

41



《系统测试方案》编写内容规范

《系统测试方案》描述了测试活动的范围、方法、资源和进度。具体编写内容如下。

1。概述

1.1被测试系统简述

简述被测系统的主要构成及原理。

1.2背景说明

1.2.1执行本测试方案前必须完成的各项工作。

1.2.2术语简介

列出本测试方案中专用名词和术语的定义和英文缩写所代表的原意。

1.2.3测试依据

列出本测试所引用各种技术方案的资料、国际国内标准规范、测试原理及测试规范等文

件资料。

1.3测试目标与测试总体思路

测试任务所需达到的目标、总体测试任务要求及为完成测试任务而制定的测试总体

思路。

2。任务描述

2.1确立测试子任务

先划分测试软、硬件模块,然后把其中某一模块或几个模块的组合作为一测试子任务确

定下来。例如:硬件的某块单板或几块单板的组合构成一个测试子任务,要简要说明如此确

定的原因。

2.2测试子任务1

2.2.1测试方法

描述子任务测试的总体方法,规定测试子任务的主要活动、技术、工具及目的。

2.2.2资源、进度规划

依据总体方案进度安排,估计完成测试子任务所需的时间,为每个测试子任务确定测试

里程碑并规定进度、相关负责人。初步确定所需资源,并对软、硬件测试资源进行目的和内

容描述。

2.2.3测试子任务通过准则

规定该测试子任务通过测试的标准。

2.2.4人员素质要求

指明子任务测试人员应有的水平以及为掌握必要技能所必须进行的培训内容。

2.3测试子任务2

以与2.2节相类似的方式说明用于另一项及其后各子任务的测试方案

42



《可靠性试验方案》编写内容规范

《可靠性试验方案》描述了可靠性测试活动的范围、方法、资源和进度。具体编写内容

如下。

产品说明

说明产品的名称、型号和规格(包括软件和硬件版本等)。规定受试产品的数量和配置,

产品的尺寸和重量。

产品功能简述。

产品的使用环境描述,以前可靠性试验的结果。以前可靠性试验中的问题和改正措施等。

引用标准

产品研制阶段可靠性试验要求

电子通信设备电磁兼容试验规范

GB2423-89 电工电子产品环境试验总纲

GJB150-86 军用设备环境试验方法

ITU-T-K.20 电信交换设备耐过电压过电流的能力

应力条件

振动应力条件

根据产品在系统中的位置和产品的使用及运输环境确定产品应当承受的振动应力及是

否带电测试。单板的振动应力应高于单机、单机应高于系统,车载设备的振动应力应高于

室外设备、室外设备应高于室内设备、余类推。推荐采用随机振动。

随机振动的最大功率谱密度

推荐使用0.04g2/Hz(对单板)、0.02g2/Hz(对单机)

随机振动的持续时间和振动方向

推荐值:X、Y、Z三个方向,每方向30min.

随机振动功率谱密度曲线

推荐曲线 5~20Hz +3 dB/OTC

20~80Hz 最大功率谱密度

80~500Hz -3dB/OTC

43



扫 频 振 动

在没有条件进行随机振动时,可采用扫频振动

推荐振动条件:扫频范围 5~55Hz

振幅 0.35mm

扫频周期 5 min

振动时间 30min

振动方向 X、 Y、 Z

冲 击 试 验

根据用户或产品标准的要求而定,推荐的冲击试验条件:

脉宽: 11ms 波形:半正弦 加速度: 30g 冲击次数: 5~10 次

汽 车 运 输 试 验

对于无法在振动台上试验的系统设备,以及在考察包装的抗振能力的时候,应采用汽

车运输试验或模拟汽车运输试验。如试验条件:三级公路、 200 公里、时速 20~40 公里 /小

时。

极 限 振 动 应 力

推荐系统可以进行的极限振动的方式和应力条件。

EMC 试 验 条 件

根据产品的使用环境(强电磁环境或 一般电磁环境)和产品的电磁辐射特性(大功率

辐射设备或一般辐射设备)以及有无外线等情况选择 EMC 试验的严酷度等级 (二级或三级 )。

静 电 抗 扰 性 要 求



浪 涌 抗 扰 性 要 求

按 标准

电 快 速 脉 冲 群 抗 扰 性 要 求

按 标准

电 源 跌 落 抗 扰 性 要 求

按 标准

44



辐 射 射 频 电 磁 场 抗 扰 性 要 求

按 标准

射 频 场 传 导 抗 扰 性 要 求

按 标准

无 线 电 干 扰 特 性 测 试

按 标准

辐 射 发 射 测 试

按 标准

过 电 流 和 过 电 压 能 力 测 试

对交换设备的模拟用户口,按 K20 标准进行过电流和过电压能力测试。测试条件为:

雷击波形 10/700ms、电压峰值 1KV(无一级保护)或 4KV(有一级保护) 。

电力线感应 600Vrms、持续时间 0.2s(无一级保护)或 1s(有一级保护)

电力线接触 220Vrms、持续时间 15min

对其它设备或其它接口,参照 K20 标准执行。

温 度 循 环 应 力 条 件

低 温 工 作 温 度 T1

在该温度下设备应保证全部功能指标。

最 低 工 作 温 度 T2

在该温度下设备保证全部功能,不考核指标。

高 温 工 作 温 度 T3

在该温度下设备应保证全部功能指标。

最 高 工 作 温 度 T4

在该温度下设备保证全部功能,不考核指标。

45



温 度 循 环 周 期 t( 小 时 )

温 度 循 环 次 数 n

总 试 验 时 间 T( 小 时 )

最 高 温 变 率 ( C/分 钟 )

受 试 产 品 负 载 率

试验应带载进行,推荐负载率 80%

极 限 温 度

系 统 可 以 进 行 的 极 限 工 作 温 度 和 时 间 。

温 度 循 环 试 验 剖 面 图

0

电 应 力 条 件

额 定 电 应 力

设备的额定电源电压

最 高 电 应 力

至少比额定电压高 10%,推荐 20%。

最 低 电 应 力

至少比额定电压低 10%,推荐 20%。

电 应 力 在 试 验 过 程 中 的 分 布

非额定电应力应占整个试验时间的 30%以上。

在 每 个 温 度 循 环 周 期 中 开 关 电 的 次 数

推荐值: 10 次

其 它 应 力 条 件

根据设备的使用环境,产品标准的规定或用户的要求,选择高低温存贮、淋雨、沙尘、

盐雾、霉菌等试验条件及合格要求。

测 试 项 目 及 要 求

46



产品在试验前需进行全面的功能指标测试,保证产品在试验前是合格的。在试验后也应

进行全面的功能指标测试。在试验过程中根据条件、选择几项主要的功能指标进行监测。



试验结果的处理

试验中故障的处理办法

对故障的维修、分析、研究及更改的人员和时间作出必要的规定。

故障对试验进程的影响

故障第一次出现,及时修复或更换后、继续试验。故障重复出现,暂停试验,出具整改

意见后方可恢复试验。故障再次重复出现,试验终止。

实验效果的评估方法

推荐采用杜安模型、根据试验时间、加速系数、可靠性预计值、试验中的故障数、评估受试

产品试验前和试验后的MTBF值。

试验是否通过(满意)的判据

根据试验效果评估的结果,判断试验是否满意。可靠性增长30%以上,判为满意。

其它需要说明的问题





47



《系统测试规程》编写内容规范

《系统测试规程》包含《集成测试规程》和《系统综合测试规程》。《系统测试规程》详

尽描述了在测试中针对每一子任务的每一项特性所必须完成的基本测试项目和测试通过的

准则。每一个子任务都有一个测试规程与之对应。具体编写内容如下。



1。概述

简要描述子任务中被测系统的功能和测试子任务的内容及目的。

2.测试特性描述

2.1确定测试特性

把测试子任务细化为一个个具体的测试特性。测试特性包括系统方案设计中的功能、指

标、约束、限制、可靠性要求、边沿特性要求、故障恢复能力、极限处理能力等。

2.2测试特性1

2.2.1测试特性描述

用图形、文字或图表的方式详细描述该测试特性,必要时引用相关的国际、国内标准。

2.2.2测试环境

规定测试项目中所需的测试仪表、测试电路的搭建方法、测试软件工具,指出相应的

使用要求。

2.2.3测试方法描述

针对该测试特性,对测试方案中规定的测试方法进行细化,最终细化为具体的测试项

目。一个特性测试由一个或多个测试项目组成,对每一测试项目要指出所用的具体测试技术、

规定分析测试结果的方法、测试用例设计的要求。

2.2.4测试用例设计

测试用例是实施一次测试而向被测系统提供的输入数据、操作或各种环境设置,是对

测试项目的进一步实例化。每一测试项目可由一个或多个测试用例组成。每一测试用例要有

详细的测试输入说明及预期的输出说明。

2.2.5通过准则

规定该测试特性测试通过准则。

2.3测试特性2

以与2.2节相类似的方式说明用于另一项及其后各项测试特性的测试规程。

48



《系统测试报告》编写内容规范

《系统测试报告》包括《集成测试报告》和《系统综合测试报告》 ,对于同一类型的测

试可能会进行多次回归测试,在报告中应注明回归测试序号。具体编写内容如下。



1 。概述

1.1测试任务名称及内容

简要描述本次测试任务的名称、内容及目的。

1.2测试环境与实际运行环境的差异与影响

指出测试环境与实际运行环境的差异,并分析这些差异将给测试结果带来的影响。

1.3测试的总体环境与版本

描述测试总体环境,软硬件版本,完成日期和其他需要说明的情况。

1.4主要测试仪表

2 。测试记录及分析

2.1 测试记录

测试记录的记录方式可以有 2 种:

1) 可以收集按表 1 填写的测试记录,并按编号进行统计,编号的名称如下:

zg ××××- ××

子任务代号( 1 位) 发现问题的个数( 2 位)

测试特性代号( 2 位) 测试项目代号( 1 位)



2) 也可以文字的形式对每一测试特性的测试结果进行描述, 但是必须与测试规程中设计

的测试实例一一对应,并对测试的结果作出评价,对于发现故障的,要详细描述故障的

表现,包括:故障发生环境、执行的操作、涉及的网元和单板、故障发生的次数、系统

反应、故障发生的第一和最后一次的时间、故障等级等。

2.2 结果分析

2.2.1 故障总结

1) 测试记录的统计结果填入表 2:测试问题统计表 ;

2) 分析故障的类型分布、故障密度分布、功能上的分布 ;

3) 故障改正的平均时间。改正一个故障又引入的新故障平均个数 ;

4) 与上次测试的对比 ;

5) 对测试方法和工具的评价 .

2.2.2 测试结论

描述对被测对象的总体印象并根据子任务测试通过准则及特性测试通过准则,评价被测

系统完成总体方案设计目标的程度,给出是否通过测试的结论。

49



3.测试总结

总结已解决问题的方法和经验,分析测试活动中一些失败的经验和教训,为今后的系统

设计、开发和测试工作提出建议。

表1:测试记录表

测试子任务名称测试记录

测试人: 时间: 编号:TR××××××

测试特性

测试项目

测试环境

测试对象版本

测试依据

问题描述

问题级别

可重复性

建 议

送处理人

处理人意见

回归测试进度

回归测试结论

























时间



处理人:

50



表2:测试问题统计表

测试问题统计表













子任 提

务名称 等级





一级









二级









三级









四级









总计







解决问题的统计



问题

个数



该问题所占

百分比



已解决问题的个





占出现问题的百分比











51





《 可 靠 性 报 告 》 编 写 内 容 规 范

《可靠性报告》是对系统整个可信性工作进行总结。具体编写内容如下:



1.概述

说明研发阶段可信性工作的目的和研发阶段可信性工作的内容。

2.可信性工作实施

2.1 可信性管理

对可信性管理进行总结,给出评价。

2.1.1 可靠性指标

对系统可靠性指标是否可行进行评价。

2.1.2 工作环境

评价系统设计文档中是否明确设备工作环境。

2.1.3 关键项目和环节

评价系统文档中是否明确了关键项目和环节。

2.1.4 资源及组织

评价系统文档中是否明确规定了可信性工作所需资源和工作组织。

2.1.5 可信性设计规范

评价系统文档中是否明确了系统开发设计应遵守的规范和原则。

2.1.6 FRACAS 的建立

评价 FRACAS 运作情况。

2.2 可信性设计

对系统可信性设计工作进行总结。

2.2.1 可靠性模型

评价是否建立了系统的基本可靠性模型,模型是否合理。

2.2.2 可靠性预计

总结可靠性预计的工作,预计系统可靠性指标 MTBF。

2.2.3 元器件的选用

评价开发中元器件使用和管理工作。 分析哪些工作做得好, 有成效; 哪些工作做得不好

及可能造成的结果。

2.2.4 降额设计

评价系统设计是否符合公司已发布《元器件降额准则》要求,

2.2.5 热设计

52



评价系统热设计是否全面、合理。

2.2.6 电路容差分析

评价系统电路设计在容差上是否全面、合理。

2.2.7 冗余设计

评价系统是否考虑了冗余设计,冗余部分是否影响可靠性的关键点、分析设计的效果。

2.2.8 电磁兼容( EMC)设计及静电防护设计

评价系统设计上是否考虑了电磁兼容和静电防护,分析其效果。

2.2.9 耐环境设计

评价系统设计是否考虑环境因素,对恶劣环境是否有防护设计,分析其效果。

2.2.10 FME( C) A

评价系统设计是否进行了 FMEA 和 FMECA 工作,特别是单点故障的分析工作。

2.2.11详细设计评审

对详细设计评审工作进行评价。



2.3 可靠性试验

描述可靠性试验的过程和记录,记录规范参见《测试报告》编写规范给出可靠性试验的

结论。

53



《项目开发总结报告》编写内容规范

《项目开发总结报告》是项目开发终结后对整个项目的总结,具体编写内容如下。

1 引言

1.1 编写目的

1.2 项目背景

1.3 说明项目来源、承担单位

1.4 参考资料

2 开发结果

2.1 产品

产品文档名称、程序名称及总量、单板名称等

2.2 主要功能及性能

2.3 技术水平

通过该项目所达到的技术水平,关键的技术情况介绍,可重复应用的前景和

对以后的产品开发的实际意义等。

2.4 所用人年数

2.5 进度执行情况

说明总的计划和各阶段计划进度与实际进度的对比、原因等。

2.6 费用

说明计划人工费用、材料费、仪器仪表的投入和其它费用等和实际使用的费

用的对比、原因和影响等。



3 评价

3.1 技术方案评价

3.2 产品质量评价

3.3 配合协调评价

3.4 同行对比评价



4 经验与教训

通过本项目应该注意的问题说明。





54



3.文档编写格式要求

3. 1 范围

本要求适用于公司归档的所有技术文件(企业标准除外) 。

3. 2 引用标准

GB/T1.1-1993 标准化工作导则 第 1 单元:标准的起草与表述规则

第 1 部分:标准编写的基本规定

GB/T1.2-1996 标准化工作导则 第 1 单元:标准的起草与表述规则

第 2 部分:标准出版印刷的规定

3. 3 技术文件的幅面

技术文件采用 A4 幅面( 210mm× 297mm) 。

3. 4 技术文件的格式

3.4.1 技术文件一般包括以下几部分:







文件封面

目录

正文

附录

3.4.2 技术文件的封面格式

封面格式左边距为 2cm,右边距为 1cm,上边距为 0.5cm,下边距为 0.5cm。其中〖技术

文件名称〗和〖技术文件编号〗使用宋体小四号字, 〖版本〗和〖文件质量等级〗使用宋体

三号字。封面上需要签名的项目空出。技术文件的封面样式见附录 2。

3.4.3 技术文件的目录

目录包括目录标题和目录内容,目录标题使用黑体三号字,字间距离为四字。目录内容

包含正文中第一和第二级标题。最多包含第三级标题。标题的建立使用 WORD 中〖插入〗

→〖索引和目录〗中的“正式目录”样板。

3.4.4 技术文件正文格式要求

3.4.4.1 文件页眉距页上边距为 1.5cm( WORD 缺省值) ,页眉上注明文件名称、版本号。文

件页脚距页下边距为 1.75cm( WORD 缺省值) ,从首页开始,在页脚右下角位置用阿拉伯数

字标注页码。

3.4.4.2 文件的正文边距为 WORD 缺省值。上边距为 2.54cm,下边距为 2.54cm,左边距为

3.17cm,右边距为 3.17cm。

3.4.4.3 文件的内容层次编号采用阿拉伯数字,每两个层次之间加下脚点,任何层次的编号

均顶格起排,编号与文字之间空一个字的距离。文件内容层次最多不超过四层。

每段文字空二字起排,回行时顶格排。

列项说明的内容:在各项前加带半括号的阿拉伯数字,数字编号空二字,起排数字编号

与文字之间空半个字的距离,回行时顶格排。如果需要再细分,则应在其前加半括号的英文

55



小写字母,字母编号空四字起排,字母编号与文字之间空半个字距离,回行时与文字取齐。

3.4.5 表头及表格的编排

3.4.5.1技术文件中的表应从1开始的阿拉伯数字编号,这一编号应独立于章和任何图的编号。

只有一张表则应标明“表1”。表题应放在表的上面,居表中。其编排如下例所示:

表1 机械性能

类型线性密度

kg/m



3.4.5.2 表的接排

如果表的长度超过两页或两页以上,应在每页重复表的编号,并应在编号后用适当的文

字外加括号注明,举例如下:

——“表1(续)”,在表未完的各页中。

——“表1(完)”,在表的末页。

续表均应排列表头。

3.4.6 图

3.4.6.1 图的编号

图应该用从1开始的阿拉伯数字编号,这一编号应独立于章和任何表的编号。只有一幅

图则应标明“图1”。

3.4.6.2 图题的编排

图题应放在图的下面,其编排如下例所示:







图1 仪器详图

3.4.7文件的字号和字体

文件首层标题采用四号字,宋体加黑。行距为1.5倍,字间距为WORD缺省值。

文件的其余层次及正文采用五号字,宋体。行距为1.5倍,字间距为WORD缺省值。

3.4.8附录要求

附录一般的序号为“附录1”、“附录2”等。其它要求同“正文要求”。



内直径

mm



外直径

mm

56



4.附录

附录 1:软件设计 IPO 图

IPO( Input-Process-Output)图,顾名思义,是一种反映系统的输入、处理和输出等图形

方式。是系统分析和设计的图形工具。

一.顶层 IPO 图

顶层 IPO 图( Top IPO、简称 TIPO)是用来描述某个程序(系统)的总体输入输出和处

理情况图表。从顶屋 IPO 图,可以对该系统的输入、输出和修理一目了然。例如图 1 是一个

字处理软件的顶层 IPO 图。

输入 处理 输出













图 1. 顶层 IPO 图例子



二、层次图与 HIPO

层次图是软件分析与设计常见的图形工具。 层次图是用一种层次结构描述系统中各个组

成部分的关系。在软件设计中,层次图的每个单元表示一个模块,层次关系表示模块的调用

关系。为了更好地表示层次图中各单元及其关系,通常还对层次图中单元加上反映层次关系

的编号。图 2 是一个层次图例子。













A1.0 A2.0





A2.1









图 2 层次图

HIPO( Hierarch Plus Iuput/Process/Output)图是美国 IBM 公司提出的一种“层次圆

1.手写体正文

2.打印手稿

3.图表

1.操作输入处理

2.编辑

3.输出

4.存储

5.检索

6.操作

1.高级用户

2.透明胶片用户

3.幻灯片用户

4.事务信

A. SYS

A3.0 A4.0 A5.0

A2.2

A2.2.1

57



圈输入 /处理 /输出”图的缩写。 HIPO 图一般被描述成由:总体 IPO 图、 HIPO 图和详细 IPO

图三种图组成一个概念。本书所谓 HIPO 是特指一种描述模块结构的层次图形工具,是一种

具体的层次图。 总体 IPO就是上面介绍的顶层 IPO图, 详细 IPO图则是下面将介绍的模块 IPO

图。图 3 是对应图 1 字处理软件的 HIPO 图。















添加 2.1



图 3 HIPO 图



三、模块 IPO 图

HIPO 图既反映了软件的总体结构, 又反映了软件系统各个模块之间的关系。 所以 HIPO

图是软件设计中非常重要的图形工具。但是在 HIPO 图中每个模块只有名称,按照软件设计

的目标,还必须有模块详细描述。模块 IPO(简称 MIPO)图应是这样一种图形工具。

前面提到, 一般 HIPO 图的定义是将描述模块的 ( MIPO) 图称为详细 IPO 图, 我们认为称为

模块 IPO 图更为恰当些。

最初的详细 IPO 图画法与顶层 IPO 图很类似,有些画法加上数据存储部分。图 4 是一

种画法例子。但是,这种传统的 IPO 图存在一些不足,主要表现在如下几点:

1)在内容上,表现在反映的信息量不够。模块的详细说明主要内容包括输入、输出和处理

及数据文件,但是还有许多信息也是不可缺少的,如该模块的调用关系,模块的别名,模块

所在的系统或子系统名,模块的设计者等信息。

2)在形式上,以这种图形方式不适合描述模块的信息。一个系统由若干模块组成,每个模

块简易程度有所不同,采用图形方式不易统一格式。另外,图形方式不易表达增加的信息。

所以, 一种改进的方法是用表格方式代替图形方式。 图 5 是一种简单的改进的表格方式

的模块 IPO 图的样板例子。











58

字处理软件

输入 1.0 编辑 2.0 输出 3.0 存储 4.0 操作 6.0

删除 2.2 修改 2.3

输入 处理 输出



数据文件

图4原始的模块IPO图

XX软件模块IPO图样式

系统名称:

模块编号: 模块名称:

模块描述:



模块设计者: 设计日期:

被调用模块: 调用模块:

输入:

输出:

处理:

备注:



图5 模块IPO图



59

























































:技术文件的封面样式

技 术 文 件

技术文件名称:

技术文件编号:

版 本:

文件质量等级:

共 页

(包括封面 )

拟 制

审 核

会 签







标准化

批 准





60

附录 2



























































献花(0)
+1
(本文系考试资料文...原创)