Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- WordPress
- Penulis teknis:
- tasitonik
- Nama proyek:
- Panduan Gaya Dokumentasi Lengkap dan Terbaru
- Durasi proyek:
- Jangka panjang (5 bulan)
Project description
Sinopsis:
WordPress adalah organisasi software nonprofit global yang didedikasikan untuk melayani komunitas global dengan software yang menekankan aksesibilitas, performa, keamanan, dan kemudahan penggunaan. Upaya WordPress berupaya mendemokrasikan software publikasi dan open source di web. Di era digital kita, situs secara harfiah adalah fasad online sebuah organisasi/individu. WordPress memiliki tugas besar untuk melayani ratusan juta pengguna secara efisien - dikaitkan dengan 35% internet yang dijalankannya - dengan software mereka. Untuk melayani pengguna ini 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 mencakup serangkaian aturan yang universal & terpadu, serta pedoman gaya untuk publikasi. Tujuan dari proposal ini adalah untuk membuat serangkaian panduan gaya dokumentasi yang lengkap dan diperbarui, yang berlaku secara universal untuk dokumentasi WordPress. Ide proyek melibatkan konsolidasi semua aspek pedoman desain dan gaya seperti semantik, sintaksis, pedoman tata bahasa, tanda baca, aturan khusus pengembangan, atribut desain dan detail pemformatan. Sistem ini juga menggabungkan konvensi bahasa seperti suara, nada, ketegangan, semua gaya bahasa, serta konvensi penamaan. Alat, bahasa, dan platform yang digunakan adalah CMS WordPress, GitHub, Markdown, dan mungkin juga terdiri dari PHP/MySQL, HTML/CSS, dan JavaScript.
Rencana Proyek:
Status Panduan Gaya Dokumentasi WordPress Saat Ini: Tim Dokumentasi WordPress telah menerapkan metodologi pedoman publikasi yang tidak dinyatakan, tetapi tidak mutlak. Tapi sesekali, beberapa elemen diprakirakan dan prosesnya menjadi spekulatif. Tidak ada standar dan kriteria tetap untuk tujuan penulisan dan publikasi artikel untuk WordPress. Tim dokumentasi telah menulis pedoman gaya khusus proyek, tetapi tidak ada yang berlaku secara universal. Sebagian besar panduan gaya yang ada tidak digabungkan dalam satu panduan, atau tidak digunakan lagi dan perlu diperbarui. Oleh karena itu, Anda perlu merancang 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 untuk memenuhi fungsi ini secara efisien tanpa kerepotan, bahkan jika terjadi ketidaknyamanan. Tujuan keseluruhan dari proposal proyek ini adalah untuk menstandarkan panduan desain & gaya, menyatukan panduan gaya yang sudah ada dan melakukan pembaruan, 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 proyek ini, proyek ini dapat didekati dalam 4 fase: fase Penemuan, Definisi, Implementasi, dan Pemeliharaan. Sebelum proyek dimulai, selama periode pra-magang, saya akan bekerja dengan mentor saya dan menyusun jadwal dan {i>timeline<i} yang sesuai sesuai dengan rentang waktu dan hasil kerja saya. Saya akan membiasakan diri lebih lanjut dengan sistem WordPress dan protokol kerja untuk project ini.
Saat magang dimulai, saya akan mendiskusikan dan menyusun abstrak rencana dengan mentor saya. Persyaratan dan kebutuhan akan ditentukan. Pertama, saya akan menguraikan alur dokumentasi dan proses interaksi pengguna. Selanjutnya, {i>wireframe<i} 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 ditambahkan/dihapus. Saya kemudian akan melakukan riset pengguna untuk menentukan {i>usability <i}(kegunaan) dan kelayakan alur antarmuka. Selanjutnya, Panduan Gaya Dokumentasi akan diimplementasikan (seperti yang digambarkan dalam diagram di bawah) per bagian. Panduan gaya dari organisasi lain yang berada di bawah lisensi open source atau Creative Commons dapat dirujuk untuk menambahkan juga panduan kami. Jika selama periode ini, kesulitan kegunaan apa pun terjadi, saya akan mendesain ulang.
Pengujian dan pengoptimalan akan dilakukan setelah panduan gaya selesai dan terintegrasi dengan HelpHub. Kerentanan, elemen, atau komponen yang berlebihan akan diperbaiki. Pengujian UI dan kode akan dilakukan dan bug serta error yang tidak diinginkan akan diperbaiki, jika diperlukan. Kontrol kualitas 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 dianggap layak selama proyek dapat diterapkan setelah pengujian akhir dilakukan. Rencana deployment akan dibuat dan produk jadi akan dikirim.
Alat & Metodologi:
Dokumentasi akan dikompilasi dan diedit di platform kolaboratif, seperti Google Dokumen. Jika diperlukan untuk memublikasikan melalui GitHub, bahasa markup seperti Markdown atau GitHub Flavored Markdown juga dapat diimplementasikan. Untuk standar desain dan gaya, pedoman gaya {i>open source<i} juga dapat dirujuk. Terakhir, dokumen yang sudah selesai akan diformat dan dipublikasikan menggunakan WordPress.
Tabel Komponen:
Ini adalah daftar lengkap komponen yang dapat diimplementasikan di Panduan Gaya. Pedoman Dokumen - Aksesibilitas, Struktur Dokumen, Encoding, Sumber Eksternal, Fakta, Font, Audiens Global, Inklusivitas, Legalitas, Aksesibilitas Multiplatform, Tidak ambigu, Tidak Ada Klaim Berlebihan, Tata Letak Halaman, Kebenaran Politik, Protokol, Keamanan, Struktur Kalimat, Penulisan Ringkas, Nada & Gaya, Tidak Memihak
Bahasa & Tata Bahasa - Singkatan & akronim, Penegasan & Negasi, Artikel, Kapitalisasi, Klausa, Pidato Langsung/Tidak langsung, Orang Pertama/Kedua/Ketiga, Jenis Kelamin, Daftar Istilah, Kata benda, Awalan & akhiran, Preposisi, Sebutan, Pengarahan, Kata-kata gaul & jargon, Ejaan, Istilah teknis, Tulang
Tanda Baca - Apostrof & Tanda Kutip, Titik Dua & Titik Titik, Koma, Elipsis, Tanda seru, Tanda Hubung & Tanda Hubung, Tanda Kurung, Titik, Tanda Tanya, Garis miring
Pemformatan - Abstrak, Pengantar, Kata Pengantar, Nama Merek, Nama Produk, Teks, Cuplikan Kode, Blok Kode, Tanggal & Waktu, Zona Waktu, Tempat, Mata Uang, Nama File, Catatan Kaki, Judul & Judul, Sorotan (Tebal, Miring, Garis Bawah, Nama Produk, Teks, Cuplikan Kode & Blok Kode, Tanggal & Waktu, Zona Waktu, Tempat, Mata Uang, Nama File, Catatan Kaki, Judul & Judul, Sorotan (Tebal, Miring, Garis Bawah, Peringatan Coret, Kutipan), Indentasi & Nomor Telepon
Antarmuka Pengguna - Aktivitas, Tombol, Cuplikan Kode, Blok Kode, Antarmuka Baris Perintah, Dialog, Menu & Dropdown, Munculan & Peringatan, Tab, Terminologi, elemen UI, Windows
Kode - CSS, HTML, JS, Markdown, MySQL, PHP, Sintaks, XML
Kamus/Glosarium Penggunaan Kata - A ke Z