硬件开发文档规范文件介绍

为规范硬件开发过程中文档的编写，明确文档的格式和内容，规定硬件开发过程
中所需文档清单，与《硬件开发流程》对应制定了《硬件开发文档编制规范》。开
发人员在写文档时往往会漏掉一些该写的内容，编制规范在开发人员写文档时也有
一定的提示作用。《硬件开发文档编制规范》适用于中央研究部立项项目硬件系统
的开发阶段及测试阶段的文档编制。规范中共列出以下文档的规范：
.. 硬件需求说明书
.. 硬件总体设计报告
.. 单板总体设计方案
.. 单板硬件详细设计
.. 单板软件详细设计
.. 单板硬件过程调试文档
.. 单板软件过程调试文档
.. 单板系统联调报告
.. 单板硬件测试文档
.. 单板软件归档详细文档
.. 单板软件归档详细文档
.. 硬件总体方案归档详细文档
.. 硬件单板总体方案归档详细文档
.. 硬件信息库

这些规范的具体内容可在HUAWEI 服务器中的“中研部ISO9000 资料库”中找
到，对应每个文档规范都有相应的模板可供开发人员在写文档时“填空”使用。模
块在rndI 服务器中的文档管理数据库中。

 硬件开发文档编制规范详解
1、硬件需求说明书
硬件需求说明书是描写硬件开发目标，基本功能、基本配置，主要性能指标、
运行环境，约束条件以及开发经费和进度等要求，它的要求依据是产品规格说明书
和系统需求说明书。它是硬件总体设计和制订硬件开发计划的依据，
具体编写的内容有：系统工程组网及使用说明、硬件整体系统的基本功能和主要
性能指标、硬件分系统的基本功能和主要性能指标以及功能模块的划分等。
2、硬件总体设计报告
硬件总体设计报告是根据需求说明书的要求进行总体设计后出的报告，它是硬件
详细设计的依据。编写硬件总体设计报告应包含以下内容：
系统总体结构及功能划分，系统逻辑框图、组成系统各功能模块的逻辑框图，电
路结构图及单板组成，单板逻辑框图和电路结构图，以及可靠性、安全性、电磁兼
容性讨论和硬件测试方案等。
3、单板总体设计方案
在单板的总体设计方案定下来之后应出这份文档，单板总体设计方案应包含单板
版本号，单板在整机中的位置、开发目的及主要功能，单板功能描述、单板逻辑框
图及各功能模块说明，单板软件功能描述及功能模块划分、接口简单定义与相关板
的关系，主要性能指标、功耗和采用标准。
4、单板硬件详细设计
在单板硬件进入到详细设计阶段，应提交单板硬件详细设计报告。在单板硬件详
细设计中应着重体现：单板逻辑框图及各功能模块详细说明，各功能模块实现方
式、地址分配、控制方式、接口方式、存贮器空间、中断方式、接口管脚信号详细
定义、时序说明、性能指标、指示灯说明、外接线定义、可编程器件图、功能模块
说明、原理图、详细物料清单以及单板测试、调试计划。有时候一块单板的硬件和
软件分别由两个开发人员开发，因此这时候单板硬件详细设计便为软件设计者提供

了一个详细的指导，因此单板硬件详细设计报告至关重要。尤其是地址分配、控制
方式、接口方式、中断方式是编制单板软件的基础，一定要详细写出。
5、单板软件详细设计
在单板软件设计完成后应相应完成单板软件详细设计报告，在报告中应列出完成
单板软件的编程语言，编译器的调试环境，硬件描述与功能要求及数据结构等。要
特别强调的是：要详细列出详细的设计细节，其中包括中断、主程序、子程序的功
能、入口参数、出口参数、局部变量、函数调用和流程图。在有关通讯协议的描述
中，应说明物理层，链路层通讯协议和高层通讯协议由哪些文档定义。
6、单板硬件过程调试文档
开发过程中，每次所投PCB 板，工程师应提交一份过程文档，以便管理阶层了
解进度，进行考评，另外也给其他相关工程师留下一份有参考价值的技术文档。每
次所投PCB 板时应制作此文档。这份文档应包括以下内容：单板硬件功能模块划
分，单板硬件各模块调试进度，调试中出现的问题及解决方法，原始数据记录、系
统方案修改说明、单板方案修改说明、器件改换说明、原理图、PCB 图修改说
明、可编程器件修改说明、调试工作阶段总结、调试进展说明、下阶段调试计划以
及测试方案的修改。
7、单板软件过程调试文档
每月收集一次单板软件过程调试文档，或调试完毕（指不满一月）收集，尽可能
清楚，完整列出软件调试修改过程。单板软件过程调试文档应当包括以下内容：单
板软件功能模块划分及各功能模块调试进度、单板软件调试出现问题及解决、下阶
段的调试计划、测试方案修改。
8、单板系统联调报告
在项目进入单板系统联调阶段，应出单板系统联调报告。单板系统联调报告包括
这些内容：系统功能模块划分、系统功能模块调试进展、系统接口信号的测试原始
记录及分析、系统联调中出现问题及解决、调试技巧集锦、整机性能评估等。
9、单板硬件测试文档
在单板调试完之后，申请内部验收之前，应先进行自测以确保每个功能都能实
现，每项指标都能满足。自测完毕应出单板硬件测试文档，单板硬件测试文档包括
以下内容：单板功能模块划分、各功能模块设计输入输出信号及性能参数、各功能

模块测试点确定、各测试参考点实测原始记录及分析、板内高速信号线测试原始记
录及分析、系统I/O 口信号线测试原始记录及分析，整板性能测试结果分析。
10 、硬件信息库
为了共享技术资料，我们希望建立一个共享资料库，每一块单板都希望将的最有
价值最有特色的资料归入此库。硬件信息库包括以下内容：典型应用电路、特色电
路、特色芯片技术介绍、特色芯片的使用说明、驱动程序的流程图、源程序、相关
硬件电路说明、PCB 布板注意事项、单板调试中出现的典型及解决、软硬件设计
及调试技巧。