Bagaimana membuat dokumentasi perangkat keras?

10

Saya sedang membuat beberapa slide untuk kelas saya tentang bagaimana kita harus mendokumentasikan perangkat keras yang kita kembangkan.

Saya ingin membuat daftar dokumen yang harus kita buat ketika membangun beberapa perangkat keras. Saya terinspirasi pada dokumentasi perangkat lunak UML, yang membawa banyak jenis dokumen untuk hampir setiap situasi.

Dari pengalaman dan penelitian saya, banyak proyek hanya memiliki skema, tata letak dan bill of material. Saya pikir kita juga harus menambahkan informasi tentang motif (persyaratan) yang mengarahkan kita dalam memilih satu mikrokontroler dan bukan yang lain. Ada juga beberapa informasi mengenai tata letak yang tidak kita tulis, sebagai posisi komponen khusus yang tidak boleh diubah.

Itu dikatakan:

  • Bagaimana kita harus mendokumentasikan perangkat keras kita?
  • Dokumen penting apa yang ingin Anda miliki jika Anda perlu melakukan perbaikan / perubahan pada perangkat keras orang lain yang belum pernah Anda lihat?
  • Bagaimana mengatur informasi ini dengan jelas?
documentation RMAAlmeida
sumber
1
Saya pikir pertanyaan tentang kiriman ini memiliki saran hebat tentang apa yang perlu diberikan untuk sepenuhnya menyerahkan hasil proyek desain yang terkait dengan perangkat keras.
Kortuk
Foto !!!! Sejumlah besar konten informasi dan kepadatan informasi jika digunakan dengan baik.
Russell McMahon
Terima kasih Kortuk. Itu adalah jenis informasi yang saya cari, tetapi saya masih berpikir bahwa kita memerlukan lebih banyak informasi tentang bagaimana proyek itu dikembangkan dan mengapa insinyur mengambil beberapa keputusan.
RMAAlmeida

Jawaban:

3

Saya sangat setuju dengan paragraf ketiga Anda. Terlepas dari hal-hal yang jelas seperti skema, BOM dll ada hal-hal yang kurang nyata seperti, seperti yang Anda katakan, mengapa Anda memilih komponen tertentu dan sama pentingnya, mengapa Anda tidak memilih komponen yang mungkin lebih jelas.

Sekarang saya mungkin menunjukkan usia saya di sini tetapi saya masih suka menggunakan buku catatan bersampul keras untuk merekam proses pemikiran saya & keputusan desain - bahkan yang salah. Jika seseorang di masa depan mencoba untuk mengganti komponen dengan yang lebih 'cocok' atau memindahkan trek pada PCB, catatan saya mungkin mengatakan kepada mereka bahwa saya sudah berada di sana dan membakar jari saya (mungkin secara harfiah!).

Saya selalu memberi nomor halaman dan membiarkan beberapa halaman di depan sebagai daftar isi. Anda juga dapat mendokumentasikan hal-hal seperti penghilangan daya, toleransi, pewaktuan, dll. (Kebiasaan ini berasal dari hari-hari saya di industri dirgantara di mana menyimpan buku catatan adalah wajib). Tentu saja Anda selalu bisa memasukkan informasi ini dalam dokumen WP tetapi saya akan tetap berpegang pada kertas!

Deskripsi rangkaian mungkin juga sesuai untuk sirkuit yang tidak biasa (terutama analog). Saya akan memperlakukan komentar perangkat lunak seperti ini untuk mendokumentasikan sirkuit atau komponen fungsi yang tidak terlihat. Skema, seperti perangkat lunak harus 'mendokumentasikan diri sendiri' sejauh mungkin tetapi kadang-kadang ini tidak cukup.

Alternatif yang lebih mutakhir, terutama di lingkungan pendidikan, mungkin memiliki situs web proyek. Ini dapat diatur sebagai kumpulan blog untuk setiap disiplin - desain perangkat keras, tata letak pcb, perangkat lunak dll. Sifat blog akan memungkinkan kontributor untuk menunjukkan alur pemikiran mereka dan mendokumentasikan kemajuan proyek yang sedang berlangsung sementara halaman lain dapat lebih formal (kemajuan Gantt chart, hasil tes, dll). Anda bahkan dapat menambahkan menit rapat dan daftar tindakan. Hyperlink memudahkan referensi silang dan sekarang kami memiliki MathJax sehingga persamaan desain pun mudah disisipkan.

MikeJ-UK
sumber
Ada alat online yang jauh lebih baik untuk tujuan ini daripada kumpulan blog. Di tempat kerja, kami (~ 500 insinyur) menggunakan manajemen proyek Redmine untuk wiki, pelacakan bug, dan alat kontrol versi, tetapi ada banyak alternatif . Di sekolah, kami menggunakan Google Sites dan Documents.
Kevin Vermeer
@Kevin Vermeer - Paragraf terakhir ditambahkan sebagai renungan - saya belum pernah bertemu Redmine sebelumnya, tetapi kelihatannya bagus untuk tujuan ini karena tampaknya jauh melampaui manajemen proyek dasar. Banyak alat yang bagus dalam satu atau dua bidang dan kurang dalam yang lain.
MikeJ-UK
Untuk proyek apa pun yang melibatkan desain, notebook lab harus dipelihara, berisi catatan tertulis, menyoroti mengapa pilihan dibuat, direkam dalam skema, tanda tangan saksi berkala .... Hal-hal semacam ini membuat pengacara kekayaan intelektual senang, dan juga mendokumentasikan semacam hal-hal yang dibicarakan OP
Scott Seidman
2

  • Bagaimana kita harus mendokumentasikan perangkat keras kita?

  • Dokumen penting apa yang ingin Anda miliki jika Anda perlu melakukan perbaikan / perubahan pada perangkat keras orang lain yang belum pernah Anda lihat?

  • Bagaimana mengatur informasi ini dengan jelas?

Di perusahaan kami, kami diharapkan untuk menulis dokumen deskripsi desain perangkat keras. Ini cukup mudah: Anda menjelaskan di awal apa yang seharusnya dilakukan sirkuit, dan kemudian menjelaskan secara terperinci di setiap bagian. Setiap nilai komponen seharusnya dibenarkan dalam beberapa cara: jika Anda memiliki "standar" pullup atau resistor seri, mereka harus disebutkan dalam catatan di awal (misalnya "kapasitor bypass 10K dan kapasitor bypass 0,1uF digunakan kecuali dinyatakan sebaliknya") , jika tidak, pilihan untuk nilai komponen perlu dijelaskan. mis. "4.7K dan 0.1uF RC filter (tau = 0.47msec) digunakan untuk membatasi komponen frekuensi tinggi" atau "NLAS4051 multiplexer digunakan untuk kebocoran rendah - node rangkaian ini sensitif".

Jason S
sumber