ハードウェア設計の決定をどのように文書化しますか?


43

設計段階でハードウェアの決定をどのように文書化しますか?過去に作成したハードウェア設計を確認する際に、次の質問を自問する必要を避けるにはどうすればよいですか?

  • なぜこのコンポーネントを選択したのですか?
  • このコンポーネントにこれらの特定のパラメーターを選択した理由/方法
  • 回路のこの部分は何をしますか?
  • このコンポーネントの消費電力はどのくらいですか?
  • この回路の総消費電力はいくらですか?
  • このコンポーネントを他のコンポーネントに置き換えることはできますか?このコンポーネントと同等のコンポーネントはありますか?等

回路の設計段階での決定と計算を文書化する良い方法は何ですか?数百のデータシートページを再度調べることなく、上記の質問に対する回答を得るにはどうすればよいですか?

考えられる方法の1つは、回路図ファイルにメモを追加することです(EDAがサポートしている場合)が、あまり多くの情報で回路図を乱雑にしたくありません。


1
誰がこれらの詳細を見ますか?彼らはあなたの参考のためだけですか、他の人に見られますか?
スタンリ

@Staceyこのドキュメントは、私と他のデザイナーが読むことを目的としています。将来のデザインのほとんどをオープンソースにしたいのですが、それらを適切に文書化することが非常に重要です。
m。アリン

9
@ステイシーしかし、本当に..違いは何ですか?しばらくすると、自分のデザインを初めて見たときのように見ることになります
。– m.Alin

2
違いは、情報の表示方法にあります。プロの口調で行ったすべての決定を説明する正式な文書は、数式をすばやく書き留めて選択した値についてメモするよりもはるかに多くの作業になります。さらに、他の誰かがメモを見る場合、それらがデジタルであることは重要です。
スタンリ

4
OMG私はこの質問が大好きです。(申し訳ありませんが、実際には役立っていませんが、これは私が現在取り組んでいるものですので、これは素晴らしいことです)。続ける。
efox29

回答:


15

私は個人的に昔ながらのルートに行きます。私はデザインノートを持ち、自分が下したデザインの決定に関するすべてを絶対に書き留めています。特に、コンポーネントと値の選択、現在の計算、電源の計算、すべて。ソフトウェア/ファームウェアの決定と、タイミングとリソースの使用に関する注意事項も文書化します。

各ノートブックには、デザインの特定の部分(電源など)を参照するコンテンツページがあり、すべてのページに番号が付けられています。

私は何度もデジタル化を検討してきましたが、作業中にノートブックを目の前に置いておくのはいいことです。手作業で計算を書く方がはるかに簡単です。

ボード設計の仕様または正式なドキュメントを準備するとき、私は通常、自分のやったことの復習としてノートブックを参照します(または同時にデジタルドキュメントを書きます)。これは私が同じことを2回行っているように見えるかもしれませんが、私のノートブックはほとんどすべて自分自身の計算と説明であり、ドキュメントの冗長性は低く、他の人にとってはより形式的で説明的です そのため、同じことを2回書いていることはあまりありません。


数式の問題については完全に同意しますが、約5年前に紙のメモの使用をやめました。タイピングは、書き込みよりもはるかに容易であり、すべての通常の電子テキストの利点がある-検索可能、送信可能、バックアップ可能、など
マルクト

2
私たちの時代の最も印象的で重要なデザインノートブックのいくつか:computerhistory.org/collections/fairchild。紙のログブック/ノートブックの重要な利点の1つは描画です。私のラップトップで物事を描く/スケッチするのにかなりの労力が必要です(iPadの方が簡単ですが、たとえば私の妻はデザインノートをiPadに保存します)。私はグラフィカルに考える傾向があるので、ブロック図を描くことで多くの設計を行います。
スリーブマン

11

戻って、この情報を使用して設計仕様を更新できます。または、仕様を取得し、低レベルの仕様を作成します。ここでは、理想的な回路図を開始する前に、何をするのか、そしてその理由を詳細に記述します。その後、更新しながらスケマティックでアーカイブします。


以下の質問に答えます。まあ、私たちは通常、マーケティングの要件から始めて、その後、正式なエンジニアリングの対応または単に非公式な議論をすることです。これに続いて、テンプレートを使用してMRD(マーケティング要件ドキュメント)が続きます。これには、要件、競合分析、市場規模、機会、開発費用の見積もりなどが含まれます。通常、これはマーケティング担当者(または私の賃金等級以上の人)によって書かれます。

これに続いて、通常はエンジニアリングによって作成されたPRD(製品要件ドキュメント)がワードテンプレートで作成されます。これは、製品が何をするか、どの部分が必要であるか、および各部がどのように機能するかを高レベルでより技術的な詳細で説明します。多くの場合、目標のパフォーマンス、価格、消費電力、サイズ、その他の指標をここに含めます。

その後、各セクションの詳細な機能仕様が続きます。いくつかの設計作業は、実際に回路図に入る前にここで実際に行われます。たとえば、消費電力が計算され、部品が選択され、多くの研究が行われます。これは、非自明な設計決定を文書化する場所です。

最後に、多くのハードデザイン作業が仕様段階で行われたため、この時点で簡単な部分である回路図に進みます。私の意見では、どこでそれを行うべきですか?戻って仕様を更新します。

すべての仕様、PRD、MRDは、内部WikiのドキュメントへのリンクとともにSVNに保持されます。仕様を変更すると、SVNが更新され、関係者に通知されます。もちろん、どこかにある共有フォルダに手動で保存することもできます。

それは多かれ少なかれ私のプロセスです。デザインに関してなされたあらゆる小さな決定を文書化したいと思うかもしれませんが、私たちは間違いなくそれをしません。すべきではない、と言っていない、私はそれがどこに役立つかわかりました。私たちは通常、なぜではなく、常に方法を文書化していると思います。


おそらく各質問にも対処する必要がありました:)

あなたが計算をしているなら、多分エクセルで?または、紙の上で、結果と方法が回路の理解と設計に重要であると考えている場合、設計仕様の適切なセクションにそれらを含める必要があります。それはあなたの手描きの写真を撮ることを意味する場合でも:)

なぜこのコンポーネントを選択したのですか? 機能仕様はこれに適した場所だと思います。夢中になる必要はありませんが、それが何の利点であるかについての簡単な説明です。重要なコンポーネントのためにこれを予約します。たとえば、プルアップ抵抗を選択した理由を説明したいとは思わないでしょう。

このコンポーネントにこれらの特定のパラメーターを選択した理由/方法 これを上記と組み合わせます。

回路のこの部分は何をしますか? これは機能仕様の一部になります。この質問を正当化するのに十分なほど回路が重要な場合は、仕様の独自のセクションが必要です。

このコンポーネントの消費電力はどのくらいですか? 電源について話している場合は、これを電源セクションに入れてください。回路図でもこれを書き留めておきます。本当に私のすべての部品はデータベースから来ており、回路図はそれらに直接リンクされているので、パラメーター、データシートなどを簡単に見ることができます。

この回路の総消費電力はいくらですか? これは仕様の電源セクションに属していると思います。

このコンポーネントを他のコンポーネントに置き換えることはできますか?このコンポーネントと同等のコンポーネントはありますか?など これは私があなたのBOMに属しているか、製造に使用するものは何でもプロセスだと思います。代替部品は、調達を容易にすることです。繰り返しになりますが、これはすべて部品データベースからのものです。


私は自分のデザインを文書化する必要があることに気づきました(そのため質問です)が、それを行う良い方法がわかりません。テキストファイルにメモを書きますか、回路図に直接メモを書きますか。紙にメモを書き、スキャンしますか。設計決定ノートを設計と同期させるにはどうすればよいですか?また、ノートには実際に何を含める必要がありますか?あなたのために働くドキュメンテーション方法は何ですか?
m。アリン

1
@ m.Alin SHGは私のように動作しているようで、回路図を作成する前に仕様ドキュメントを作成しています。このドキュメントには、回路に関する詳細な要件、システム全体に関する情報、主要な決定の背後にある理由などが記載されている必要があります。これはプロの設定に行く方法ですが、自宅でデザインをしている場合は、ノートブックなどで逃げることができます。私は通常で私の仕事サーバー上のフォルダを保つ
I.ウォルフ

1
部屋が足りなくなった...-仕様書、テスト文書、システム全体のブロック図、重要な部品のデータシートなど。プロジェクトフォルダー内の1つのサブフォルダー(計画/仕様フォルダー)にすべてあります。別のフォルダに、回路図、PCBレイアウト、および関連するアセンブリ/製造ドキュメントがあります。理想的には、誰かが1つのドキュメントから必要な情報をすべて取得できるようにしたいが、データシートや詳細なテスト情報/計算が必要ない場合があります。
I.ウルフ

インラインのプロセスに関するコメントを追加
Some Hardware Guy

4
重要なドキュメントのバージョン管理を使用するための+1。一人の自営業のエンジニアであっても、誰もが使用する必要があります。
リオールビリア

5

私は多くのクイックターンデザインを行い、言わなければならない:回路図に注釈を付けることは、断然最も便利なことです。私のデザインが2枚または3枚以上のA4シートになることはめったにないので、デザインの決定の量は限られています。設計上の決定の多くは、ほとんど自動的に行われます。すべてのパーツの理由をリストする必要はありません。主要な部品は1つまたは2つだけで、フィルターやセンシングの受動的なサイズ設定も可能です。残りは、経験豊富な設計エンジニアであればすぐにわかることです。

最後の質問として、代替部品は一般に設計上の決定ではなく、調達の決定であるため、調達ワークフローの一部です。私の場合、代替部品は私の部品プロパティにあり、在庫が主要部品または供給元でなくなると自動的に供給されます。

大規模な設計やシステム設計では、デザインドキュメントテンプレートでGoogleドキュメントを使用する傾向があります。

要約すれば; 個人的には、コンパクトなワークフローが最終的に成果を上げると考えています。設計情報(基本的な回路図およびレイアウトファイルとは別のシステム設計、設計決定文書、ソース文書)を含む多数の個別のファイルがあると、多くの(精神的な)混乱が生じ、設計を確認するたびにコンテキストを切り替える必要があります決定。すべてを1か所にまとめるとうまくいきます。回路図が乱雑に見えるようになった場合、これはこのワークフローの問題ではなく、デザインをより適切に区分するか、より多くのシートを使用するか、より大きなシートを使用する必要があることを意味します。


3
通常、少なくとも専門的な設定では、仕様文書を用意することをお勧めします。たとえば、ヒューズ値を選択した理由を知りたい場合、私の出力が50uSで700mA、3sで300mAを消費することを知っておくとよいでしょう。この情報は、実際に配置する必要があるのはヒューズの定格だけですが、ある時点で必要になる可能性がある回路図を混乱させています。また、1つのレギュレータで6つのサーボが動作している状況もあり、同時にいくつのモーターが動作するかを知る必要があります。再び必要なものがありますが、回路図にはありません。
I.ウルフ

1
もちろん、意見は異なります。私が言っているのは、私のベルトの下に200以上のデザインがあると、これが本当にうまくいくということです。「プロフェッショナル」は厳密なプロトコルと方法論を意味する必要はありません。比較的小さな設計(これは私が行うことの大部分)でうまく機能します。より大きなデザイン、特にコラボレーションデザイン(最近では非常にまれです。RaspberryPiのようなものでさえ、同じ男がデザインしてレイアウトしています)には、もう少しボイラープレートが必要です。
user36129

4

私の小さなプロジェクトの多くでは、通常、サブサーキットの周りに単純な緑のラベルと境界線を配置しています。大規模なプロジェクトの場合、一部のeCADソフトウェアでは、ブロック図から構築することができます。各シートでは、単一のブロックについてさらに説明しています。問題を分解し、トレードオフを管理する技術があります(それが私見です)。アナログフィルタリングなどのコンポーネントを選択するための明確な分析がある場合、カットオフ周波数とフィルタータイプに注意します(例:ローパスフィルター(f_c = 100Hz))

私が時間に遭遇する一般的なブロックには、次のものが含まれます:

  • 電源管理(電圧レギュレータ、逆極性保護、TVSダイオード、電源スイッチ、バイパスキャップなど)
  • MCU(マイクロコントローラー、プログラミングヘッダーまたはパッド、チップバイパスキャップ)
  • インジケーター(LED、ELワイヤー、7セグメントディスプレイ、vibモーターなど)
  • 特定の機能の検知(電流検知、タッチ検知、GSR、アクティビティ、環境検知など)
  • デバッグ通信(フェライトビーズ、USB、I2C、UART、SPI、情報を取得する何らかの方法)
  • 無線(多くの無線のすべてのサポートコンポーネント)
  • ビデオ(カメラのすべてのサポートコンポーネントとチップ)
  • 外部ストレージ(外部フラッシュ、設定を保存するためのEEPROMチップなど)
  • デザインに固有のその他の機能

これらのサブブロックが明確に整理されラベル付けされているので、通常は数分で回路図を消費できます。


3

私はデザインノートを保管し、ニーズ/要望を注意深く文書化します。最も初期のプロトタイプについては、部品の選択を行い、すべての実際の決定についてメモします。その後の変更については、かなり正式なFMEAプロセスを使用して、変更を正当化するために、どのニーズが満たされていないかを文書化します。

これについて十分に厳密であれば、必要に応じてすべての設計変更(ハードウェア、ソフトウェア、メカニック)を追跡できます。

すべてのもののすべてのバージョンは、Subversionを使用して追跡されます。

これは、設計履歴ファイルの重要なコンポーネントになる可能性があり、FDAにとって必須です。


3

私はよく基調講演を使用しました(PowerPointを使用することもできます)。これには、SPICE GUIなどのシミュレーションソフトウェアのスクリーンキャップを使用できるという利点があります。

私にとって本当に重要なのは、データシートからスニペットをドロップし、マークアップして、設計上の決定における相対的な重要性が現れるようにする機能です。また、初期の回路基板またはブレッドボードの写真や、デザインの選択に使用した記事へのリンクを含めることもできます。

また、紙に鉛筆を使って数学や絵を描きたいと思うことがあります。携帯電話で写真を撮り、再入力せずに基調講演にドロップします。短い方程式の場合は、LaTeXを使用してドロップインすることもあります。

また、オクターブなどの科学ソフトウェアによって描画されたプロットを含めることもできます。

最近では、特に計算量の多いタスクの場合、IPythonノートブックでこの作業の一部を選択することがありますが、物理設計のためだけに、回路設計用には特に行っていません。

最後に、Keynotes / Powerpointsは簡単に他の人に見栄えを良くしたり、PDFとしてエクスポートして技術者以外の/少ない技術者に配布したりできます。


3

回路図にエンジニアリングノートを配置し、必要に応じてさらにシートを作成します。私の世界では、1/2の焼き付けられたデザインをしばらく見直さなければならず、別のデザインを拾い上げている間にバックバーナーに再び置く必要があるかもしれないので、私は常にすべての回路図にエンジニアリングノートを配置します。非常に流動的な設計フロー。これらのEEノートは、私と他の人が少しの労力で設計意図を取り戻すのに役立ちます。また、異なる色のテキスト/グラフィックスを使用して、重要性またはコンテキストを示します。以下の例...ここに画像の説明を入力してください

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.