Cara Menulis Dokumen Desain yang Baik

• Dokumen desain adalah laporan teknis yang merangkum strategi implementasi, batasan, dan trade-off dari sebuah sistem
• Dokumen desain berperan untuk meyakinkan pembaca bahwa desain tersebut cocok untuk situasi yang dihadapi
• Susunan dokumen itu penting, dan alur yang logis harus membuat pembaca tidak merasa terkejut oleh isinya
• Melalui penyuntingan, kita perlu mengurangi kata-kata yang tidak perlu dan menghemat sumber daya konsentrasi pembaca
• Penggunaan paragraf pendek dan lampiran, serta peningkatan kemampuan menulis dokumen melalui latihan, sangat penting

---

Definisi

• Dokumen desain adalah laporan teknis yang merangkum strategi implementasi sistem dalam konteks trade-off dan batasan

Tujuan

• Dokumen desain bertujuan meyakinkan pembaca bahwa desain tersebut optimal, seperti halnya pembuktian dalam matematika membuat sebuah teorema dapat diterima
• Dalam proses desain, kegiatan menulis itu sendiri meningkatkan ketelitian berpikir
• Dengan menulis dokumen desain, gagasan yang samar bisa diubah menjadi pemikiran yang konkret

Pengorganisasian

• Susunan dokumen desain yang baik sama pentingnya dengan pengorganisasian kode
• Seperti pemula yang menulis kode, banyak orang cenderung membuat 'dokumen desain spaghetti'
• Jika kalimat hanya disusun tanpa urutan logis, pembaca akan sulit mengikuti konteks dan menjadi bingung
• Dokumen yang sempurna harus memiliki alur yang alami sehingga pembaca tidak terkejut, dan setiap kalimat harus berlanjut secara wajar berdasarkan isi sebelumnya
• Tujuannya adalah memahami keadaan berpikir pembaca lalu membimbingnya secara bertahap ke keadaan yang baru
• Keberatan yang bisa diperkirakan harus diselesaikan lebih dulu; penjelasan harus datang sebelum pembaca sempat mengajukan sanggahan

Penyuntingan

• Setelah isi tertata dengan baik, tahap menghapus kata-kata yang tidak perlu (penyuntingan) menjadi penting
• Konsentrasi pembaca adalah sumber daya yang terbatas, sehingga informasi yang tidak perlu harus dibuang dengan tegas
• Dari draf awal, sekitar 30% ungkapan yang tidak bermakna bisa dikurangi
• Dengan menyunting dokumen orang lain dan melatih sudut pandang kritis, kita juga bisa merapikan tulisan sendiri dengan lebih efisien
• Berlatih dengan tweet pendek (batas 280 karakter) juga membantu menyederhanakan pemikiran dan meningkatkan kemampuan merangkum

Pengalaman dan Latihan

• Tidak ada jalan pintas yang lebih baik untuk meningkatkan kemampuan selain latihan berulang
• Pengalaman dengan budaya kerja yang berpusat pada dokumen di Amazon sangat membantu meningkatkan kemampuan menulis dokumen
• Dalam rapat penting, digunakan cara membagikan dokumen desain sepanjang 1–6 halaman terlebih dahulu, lalu semua orang membacanya dalam diam dan menuliskan pendapat di margin
• Dengan menerima umpan balik, kemampuan menulis dapat ditingkatkan secara nyata

Tips Konkret

Gunakan paragraf pendek

• Dokumen desain harus membangun alur dengan bullet point yang ringkas dan berurutan
• Setiap bullet point (observasi, ide, masalah, perbaikan, dan sebagainya) disusun sebagai paragraf pendek yang berfokus pada satu konsep
• Setiap paragraf harus cukup jelas untuk diringkas menjadi satu kalimat; ini membantu menghemat sumber daya memori jangka pendek pembaca

Manfaatkan lampiran

• Perhitungan yang rumit atau hasil simulasi sebaiknya dirapikan secara rinci di lampiran, bukan di isi utama dokumen, dan cukup disebutkan secara singkat dalam bentuk catatan kaki di bagian utama
• Lampiran tidak wajib untuk memahami kesimpulan utama isi dokumen, tetapi disediakan agar pembaca yang penasaran bisa merujuknya

Contoh penyuntingan

• (Sebelum disunting, paragraf bertele-tele):

  Setiap bullet point harus menjadi paragraf terpisah dalam dokumen. Setiap paragraf harus bisa diringkas menjadi satu kalimat. Tidak harus benar-benar hanya satu kalimat, karena penjelasan tambahan bisa dimasukkan untuk menjelaskan konsep. Namun, setelah membacanya, pembaca tetap harus bisa merangkumnya menjadi satu kalimat.

• (Sesudah disunting, paragraf yang dipadatkan):

  Setiap bullet point harus berupa satu paragraf yang bisa diringkas menjadi satu kalimat. Tidak harus benar-benar hanya satu kalimat, dan bila perlu penjelasan tambahan bisa ditambahkan. Namun setelah dibaca, isinya harus tetap bisa dipadatkan menjadi satu kalimat.

Penutup

• Dokumen desain adalah proses penting untuk membangun kemampuan melalui ketelitian berpikir, alur logis, penyuntingan yang berpusat pada pembaca, dan latihan berulang