Pelajari Penurunan Harga: Alat Penulisan untuk Pengembang Perangkat Lunak

Jika Anda seorang insinyur perangkat lunak, Anda mungkin telah menghabiskan banyak waktu untuk menyempurnakan lingkungan Anda untuk meningkatkan produktivitas Anda. Anda memiliki IDE favorit Anda. Anda memiliki debugger favorit Anda. Anda memiliki alat pemantauan kinerja favorit Anda. Tapi bagaimana dengan alat Anda untuk menulis dokumentasi, manual, dan laporan? Lagi pula, menulis memang menghabiskan banyak waktu Anda, bukan? Memang, inilah saatnya untuk serius dengan alat tulis Anda.

Dan mari kita ingat bahwa Anda teknis , jadi editor WYSIWYG mungkin atau mungkin bukan pilihan terbaik untuk Anda. Anda tidak perlu (atau bahkan suka!) menavigasi menu, toolbar, dan pita untuk memformat teks Anda.

Jadi bagaimana jika, sebaliknya, Anda dapat dengan mudah menambahkan semua gaya pemformatan Anda langsung ke dalam teks sebagai sintaks sebaris sederhana untuk menghasilkan teks yang sepenuhnya diformat?

Sebenarnya, Anda bisa. Itulah penurunan harga dan itulah tujuan dari tutorial ini.

Ketika Lebih Banyak Kurang…

Perangkat lunak pengolah kata ditulis untuk memenuhi beragam pengguna dan kasus penggunaan dan, dengan demikian, perlu menyediakan segala macam fungsionalitas. Namun yang jelas, hanya sebagian kecil dari fungsi itu yang mungkin relevan untuk setiap pengguna individu. Dan bagi sebagian besar pengguna, yang hanya ingin menulis dokumen (dan tidak perlu mendesain brosur atau poster pemasaran), sebagian kecil dari banyak pilihan yang tersedia relevan.

Faktanya, Microsoft dengan jelas menyadari hal ini beberapa tahun yang lalu ketika mereka mendesain ulang antarmuka pengguna Microsoft Word menjadi pengelompokan fungsional yang berbeda yang mereka sebut "pita". Namun yang menarik, sebagian besar pengguna akan memberi tahu Anda bahwa mereka menemukan antarmuka baru lebih membingungkan dan sulit dinavigasi daripada pendahulunya.

Memang, lebih banyak terkadang bisa lebih sedikit dalam hal kemudahan penggunaan dan produktivitas.

… dan Ketika Lebih Sedikit Lebih Banyak

Hadapi saja, Anda adalah seorang insinyur perangkat lunak, bukan seorang desainer grafis. Anda hanya ingin menulis manual itu, atau dokumen teknis, atau laporan, dan selesai dengan itu. Anda akan sangat senang dan puas dengan beberapa kemampuan pemformatan dasar seperti heading, daftar berpoin atau bernomor, dan blok kode. Dan, oh ya, beberapa pemformatan font (tebal, miring, dll.) juga akan membantu. Itu saja. (Dan kawan, jika Anda bahkan bisa melakukannya di vi, itu akan sangat luar biasa!)

Masukkan Penurunan Harga.

Apa itu Markdown?

John Gruber (dengan kontribusi substansial dari guru teknis dan aktivis Internet Aaron Swartz) menciptakan bahasa Markdown pada tahun 2004 dengan tujuan memungkinkan orang “menulis menggunakan format teks biasa yang mudah dibaca, mudah ditulis, dan opsional mengubahnya menjadi XHTML (atau HTML) yang valid secara struktural”.

Penurunan harga dirancang agar dapat dibaca apa adanya, tanpa terlihat seperti telah ditandai dengan tag atau instruksi pemformatan (tidak seperti teks yang diformat dengan bahasa markup seperti RTF atau HTML yang sulit untuk ditulis dan sulit dibaca dalam format mentahnya. ).

Penurunan harga memungkinkan Anda menulis menggunakan format teks biasa yang mudah dibaca dan ditulis, yang kemudian dapat diubah menjadi HTML yang valid secara struktural. Jadi, tepatnya, penurunan harga sebenarnya adalah dua hal:

1. Sintaks pemformatan teks biasa
2. Alat perangkat lunak (versi pertama yang ditulis dalam Perl) yang mengubah format teks biasa menjadi HTML.

Penurunan harga menggabungkan beberapa konvensi sintaks yang sederhana, cukup intuitif, dan mudah digunakan. Khusus untuk Anda sebagai seorang insinyur perangkat lunak – yang tidak menunda-nunda kebutuhan untuk mempelajari dan menggunakan konvensi sintaksis dasar ini – Penurunan harga memang bisa menjadi jalan yang paling tidak tahan antara apa yang ingin Anda tulis dan tuliskan.

Pelajari Penurunan Harga: Memulai

Penurunan harga mudah dipelajari. Sangat mudah. Anda dapat mempelajari dasar-dasarnya dalam lima menit dan itu akan segera menjadi kebiasaan. Dan – seperti hubungan antara CSS dan praprosesor CSS – Anda dapat menggunakan sesedikit atau sebanyak yang Anda suka.

Jika Anda terbiasa dengan konvensi penulisan teks biasa, Anda mungkin sudah terbiasa dengan beberapa konvensi penurunan harga, seperti angka atau tanda hubung di awal kalimat untuk membuat daftar, tanda bintang di sekitar kata untuk penekanan, dan sebagainya. di. Jadi, misalnya, jika Anda ingin menampilkan sesuatu dalam huruf miring, cukup bungkus dengan tanda bintang seperti *this* (sebagai lawan dari sintaks HTML yang lebih kaku seperti <span>this</span> ).

Demikian pula, Anda dapat menentukan judul H1 hanya dengan menambahkan awalan '#' ke baris Anda (misalnya, # Section Heading , daripada <h1>Section Heading</h1> ).

Penggunaan hebat lainnya untuk mempelajari penurunan harga, terutama bagi kami para insinyur perangkat lunak, adalah menggunakannya untuk dokumentasi pada repositori kode sumber. Kebanyakan repo menyertakan file README.md ( .md adalah ekstensi standar untuk file penurunan harga). Github, misalnya, memiliki “Penurunan harga rasa Github” sendiri, yang menambahkan fungsionalitas tambahan khusus untuk dokumentasi pengembangan. Ini tentu dapat menghemat waktu karena harus menulis dokumentasi ini dalam HTML.

Sebagai contoh sederhana, katakanlah Anda ingin menyertakan cuplikan berikut dalam dokumentasi Anda:

<h2 style=color:#3863a0;font-size:1.5em;font-weight:600;margin-top:2em;margin-bottom:1em;line-height:1.3em;>Memulai Plugin</h2>

Mulai pluginName pada wadah Anda menggunakan jQuery sebagai berikut:

$(function() { $('#container').pluginName(); }); Menggunakan ID penampung kita, kita dapat memulai pluginName dengan metode jQuery .pluginName() .

Berikut perbandingan bagaimana ini akan dilakukan dalam HTML vs. Penurunan harga:

Untuk bantuan lebih lanjut dalam memulai, ada banyak tutorial Penurunan Harga secara online untuk membantu Anda mendapatkan informasi terkini termasuk ikhtisar Penurunan Harga oleh John Gruber (pembuat Penurunan Harga) serta tutorial Penurunan Harga online.

Pengurai dan Alat Penurunan Harga

Setelah Anda menulis artikel Anda di Markdown, Anda akan memerlukan sebuah aplikasi untuk mengurai sintaks ke dalam HTML. Ada beberapa yang bagus yang gratis termasuk:

• StackEdit - editor penurunan harga berbasis browser yang memiliki beberapa opsi sinkronisasi dengan layanan populer seperti Google Drive dan Dropbox
• Editor Kramdown Online - editor penurunan harga berbasis browser lainnya dengan antarmuka yang sangat sederhana
• Mou - penulis Markdown berbasis Mac terbaik yang pernah saya temui sebagai opsi geekier untuk pengembang; banyak fitur dan gratis (saat dalam versi beta) [inilah yang saya gunakan untuk menulis artikel ini]
• MarkdownPad - editor penurunan harga yang bagus untuk Windows
• Teks - editor lintas platform (Mac dan Windows) yang bagus; ekspor ke berbagai format seperti PDF, .doc, dan ePub

Beberapa platform utama telah mengadopsi (atau setidaknya mengizinkan) penggunaan penurunan harga di editor mereka bagi mereka yang ingin menggunakannya. Dengan yang lain, seperti WordPress, Evernote, dan Google Documents, dukungan asli (pada saat menulis artikel ini) belum dimasukkan, tetapi solusi khusus telah diperkenalkan oleh pihak ketiga. Ini termasuk:

• Platform blogging baru yang populer Ghost, dalam upaya merampingkan penulisan online, menggunakan Markdown untuk editor kontennya.
• Untuk WordPress, plugin Jetpack sekarang secara resmi mendukung penurunan harga, yang dapat Anda aktifkan di bawah Pengaturan > Diskusi jika Anda menggunakan plugin. Atau Anda dapat menggunakan plugin seperti WP-Markdown yang akan mengubah konten penurunan harga posting Anda menjadi HTML, dan kembali ke Penurunan harga saat Anda perlu mengeditnya.
• Untuk Evernote, beberapa aplikasi penurunan harga seperti editor online Markable atau editor Mac Byword memungkinkan ekspor dan penerbitan langsung ke catatan. Atau jika Anda lebih suka menggunakan aplikasi web Evernote secara langsung, Anda dapat menggunakan ekstensi browser bernama Markdown Here yang mengubah catatan terpilih yang ditulis menjadi Markdown menjadi teks yang diformat dengan mengklik tombol toolbar.
• Google Documents belum mendukung penurunan harga secara asli, tetapi beberapa editor (seperti StackEdit) akan mengekspor/menyinkronkan langsung dengan Drive.

Kekurangannya

Tentu saja, dengan kesederhanaan yang luar biasa datang keterbatasan. Seperti yang sudah saya jelaskan, Penurunan harga tidak ditulis untuk tugas pemrosesan kata yang rumit yang membutuhkan fitur pemformatan tingkat lanjut. Jika itu yang Anda butuhkan, Markdown bukanlah alat yang tepat.

Tetapi untuk pengembang yang perlu menulis panduan pengguna atau dokumentasi teknis atau laporan teknis, penurunan harga memberikan keseimbangan yang hampir sempurna antara kesederhanaan dan fitur yang Anda butuhkan.

Mungkin kelemahan terbesar – terutama bagi kami para insinyur yang pecandu kontrol perubahan – adalah ketidakmampuan untuk bekerja secara kolaboratif dalam Penurunan Harga dan untuk melacak perubahan (satu pengecualian penting untuk ini, adalah plugin StackEdit untuk Google Documents). Dan tentu saja, dengan sedikit usaha, seseorang dapat dengan mudah berkolaborasi pada dokumen Markdown melalui repositori git dan dengan demikian mendapatkan semua pelacakan perubahan dan kolaborasi yang biasanya dibutuhkan.

Kesimpulan

Jadi, apakah belajar Markdown untuk semua orang? Tentu saja tidak. Tidak ada satu alat pun yang pernah ada.

Tetapi jika Anda seorang insinyur perangkat lunak, itu bisa menjadi alat penulisan yang Anda cari. Jadi, jika Anda belum mencobanya, Anda harus benar-benar mencobanya.