Documentation/Style guide/id

Gambaran umum
Panduan gaya ini memberikan panduan untuk menulis dan menyunting dokumentasi teknis di MediaWiki dan ruang teknis lainnya. Panduan ini memberikan kiat-kiat menulis dokumentasi teknis yang jelas dan ringkas dalam bahasa yang sederhana. Panduan ini juga menautkan sumber daya lain mengenai penulisan dan penyuntingan teknis secara umum.

Dokumentasi teknis yang bagus memudahkan orang-orang berkontribusi ke proyek-proyek Wikimedia. Penting untuk mengikuti standar yang jelas dan panduan gaya menulis dan menyunting dokumentasi, khususnya ketika kontributor dan pembaca punya tingkat kemampuan dan pengalaman yang beragam. Tidak peduli apakah Anda merasa diri Anda adalah seorang penulis atau bukan, kontribusi Anda dibutuhkan dan diapresiasi.



Pedoman Gaya Wikipedia bahasa Inggris
Pedoman Gaya Wikipedia bahasa Inggris mencakup topik-topik penulisan secara umum (seperti tanda baca) secara terperinci, dan meringkas poin-poin penting dari panduan gaya lainnya. Pedoman ini bisa menjadi rujukan yang berguna bagi siapa pun yang menulis atau menyunting dokumentasi teknis dalam bahasa Inggris di proyek-proyek Wikimedia, khususnya apabila wiki lokal tidak punya panduan yang lebih spesifik.

Halaman ini menyediakan panduan dan kiat-kiat untuk membantu Anda memulai terbiasa dengan dokumentasi teknis. Halaman ini mengandung beberapa informasi spesifik mengenai dokumentasi teknis yang tidak dicakup di Pedoman Gaya Wikipedia.



Pembaca dan konten


Menulis untuk pembaca teknis
Sebelum Anda mulai menulis, pertimbangkan siapa pembaca karya Anda.


 * Siapa yang Anda bayangkan akan membaca dokumentasi teknis ini?
 * Dari mana asal mereka?
 * Seberapa kenal mereka dengan konsep yang Anda sampaikan?
 * Apa yang mungkin mereka perlu ketahui agar paham?

Setelah Anda paham siapa pembaca Anda, Anda harus memahami apa yang Anda perlu komunikasikan.



Menulis dengan tujuan
Tujuan apa yang akan dicapai oleh dokumentasi teknis Anda? Terdapat banyak alasan untuk menulis dokumentasi. Akan berguna untuk mengetahui mengapa Anda menulis dan apa sasaran Anda sebelum Anda memulai.


 * Apakah untuk mengajari seseorang, misalnya pendatang baru, tentang suatu proses atau konsep?
 * Apakah untuk menunjukkan seseorang cara melakukan suatu proses?
 * Apakah untuk memberikan latar belakang dan konteks untuk suatu konsep atau proses?
 * Apakah untuk dijadikan referensi yang dimaksudkan untuk memberikan informasi?



Menulis di dalam konteks
Ketika menentukan apa yang mau ditulis dan bagaimana cara menyampaikannya kepada pembaca Anda, sebaiknya Anda menetapkan konteks atau latar belakang dari tulisan Anda. Komunikasi Anda terjadi dalam suatu konteks situasi yang lebih besar. Konteksnya bisa dibatasi oleh era waktu Anda menulis, jenis teknologi yang tersedia, lokasi geografis dan budaya Anda, atau budaya dan gaya komunikasi pembaca Anda. Latar belakangnya bisa jadi bersifat pribadi dan muncul dari situasi yang memotivasi Anda untuk menulis atau memperbaiki suatu dokumentasi.

Contohnya, jika Anda menulis dokumentasi teknis untuk proyek Wikimedia, pertimbangkan budaya yang dibuat oleh orang-orang yang berpartisipasi dalam proyek-proyek tersebut. Bagaimana Anda sebaiknya memosisikan tulisan Anda di dalam konteks komunitas ini dan budayanya demi membuat dokumentasi teknis yang sebermakna dan seberguna mungkin?



Uji coba dan umpan balik pengguna
Buatlah dokumentasi teknis untuk mengomunikasikan gagasan dan konsep kepada pengguna pembaca yang nyata. Tentu saja, pembaca ini sebaiknya memainkan peran penting dalam pembentukan dan pembentukan ulang dokumentasi ini. Pikirkan cara untuk Anda mengumpulkan informasi tentang pengalaman pengguna Anda. Luangkan waktu untuk menjawab pertanyaan berikut:


 * Apakah dokumentasi Anda memiliki mekanisme untuk umpan balik?
 * Bisakah Anda melakukan percakapan dengan para pembaca untuk membuat perbaikan?
 * Can you use forums like Stack Overflow or mailing lists to check if your document answers the most common questions people have about your specific topic?



Kejelasan dan konsistensi
Kejelasan dan konsistensi membuat mengakses, membaca, dan membuat dokumentasi teknis untuk MediaWiki/Wikimedia menjadi lebih mudah. Dokumentasi teknis ditulis untuk pembaca yang luas dan disunting oleh beragam kontributor.

Suara, nada, tata bahasa, gaya, dan format sebaiknya konsisten di seluruh dokumentasi dan kumpulan konten lainnya. Ini membantu para pembaca mempelajari cara menelusuri informasi dan mempermudah kontributor memahami cara menyunting dan menambahkan informasi baru.



Menentukan jenis dokumen
Kenali pembaca utama Anda, tujuan, dan konteks terlebih dahulu untuk memutuskan jenis dokumen yang akan Anda buat.

Language
This section briefly mentions some topics worth exploring elsewhere in more detail. Always check your words and expressions against these criteria on Wiktionary: Wiktionary entries cover hundreds of languages, explicitly state the grammatical and lexical features of words and their declensions, provide detailed context labels (including about jargon, UK vs. USA English) and expose how translatable terms are in hundreds of other languages.

Plain English
Please remember: many visitors to these pages are not native English speakers.

For documentation written in English, Plain English (also called plain language) works best. Clear writing is the most understandable by diverse audiences, and is also easiest to translate. There are a number of good tools for checking your writing, at Tech News' Writing Guidelines on Meta-Wiki.

Voice and tone
MediaWiki is a place where anyone can edit. Thus, it can be difficult to maintain a consistent voice and tone in the documentation.

Consider using these elements in your writing:

Point of view

 * Use second person ("You" or assumed "You") when addressing your audience.
 * Avoid first person ("I" or "we"), unless you are writing a FAQ with questions asked from the first person perspective.
 * Use an imperative mood for most documentation focused on goals or process.

Dates

 * Always use the full, four-digit year.
 * Use absolute dates ("in May 2037") instead of relative dates ("next year in May").
 * Avoid adding dates that will require regular manual updates. Example: Write  instead of  when referring to the current year, no matter what year it is currently.

Overview
All pages should include an overview section (also called the Lead section) that explains:


 * 1) Purpose of the page
 * 2) Audience of the page
 * 3) Prerequisites the reader will need to know before proceeding (Ex. a working knowledge of Python)
 * 4) Software or tools the reader will need to complete the processes or tasks outlined on the page (Ex. Java installed)
 * 5) Use case, case study, a practical understanding of the product, service or tool in action. (optional)

Table of contents

 * Each page should include a table of contents, so information can be accessed easily.

Titles and headers

 * Use sentence case for headers.
 * Keep header fonts consistent throughout documentation.
 * Optional use of anchors to link sections or subsections in the same page.
 * Add a blank line after section headers. This impacts how the content is packaged for translation.
 * Do not put a header before your overview or lead section.

Information flow
Technical documentation pages should follow a consistent pattern across content collections.

An ideal pattern for each page might be:


 * Page title
 * Introduction/Overview
 * Header
 * Content
 * Subhead if needed
 * Content

Formatting code examples and other technical elements
Formatting distinguishes code and other technical elements from regular text.

Templat
Templates are often used on MediaWiki.org pages. Templates can help to maintain consistency and can make it easier to translate information.

Below are some common templates.

Templates for page formatting

 * caution, fixtext, note, tip, todo, warning - for styles of inline highlight boxes
 * fixme, historical, notice, outdated, update - for page/section message boxes
 * main, see also - for page/section hatnotes (a short note placed at the top of an article)

Templates for MediaWiki core and Git source

 * class doclink, file doclink, js doclink - to link to MediaWiki core's generated documentation
 * MW file - for a box with info and links for a file in MediaWiki core
 * git file - to link to source code

Templates for Phabricator

 * ptag - for the top-right-of-page Phabricator project tag
 * tracked - for the related Phabricator task

Other useful templates

 * - for IRC link
 * Key press - for, e.g. Ctrl, and button for, e.g.
 * ApiEx - for api.php request URLs
 * Api help - to transclude generated API documentation
 * RestOfVariableName - for global variables
 * tag - for a quick way to mention an XML-style tag in a preformatted way

Terjemahan
All pages on mediawiki.org are candidates for translation into multiple languages. MediaWiki.org is a multilingual wiki, it uses the Translate extension to present alternative translations and manage the translation of pages.



Lihat pula

 * Some other technical documentation style guides:
 * Google Developer Documentation Style Guide
 * MDN Web Docs Writing Style Guide
 * Technical writing
 * Other language related resources:
 * word-list
 * Naming things
 * Naming things