10 petua mengenai cara untuk mendokumenkan rekaan dengan betul supaya orang lain dapat mengikuti

"Marching to Zion" Full Movie with subtitles (Julai 2019).

$config[ads_text] not found
Anonim

Oleh itu, anda ingin membuat peranti elektronik, tetapi adakah anda tahu apa yang diperlukan untuk menjadi seorang pereka profesional? Petunjuk: Ini bukan hanya kemahiran reka bentuk yang baik.

Oleh Richard Quinnell, editor-in-chief

Tanya kebanyakan pemaju elektronik apa yang mereka lakukan untuk hidup dan, kebanyakan masa, anda akan mendapat jawapan menerangkan jenis produk yang mereka usahakan. Tetapi kebenaran perkara itu jauh lebih biasa. Penyampaian yang paling penting pada akhir perkembangan produk bukanlah prototaip perkakasan atau perisian aplikasi. Ia adalah dokumentasi reka bentuk, dan mendapatkannya dengan betul boleh membayar faedah yang besar ke garisan.

Pemaju profesional adalah mereka yang membuat produk yang ditakrifkan untuk pembuatan, pengedaran, dan penjualan. Dalam kebanyakan kes, produk ini juga memerlukan penyelenggaraan lapangan, pembetulan pepijat, peningkatan, dan sokongan pengguna serta variasi produk pemijahan dan seringkali mempunyai sekurang-kurangnya sebahagian reka bentuk yang disalin dan digunakan semula dalam produk yang sama sekali baru. Tiada satu pun dari ini boleh berlaku jika reka bentuk asal tidak didokumenkan dengan betul. Pasti, ada kemungkinan untuk menterbalikkan-sesuatu jurutera tanpa mempunyai dokumentasi reka bentuk dan kemudian bergerak maju untuk terlibat dalam aktiviti-aktiviti ini. Tetapi pada masa itu, hasil pertama usaha kejuruteraan terbalik adalah dokumentasi asas reka bentuk yang sedia ada.

Cara kebanyakan projek pergi, pereka bergerak ke sesuatu yang baru apabila pembangunan selesai, meninggalkan tanggungjawab untuk semua aktiviti tindak lanjut kepada orang lain. Tetapi walaupun pereka asal dipanggil untuk membantu, kemungkinan besar pemikiran reka bentuk asal mereka telah dilupakan. Oleh itu, dalam kes yang sama, mempunyai dokumentasi yang baik akan menjadi tidak ternilai dalam mempercepatkan usaha.

Apa yang menjadi dokumentasi "layak", bagaimanapun, agak subjektif dan tertakluk kepada bias budaya pasukan pembangunan. Selain itu, terdapat banyak jenis dokumentasi yang perlu dikeluarkan daripada usaha pembangunan yang bertujuan untuk pengeluaran, termasuk, tetapi tidak terhad kepada, manual pengguna, prosedur ujian, penerangan produk dan spesifikasi reka bentuk. Kebenaran ini membawa kepada yang pertama daripada 10 elemen utama yang membentuk dokumentasi berguna:

1. Sasarkan penonton. Butiran mengenai apa yang harus mengandungi dokumen akan berbeza dengan tujuan dokumen, jadi perkara pertama yang diketahui ialah siapa dokumentasinya ditulis untuk. Tanya tentang (atau menjangkakan) keperluan maklumat mereka dan apa yang mereka akan menggunakan dokumen untuk membantu mereka mencapai. Jawapan kepada soalan tersebut boleh membantu anda memilih jenis dan berapa banyak maklumat yang perlu dimasukkan ke dalam dokumen. Dalam artikel ini, saya menganggap bahawa kita bercakap tentang menyediakan dokumentasi sistem yang diperlukan untuk membantu pemaju masa depan menyesuaikan, memperluaskan, atau menggunakan reka bentuk anda untuk memenuhi keperluan baru atau membetulkan tingkah laku yang tidak dijangka (iaitu, pepijat). Kebanyakan maklumat mentah yang diminta dalam petua berikut boleh ditangkap dalam masa nyata, seperti dalam buku nota, tetapi masih perlu disusun dan dibentangkan dalam cara yang memenuhi keperluan khalayak tertentu sebaik sahaja fasa reka bentuk selesai.

2. Mengekalkan tumpuan tugas. Tumpukan dokumentasi anda untuk membantu pembaca mencapai matlamat yang diharapkan. Salah satu cara untuk melakukan ini ialah bertanya kepada diri sendiri tentang apa yang anda ingin tahu tentang reka bentuk untuk membantu mempercepatkan kemampuan anda untuk membuat perubahan tanpa memperkenalkan akibat yang tidak diinginkan, kemudian berikan maklumat itu. Ini memerlukan lebih daripada sekadar menyatakan apa yang telah dilakukan; ia memerlukan penerangan tentang sebab-sebab di sebalik pilihan reka bentuk.

Sumber imej: Morguefile.
Dokumentasi perkakasan
3. Huraikan fungsi perkakasan dan niat. Untuk reka bentuk perkakasan, berikan pembaca dokumen dengan maklumat yang dapat membantu mereka memahami kedua-dua butiran reka bentuk dan keseluruhan struktur dan operasi mereka. Ramai pemaju memilih, contohnya, untuk mengatur skema menggunakan garis putus-putus untuk mengelilingi blok berfungsi atau subsistem (seperti modulator, pengurusan kuasa, atau perapi isyarat) atau meletakkannya pada halaman individu dan memberikan penulisan yang menangani blok ini secara individu. Mereka kemudian menyediakan gambarajah keseluruhan reka bentuk menggunakan blok yang sama dan menerangkan bagaimana blok beroperasi sebagai ensemble untuk menyediakan gambaran keseluruhan sistem. Penulisan blok individu sangat berguna kepada pemaju yang ingin menggunakan semula segmen reka bentuk dalam sesuatu yang baru.

4. Huraikan antara muka. Perincian ciri-ciri utama elektrik dan pemasaan isyarat yang masuk dan keluar dari blok fungsi, termasuk kuasa. Sekali lagi, ini memudahkan lagi penggunaan semula blok perkakasan, tetapi ia juga membantu semasa debug dan menguji dengan menunjukkan apa isyarat utama sepertinya. Sekiranya terdapat keperluan masa kritikal (seperti waktu persediaan dan pegang) atau batasan seperti impedans beban atau tahap voltan / kuasa, pastikan untuk memasukkannya. Sesetengah pemaju menyenaraikan skema mereka secara langsung dengan nota yang menunjukkan garis isyarat atau komponen tertentu yang terlibat untuk memberikan maklumat sedemikian.

5. Bincangkan pilihan komponen. Dalam banyak kes, mengapa jenis atau nilai tertentu komponen dipilih sama pentingnya dengan penempatan komponen dalam litar. Adakah terdapat sebab untuk menggunakan penghalang wayar-luka bukan komposit karbon atau seramik dan bukannya kapasitor poliester? Tidak semua komponen memerlukan justifikasi, tetapi membuat nota tentang pilihan tersebut dan sebab-sebab di belakangnya apabila ia penting. Begitu juga, jika terdapat penarafan kuasa, ciri kekerapan, keperluan dimensi, atau sebarang sebab penting lain untuk pilihan tertentu, perhatikannya. Ini akan menghalang masalah di bawah garis sekiranya seseorang dicobai (atau dikehendaki) untuk membuat penggantian untuk kemudahan atau menjimatkan kos. Nota tersebut boleh dimasukkan dalam bil bahan atau secara langsung pada skema seperti yang paling sesuai.

6. Sertakan pengiraan yang berkaitan. Dalam menangani isu-isu seperti pelesapan kuasa, tindak balas frekuensi, litar pelindung, pemalar masa, padanan impedans, mendapatkan tetapan, dan sebagainya, para pereka biasanya perlu mengira nilai yang sesuai. Memelihara pengiraan ini untuk pemaju kemudian untuk mengkaji semula dapat sangat membantu pemahaman mereka tentang fungsi dan operasi litar, terutama jika mereka ingin mengubah satu atau lebih ciri-ciri ini. Cara paling biasa untuk mengekalkan pengiraan ini adalah dalam buku nota reka bentuk (atau dokumen dalam talian) yang membolehkan para pemaju menjalankan log pemikiran mereka semasa membuat reka bentuk mereka. Buku nota itu sendiri adalah yang paling berguna kepada pereka asal untuk rujukan masa depan mereka sendiri, tetapi ringkasan pengiraan kritikal juga harus dimasukkan dalam dokumentasi sistem untuk membimbing mana-mana orang luar masa depan. Buku nota menjadikannya mudah untuk meniru maklumat tersebut ke dalam dokumen lain, walaupun tanpa perlu mengira lagi pengiraan.

Sumber imej: Pixabay.
Dokumentasi perisian
Banyak cadangan di atas digunakan untuk dokumentasi perisian, juga, tetapi dengan sedikit sentuhan. Perisian tidak perlu direka, jadi tidak ada keperluan untuk menjangka penggantian yang mungkin, dan prototaip akhir - kod sumber - juga boleh membentuk banyak dokumentasi sendiri. Tidak semua.

7. Huraikan arsitektur peringkat tinggi. Kod sumber yang dikemukakan dengan baik adalah berguna untuk pemaju kod kemudian yang cuba mengikuti logik dan pelaksanaan fungsi dan prosedur individu, tetapi ada juga perlu penerangan peringkat tinggi yang menggambarkan bagaimana bahagian-bahagian ini sesuai dengan sistem keseluruhan. Keterangan ini boleh berupa diagram alir, gambarajah negara, atau teks, dan tujuannya adalah membiarkan pemaju melihat sekilas pandang yang membuat perubahan dalam blok kod individu mungkin berdampak pada operasi sistem operasi yang lain.

8. Jelaskan pembolehubah. Bersama-sama dengan komen, blok kod harus mengandungi penjelasan ringkasan pemboleh ubah yang digunakan oleh kod, tujuannya, jenis dan dimensi mereka, dan julat nilai yang diharapkan. Nama deskriptif boleh membantu dalam menjelaskan maksud pemboleh ubah dan lebih berguna dalam membantu pemaju mengikuti logik kod tetapi tidak boleh menjadi satu-satunya huraian yang disediakan

9. Strike a balance. Einstein dikreditkan dengan berkata, "Buat perkara semudah mungkin, tetapi tidak lebih mudah." Dokumentasi kod adalah sasaran sempurna untuk nasihat itu. Keterangan panjang yang lebih panjang yang memberitahu pembangun lebih daripada yang mereka perlu tahu bukan hanya memakan masa untuk mencipta dan sukar untuk mengekalkan ketika kod berkembang, mereka juga sukar dibaca dan diserap. Mengimbangi keseimbangan yang betul antara kesempurnaan dan keringkasan boleh mencabar tetapi berbaloi.

10. Kerjasama. Satu cara untuk membantu menyerang keseimbangan yang diperlukan adalah untuk bekerjasama dengan orang lain untuk membuat dan mengkaji semula dokumentasi. Semuanya terlalu mudah bagi seseorang yang menggambarkan pemikiran reka bentuk mereka untuk melupakan bahawa orang lain tidak hidup dengan reka bentuk itu selama berminggu-minggu dan berbulan-bulan. Mempunyai orang lain melihat perkara yang seolah-olah mereka menjadi orang seterusnya yang bekerja pada reka bentuk akan membantu untuk memastikan bahawa semua maklumat yang diperlukan hadir dan mencukupi. Sebagai alternatif, bekerja dengan seseorang mahir dalam membuat dokumentasi boleh membantu menangkap niat reka bentuk.

Semua aktiviti dokumentasi ini, oleh mana-mana anggaran, memerlukan sejumlah usaha yang besar, tetapi ia dapat membayar dengan sangat baik kemudian apabila reka bentuk perlu dikemas kini, diubahsuai, tidak dapat dikendalikan, atau ditetapkan. Usaha ini juga merupakan salah satu perbezaan yang paling ketara antara reka bentuk amatur / hobi dan profesional. Bagi profesional, mewujudkan sistem yang berfungsi bukan matlamat akhir mereka. Matlamat yang sebenar adalah untuk meletakkan ke tangan orang lain satu pakej yang membolehkan reka bentuk itu dihasilkan dengan cekap, dipasang, dikendalikan, dan berkembang tanpa penglibatan pereka.

Untuk mempelajari bagaimana untuk merekabentuk dan membangunkan aplikasi kawalan motor dengan MCU NXP MagniV menggunakan reka bentuk berasaskan model, mendaftar untuk webinar percuma , yang ditaja oleh NXP

Oleh Richard Quinnell