Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- WordPress
- {i>Technical writer <i}(Penulis teknis):
- tacitonic
- Nama project:
- Kumpulan Panduan Gaya Dokumentasi Lengkap dan Terbaru
- Durasi project:
- Berjalan lama (5 bulan)
Project description
Sinopsis:
WordPress adalah organisasi software nonprofit global yang berdedikasi untuk melayani komunitas global dengan software yang menekankan aksesibilitas, performa, keamanan, dan kemudahan penggunaan. WordPress berupaya mendemokratisasi publikasi dan software open source di web. Di era digital ini, situs adalah fasad online organisasi/individu; dan WordPress menjalankan tugas besar untuk melayani ratusan juta pengguna secara efisien - yang diatribusikan ke 35% internet yang dijalankannya - dengan software-nya. Untuk melayani pengguna ini secara lebih efisien, dokumentasi terbukti sangat penting dan digunakan oleh sebagian besar developer, administrator, dan pengguna akhir. Oleh karena itu, dokumentasi dapat ditetapkan sebagai faktor utama ekosistem WordPress. Dokumentasi WordPress saat ini tidak menyertakan kumpulan aturan dan pedoman gaya yang universal & terpadu untuk publikasi. Motif proposal ini adalah untuk membuat serangkaian panduan gaya dokumentasi yang lengkap dan diperbarui, yang berlaku secara universal untuk dokumentasi WordPress. Ide project melibatkan penggabungan semua aspek pedoman desain dan gaya seperti semantik, sintaksis, pedoman tata bahasa, tanda baca, aturan khusus pengembangan, atribut desain, dan spesifikasi pemformatan. Hal ini juga menggabungkan konvensi bahasa seperti suara, nada, tense, semua bagian ucapan, serta konvensi penamaan. Alat, bahasa, dan platform yang digunakan adalah WordPress CMS, GitHub, Markdown, dan mungkin juga terdiri dari PHP/MySQL, HTML/CSS, dan JavaScript.
Rencana Project:
Status Saat Ini Panduan Gaya Dokumentasi WordPress: Tim Dokumentasi WordPress telah menerapkan metodologi panduan publikasi yang tidak dideklarasikan, tetapi bulat. Namun sesekali, beberapa elemen digunakan dan prosesnya menjadi spekulatif. Tidak ada standar dan kriteria tetap untuk tujuan menulis dan memublikasikan artikel untuk WordPress. Tim dokumentasi telah menulis panduan gaya khusus project, tetapi tidak ada yang berlaku secara universal. Sebagian besar panduan gaya yang sudah ada tidak digabungkan dalam satu buku panduan, atau sudah tidak digunakan lagi dan perlu diperbarui. Oleh karena itu, perlu mendesain dan mengembangkan panduan gaya terpadu untuk menstandarkan dokumentasi WordPress.
Tujuan:
Lebih dari 35% situs internet berjalan di WordPress, yang pada akhirnya menunjukkan bahwa jutaan developer dan pengguna akhir menggunakan fungsi WordPress yang mengesankan. Dokumentasi adalah elemen penting dalam membantu developer dan pengguna ini memenuhi fungsi ini secara efisien tanpa kerumitan, bahkan jika ada ketidaknyamanan. Tujuan keseluruhan proposal project ini adalah untuk menstandarkan panduan desain & gaya, menyatukan panduan gaya yang ada dan memperbarui serta menambahkan peraturan dan spesifikasi baru untuk dokumentasi WordPress. Hal ini akan memungkinkan kemudahan penggunaan, kesederhanaan, dan keseragaman dalam dokumentasi WordPress.
Implementasi:
Seperti yang disarankan oleh mentor (Jon Ang) untuk project ini, project dapat dilakukan dalam 4 fase: fase Penemuan, Definisi, Penerapan, dan Pemeliharaan. Sebelum memulai project, selama periode pra-magang, saya akan bekerja sama dengan mentor saya dan menyelesaikan jadwal dan linimasa yang sesuai dengan linimasa & hasil yang akan saya capai. Saya akan lebih memahami sistem WordPress dan protokol kerja untuk project ini.
Saat magang dimulai, saya akan mendiskusikan dan membuat draf abstrak rencana dengan mentor saya. Persyaratan dan kebutuhan akan ditentukan. Pertama, saya akan menguraikan alur dokumentasi dan proses interaksi pengguna. Selanjutnya, wireframe tata letak dari setiap bagian, kategori, dan komponen akan diuraikan. Tata letak ini kemudian akan ditinjau oleh mentor saya. Jika diperlukan, tata letak akan didesain ulang dan beberapa komponen akan ditambahkan/dihapus. Kemudian, saya akan melakukan riset pengguna untuk menentukan kegunaan dan kelayakan alur antarmuka. Selanjutnya, Panduan Gaya Dokumentasi akan diterapkan (seperti yang diilustrasikan dalam diagram di bawah) per bagian. Panduan gaya dari organisasi lain yang berada di bawah lisensi open source atau Creative Commons juga dapat dirujuk untuk menambahkan panduan kami. Jika selama periode ini, terjadi kesulitan kegunaan, saya akan mendesain ulang.
Pengujian dan pengoptimalan akan dilakukan setelah panduan gaya selesai dibuat dan diintegrasikan dengan HelpHub. Setiap kerentanan, elemen atau komponen yang berlebihan akan diperbaiki. Pengujian UI dan kode akan dilakukan dan bug & error yang tidak diinginkan akan diperbaiki, jika diperlukan. Kendali mutu akhir untuk panduan gaya yang lengkap akan dilakukan untuk bahasa, tata bahasa, ejaan, tanda baca, dll.
Tugas yang tertunda karena penundaan yang tidak terduga akan diselesaikan dalam periode buffering. Fungsi atau fitur tambahan yang akan ditentukan dapat dilakukan selama proses project dapat diterapkan setelah pengujian akhir selesai. Rencana deployment akan dibuat dan produk jadi akan dikirimkan.
Alat & Metodologi:
Dokumentasi akan dikompilasi dan diedit di platform kolaboratif, seperti Google Dokumen. Jika diwajibkan untuk memublikasikan melalui GitHub, bahasa markup seperti Markdown atau GitHub Flavored Markdown juga dapat diterapkan. Untuk standar desain dan gaya, pedoman gaya open source juga dapat dirujuk. Terakhir, dokumen yang telah selesai akan diformat dan dipublikasikan menggunakan WordPress.
Tabel Komponen:
Ini adalah daftar lengkap komponen yang dapat diimplementasikan dalam Panduan Gaya. Pedoman Dokumen - Aksesibilitas, Struktur Dokumen, Encoding, Sumber Eksternal, Fakta, Font, Audiens Global, Inklusivitas, Legalitas, Aksesibilitas Multi-platform, Tidak Ambigu, Tidak Ada Klaim Berlebihan, Tata Letak Halaman, Kesesuaian dengan Norma Politik, Protokol, Keamanan, Struktur Kalimat, Penulisan Ringkas, Nada & Gaya, Tidak Bias
Bahasa & Tata Bahasa - Singkatan & akronim, Pernyataan & Negasi, Artikel, Huruf kapital, Klausa, Ucapan langsung/tidak langsung, Orang pertama/kedua/ketiga, Gender, Glosarium, Kata benda, Awalan & akhiran, Preposisi, Kata ganti, Referensi, Slang & jargon, Ejaan, Istilah teknis, Tenses, Kata kerja, Suara
Tanda Baca - Tanda Kutip & Apostrof, Titik Dua & Titik Koma, Koma, Elipsis, Tanda Seru, Tanda Hubung & Garis Miring, Tanda Kurung, Titik, Tanda Tanya, Garis Miring
Pemformatan - Abstrak, Pengantar, Prakata, Nama Merek, Nama Produk, Teks, Cuplikan Kode, Blok Kode, Tanggal & Waktu, Zona Waktu, Tempat, Mata Uang, Nama File, Catatan Kaki, Judul & Judul, Penandaan (Tebal, Miring, Garis Bawah, Coretan, Kutipan), Indentasi, Indeks, Link & URL, Daftar, Poin Butir, Penomoran, Media (Gambar, Video) & Ilustrasi, Catatan, Peringatan, Tips, Angka & Nomor Telepon, Polyglot, Terjemahan, Skrip Bahasa, Spasi, Tabel, Teks, Merek Dagang, Hak Cipta, Paten, Kutipan, Tutorial & Prosedur, Elemen UI, Satuan Pengukuran
Antarmuka Pengguna - Aktivitas, Tombol, Cuplikan Kode, Blok Kode, Antarmuka Command Line, Dialog, Menu & Dropdown, Pop-up & Notifikasi, Tab, Terminologi, Elemen UI, Jendela
Kode - CSS, HTML, JS, Markdown, MySQL, PHP, Sintaksis, XML
Kamus/Glosarium Penggunaan Kata - A sampai Z