我正在为我的班级制作一些关于我们应该如何记录我们正在开发的硬件的幻灯片。
我想列出我们在构建一些硬件时应该制作的文件。我受到 UML 软件文档的启发，它为几乎所有情况带来了许多文档类型。
根据我的经验和研究，很多项目只有原理图、布局和材料清单。我认为我们还应该添加有关引导我们选择一个微控制器而不是另一个微控制器的动机（要求）的信息。还有一些关于布局的信息我们只是不写，作为不应更改的特殊组件位置。
被告知：
我非常同意你的第三段。除了原理图、BOM 等显而易见的事情之外，还有一些不太明显的事情，如您所说，为什么选择特定组件，同样重要的是，为什么不选择可能更明显的组件。
现在我可能会在这里显示我的年龄，但我仍然喜欢使用精装本格的日志来记录我的思维过程和设计决策——即使是错误的。如果将来有人试图用更“合适”的组件替换组件或移动 PCB 上的轨道，我的笔记可能会告诉他们我已经去过那里并且烧伤了我的手指（也许是字面意思！）。
我总是给页面编号，并允许在前面放几页作为目录。您还可以记录诸如功耗、容差、时间等的计算（这个习惯来自我在航空航天业的日子，那时我必须保留日志）。当然，您可以随时将此信息放在 WP 文档中，但我会坚持使用纸质文件！
电路描述也可能适用于不寻常的（尤其是模拟）电路。我会将这些视为软件注释，以记录任何不明显的电路或组件功能。原理图，如软件，应尽可能“自我记录”，但有时这还不够。
一个更新的替代方案，尤其是在教育环境中，可能是拥有一个项目网站。这可以安排为每个学科的博客集合 - 硬件设计、PCB布局、软件等。博客性质将允许贡献者展示他们的思想流并记录项目的正在进行的进度，而其他页面可能更正式（进度甘特图、测试结果等）。您甚至可以添加会议记录和行动清单。超链接使交叉引用变得容易，现在我们有了 MathJax，因此即使是设计方程也很容易插入。
我们应该如何记录我们的硬件？
如果您需要对您从未见过的其他硬件进行一些改进/更改，您想要拥有哪些重要文件？
如何以清晰的方式组织这些信息？
在我们公司，我们需要编写硬件设计描述文件。这些非常简单：您在开始时解释电路应该做什么，然后在每个部分中详细介绍。每个组件值都应该以某种方式证明：如果您有“默认”上拉或串联电阻，则应在开头的注释中提及它们（例如“除非另有说明，否则使用 10K 上拉和 0.1uF 旁路电容器”） ，否则需要解释组件值的选择。例如“用于限制高频分量的 4.7K 和 0.1uF RC 滤波器 (tau = 0.47msec)”或“用于低泄漏的 NLAS4051 多路复用器——该电路节点很敏感”。