【原】硬件开发文档规范

本文出发点：一般来说，越是大公司越注重开发文档的规范性，因为这样最大的好处是能够保证开发的连贯性，也就是即使有员工离职了，只要开发文档是齐全的，新员工入职后，就能够很快接手工作，而不会对项目开发有较大的损失。

而对于工程师来说，熟练的硬件开发文档的写作能力是必须的，电路要设计好，文档也要及时补全。甚至，对个人来说，还可以进行总结，我个人就是从2010年开始，就有每天写工作日志的习惯。这样可以让技术有一个记录。另外，也会按照领域和项目的细分进行笔记的整理，将开发中遇到的各种问题进行分类整理，并详细记录，时而温故知新，因此技术能力得到了不断地增强，积累了经验，工作时间越长，也就更加得心应手了。

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

为规范硬件开发过程中文档的编写，明确文档的格式和内容，规定硬件开发过程中所需文档清单。开发人员在写文档时往往会漏掉一些该写的内容，因此编制规范在开发人员写文档时也有一定的提示作用。规范中共列出以下文档的规范：

a硬件需求说明书

b硬件总体设计报告

c单板总体设计方案

d单板硬件详细设计

e单板软件详细设计

f单板硬件过程调试文档

g单板软件过程调试文档

h单板系统联调报告

i单板硬件测试文档

j单板软件归档详细文档

k单板软件归档详细文档

l硬件总体方案归档详细文档

m硬件单板总体方案归档详细文档

当然，这是大公司一般的文档数量和规范，基本都是差不太多的内容，可能名字略有差异。但是小公司，可能会更加简化，但基本的文档都是一致的。

2.对硬件开发文档编制规范进行详解

1、硬件需求说明书

硬件需求说明书是描写硬件开发目标，基本功能、基本配置，主要性能指标、 运行环境，约束条件以及开发经费和进度等要求，它的要求依据是产品规格说明书和系统需求说明书。它是硬件总体设计和制订硬件开发计划的依据，    

具体编写的内容有：硬件整体系统的基本功能和主要性能指标、硬件分系统的基本功能和主要性能指标以及功能模块的划分等。

          

2、硬件总体设计报告

硬件总体设计报告是根据需求说明书的要求进行总体设计后出的报告，它是硬件详细设计的依据。编写硬件总体设计报告应包含以下内容：

系统总体结构及功能划分，系统逻辑框图、组成系统各功能模块的逻辑框图，电路结构图及单板组成，单板逻辑框图和电路结构图，以及可靠性、安全性、电磁兼容性讨论和硬件测试方案等。

3、单板总体设计方案

在单板的总体设计方案定下来之后应出这份文档，单板总体设计方案应包含单板版本号，单板在整机中的位置、开发目的及主要功能，单板功能描述、单板逻辑框图及各功能模块说明，单板软件功能描述及功能模块划分、接口简单定义与相关板的关系，主要性能指标、功耗和采用标准。    

          

4、单板硬件详细设计

在单板硬件进入到详细设计阶段，应提交单板硬件详细设计报告。在单板硬件详细设计中应着重体现：单板逻辑框图及各功能模块详细说明，各功能模块实现方式、地址分配、控制方式、接口方式、存贮器空间、中断方式、接口管脚信号详细定义、时序说明、性能指标、指示灯说明、外接线定义、可编程器件图、功能模块说明、原理图、详细物料清单以及单板测试、调试计划。有时候一块单板的硬件和软件分别由两个开发人员开发，因此这时候单板硬件详细设计便为软件设计者提供了一个详细的指导，因此单板硬件详细设计报告至关重要。尤其是地址分配、控制方式、接口方式、中断方式是编制单板软件的基础，一定要详细写出。以方便其他部门同事进行开发。

          

5、单板软件详细设计

在单板软件设计完成后应相应完成单板软件详细设计报告，在报告中应列出完成单板软件的编程语言，编译器的调试环境，硬件描述与功能要求及数据结构等。要特别强调的是：要详细列出详细的设计细节，其中包括中断、主程序、子程序的功能、入口参数、出口参数、局部变量、函数调用和流程图。在有关通讯协议的描述中，应说明物理层，链路层通讯协议和高层通讯协议由哪些文档定义。这部分主要有软件同事完成，但一般而言，硬件同事会给一些辅助，并且提供详细的接口开发文档。

          

6、单板硬件过程调试文档

开发过程中，每次所投 PCB 板，工程师应提交一份过程文档，以便管理阶层了解进度，进行考评，另外也给其他相关工程师留下一份有参考价值的技术文档。每次所投 PCB 板时应制作此文档。这份文档应包括以下内容：单板硬件功能模块划分，单板硬件各模块调试进度，调试中出现的问题及解决方法，原始数据记录、系统方案修改说明、单板方案修改说明、器件改换说明、原理图、PCB 修改说明、可编程器件修改说明、调试工作阶段总结、调试进展说明、下阶段调试计划以及测试方案的修改。    

          

7、单板软件过程调试文档

一般是项目调试结束，收集单板软件过程调试文档，要求尽可能清楚，完整列出软件调试修改过程。单板软件过程调试文档应当包括以下内容：单板软件功能模块划分及各功能模块调试进度、单板软件调试出现问题及解决、下阶段的调试计划、测试方案修改。

8、单板系统联调报告

在项目进入单板系统联调阶段，应出单板系统联调报告。单板系统联调报告包括这些内容：系统功能模块划分、系统功能模块调试进展、系统接口信号的测试原始记录及分析、系统联调中出现问题及解决、调试技巧集锦、整机性能评估等。    

          

9、单板硬件测试文档

在单板调试完之后，申请内部验收之前，应先进行自测以确保每个功能都能实现，每项指标都能满足。自测完毕应出单板硬件测试文档，单板硬件测试文档包括以下内容：单板功能模块划分、各功能模块设计输入输出信号及性能参数、各功能模块测试点确定、各测试参考点实测原始记录及分析、板内高速信号线测试原始记录及分析、系统 I/O 口信号线测试原始记录及分析，整板性能测试结果分析。

其实，说到最后一步，整个项目就基本完成了，如果没有大的bug, 基本就可以开始量产了。