Menulis Teknis Hebat: Waspadalah terhadap Editor Anda / cintai Editor Anda

Ikhtisar

Editor Anda harus menjadi bagian integral dari tim penulisan Anda. Jangan anggap dia sebagai hakim, melainkan sebagai sumber untuk membantu Anda dalam semua tahap proyek penulisan. Artikel ini akan membantu Anda mengatasi rasa takut editor Anda, dan bagaimana memanfaatkan editor Anda secara efektif selama proses penulisan. Baca juga artikel tentang Menulis Teknis Hebat: Buang Dua Sikap Ini.

Waspadalah terhadap Editor Anda

Beberapa perubahan yang mungkin disarankan oleh editor bisa membuat Dokumen Pengguna lebih sulit dipahami oleh Reader Anda.

Meningkatkan Tulisan Anda

Setelah editor Anda berhasil melewati tugas pengeditan dasar mekanis:

* tata bahasa

* tanda baca

* ejaan

* mengedit ke Style Sheet,

dia mungkin bekerja pada "memperbaiki tulisan Anda."

Editor Anda mungkin percaya bahwa salah satu cara untuk membuat tulisan lebih menarik adalah menggunakan sinonim saat Anda merujuk kembali ke sesuatu. Dengan demikian Anda bisa memanggil sesuatu "chip bin" di satu bagian teks Anda, dan editor Anda mungkin menyarankan menggunakan istilah yang berbeda, seperti "perangkap limbah", nanti di dokumen. Ini harus membuat tulisan Anda "lebih menarik."

Anda tidak ingin menulis menarik dalam Dokumen Pengguna Anda! Anda ingin jelas, sederhana, sangat mudah dimengerti menulis. Jika Anda membuat tulisan Anda lebih menarik dengan menggunakan sinonim ("perangkap limbah"), maka Anda memaksa pembaca Anda untuk memikirkan apakah ini adalah hal yang sama atau tidak. Sebaiknya gunakan kata-kata yang sama persis di setiap Dokumen Anda di mana Anda mengacu pada hal yang sama. Tidak ada sinonim disini

Jika Pembaca Anda ingin dihibur atau dipikirkan pikirannya, maka dia akan membaca sebuah novel.

Jangan biarkan editor Anda membuat tulisan Anda lebih menarik atau lebih pintar jika usaha tersebut membuat materi lebih sulit dipahami oleh Reader Anda.

Pengetahuan

Tempat lain untuk waspada terhadap editor Anda adalah "pengetahuan." Artinya, saat editor yang mencoba membuat Dokumentasi User anda terdengar lebih formal. Selain informasi disclaimer, legal, dan keselamatan, Dokumen Pengguna harus terdengar ramah, dengan nada percakapan.

Misalnya, seorang editor mungkin menyarankan untuk mengubah kontraksi (seperti "jangan") ke dalam bentuk yang lebih formal ("jangan"). Jangan lakukan itu Kontraksi bersifat percakapan dan tidak boleh dihindari.

Jika Anda memikirkannya, kebanyakan orang membaca Dokumentasi Pengguna untuk produk apa pun berada dalam beberapa bentuk stres:

* Mereka juga ingin terus menggunakan produk, atau

* Ada yang salah.

Dokumen resmi akan membuat Pengguna tidak aktif. Dokumen seharusnya tidak konyol atau sembrono; Namun, itu harus memberikan informasi yang dibutuhkan Pengguna dalam gaya percakapan yang mudah dipahami. Informasi yang dibutuhkan harus mudah ditemukan.

Meskipun kebanyakan pemeriksa tata bahasa word processor sangat tidak memadai, banyak dari checker ini dapat dibuat untuk memberikan skor keterbacaan (Anda mungkin harus menetapkan opsi untuk mengaktifkan fitur ini). Pengeditan harus membantu meningkatkan keterbacaan (ditunjukkan dengan penurunan tingkat nilai baca) dari dokumen. Jika pengeditan meningkatkan tingkat membaca, mintalah editor Anda mengapa skor itu telah berubah.

Apa yang harus dilakukan

Berikan editor Anda informasi yang memungkinkannya melakukan pekerjaan terbaik. Berikut adalah beberapa hal yang perlu diceritakan kepada editor Anda:

* Pendengar yang dituju untuk Dokumen Pengguna

* Beritahu editor Anda bahwa Anda menginginkan gaya informal dari User Document

* Apa gaya manual atau panduan yang akan digunakan dalam editing

Penjadwalan dan kemajuan proyek

* Format untuk berbagi dan mengedit teks (pastikan editor bisa membaca dokumen elektronik Anda - lakukan ini saat Anda menyewa editornya)

(Setiap kali Anda berurusan dengan seseorang di luar organisasi Anda, Anda harus memiliki perjanjian non-disclosure yang ditandatangani. Ini selain item kontraktual lainnya antara orang luar dan organisasi Anda.)

Kenali Editor Anda

Editor Anda BUKAN guru sekolah Anda. Di hari sekolah Anda, guru Anda-sebagai-editor adalah seorang hakim. Tujuan Anda adalah untuk mengesankan guru Anda dengan tulisan Anda. Anda bekerja untuk sebuah kelas. Dengan demikian Anda mungkin menjadi takut pada editor Anda.

Ubah pemikiranmu Sekarang, editor Anda ada di pihak Anda. Editor Anda akan bekerja sama dengan Anda untuk menghasilkan tulisan terbaik. Anda tidak perlu terlalu khawatir tentang tata bahasa. Tujuan Anda adalah untuk mendapatkan informasi "di atas kertas" sejelas dan setulus mungkin. Editor Anda akan menyarankan perubahan untuk memoles teks.

Jadi jangan takut editor anda. Jadikan editor Anda bagian dari tim penulisan Anda.

Cinta editor anda

Hire editor Anda di awal kehidupan proyek. Setidaknya ada dua manfaat untuk mempekerjakan editor lebih awal:

Pekerjakan Editor Anda di awal Proyek

* Pertama, editor Anda akan siap untuk tugas pengeditan. Dia akan memiliki waktu untuk mengenal produk, target audiens, dan panduan gaya organisasi Anda.

* Kedua, editor Anda dapat membantu Anda dalam menulis Anda, seperti yang saya jelaskan di bawah ini ...

Biarkan Editor Anda Membantu Anda

Jika Anda mengalami masalah tentang bagaimana menulis sesuatu, hubungi editor Anda. Kemungkinan editor Anda bisa memberikan kata-kata yang efektif untuk membawa Anda berkeliling ke blok Anda. Itulah salah satu alasan mengapa Anda mendapatkan editor proyek lebih awal. Inilah yang lain ...

Rekomendasi

Saya menyarankan agar Anda mengerjakan sebagian kecil Dokumen Pengguna, dan mengedarkan potongan kecil ini (draft kasar) ke tim pengembang untuk mendapatkan komentar. Kemudian gunakan komentar mereka untuk memperbaiki tulisan, dan kembali mengedarkan materi yang lebih baik. Lanjutkan ini untuk beberapa siklus. Saya menyebutnya "Ilustrasi, Penulisan Interaktif". Ini adalah metode yang efektif untuk menulis dengan cepat dan akurat.

Jika Anda merasa tidak nyaman dengan mengedarkan draft kasar ke tim pengembangan produk untuk ditinjau, inilah solusinya. Mintalah editor Anda melakukan pengeditan cepat dari draft kasar sebelum Anda menyebarkannya untuk komentar. "Konsep" Anda akan terlihat cukup bagus, dan tim pengembang akan berkonsentrasi pada konten, bukan kata-kata atau tata bahasa (dan komentar tentang konten yang Anda inginkan dari tim).

Garis bawah

Jangan pikirkan editor Anda sebagai musuh yang mengintai di akhir jalur produksi dokumen Anda. Sebagai gantinya, sadarilah bahwa editor Anda bisa menjadi anggota tim tulisan Anda yang berharga, dan berada di pihak Anda. Dia harus:

Dibawa ke proyek penulisan lebih awal

* Sadar akan status proyek penulisan

* Digunakan sebagai tulisan, begitu juga dengan editing, resource

Tip: Jauh lebih menyenangkan bagi penulis (Anda) untuk bekerja dengan dokumen elektronik "ditandai", bukan dokumen cetak yang ditandai. Selidiki kemampuan "beberapa pengulas" pengolah kata Anda. Untuk menggunakan kemampuan ini mengharuskan Anda dan editor menggunakan perangkat lunak pengolah kata yang sama atau kompatibel.

CATATAN: Saya bukan editor, saya juga tidak mewakili editor apapun. Tapi sebagai penulis, saya menghargai editing.

Posted by Unknown