哲学とドキュメンテーション

私がコントロールデータ（実際には子会社）で働いていたとき、すべての回路図には、昇順で並べられた単純な識別番号が付けられていました。同じことが機械図面やプリント回路基板にも当てはまりました。私はドキュメンテーション部門に雇われていましたが、私たちが取り組んでいるミニコンピューターを作成するためにそれらすべてがどのように集まったかを覚えていないことを認めなければなりません。

当時、すべてが手作業で生成されていました。回路図はスケッチされて製図部門に渡され、標準的な記号を使用してベラム（若い読者にとっては両方の概念がカーボン紙と同じくらい異質かもしれませんが、トレーシングペーパーでもあります）に置き換えられました。ステンシルを使用して均一性を実現します。専門の製図技師がドットとテープを使用してPCBをレイアウトし、機械エンジニアが製図テーブルでパッケージを作成します。オフィス内のコミュニケーションは、メモ、レポート、会議、そしてもちろん個人的なやり取りを介して行われました。 「どうだったか：RubylithからDot、TapeからCADまでのPCBレイアウト」についての思い出をブログに書きました。

コンピュータ支援設計が改善されたため、図面は紙の証跡で電子化されましたが、それは単にドキュメントに現状を実装するためのより便利な方法でした。 PCBに関する限り、回路図はネットリストを取得する方法にすぎませんでした。機械製図では、PCB出力を.dxfファイルに変換してAutocadにインポートするために1つまたは2つの手順が必要でした。さまざまなドキュメント出力を簡単に分離して分類できました。

私が取り組んでいる製品は段階的に構築されているため、サブアセンブリがあります。私たちはいつもこれに悩まされてきました。さまざまなコンポーネントを使用してさまざまなビルドがあると仮定しましょう。ドキュメント階層には、共通の前提条件である部分的なビルドが存在するポイントがあります。回路図面はどのレベルに属しますか？コンポーネント値が割り当てられていない最も初期のレベルに存在するのか、それとも選択されたコンポーネント値を示す一意の回路図が各トップレベルに存在するのか。回路図面が何に使用されているか、システムのデバッグに使用されているか、本番環境の概要を提供しているか、サービスに使用されているかによって、ある程度選択が決まる場合があります。

何年にもわたって、私の雇用主の文書化システムは一貫性がなく、無計画に進化してきました。何人かの人が影響を与えており、他の組織からの経験を持っていることを考えると、その要素は皆さんにとってなじみ深いものになると思います。私が実装しようとした最も重要な原則の1つは、航空宇宙産業からのものです。特定のドキュメントは1つしかなく、複数のドキュメントを維持するのは面倒でエラーが発生しやすいため、2か所に存在することはできません。

図1.私たちが作る少し複雑な製品の1つ。 Aの完全な製品部品表には、サイドラベル（B）、ハウジング（C）、フロントパネル（D）の図面、プラグインコネクタ、およびコネクタのラベルの図面（E＆ F）、サブアセンブリ（G）であり、図には示されていません。ファームウェアのドキュメントは、Gのマイクロにプログラムされます。パッケージも追加されます。サブアセンブリは、PCBとそれに取り付けられたすべてのコンポーネントで構成されています。階層のどこに回路図面を配置しますか？ （出典：著者）

私たちが製造するすべての製品には、「カタログ番号」と呼ばれる識別番号（ほとんどが順番に割り当てられます）があります。階層内のそのレベル（最上位）レベルのすべてのドキュメントは、文字の接頭辞、カタログ番号、およびリビジョンの接尾辞で構成されています。たとえば、カタログ番号330924の回路図（rev C）はW330924C、機械製図（ref F）はM330924F、BOM（rev G）はP330924Gになります。サブアセンブリがある場合は、独自の連続番号（SB00123など）が割り当てられ、そのレベルに必要なドキュメントには、同じ接頭辞の考え方であるSB00123-サフィックスを使用して番号が付けられます。ドキュメントは必要な場所にのみ存在し、たとえば回路図は一般的な先行詞のレベルに沈みます。ビルド間で変更される可能性のあるコンポーネント値は、部品表に値が定義されていることを示す記号でマークされています。メカニカルアセンブリとファームウェアは同じ考え方に従います。同様に、PCBは連番とリビジョンを取得します–プレフィックスはありません。

しかし、CADの世界は変化し、難問はより謎めいたものになっています。 Altiumのようなパッケージは、設計の多くの側面を統合しています。回路図、PCB、組立図、機械式、場合によってはファームウェアもすべて同じ設計環境の一部です。私たちの製図技師は、PCBは回路図の物理的な表現であると主張しているので、両方とも同じリビジョンを使用して常にロックステップにある必要があります。したがって、コンポーネントの値が変更された場合は、PCBリビジョンを変更する必要があります。職業はなんですか？それに加えて、PCBが変更されるたびに変更される回路図面、アセンブリ、および機械図面に割り当てられる番号は何ですか（シルクスクリーンの更新などの些細なことを含む）？それらは階層のどこにありますか？それらはカタログ番号またはPCB番号に関連付けられていますか？また、エンジニアが図面を更新するときに、PCBパッケージの一部として自動的に保存される図面ではなく、変更された図面から製図技師が作業するように、どこにファイルしますか？ヘルプ！

誰かが私たちのシステムを更新しようとすることができるように、現代的で一貫性があり、可能であればどこかに記述されているシステムを知っていますか？博士論文の資料を探している博士課程の学生を知っている人はいますか？以下にあなたの考えとあなたの経験の説明を追加してください。