Perkenalan Riset Teknologi Informasi dokumen slide

Pendahuluan Penulisan
Technical Report
(Laporan Teknikal)

Presented By: Abdullah Fajar, S.Si, M.Sc

Bagaimana kita berkomunikasi





CV, Resume
Email, Web site, FAQs
Surat, Surat Kabar, Brosur, Artikel, Katalog
Iklan, Papan Pengumuman, Pamflet, Petunjuk
Arah, Rilis Media
• Presentasi, multimedia, berbicara
• Laporan, Panduan, Proposal, Buku

Jenis Komunikasi/Laporan Teknikal

Contoh-contoh:










Laporan tahunan
Buku
Panduan Perangkat keras komputer
Majalah
Surat Kabar
Tata tertib organisasi/perusahaan
Jurnal/artikel ilmiah/akademik
Panduan Perangkat Lunak
Lapora Teknis


Laporan Penulisan Teknikal





Proposal
Panduan/Petunjuk Penggunaan
Panduan Teknikal
Paper/tulisan ilmiah

Klasifikasi Laporan





Laporan Formal dan Informal
Laporan Informasi

Laporan Analisis
Laporan Rekomendasi

Apa sebenarnya penulisan teknikal?
“Technical writing conveys specific information about a technical subject to a
specific audience for a specific purpose…The words and graphics of
technical writing are meant to be practical: that is, to communicate a body of
factual information that will help an audience understand a subject or carry
out a task.”

“Penulisan teknikal memberikan informasi spesifik tentang sebuah
subjek teknikal untuk pembaca tertentu yang spesifik untuk tujuan
yang spesifik pula. Kata-kata dan grafik dari penulisan teknikal
adalah cara praktis dalam mengkomunikasi bagian inti dari
informasi faktual yang akan membantu pembaca memahami
sebuah subjek atau bagaimana melakukan suatu tugas/kegiatan”
- Michael H. Markel

Director of Technical Communication, Boise State University


Beberapa karakteristik laporan
1.
2.
3.
4.
5.

Semua orang tidak suka menulisnya,
Semua orang tidak suka membacanya,
Hampir semua orang tidak membacanya,
Perlu waktu lama untuk menulisnya,
Penulisan teknikal mutlak penting bagi
kesuksesan anda bekerja di bidang
rekayasa/engineering!

Karateristik lainnya dari laporan
Laporan tersebut biasanya:

6. Terlalu panjang,
7. Susunannya tidak mudah dipahami,

8. Tidak lengkap.

Karateristik penulisan teknikal yang
efektif
Ada empat C:
• Clarity /jelas/sederhana/persis/tidak
ambigumudah untuk dipahami oleh pembaca
• Comprehensiveness/Kelengkapan semua
informasi yang diperlukan dihadirkan
• Conciseness/ringkas banyak mengandung
istilah/kata-kata yang mudah dipahami/ringkas
• Correctness/benar/sesuai dengan tatabahasa
mengikuti konvensi/aturan tata bahasa

Mengapa perlu menulis Laporan?
• Waktu menjadi terbuang kecuali jika kita bisa
mengkomunikasikan apa sudah kita lakukan
dengan cara menuliskannya
• Cara yang paling banyak digunakan untuk
mengkomunikasi hal teknikal adalah dengan

menulis laporan, sehingga kita perlu lebih baik
dala melakukannya!

Manfaat/Kepentingan








Meningkatkan produktivitas
Meningkatkan penggunaan produk
Meningkatkan keamanan
Perlindungan Hukum
Mengurangi biaya pelatihan
Mengurangi permintaan dukungan
Mengurangi peluang penolakan


Pembaca
• Analisis
– Survey, kuisioner, wawancara terstruktur, test
penggunaan

• Karakteristik





Pendidikan dan latar belakang professional
Pengetahuan dan tingkat pengalaman
Bahasa
Konteks

• Tujuan dan kebutuhan
• Profil

Analisis Informasi

• Tujuan dan struktur
• Jenis Dokumen
• Pemasaran
• Konseptual, Prosedural, Tutorial, Panduan Kerja
• Referensial

• Frekuensi dan pola penggunaan
• Fitur tekstual

Fitur Tekstual








Ikhtisar, ringkasan
Instruksi langkah per langkah

Paparan naratif
Model Konseptual, analogi dan/atau contoh
Gambar, carta, grafik dan/atau tabel
Referensi silang dan/atau bantuan navigasi
Terminologi teknical, konvensi bahasa dan/atau
konvensi simbolik

Karakteristik Media











Artikel – naratif

Buklet – bersifat dialog
Brosur – enak dipandang
Surat Kabar – jurnalistik
Korespondensi – formal, informal
Panudan/petunjuk – berorientasi aksi
Laporan – formal dan objektif
Sistem Bantuan – berorientasi aksi
Wizard – ringkas dan berorientasi aksi
Website – enak dipandang dan mudah digunakan

Bentuk keluaran dokumen








Cetak

Fax
Jaringan
Floppy disk
FTP (file transfer protocol)
Lampiran email
Website

Proses Penulisan Teknikal

Menulis

Merevisi

Mengedit

Mempublikasikan

Mereview

Proses Penulisan


Rencana/Rancangan Dokumen










Pembaca
Tujuan
Media
Sumber daya
Daftar Isi
Jadwal

Kerangka Tulisan
Template

Menulis
• Tulis dengan bahasa positif.
Jangan Lakukan:
“Akses terhadap informasi siswa tidak diperbolehkan
kecuali oleh pihak akademik.”
Pegawai yang mempunyai akses terhadap informasi
tersebut tidak boleh membocorkan informasi tersebut
kepada pihak ketiga yang tidak berhak

Lakukan
Akses informasi siswa hanya ditujukan kepada pihak
yang diotorisasi yaitu pihak akademik.
Pegawai yang mempunyai akses terhadap informasi
tersebut diminta untuk melindungi dan menjaga
informasi tersebut bersifat rahasia

• Jangan tulis huruf besar pada lebih dari satu kata.

Menulis (lanjutan)
• Gunakan daftar ketika diperlukan
• Gunakan judul untuk mendefinsikan suatu
kegiatan/tugas.
• Gunakan Judul Bab dan Sub bab.
• Segmen label yang mencerminkan bagaimana
pembaca berfikir tentang sebuah operasi atau
prosedur

Menulis (lanjutan)
• Sediakan hanya satu cara untuk melakukan
sesuatu dalam satu langkah saja.
• Lakukan dengan benar pada penulisan instruksi
• Gunakan peringatan
• Tulis kesimpulan; Misalnya: Selamat! Anda baru
saja menulis dokumen pertama anda
• Jangan mengecewakan/memprovokasi pembaca

Penulisan
• Cungkil informasi yang anda punya
• Jaga agar paragraf tetap singkat/pendek
• Lebih sedikit lebih baik
• Kendalikan lebar teks dengan penggunaan kolom

Proses Revisi









Tujuan
Kelengkapan
Alur
Bahasa
Tata Bahasa, Ejaan dan tanda baca
Grafik
Format
Konsistensi

Proses Review





Peer
Teknikal
Domain
Kualitas

Tools










Microsoft Outlook – email
Microsoft Word – dokumen
Microsoft Excel – lembar kerja
Microsoft PaintBrush – menggambar
Adobe Acrobat – PDF
Adobe InDesign – publikasi desktop
Adobe Flash – animasi/presentasi
Google Apps – kolaborasi
Freemind – peta pikiran

Dimana menemukan materi untuk
menulis laporan?
Contoh:















Dokumen yang terkait dengan proyek/pekerjaan yang sedang dilakukan
Google, Bing, Yahoo
Google hacks/scripts (filetype, intitle, inurl, site)
Journal (ex: Emeraldinsight.com, DOAJ.org, HighWire.stanford.edu)
Scitopia.org
Scirus.com
Wolframalpha.com
RSS readers – (Pageflakes.com)
Milis (Google Groups, Yahoogroups)
Filesharing – Bittorent.com, Furk.net, Mininova.org
Situs Media Sosial – Facebook, Myspace, Friendster
Youtube.com, Metacafe.com etc.
Referensi, bibliography – Bibme.com
Ebook gratis – Hongkiat.com - 20-best-websites-to-download-free-e-books.
OPPapers.com – Research Papers and Essays

Ringkasan Teknikal Dasar
• Etika dan profesionalisme dalam pelaporan
• Ketahui siapa pembaca
• Tulisan kerangka tulisan
• Penulisan laporan (Stuktur rigid/baku)

Etika dan profesionalisme dalam
pelaporan
• Individu yang berbeda mempunyai kepribadian yang
berbeda dan cara komunikasi yang berbeda pula.
• Jika menggunakan rumusan sudah dipersiapkan
secara kaku dalam komunikasi teknikal dapat
mengakibatkan kesulitan tertentu.
• Dalam struktur umum komunikasi teknikal secara
formal, ada ruang untuk menunjukan kepribadian
penulis didalamnya.

Mengetahui Pembaca Laporan
• Pada tahapan awal, pikirkan seperti apa pembaca
laporan kita.
• Pemilihan kata, tingkatan motivasi dan latar
belakang diperlukan bagi sebuah
laporan/presentasi yang bergantung sekali pada
latar belakang pembaca/audiennya

LatihanAnalisis Karakteristik
Pembaca
Pengetahuan Pembaca (Level Teknis, Pendidikan,
Pengalaman Kerja, Latar belakang Budaya)
Topik yang diinginkan oleh Pembaca
Hubungan Penulis dengan Pembaca(Posisi dalam
pekerjaan, jabatan)
Sikap pembaca terhadap topik dan tujuan laporan (friendly,
cenderung bermusuhan, tidak peduli)
Kebutuhan informasi pembaca(mengapa ybs haru
membaca)
Tujuan laporan (Apa yang haru pembaca ketahui, pikirkan,
lakukan, dapat lakukan setelah membaca laporan)

Tujuan kerangka tulisan


Mengapa kita mempresentasikan pekerjaan
ini? Apa yang kita inginkan dari pembaca dari
tulisan atau presentasi ini?



Petunjuk: rumuskan satu atau dua pesan
sederhana ("take-home messages“) yang kita
coba kirimkan pada pembaca

Latihan Analisis Kondisi dan
Kandungan Laporan
Apa topik laporan yang akan dibuat?
Apa tujuan dari laporan yang akan anda tulis?
Siapa pembacanya?
Mengapa anda menulis laporan? Mengapa laporan itu diminta?
Siatuasi dan kondisi apa yang menyebabkan laporan tersebut
diperlukan?
Apa topik yang diperlukan untuk laporan tersebut? Apa yang ingin
diketahui pembaca? Apa yang perlu pembaca lakukan?
Struktur laporan seperti apa yang akan digunakan dalam penulisan
laporan? Apakah perlu laporan dipecah dalam beberapa bagian?
Apa sumber informasi yang anda punya? Sumber informasi mana yang
akan anda gunakan?
Jenis visualisasi apa yang akan anda pergunakan? Bagaimana
meningkatan presentasi konten laporan?

Berapa lama menulis laporan?


Panjang dari presentasi /tulisan kita baik tertulis
atau dipresentasikan sering dikendalikan oleh
faktor eksternal



Terkait dengan presentasi secara oral, kita sering
dihadapkan pada waktu yang sangat sempit:
 Pastikan kita dapat mengambil pesan penting dalam
presentasi/tulisan tanpa terburu-buru



Petunjuk: berlatihlah berbicara untuk presentasi
dengan stop-watch ditangan

Format Umum Laporan
Banyak format dari berbagai jenis dokumen yang
dapat ditulis tetapi…
Standard umum dalam bidang
rekayasa/engineering adalah IMRaD - Introduction Methods - Results - and Discussion.
Catatan: Laporan yang dibuat tidak perlu mengikuti
secara kaku format di atas, tetapi gunakanlah
sebagai panduan dan sampaikan semua informasi
dalam setiap paragraf tertentu yang kita harus buat.

Praktek Menulis Teknikal
– User Friendly
• menarik
• Instruksi langkah per langkah
• Gaya dan bahasa

– Mudah untuk dikutip

• Konten
• Judul/Sub-judul
• Referensi silang
• Indeks

Modular
– Mudah untuk dirawat

• Modular, dapat digunakan ulang
• Template dan tool yang tepat

Bahasa dan Gaya
– Bahasa
• Parallelisme
• Tata Bahasa
• Suara aktif/pasif
• Anda/Kita

– Panduan gaya
• Konsisten
• Gaya tersendiri

Rancangan User Friendly
– Format dan Struktur
• Judul, daftar isi, referensi silang, indeks
• Template

– Konsisten
• Judul, bahasa, daftar, referensi silang dan
kata-kata

Menulis secara terstruktur
– Daftar
– Tabel
– Grafik
– Instruksi
– Tasks/kegiatan
– Konkrit
• Skenario, studi kasus, contoh

Rancangan Dokumen
• Seimbang
• Latar Belakang putih
• Maksimum 5 jenis huruf
– Serif fonts (Times) – paper
– Sans Serif fonts (Verdana) - online

• Maksimum 5 warna

Panduan Gaya
• Chicago Manual of Style
– Tata bahasa, referensi, indeks, tanda baca

• Microsoft Manual of Style
– Digunakan dalam industri komputer

• Elements of Style





Latar putih dan kontras
Tata bahasa dan tanda baca
Tips menulis
http://www.bartleby.com/141

Penulisan Teknikal
yang baik

Penulisan Teknikal yang baik
Seorang pelajar Universitas XYZ
ditemukan bunuh diri di kamarnya dalam
kondisi acak-cakan. Polisi mengatakan
pemuda tersebut gantung diri.
“Gagasan Utama”

Penulisan Teknikal yang baik
Si Fulan sedang menyelesaikan Kalkulus sebagai mata
pelajaran utama pada Universitas XYS. Dia, merupakan pelajar
tahun akhir, tidak berhasil standar nilai pada ujian akhir dan
gagal lulus. Menurut keterangan resmi universitas, administrasi
universitas memisahkan dia dari kelas kuliahnya terkait
kondisi mentalnya pada lima hari teraknir. Pada hari senin,
ibunya Ali meneleponnya tetapi tidak dijawab, setelah ibunya
berbicara via telepon dengan Ahmad adiknya yang ada di
universitas yang sama. Ahmad menuju kamar kakaknya dan
karena tidak jawaban saat diketuk, pintu kamar dijebol dan
menemukan si Fulan tergantung pada kipas angin.

“Bahasa Formal”

Penulisan Teknikal yang baik
Polisi setelah mendapatkan laporan, menuju lokasi
kejadian dan mulai menyelidiki kasus tersebut. Menurut
pelajar lain, si Fulan tampak normal selama sarapan,
akan tetapi tidak terlihat di kampus pada hari tersebut.
“Kalimat tidak terpotong-potong”

Penulisan Teknikal yang baik
Penyeledikan awal mendapatkan bahwa si
Fulan merasa tertekan dengan kegagalan berturutturut dalam kuliah dan akhirnya merasa depresi
setelah orang tuanya menerima surat dari
administrasi kampus terkait presetasi buruk selama
perkuliahan.
Sebuah laporan dari surat kabar mengatakan “
Sekitar 200 pelajar melakukan bunuh diri setiap
tahun karena tekanan dalam belajar.
“Fakta”