Bagaimana Menguraikan Dokumen Penulisan Teknis

Anonim

Bagaimana Menguraikan Dokumen Penulisan Teknis. Dokumen yang ditulis dengan baik tidak dibuat secara kebetulan. Materi yang tercakup dalam laporan, manual, atau dokumen teknis lainnya direncanakan, diorganisir, dan kemudian ditulis. Tahap menguraikan dokumen adalah langkah kunci dan kemungkinan informasinya tidak akan disajikan secara logis jika garis besar tidak dibuat. Garis besar memberi penulis kesempatan untuk memikirkan informasi yang harus dan tidak boleh dimasukkan.

Pikirkan ide-ide Anda. Tuliskan semua ide dalam garis besar Anda yang menurut Anda harus dimasukkan dalam dokumen teknis. Jangan khawatir dengan urutan informasi. Yang penting semua informasi termasuk dalam proses brainstorming.

Tentukan tujuan dokumen teknis. Tanyakan kepada diri Anda pertanyaan-pertanyaan seperti siapa yang akan membaca dokumen, mengapa akan dibaca dan bagaimana akan digunakan.

Tentukan jenis garis besar yang ingin Anda buat: historis, kronologis, spesifik untuk umum, kecil hingga besar, sederhana hingga kompleks atau bentuk lain apa pun yang sesuai dengan konten. Pikirkan tentang audiens dan informasi yang ingin Anda presentasikan. Pastikan bahwa cara informasi diatur membuat paling masuk akal untuk jenis informasi yang disajikan dan kepada audiens yang akan membaca dokumen teknis.

Atur informasi dalam urutan yang sesuai. Garis besar melibatkan pengelompokan informasi ke dalam bagian dan level yang logis. Anda dapat membuat topik utama dan subtopik dan subtopik.

Selesaikan garis besar dengan meninjau informasi untuk memverifikasi bahwa subjek diatur dengan tepat dan logis. Pastikan Anda tidak melewatkan fakta kunci. Hapus semua informasi yang tidak relevan dengan dokumen teknis.