ハードウェアのドキュメントをどのように作成しますか？

開発中のハードウェアを文書化する方法について、クラス用のスライドをいくつか作成しています。

ハードウェアを構築する際に作成する必要があるドキュメントをリストします。私はUMLソフトウェアのドキュメントに触発されました。UMLソフトウェアのドキュメントには、ほとんどすべての状況に対応する多くの種類のドキュメントがあります。

私の経験と研究から、多くのプロジェクトには回路図、レイアウト、部品表しかありません。また、一方のマイクロコントローラーではなくもう一方のマイクロコントローラーを選択する動機（要件）に関する情報も追加する必要があると思います。変更すべきではない特別なコンポーネントの位置として、私たちが書いていないレイアウトに関するいくつかの情報もあります。

言われていること：

• ハードウェアをどのように文書化すべきですか？
• あなたが今まで見たことのない他のハードウェアにいくつかの改善/変更を加える必要がある場合に、あなたが欲しかった重要なドキュメントはどれですか？
• これらの情報をどのように明確に整理しますか？

私はあなたの第3段落に強く同意します。回路図やBOMなどの明白なものとは別に、あなたが言うように、なぜ特定のコンポーネントを選択したのか、それと同じくらい重要なのに、おそらくもっと明白なコンポーネントを選択しなかったのかといった具体的なものはありません。

ここで自分の年齢を示しているかもしれませんが、私はハードバックのルール付きログブックを使用して、私の思考プロセスと設計の決定を記録します。将来誰かがコンポーネントをより「適切な」コンポーネントに交換しようとしたり、PCB上のトラックを移動したりすると、私のノートには、私がすでにそこにいて指を焼いたことが（おそらく文字通り！）

私は常にページに番号を付け、目次として表の数ページを許可します。また、消費電力、許容誤差、タイミングなどの計算などを文書化することもできます（この習慣は、航空宇宙業界での日誌の記録が義務付けられていた頃のことです）。もちろん、いつでもこの情報をWPドキュメントに入れることができますが、私は紙に固執します！

回路の説明は、異常な（特にアナログ）回路が関係する場合にも適切です。私はこれらをソフトウェアのコメントのように扱い、明らかでない回路やコンポーネントの機能を文書化します。ソフトウェアのような回路図は、可能な限り「自己文書化」する必要がありますが、これだけでは不十分な場合があります。

特に教育環境での、より最新の代替手段は、プロジェクトのWebサイトを持つことです。これは、ハードウェアデザイン、PCBレイアウト、ソフトウェアなど、各分野のブログのコレクションとして整理できます。ブログの性質により、寄稿者は自分の考えの流れを示し、プロジェクトの進行状況を文書化し、他のページはより正式なものにすることができます（進捗状況）ガントチャート、テスト結果など）。議事録やアクションリストを追加することもできます。ハイパーリンクにより相互参照が容易になり、MathJaxが導入されたため、設計方程式も簡単に挿入できます。

• ハードウェアをどのように文書化すべきですか？

• あなたが今まで見たことのない他のハードウェアにいくつかの改善/変更を加える必要がある場合に、あなたが欲しかった重要なドキュメントはどれですか？

• これらの情報をどのように明確に整理しますか？

弊社ではハードウェア設計書を作成することを期待しています。これらは非常に簡単です。最初に、回路が何をすることになっているのかを説明してから、各セクションで詳しく説明します。すべてのコンポーネント値は何らかの方法で正当化されることになっています。「デフォルト」のプルアップまたは直列抵抗がある場合、それらは最初の注記に記載する必要があります（たとえば、「特に指定のない限り、10Kプルアップと0.1uFバイパスコンデンサが使用されます」）。それ以外の場合は、コンポーネント値の選択について説明する必要があります。たとえば、「高周波コンポーネントを制限するために使用される4.7Kおよび0.1uF RCフィルター（タウ= 0.47ミリ秒）」または「低リークに使用されるNLAS4051マルチプレクサー-この回路ノードは敏感です」。