Bagaimana Membuat Dokumen Teknis yang Profesional - Bagian 2
Indonesian (Bahasa Indonesia) translation by Kurniawan Sugi Purwanto (you can also view the original English article)
Membuat Dokumen Teknis
Anda punya Mac baru dan ingin melakukan pengaturan awal Internet untuk mengakses Web. Anda takut bahwa Anda mungkin lupa caranya, atau ingin membantu orang lain. Dalam contoh ini, saya akan membuat dokumen teknis sederhana dan langkah demi langkah serta menyimpannya sebagai dokumen PDF.
1. Tambahkan Subjek dan Deskripsi Artikel
Tulis Subjek dan Deskripsi Artikel singkat. Harus singkat, jelas, dan secara tepat menyampaikan hal-hal yang Anda ingi tunjukkan, dalam hal ini Anda ingin melakukan pengaturan awal (setup) Internet di sebuah Mac. Baris Subject yang tampil di bilah samping dasbor Clarify.
Klik File > Save As dan pilih folder untuk menyimpan file. Secara default, akan dipilih subjek untuk dokumen Clarify sebagai nama file dengan ekstensi .clarify dan menyimpannya di folder Clarify Documents.



2. Tambahkan Judul Langkah (Step Title) dan Teks Paragraf
Klik simbol + untuk menambahkan langkah baru. Tulis Judul Langkah dan teks paragraf di kotaknya masing-masing.
Jika Anda melakukan kesalahan, klik kotaknya untuk mengedit. Apabila Anda menambahkan judul langkah, Anda akan melihat judul langkah tersebut di bilah samping dasbor Clarify.



3. Format Teks Paragrafnya
Clarify menawarkan sejumlah pilihan untuk memformat teksnya. Bilah format akan muncul apabila Anda memilih kotak isian paragraf. Klik salah satu ikon untuk mengubah format teks Anda, Anda bisa memilih Bold, Italic, Bullet list, Link, Superscript dan lebih banyak lagi.
Apabila Anda menekan tombol enter, Clarify akan membuat paragraf baru. Clarify menambahkan spasi antar tiap paragraf seperti teks yang Anda lihat di suatu situs web.



Clarify juga mengizinkan Anda memformat kode sebagai satu blok kode atau sebagai kata tersendiri dalam suatu kalimat. Untuk menandai satu atau dua kata sebagai kode, pilih kata yang dimaksud dan klik tombol Format as code dari bilah alat pemformatan.
Ketika Anda mengekspor dokumen Clarify sebagai HTML, teksnya akan dilingkupi dalam tag <code>..</code>. Pilih keseluruhan paragraf dan klik Format as code, untuk mengonversi teks menjadi satu blok kode dengan keluaran yang dilingkupi dalam tag <pre><code>...</code></pre>.



4. Mengambil Screenshot
Anda memiliki tiga opsi untuk menangkap gambar
- Tombol Capture di aplikasi Clarify
- Tombol Capture dari bilah menu, atau
- Pintasan keyboard
Buka Clarify > Preferences dan konfigurasikan hotkeynya di pengaturan General.



Ketika Anda menekan tombol Capture alat penangkap layar akan muncul di layar, Seret ke area yang ingin Anda tangkap dan tekan tombol Return. Tekan Spasi untuk menangkap keseluruhan jendela. Tekan Spasi sekali lagi untuk kembali ke mode penangkapan area.
Tekan R untuk kembali ke area sebelumnya yang telah Anda tangkap. Ini akan bermanfaat kalau Anda ingin menangkap area yang sama di layar berkali-kali. Tekan C untuk menunjukkan atau menyembunyikan kursor ketika mengambil screenshot.



5. Melakukan Tugas-Tugas Dasar Dengan Gambar
Clarify menyediakan banyak opsi untuk memanipulasi gambar: memutar, memotong, menggunakan alat anotasi dasar, mengubah ukuran gambar dan kanvas gambar.
Untuk memutar gambar, klik Edit > Rotate Image.



Untuk memotong gambar klik Edit > Crop Image. Klik dan seret ke area yang ingin Anda pertahankan dan tekan tombol Return.



Anda bisa memilih dari sejumlah alat anotasi. Pilih gambarnya dan klik jenis alat anotasi yang Anda ingin gunakan dari bilah alat pemformatan: Line tool, Square tool, Circle tool, Sequence Numbering tool (Anda bisa mengubahsuai urutan awal), Text tool, dan Blur tool.



Clarify memiliki tiga opsi untuk mengubah ukuran gambar. Ada empat pegangan di sisi editor gambar. Klik dan seret yang mana saja dari pegangan tersebut untuk mengubah ukuran kanvas. Anda tidak bisa memotong gambar dengan menggunakan pegangan kanvas ini.
Seret dan tahan kunci Option untuk mengubah ukuran semua sisi kanvas secara sama.



Gunakan gagang pengubah ukuran gambar yang terletak di sudut kanan bawah. Tekan dan tahan tombol Option untuk mengubah ukuran gambar dengan laju pembesaran 10%.



Untuk kontrol yang presisi terhadap ukuran gambar klik pada gambar langkah lalu pilih Resize Image... Jika langkah tersebut mengandung beberapa gambar, Anda harus memilih gambar tertentu dan mengubah ukurannya melalui suatu menu kontekstual.



6. Membuat sub-langkah atau menyarangkan langkah
Clarify punya kemampuan untuk membuat sub-langkah. Sub-langkah diindentasi di bawah langkah induk dan bisa jadi satu tingkat lebih dalam. Ketika Anda mengekspor dokumennya, suatu kotak sub-langkah akan keluar dengan ukuran font kecil, penomoran sub-langkah (jika Anda mengaktifkannya). Pertama, buat langkah biasa sebagaimana dijelaskan sebelumnya.
Piih langkah yang Anda ingin buat sub-langkah. Buka menu Document > Move Step dan pindahkan langkahnya ke kanan untuk mengindentasinya. Gerakkan sub-langkah ke atas atau ke bawah untuk mengorganisasikan dokumen teknisnya, sebagaimana diminta.



7. Penomoran Otomatis Langkah-Langkah
Apabila dokumen teknis berisi sejumlah langkah, Anda bisa memberikan prefiks pada tiap langkah dengan suatu angka. Clarify akan memberikan penomoran otomatis pada langkah-langkah, klik Document Inspector dan cek Auto-number Steps. Semua langkah yang lain akan secara otomatis diberi prefiks angka.



Untuk membuat langkah tertentu tidak diberi prefiks, klik Step Inspector dan centang Exclude from Auto-number. Langkah ini tidak akan diberi awalan angka lagi.



Mungkin ada situasi yang Anda tidak ingin penomoran otomatis langkah di tingkat teratas, tetapi hanya sub-langkah saja. Untuk melakukan hal itu, klik Step Inspector dan centang Auto-number substeps. Hanya sub-langkah yang akan diberi awalan angka.



8. Melakukan Tugas-Tugas Lanjutan Dengan Gambar
Clarify mencakup sejumlah fitur canggih untuk memanipulasi gambar. Meskipun fitur-fitur tersebut tersedia di editor gambar lainnya, adanya fitur tersebut di Clarify membuat proses pembuatan dokumen teknis jauh lebih cepat. Untuk menambahkan bingkai di sekeliling gambar, pilih langkah yang Anda ingin menyuntingnya.
Klik Step Inspector dan di dalam bagian Image Settings ganti Image Border yang Anda ingin tambahkan ke gambar. Anda bisa memilih dari Line, Picture frame, dan Rounded Corners.



Clarify bisa secara otomatis mengubah skala gambar dan menguranginya jika gambarnya terlalu panjang atau lebar.
Klik Document Inspector dan centang Auto scale images. Atur nilai maksimal untuk panjang (height), atau lebar (width) gambar atau keduanya.



Menambahkan banyak gambar dalam suatu langkah adalah juga proses yang menghabiskan waktu. Klik tanda + yang terletak di sisi gagang kanvas.
Ambil screenshot, dan Anda akan menemukannya ada di dalam step.



Jika Anda telah mengonfigurasi Repeat Last Screenshot, tidak perlu repot lagi menggunakan alat penangkapan layar. Menambahkan gambar hanya berada di bawah gambar atas, dan seterusnya.



Jika Anda ingin mengganti gambar untuk langkah tertentu, lalu pilih gambar yang Anda ingin menggantinya, lalu klik ikon Replace Image di pojok kiri atas.
Atau, klik ikon Replace yang terletak di sebelah gagang kanvas.



9. Menanamkan Hosted Video ke suatu Langkah
Suatu dokumen teknis akan mudah diikuti jika Anda memasukkan suatu video. Dengan Clarify Anda bisa menanamkan hosted video dari layanan video seperti YouTube dengan mudah ke langkah-langkah ini.
Pilih langkahnya, klik Step Inspector dan ubah Media Type dari Image ke HTML.



Dengan melakukan ini Anda akan melihat suatu kotak untuk memasukkan kode HTML. Buka YouTube, dan salin embed code videonya. Klik Preview untuk melihat pratinjau HTML.



Beberapa format ekspor tidak bisa menampilkan HTML untuk suatu langkah. Klik tab Image dan tambahkan suatu gambar, untuk tipe format ekspor tersebut.
Anda harus selalu menggunakan representasi gambar, ketika mengekspor dokumen Clarify Anda ke Word (ekstensi DOCX).



10. Tambahkan Anchor ke Langkah-Langkah dalam Output HTML
Anda bisa menambahkan anchor tag ke langkah-langkah yang akan menetapkan sebagai identitas properti di keluaran HTML. Ini bisa bermanfaat untuk secara langsung menautkan dengan langkah-langkah khusus ketika Anda membagikan dokumen Clarify ke web.
Sebagai contoh, jika Anda mengeset nama anchor untuk suatu langkah special-step dan jika URL dokumen Clarify Anda adalah
https://www.myblog.com/my-article.html
maka Anda bisa langsung menautkan langkahnya dengan menambahkan #special-step ke URL:
http://www.myblog.com/my-article.html#special-step
Untuk menambahkan anchor tag ke suatu langkah, pilih langkah yang Anda ingin sunting. Klik Step Inspector dan atur nama anchor di dalam Step Settings.
Ketika menetapkan suatu nama anchor, hanya gunakan huruf, angka, tanda hubung, atau garis bawah (underscore).



Catatan: Jika Anda tidak mengatur anchor untuk suatu langkah maka Clarify akan secara otomatis membuat tag berdasarkan id internal yang ditetapkan Clarify pada langkah-langkah tersebut ketika Anda membuatnya. Anchor tag ini akan tetap sama tiap kali Anda mengekspor dokumen Clarify.
11. Mengekspor dan Membagikan Dokumen Clarify
Buka Clarity > Preferences dan klik Share. Klik tombol + dan pilih akun berbagi untuk mengekspor target. Suatu akun berbagi bisa mengekspor ke Clarify-it.com, WordPress dan Evernote. Anda juga bisa mengekspor dokumen Clarify Anda sebagai PDF, HTML, dan Word.
Untuk akun berbagi, Anda harus memiliki akun dan autorisasi. Untuk PDF, HTML, pilih atau ubahsuai templat yang Anda ingin gunakan tiap waktu.



Anda bisa mengubahsuai templat untuk PDF, HTML, Email, dan word. Di templat HTML Anda bisa memilih dari sejumlah templat: Basic, Chrome, Corporate, Markdown, Technical dan bahkan suatu templat HTML sesuaian.
Pilih logonya dan atur dimensi gambat untuk templat ini. Klik tombol Preview untuk melihat templat yang Anda ubahsuai.



Anda juga bisa mengubahsuai templat email dengan cara yang sama. Karena akan menggunakan PDF, Anda bisa mengubahsuai templat PDF dan memilih klien email: Apple Mail, Postbox, Outlook atau Airmail. Klik tombol Preview untuk melihat templat yang telah Anda ubahsuai.



Kesimpulan
Clarify adalah aplikasi native untuk Windows dan Mac untuk membuat dokumen-dokumen teknis. Aplikasi itu membuat Anda bisa menciptakan berbagai templat supaya Anda dapat berfokus pada pembuatan suatu dokumen teknis tanpa keruwetan dan mengelola banyak aplikasi—alat penangkap layar, pengolah kata, dan alat berbagi.
Dalam tutorial ini, saya telah menunjukkan pada Anda prosedur langkah demi langkah untuk membuat suatu dokumen teknis. Aplikasi ini memiliki percobaan 14 hari dan tersedia dengan harga USD 29,99. Lihat detail harga untuk informasi lebih lanjut.



