如何制作硬件文档？

我正在为我的课堂制作一些幻灯片，说明如何记录正在开发的硬件。

我想列出一些在构建硬件时应该制作的文档。UML软件文档启发了我，该文档为几乎每种情况带来了许多文档类型。

根据我的经验和研究，许多项目仅包含原理图，布局和材料清单。我认为我们还应该添加有关动机（要求）的信息，这些动机使我们选择了一个而不是另一个。还有一些我们不会写的关于布局的信息，这些特殊信息不应更改。

被告知：

• 我们应该如何记录硬件？
• 如果您需要对从未见过的其他硬件进行一些改进/更改，那么您想拥有哪些重要文档？
• 如何清楚地组织这些信息？

我完全同意你的第三段。除了诸如原理图，BOM等显而易见的事物外，还有一些较不明显的事物，如您所说的，为什么选择一个特定的组件，而同样重要的是，为什么没有选择一个也许更明显的组件。

现在我可能会在这里显示年龄，但是我仍然喜欢使用精装硬木日志​​记录我的思维过程和设计决策，甚至是错误的决策。如果将来有人试图用更“合适”的组件替换组件或在PCB上移动轨迹，我的笔记可能会告诉他们我已经去过那里并烧伤了手指（也许是字面意思！）。

我总是对页面进行编号，并允许在前面的几页作为目录。您还可以记录诸如功耗，容差，时序等的计算信息（这种习惯来自我在航空航天业的生活，在那儿必须保留日志）。当然，您总是可以将此信息放在WP文档中，但我会坚持下去！

在涉及到异常（特别是模拟）电路的地方，电路描述也可能适用。我将这些视为软件注释，以记录任何不明显的电路或组件功能。像软件一样，原理图应尽可能“自我记录”，但有时这还不够。

一个更新的替代方法，尤其是在教育环境中，可能是拥有一个项目网站。可以将其安排为各个学科的博客集合-硬件设计，PCB布局，软件等。博客的性质将使贡献者能够展示其思想流并记录该项目的进展情况，而其他页面则可以更加正式（进展）。甘特图，测试结果等）。您甚至可以添加会议记录和操作列表。超链接使交叉引用变得容易，现在我们有了MathJax，因此即使设计方程式也很容易插入。

• 我们应该如何记录硬件？

• 如果您需要对从未见过的其他硬件进行一些改进/更改，那么您想拥有哪些重要文档？

• 如何清楚地组织这些信息？

在我们公司，我们期望编写硬件设计描述文件。这些非常简单：在开始时就说明该电路应该做什么，然后在每个部分中进行详细说明。每个组件的值都应该以某种方式被证明是合理的：如果您具有“默认”上拉或串联电阻，则应在开头的注释中提及它们（例如，“除非另有说明，否则使用10K上拉和0.1uF旁路电容器”） ，否则需要说明组件值的选择。例如“用于限制高频分量的4.7K和0.1uF RC滤波器（tau = 0.47毫秒）”或“用于低泄漏的NLAS4051多路复用器-该电路节点敏感”。