Bagaimana Anda menulis blog teknis? [Tutup]

Saya biasanya membaca banyak tentang pemrograman hal-hal terkait. Ketika topik yang saya baca tidak terkait dengan pekerjaan saya secara langsung, (katakanlah membaca tentang beberapa Algoritma yang tidak saya gunakan dalam pekerjaan sehari-hari), saya lupa mereka.

Salah satu cara untuk memperkuat apa yang telah dipelajari adalah menulis blog. Saya seorang pemula dalam menulis blog. Ketika saya mulai menulis, saya menemukan bahwa itu sangat sulit. Bahkan sekadar mereproduksi konten membutuhkan waktu sekitar dua jam. Menulis pemikiran yang baik tentang blog seringkali membutuhkan waktu sehari penuh atau terkadang akhir pekan.

Apakah ini normal? Adakah tips untuk menulis tutorial teknis / blog teknis?

Menulis itu sulit, menulis yang baik bahkan lebih sulit. Hal tentang mencoba menjelaskan sesuatu adalah bahwa hal itu membutuhkan lebih banyak pengetahuan daripada hanya "agak mengetahuinya". Saya menemukan bahwa dengan blogging saya 1. mencari tahu topik terkait yang perlu saya pahami, 2. mengidentifikasi di mana pemahaman saya dangkal

Bacalah slide ini http://www.ai.uga.edu/mc/WriteThinkLearn.pdf . Mereka banyak menjelaskan tentang menulis (dan bahkan membandingkannya dengan pemrograman)

Setiap pekerjaan yang berkualitas membutuhkan waktu dan upaya. Itu yang diharapkan.

Beberapa tulisan blog saya yang lebih lama membutuhkan waktu sekitar 3 minggu untuk selesai. Anda menulis konsep, membaca ulang, membuat koreksi yang diperlukan, memindai lagi lalu membacanya. Ini membutuhkan waktu.

Satu ide sederhana bagaimana membuat diri Anda termotivasi. Jika Anda merencanakan sesuatu yang besar, pertimbangkan apakah akan masuk akal untuk membagi pekerjaan menjadi 2-3 bagian dan menerbitkannya secara terpisah. Bagian-bagian perlu tentu saja berguna bagi pembaca Anda sendiri. Kemudian karena mereka mengambil lebih sedikit waktu Anda lebih mungkin untuk berhasil dan menyelesaikan pekerjaan parsial.

Beberapa tips dari blogger teknis yang tidak dikenal ini:

• Verifikasi (bukan hanya membaca) kode yang Anda masukkan dengan memotong dan menempelkan dari pratinjau ke baris perintah atau file teks untuk menjalankan. Beberapa hal (seperti ujung baris, lekukan, dan karakter Unicode) dapat kacau ketika mentransfer dari editor (atau shell) ke halaman web dan kembali.
• Dapatkan manusia untuk memeriksa ejaan, tata bahasa, dan konten - Ini menunjukkan bahwa beberapa upaya dilakukan untuk membuat artikel yang benar dan mudah dibaca. Jika tidak ada orang di sekitar Anda, pastikan untuk membaca kembali seluruh artikel sebelum diterbitkan.
• Jika platform blogging memiliki penyorotan sintaksis , gunakan itu. Jika tidak, kirim kode di suatu tempat yang memilikinya dan tautkan di sana.
  • Konsekuensi: Jauhkan potongan kode yang sangat besar dari teks artikel. Ini agak kabur, tetapi jika teks menjelaskan cara kerja beberapa kode, boleh saja menyertakan cuplikan. Jika menghadirkan perangkat lunak untuk diunduh, lebih baik merujuk ke antarmuka web VCS.
• Setiap artikel harus dapat dibaca sendiri . Merujuk artikel lain baik-baik saja, tetapi jangan hanya berasumsi bahwa pembaca telah membaca tulisan lain sebelum ini.
• Gunakan format lain selain teks ketika mereka membantu pemahaman. Untuk beberapa hal, kodenya cukup, tetapi untuk beberapa gambar atau bahkan animasi mungkin jauh lebih mudah dipahami.

Seringkali saya menemukan bahwa posting blog yang sulit membutuhkan waktu lama karena memerlukan penelitian; penelitian itu tidak hanya membantu posting blog Anda, tetapi membantu Anda membangun pengetahuan pribadi Anda sendiri dalam prosesnya. Seperti yang Anda katakan, Anda memperkuat pengetahuan dengan menulis posting; Anda juga memperluas pengetahuan Anda. Rangkullah waktu yang dibutuhkan dan nilai itu sebagai pengalaman belajar.

Ya, wajar jika penulisan blog teknis membutuhkan waktu. Bagi saya, penulisan membutuhkan waktu paling singkat (sesingkat satu jam, atau hingga satu hari, tergantung pada lamanya). Kemudian pengeditan dan penulisan ulang biasanya memakan waktu lebih lama (hingga dua atau bahkan tiga hari). Aspek lain yang telah disebutkan yang membutuhkan waktu adalah mengklarifikasi kode sampel. Saya juga suka menghabiskan waktu mencari tautan pendukung untuk topik saya. Itu semua butuh waktu!

Saya kira Anda bisa menulis blog teknis sekarang. Tetapi saya menyarankan Anda untuk melakukannya ketika Anda menjadi ahli dalam beberapa domain tertentu. Menghabiskan akhir pekan sepertinya tidak terlalu banyak waktu. itu semua tergantung pada kompleksitas topik. Saya kira apa yang saya katakan adalah bahwa inti dari ide Anda seharusnya datang kepada Anda secara alami Eksekusi mungkin (dan akan) memakan waktu lebih lama.

Orang mencari beberapa saran ahli di blog .. bukan eksperimen noobs. tetapi saya berbicara dalam pengertian umum .. Saya tidak ingin membuat Anda takut untuk menulis blog. Tetapi ingatlah hal-hal berikut ini.

1. Blog Anda harus mengatakan sesuatu yang baru. Jangan hanya mengumpulkan data dan memasangnya di blog Anda sendiri

2. Benar-benar yakin tentang apa yang Anda katakan yaitu menempel hasil empiris yang kuat atau sangat diuji konsep atau hal-hal yang Anda harus berpengalaman tangan pertama .

3. Bersiaplah untuk kritik.

4. Pelajari teknik menulis blog (ketepatan, keringkasan, dll)

5. Menulis sesuatu karena Anda pikir itu harus ditulis; bukan karena Anda pikir itu akan dibaca.

Elemen Gaya

Saya pikir penulisan teknis mengikuti banyak aturan yang sama seperti penulisan apa pun. Jika Anda hanya membaca satu buku tentang menulis, itu harus Strunks klasik "The Elements of Style" . Itu melewati daftar hal-hal yang akan meningkatkan komposisi Anda, yang paling utama (IMO), "Abaikan kata-kata yang tidak perlu".

Saya juga merekomendasikan karya Stephen King " On Writing ". Sementara menjadi lebih lanjut tentang penulisan fiksi masih mengandung banyak permata untuk setiap penulis yang bercita-cita tinggi, terutama di bidang-bidang seperti mengedit dan proses penulisan.

Yang mengatakan hal yang sulit tentang penulisan teknis bukanlah penulisan yang sebenarnya tetapi mengklarifikasi pikiran Anda tentang hal yang Anda tulis. Pemikiran yang kacau menyebabkan tulisan yang buruk. Menulis yang baik mengharuskan Anda memiliki pemahaman yang jelas tentang topik Anda, itulah sebabnya mengajar dan menulis adalah cara yang sangat baik untuk menguasai suatu subjek.

Yah, saya butuh banyak waktu untuk menulis posting blog, ya. Saya sering menulisnya selama beberapa hari, atau bahkan meninggalkannya dalam bentuk draft selama beberapa minggu, sesekali membacanya lagi dan mengoreksi dan mengubah sedikit di sana-sini.

Butuh waktu, tetapi jika itu harga untuk menulis sesuatu yang saya tidak malu setelahnya, saya pikir itu layak.