Bagaimana Membuat Dokumen Teknis Profesional—Bagian 1

Sebuah dokumen teknis merupakan hasil membuat informasi teknis pengguna yang efektif. Itu mungkin merupakan hal berbeda bagi kebanyakan orang dalam peran yang berbeda. Kamu mungkin memerlukan dokumentasi untuk mendapatkan pekerjaan baru, menjelaskan fitur baru atau sebagai referensi bagi orang yang tidak mahir dalam teknologi.

Menuliskan sebuah dokumen teknis memerlukan sejumlah alat—sebuah aplikasi secara , sebuah editor gambar, sebuah pemrosesan kata untuk menulis instruksi dan alat untuk membagikan dokumen.

Walaupun ini adalah protokol terbaik dalam membuat dokumen teknis, itu tidak tampak benar ketika  kamu kekurangan waktu atau harus memperbaharuinya secara otomatis.

Di dalam tutorial dua bagian ini, saya akan menunjukkan bagaimana menggunakan Clarify untuk membuat dokumen teknis yang sederhana dan profesional.

• Mengkonfigurasi aplikasi untuk meraup manfaat maksimum.
• Membuat sebuah tutorial mendalam dengan banyak tahapan, gambar, dan teks.
• Membagikan dokumen dengan orang lainnya atau web.

Alasan Memilih Clarify

1. Clarify merupakan aplikasi lintas platform yang tersedia baik untuk komputer Windows dan Mac. Itu kompatibel dengan versi dari Windows Vista hingga 10 dan OS X 10.7 Lion hingga 10.11 El Capitan dan macOS 10.12 Sierra
2. Itu memungkinkanmu membuat dokumen teknis dalam ukuran kecil dan menjelaskannya dalam gaya tahap demi tahap. Kamu dapat menambahkan gambar, membuat anotasi dengan alat visual dan menambahkan teks untuk menjelaskan langkah-langkahnya.
3. Itu memiliki tool yang terintegrasi untuk memungkinkanmu membagikan dokumen melalui web, email dan evernote. Kamu juga dapat menyimpannya sebagai dokumen PDF, HTML, dan Word.
4. Itu memungkinkanmu membuat template HTML dan PDF yang disesuaikan, sehingga kamu dapat berfokus pada tugas membuat sebuah dokumen teknis dan tidak mengkhawatirkan tentang logo, font, warna, header dan footer, page break dan banyak lagi.

Mengkonfigurasi Clarify

Clarify memberikanmu beberapa pilihan untuk menggunakan atur dokumen teknis sesuai kebutuhanmu. Pergi ke Clarify > Preferences.

Kamu akan melihat tiga preferensi: General, Share, dan PDF Templates. Tiap preferensi memungkinkanmu mengkonfigurasi banyak parameter.

Pengaturan General

Konfigurasikan hotkey untuk mengambil screenshot. Untuk mengubah hotkey, klik Remove dan ketikkan sebuah hotkey baru. Jika kamu lebih suka kanvas besar untuk menulis dokumen teknis, ubah Document editor text size dari small ke large.

Clarify mengijinkanmu menyesuaikan pengaturan gambar, dengan cara yang kamu inginkan. Pilih export format sebagai PNG atau JPEG (Good, Better, Best). Kamu dapat membuat tag ALT secara otomatis untuk gambar atau secara otomatis mengubah skala gambar, baik lebar dan tinggi, sesuai panduan style.

Share

Clarify menawarkan sejumlah cara berbeda untuk membagikan dokumen yang dibuat. Kamu dapat mengekspor ke clarify-it.com sehingga yang lainnya dapat melihat dokumen. Kamu dapat mengekspor dokumen ke blog WordPress custom atau blog .com atau menyimpannya sebagai dokumen PDF, HTML, atau Word.

Template PDF

Clarify hadir dengan empat template dasar: Basic, Black dan White, Chrome, dan Corporate.

Jika kamu memiliki beberapa kebutuhan spesifik maka kamu dapat membuat sendiri template PDF. Klik tombol + untuk membuat template custom yang baru.

Di dalam tab General, sesuaikan ukuran dan margin halaman, penjajaran gambar, pengaturan alur konten dan banyak lagi. Ketika membuat sebuah dokumen PDF, Clarify menambahkan page break di dalam lokasi tertentu. Walaupun Clarify mencoba untuk menyimpan tahapan konten, kamu dapat mengkonfigurasinya.

Klik pada menu Click the Content Flow untuk mengkonfigurasi pengaturan page break. Pilih One step per page untuk menambahkan page break setelah tiap tahap.

Pilih Fit as content as possible per page untuk menempatkan sebanyak mungkin konten pada halaman. Gunakan CSS untuk mengendalikan lebih jauh terhadap page breaks.

Di dalam isian header kamu dapat menambahkan Logo dan menyesuaikan beberapa variabel. Kamu dapat menambahkan variabel seperti

• [[Document Title]] — Nama dokumen
• [[File_Name]] — Nama file PDF
• [[Date]] — Tanggal dalam format yang sistemmu gunakan
• [[MM/DD/YYYY]] — Bulan, tanggal dan tahun

Di dalam isian footer kamu dapat menambahkan nomor halaman dan teks footer. Kamu dapat menambahkan variabel seperti

• [[Page_Number]] — Nomor halaman
• [[Page_Count]] — Total jumlah halaman

Di dalam tab Fonts & Colors, atur font default, ukuran font dan warna untuk header dan footer, deskripsi artikel, judul tahapan, dan judul subtahapan. Jika kamu tidak mengatur sebuah font untuk obyek tertentu, maka itu akan menggunakan Default Font.

Tab Custom CSS memungkinkanmu membuat penyesuaian pada elemen yang tidak tersedia di dalam antarmuka pengguna. Template PDF di dalam Clarify berkerja pada prinsip HTML dan CSS. Jika kamu memiliki pengetahuan tentang keduanya, maka kamu dapat menambahkan banyak variabel pada template PDF. Sebagai contoh

.step-container (
page-break-after: always
)

CSS ini memberitahu PDF generator untuk selalu menambahkan sebuah page break setelah tiap tahap. Kamu juga dapat menambahkan font spesifik yang memberikan style pada dokumen PDF dengan menambahkan kelas CSS spesifik di dalam dokumen.

.step-title (
font-style: italic;
font-weight: lighter;
)

Beberapa kelas yang dapat kamu gunakan adalah article-description, step-title, step-container, sub-step, dan step-instructions. Pada tiap tahap kamu dapat mengklik Preview untuk melihat output akhir dari template PDF.

Kesimpulan

Aplikasi Clarify merupakan aplikasi asli untuk Windows dan Mac untuk membuat dokumen teknis. Itu memungkinkanmu membuat template sehingga kamu dapat fokus dalam membuat dokumen teknis tanpa kehebohan dan mengelola aplikasi yang banyak—alat screen dari kapsul pemrosesan kata, dan alat berbagi.

Di dalam tutorial ini, saya telah menunjukkan bagaimana mengkonfigurasi aplikasi Clarify untuk memanen manfaat maksimum dan bagaimana menyesuaikan template.

Di dalam tutorial berikutnya, saya  akan memberikan sebuah prosedur tahap demi tahap dalam membuat dokumen teknis. Aplikasi ini mencakup uji coba gratis 14 hari dan seharga $29.99. Lihat detail harga untuk informasi tambahan.