如何写好一篇硬件经验总结文档

大家好，这里是大话硬件。

今天这篇文章想分享一个工作方法，主要用在如何写好一篇硬件问题总结文档上。

我们在工作中不可避免会碰到一些复杂的硬件问题，这些问题可能出现在项目研发过程中，也可能来自客户的反馈。

当困扰大家很久的棘手问题被解决完后，如果被总结成一篇文档，这样不仅方便他人获取到我们总结的经验， 还能提醒别人在项目中避免犯同样的错误。

因此，这种写文档的能力在公司是很有必要的，也是必须的。

为什么想到写这篇文章呢？

主要是上周同事把他写的总结文档发给我，让我帮忙看一下。看完文档后，我发现他写的内容缺少一些东西，然后给他讲了一下我的理解，如果是让我来写，我会怎么写。

当然这里面的理解，包括我个人对这种经验文档的理解，以及我刚入职时，领导教给我的方法，现在我也应该把这些好的东西分享给别人，包括关注大话硬件的同学。

01

大部分人写经验文档，会按照时间顺序，写下这个单板或电路出现了什么问题，自己做了哪些工作，电路又是怎么变正常的。按照调试的过程，记录了一些波形，这一篇经验总结就写完了。我们叫这种写法成为记流水账。

记流水账型的方法，最常见的使用场合是记录一天的工作内容，方便自己下班前查看这一天做了哪些事。但是这种记流水账的方法用在写问题解决后的总结文档上，不是好的选择，那应该怎么写呢？

经验总结最大的作用是让别人知道这个问题是在什么样的情况下出现，在调试过程中，具体做了哪些措施，问题的直接原因，根本原因是什么，在后续的项目中怎么做能有效避免。

<