Nasihat untuk penulisan teknikal

Panduan ini menyusun nasihat dan pandangan mengenai penulisan teknikal, terutamanya untuk teknologi web dan blog, menarik dari profesional yang berpengalaman dan pengalaman peribadi.

Memilih topik anda:

Topik yang ideal adalah salah satu yang anda sukai dan secara peribadi melabur. Semangat anda akan bersinar. Sebagai Chris Coyier dengan bijak menasihatkan: "Tulis artikel yang anda inginkan apabila anda googled sesuatu." Walaupun penulisan berasaskan tugasan boleh menjadi produktif, sambungan peribadi meningkatkan kualiti.

Tulis sementara pengetahuannya segar:

Masa terbaik untuk menulis adalah segera setelah mempelajari sesuatu yang baru. Pengalaman masih jelas, membolehkan anda menyampaikan "sebelum" dan "selepas" pemahaman. Malah, nota cepat mengenai proses pembelajaran anda boleh menjadi sangat berharga kemudian. Pertimbangkan pendekatan "hari ini saya belajar" (TIL), seperti yang dicontohkan oleh Manuel Matuzovic.

Perbandingan leverage:

Teknik yang kuat dan kurang dimanfaatkan membandingkan teknologi baru dengan yang biasa. Rachel Andrew mencadangkan menerangkan teknik JavaScript moden kepada seseorang yang biasa dengan jQuery, merapatkan jurang antara yang baru dan yang diketahui. Pendekatan ini menghubungkan yang tidak dikenali dengan asas yang difahami dengan baik.

Membuat pengenalan yang menarik:

Satu perangkap biasa gagal menyatakan dengan jelas tujuan artikel dan penonton sasaran awal. Rachel Andrew menekankan pentingnya pengenalan ringkas yang segera menjelaskan subjek dan pembaca yang dimaksudkan. Brian Rinaldi menambah bahawa perenggan pengenalan yang ditulis dengan baik dapat menentukan sama ada pembaca berterusan.

Tajuk yang jelas dan ringkas:

Erin Kissane menganjurkan untuk tajuk yang jelas, deskriptif, mengutamakan kejelasan melalui clickbait. Tajuk yang jelas seperti "Bermula dengan Graphql, Phoenix, dan React" jauh lebih tinggi daripada yang samar -samar, clickbaity. Faedah kejelasan kedua -dua pemahaman pembaca dan SEO.

Seni Outro:

Ben Halpern menyoroti kepentingan perenggan yang menyimpulkan, selalunya bahagian paling banyak dibaca selepas pengenalan. Walaupun ringkasan yang mudah ("Beritahu 'em apa yang anda katakan' em") adalah berkesan, kesimpulan yang baik memperkuat mesej dan memberikan penutupan.

Meningkatkan kebolehkerjaan:

Brian Rinaldi menekankan pentingnya memecahkan blok besar teks untuk meningkatkan kebolehbacaan. Teknik termasuk menggunakan subheadings, senarai, imej yang relevan dan tangkapan skrin, grafik ilustrasi, video ringkas, blok kod, jadual, dan bahagian yang dilipat dengan baik menggunakan <details>/<summary></summary></details> . Penggunaan strategik elemen reka bentuk seperti jarak, warna, dan penjajaran terus meningkatkan kebolehpasaran.

Suara aktif dan pilihan perkataan:

Katy Decorah dan Neal Whitman menekankan pentingnya menggunakan suara aktif ("pelayan memproses permintaan") bukannya suara pasif ("permintaan diproses oleh pelayan"). Elakkan kata -kata seperti "adil," yang boleh merendahkan diri dan sering tidak perlu.

Mengekalkan nada dan suara:

Nada (bagaimana anda mengatakan sesuatu) harus sejajar dengan konteksnya. Nada yang mesra, berwibawa, mengalu -alukan, dan bersyukur umumnya sesuai untuk penulisan teknikal. Suara (keperibadian anda) harus tetap konsisten, walaupun semasa menyesuaikan nada untuk situasi yang berbeza.

Menguruskan Panjang:

Penulisan teknikal sering mengalami panjang yang berlebihan. Wade Christensen mengesyorkan pendekatan penyuntingan kejam. Walaupun jawatan yang terlalu pendek juga bermasalah, kejelasan dan kegunaan harus menjadi tumpuan utama, bukan kiraan perkataan. Memecahkan jawatan yang panjang ke dalam siri hanya perlu dilakukan jika bahagian-bahagiannya berbeza dan mandiri.

Mengatasi blok penulis:

Ketakutan dan keraguan diri adalah halangan umum untuk blogging teknikal. Max Böck mencadangkan penerbitan sebaik sahaja mata penting dilindungi, mengabaikan suara "tidak siap". Jeremy Keith menasihatkan untuk menjaga draf, kerana mereka sering belum selesai. Ingat, walaupun sumbangan kecil boleh membantu (Matthias Ott). Ali Spittel menunjukkan bahawa pemula mempunyai perspektif yang berharga.

Gaya dan kreativiti:

Sara Soueidan menekankan bahawa tidak ada gaya penulisan yang sempurna. Jadilah diri sendiri dan biarkan keperibadian anda bersinar sambil mengekalkan kejelasan. Eksperimen dengan format kreatif, seperti perbualan anotasi atau siri video.

Kandungan yang berfokus pada pemula:

Walaupun web dipenuhi dengan kandungan peringkat pemula, jawatan pengenalan yang ditulis dengan baik boleh menonjol. Kejelasan adalah sangat berharga untuk semua tahap kemahiran.

Contoh dunia sebenar vs abstraksi:

Christine menekankan pentingnya contoh-contoh dunia nyata untuk menggambarkan konsep kompleks. Walau bagaimanapun, elakkan contoh yang menjejaskan kejelasan. Abstraksi boleh menjadi kuat apabila digunakan dengan berkesan.

Faedah blog:

Blogging meningkatkan prospek kerjaya, menunjukkan kepakaran, dan meningkatkan pemahaman. Khoi Vinh menggambarkan blog sebagai "penguat."

Amalan dan peningkatan:

Penulisan dan penerbitan yang konsisten adalah penting untuk penambahbaikan. "Menulis dengan Stakes" (secara terbuka berkongsi kerja anda) adalah kaedah pembelajaran yang paling berkesan.

Mencari Suara Anda:

Mulakan dengan hanya berkongsi pengetahuan anda. Tingkatkan penulisan anda dengan menggabungkan pengalaman peribadi, memetik orang lain, dan menjalankan penyelidikan.

Posting Tetamu:

Jika melangkah ke tapak, semak semula garis panduan mereka dengan teliti.

Alat berguna:

Kertas Dropbox untuk kerjasama dan tatabahasa untuk pembacaan bukti adalah alat yang dicadangkan.

Atas ialah kandungan terperinci Nasihat untuk penulisan teknikal. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!