JDOC

Bagaimana Berkontribusi ke Dokumentasi Joomla!

From Joomla! Documentation

Revision as of 10:15, 1 April 2017 by FuzzyBot (talk | contribs) (Updating to match new version of source page)
Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Nederlands • ‎Türkçe • ‎eesti • ‎español • ‎français • ‎italiano • ‎português • ‎português do Brasil • ‎Ελληνικά • ‎فارسی • ‎हिन्दी • ‎বাংলা • ‎中文(台灣)‎ • ‎日本語

Dokumentasi Joomla! diperkuat oleh perangkat lunak Wikipedia yang sama. Pertumbuhan dan kesuksesannya tergantung dari orang-orang seperti Anda. Terima kasih telah mengambil langkah pertama untuk berkontribusi ke Proyek Joomla. Laman ini akan membimbing Anda tentang bagaimana cara memulainya dan bagaimana membantu usaha pendokumentasian.

Memulai!

Ada beberapa hal yang harus Anda lakukan terlebih dahulu.

Baca Kebijakan Wiki

Anda perlu mengulas kebijakan Wiki Dok Joomla! sebelum mulai mengedit.

Buat Akun Pengguna

Untuk mengedit Wiki Dokumentasi Joomla, Anda memerlukan sebuah akun pengguna. Anda bisa mendaftar disini. Setelahnya pastikanlah untuk mengkonfirmasi alamat email Anda. Mengkonfirmasi alamat email akan memberikan izin kepada Anda untuk mengedit laman apapun kecuali yang dilindungi.

Buat Laman Pengguna

Setelah membuat akun, mengkonfirmasi alamat email dan masuk, Anda harus membuat sebuah laman pengguna. Beberapa contekan kecil untuk memulai laman pengguna yaitu:
  • Pada menu pengguna, pergi ke laman Nama Pengguna Anda (atau gunakan butir menu pertama yang ada di paling ujung kanan laman)
  • Klik tombol aksi dropdown
    JDOCS-actions-create-page-id.png
  • Klik Buat
  • Tambah kode ke editor {{subst:Newuser}}
  • Isilah ringkasan (misalnya Ini adalah laman pengguna baru saya)
    JDOCS-summary-form-input-id.png
  • Klik tombol simpan

Bergabung di Milis Dokumentasi

Anda harus bergabung ke milis Dok. Memang tidak wajib, tapi mungkin Anda akan kehilangan diskusi yang berhubungan dengan dokumentasi.

Apa Yang Harus Dilakukan Pertama Kali?

Terdapat beberapa area di dokumentasi yang selalu membutuhkan perhatian. Anda bisa mulai dengan memilih salah satu dari yang paling nyaman bagi Anda atau mungkin sekaligus. Setelah memiliki akun wiki, maka Anda bebas bekerja pada aspek-aspek dokumentasi manapun yang menarik minat Anda. Bahkan kontribusi kecil seperti, memeriksa ejaan dan memperbaiki tata bahasa adalah bantuan yang besar sekali!

  1. Bantu konten dokumentasi.
  2. Tugas-Tugas Pemeliharaan.
  3. Gabung atau mulai proyek dokumentasi.
  4. Bantu Layar Bantuan.

Bantu Kelola Konten Kami

  1. Mengedit, menulis ulang, dan penyusunan laman. Periksa Perlu laman untuk area-area yang membutuhkan bantuan segera. Mereka disebut 'Perlu laman' karena memang dibutuhkan tugas-tugas kecil untuk melengkapinya. Ada yang sederhana seperti, mengulas konten atau menambahkan sebuah gambar. Yang lainnya memerlukan penambahan konten atau peningkatan. Pilihlah dan berikanlah sedikit cinta untuk mereka. Ini adalah sebuah bantuan yang hebat untuk para pengguna Joomla! yang bergantung pada dokumentasi.
  2. Bersenang-senanglah dan telusurilah artikel-artikel yang mubazir, yang sudah kadaluwarsa (seperti 1.0 dan 1.5), atau yang memerlukan pemisahan karena informasi versi tertentu. Lalu, jangan ragu untuk menggunakan templat {{delete}}, {{merge}} atau {{JSplit}} pada artikel-artikel tersebut. Klik tautan-tautan templat sebelumnya untuk melihat bagaimana cara menggunakan dan menerapkannya ke artikel-artikel yang Anda pikir perlu penanda templat ini. Tambahkanlah ke bagian paling atas laman dan demikianlah laman tersebut ditandai.
  3. Buat laman baru atau tutorial. Bila Anda ingin membuat sebuah laman baru, lakukanlah penelitian yang luas terlebih dahulu. Hindari membuat artikel baru bila sudah ada. Gunakan fitur pencarian Wiki Dok untuk melihat apakah topik Anda sudah pernah dibuat. Duplikasi akan disatukan dan/atau dihapus. Jangan ragu untuk memodifikasi, membuat format ulang, atau memperbaiki pekerjaan orang lain di Wiki Dok Joomla. Ini adalah wiki dokumentasi kolaborasi, tapi pastikan Anda mengikuti kebijakan dan panduan.
    1. Menggunakan tautan-tautan wiki. Sangat mudah untuk menautkan sebuah laman dengan menggunakan sintak standar. Bila Anda membuat sebuah tautan ke sebuah artikel yang belum ada, maka tautannya akan berwarna merah. Mengklik tautan berwarna merah akan mengantarkan Anda ke laman edit laman untuk artikel baru. Ketiklah tulisan Anda, klik simpan dan laman yang baru akan tercipta. Setelahnya tautan akan berubah dari berwarna merah menjadi biru yang menandakan bahwa artikel tersebut sekarang sudah ada.
    2. Menggunakan URL. Digunakan ketika Anda ingin membuat sebuah laman dari nol. Anda dapat menggunakan URL wiki untuk membuat sebuah laman yang baru. URL ke artikel wiki biasanya akan seperti ini: https://docs.joomla.org/JUDULARTIKELANDA. Bila Anda mengganti JUDULARTIKELANDA dengan nama laman yang ingin Anda buat, maka Anda akan mendapati sebuah laman kosong yang menandakan bahwa belum ada artikel dengan nama tersebut. Mengklik tautan Buat halaman ini akan mengantarkan Anda ke laman edit untuk artikel itu, dimana Anda bisa membuat laman baru dengan mengetikkan tulisan Anda, lalu klik Kirim.
  4. Bantu memperbarui gambar di artikel. Periksa kategori Perlu pembaruan gambar untuk melihat daftar laman yang memerlukan pembaruan gambar-gambar. Panduan untuk membantu Anda ada di artikel, panduan penamaan Gambar.


Pemeliharaan Wiki

Memelihara sebuah wiki dan membuatnya tetap tersusun rapi memerlukan usaha dan kerja yang berkesinambungan pada bagian-bagian administrator, editor, dan pengguna. Selalu ada tugas-tugas seperti: Kategorisasi, melihat laman-laman yang memerlukan bantuan, yang sedang dalam pengerjaan, atau menandakan laman untuk penghapusan, penyatuan/penggabungan atau pemisahan. Untuk semua tugas pemeliharaan dan ide-ide bantuan Anda, silakan kunjungi laman Pemeliharaan Dokumentasi kami.

Proyek Dokumentasi

  • Tim dok sedang bekerja pada Tutorial Pemula. Tujuan kami agar ia mudah dipahami dan mudah dinavigasikan, sesuatu yang dapat diikuti oleh seorang Pemula dengan mudah untuk mempelajari konsep-konsep dasar. Bayangkanlah kembali ketika pada saat pertama kali Anda masih baru dengan Joomla! dan tambahkanlah topik-topik yang dulunya susah Anda pahami sebagai seorang pemula. Alangkah bagusnya, bila Anda bergabung ke Proyek Tutorial Pemula.
  • Bergabung bersama Proyek Tutorial Pengembang dan bagilah pengetahuan Anda. Tandai nama Anda dengan menggunakan 4 tanda gelombang ( ~~~~ ) pada laman Proyek Tutorial Pengembang dan buatlah daftar apa saja yang bisa Anda lakukan. Silakan tambah beberapa topik tutorial kedalam daftar saran topik.

Layar Bantuan

Tidak ramai orang yang mengetahui, semua laman Layar Bantuan dibuat dan melayani setiap instalasi Joomla! di seluruh dunia dari wiki ini! Sangat penting untuk para pemula dan bahkan bagi mereka yang sudah menguasai Joomla! di tingkatan menengah.

Layar Bantuan Joomla! 2.5 telah selesai namun Joomla! 3.x masih dalam pengerjaan! Kontribusi Anda akan dihargai oleh banyak pengguna di seluruh dunia. Temukan matriks Layar Bantuan 3.x disini. Beberapa diantaranya hanya perlu pengulasan dan ditandai sebagai telah selesai, yang lainnya perlu dimulai, diselesaikan, pembaruan gambar (lebar maks 670px), dll.
  • The Joomla! 4.x Help Screens need to be completely created. Any contributtion you give to them will be appreciated by many users worldwide and we're looking for volunteers to help with this important task. A matrix needs to be put in place as well as an action plan.


Yang Harus Diingat

Berikut beberapa hal yang harus diingat sebagai seorang kontributor Dok Joomla.

  • Jangan takut akan merusak sebuah laman, bila Anda memang melakukannya dan sesuatu yang buruk terjadi, kembalikan editan Anda. Klik tab Lihat Riwayat laman dan Anda akan melihat tautan-tautan undo dan pengembalian.
  • Tulislah artikel-artikel dengan latar belakang pemikiran bahwa ia akan diterjemahkan kedalam beberapa bahasa yang lain. Menggunakan bahasa-bahasa prokem atau dialek kedaerahan tidak akan diterjemahkan atau hasilnya akan sulit dimengerti.
  • Jangan takut untuk mengunduh dan membaca Panduan Gaya Editorial (PDF) umum yang diterapkan ke semua Dokumentasi Joomla. Ada petunjuk--petunjuk yang bermanfaat tentang cara penulisan Dokumentasi Joomla! disana.
  • Kata-kata yang harus diperhatikan ketika menulis, baca panduan lengkap … atau gunakan tanggapan cepat dari browser Google Chrome atau Mozilla Firefox. Ada pemeriksaan ejaan bawaan yang mereka miliki yang akan menggarisbawahi sebuah kata yang salah ketik/ejaan berdasarkan pengaturan bahasa utama masing-masing browser Anda.
  • Jangan lupa tambahkan templat {{inuse}} ke artikel Anda bila pengerjaannya memakan waktu yang lama, lebih dari satu menit. Ini akan membantu mencegah konflik penyuntingan.

Tolong, saya tidak mengerti Markup Wiki!

Bila Anda masih baru di Wiki dan dalam pemakaian markup sederhana untuk membuat laman, maka Anda bisa menggunakan bantuan berikut ini.

  • WikiEditor yang baru mengandung tombol-tombol dan tautan cepat untuk membuat laman menjadi lebih mudah. Klik Tingkat Lanjut (Advanced) untuk melihat tombol-tombol lain dan tautan-tautan format tulisan.
  • Gunakan Contekan Wiki JDOC untuk mempelajari perintah dasar sintaks. Terdapat juga sebuah dropdown markup yang biasa dipakai di editor. Klik Bantuan (Help) dan ia akan muncul.
  • Masih takut? Cobalah alat berikut yang dapat membantu Anda membuat laman-laman wiki yang hebat.
  • Pengaya Microsoft Word untuk Markup Wiki, menyimpan Dok Word dalam Markup Wiki.
  • OpenOffice.org versi 2.4 dan terbaru memiliki filter ekspor MediaWiki bawaan. Buka saja sebuah dokumen Penulis dan klik Berkas - Ekspor. Lalu, ubah format Berkas ke MediaWiki.
  • Berikut adalah alat-alat yang tersedia untuk mengubah format-format lain kedalam format wiki, misalnya HTML, Excel, CSV. Beberapa diantaranya adalah konverter online, potong dan tempelkan HTML untuk membuat sebuah output ber-markup wiki.
  • Dapatkan bantuan di Glip (kami punya 2 kelompok disana yaitu: satu untuk Kelompok Terjemahan JDoc dan satunya lagi Kelompok Kerja JDoc).
  • Tanyakan pertanyaan di laman bicara editor atau kepada seorang administrator.