Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- Creative Commons
- Penulis teknis:
- JackieBinya
- Nama project:
- Panduan penggunaan tema dasar WordPress
- Durasi project:
- Durasi standar (3 bulan)
Project description
Selama fase pengajuan lamaran penulis teknis GSOD-2020, saya melakukan beberapa interaksi dengan Hugo Solar, yang merupakan mentor project dokumentasi tema dasar WordPress Creative Commons.
Dalam kontak awal saya dengannya, saya meminta bantuan untuk memahami tujuan pembuatan panduan penggunaan tema dasar WordPress. Dia sangat membantu dan dengan cepat membuat saya memahami project tersebut. Semua interaksi berturut-turut yang kami lakukan setelah itu adalah tentang meningkatkan kualitas tujuan dokumentasi tema Dasar WordPress CC.
Setelah mencapai tahap yang saya rasa sudah memahami persyaratan dan tujuan project, saya kemudian membuat draf proposal untuk Panduan Penggunaan Tema Dasar WordPress CC.
Proposal ini dibuat menggunakan template resmi Creative Commons untuk lamaran magang. Dokumen ini memberikan informasi tentang sinopsis project, struktur project yang diusulkan, dan tata letak dokumentasi Tema Dasar WordPress baru serta informasi tentang linimasa dan hasil untuk fase pembuatan dokumen.
Kemudian, Hugo Solar meninjau draf proposal saya dan memberi saya masukan untuk melakukan peningkatan. Selama proses ini, dia selalu siap menjawab pertanyaan tentang proyek.
Saya telah menerapkan masukan yang diberikan dan proposal akhir saya untuk dokumentasi Pembuatan Badge D&I tersedia di link di bawah sebagai Dokumen Google
https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing
Atau, ringkasan singkat proposal saya, dan dapat ditemukan di bawah:
Creative Commons - Panduan penggunaan tema dasar WordPress Proposal yang disiapkan oleh Jacqueline Binya, 28 Juni 2020
Sinopsis Project Tujuan utama project ini adalah membuat dokumentasi yang kaya, intuitif, menarik, dan ditampilkan dengan indah untuk komunitas yang menggunakan Tema Dasar WordPress Creative Commons.
Rencana Project Masalah Saat ini, tema Dasar WordPress Creative Commons tidak memiliki dokumentasi, sehingga menjadi penghalang untuk penggunaan tema yang efektif dalam komunitas. Tujuan saya adalah membuat panduan penggunaan lengkap untuk tema dan juga menerapkan abstraksi di codebase tema WP Base saat ini untuk mempermudah penggunaan tema.
Solusi Buat dokumen futuristik menggunakan framework modern seperti Gatsby. Gatsby memiliki pemicu yang dapat kita gunakan untuk mem-bootstrap dokumentasi Tema Dasar WordPress baru. Contoh pemicunya adalah gatsby-auction-starter, yang siap digunakan dengan dukungan pengoptimalan mesin telusur (SEO), markdown, dan Algolia ( alat yang digunakan untuk berintegrasi dengan penelusuran di situs statis). Selain itu, situs apa pun yang dibuat Gatsby dapat dioptimalkan dengan mudah untuk mengintegrasikan internasionalisasi dan aksesibilitas. Dalam membuat dokumentasi, saya ingin membuatnya seintuitif mungkin dengan: - menulis dokumen dengan cara yang mudah dipahami dan berhati-hati untuk menghindari ambiguitas dan penggunaan jargon teknis yang berlebihan dan rumit. - dengan menggabungkan ilustrasi dan media grafis dalam dokumentasi untuk digunakan sebagai alat bantu visual untuk pembelajaran. - menggunakan contoh yang menunjukkan cara melaksanakan tugas umum, misalnya penyesuaian.
Abstraksi yang ingin saya terapkan akan mencakup memastikan bahwa sebagian besar fungsi inti Tema Dasar WP seperti hook misalnya dapat dimanfaatkan oleh pengguna dari Panel Admin WordPress. Selain itu, saya ingin membuat tema turunan awal untuk Tema Dasar WP di repositori terpisah. Memiliki tema turunan awal akan memberikan pengalaman orientasi yang lebih lancar dan lebih cepat bagi pengguna baru. Setelah selesai dan disetujui, dokumentasi akan dipublikasikan dan dihosting secara online.
Struktur yang diusulkan untuk Panduan Penggunaan Tema Dasar WordPress CC - Dokumentasi yang diusulkan akan dibagi menjadi beberapa bagian yang tercantum di bawah. Item sub-daftar di bawah setiap bagian yang diusulkan kemudian memberikan detail selengkapnya tentang konten sebenarnya yang akan ditemukan di bagian masing-masing.
Bagian Ringkasan - Menjelaskan definisi, tujuan, dan fitur Tema Dasar WordPress Creative Commons(CC). * Definisi: Jelaskan secara singkat Tema Dasar CC WP. * Niat: Menjelaskan tujuan/ niat Tema Dasar CC WP * Fitur: Menjelaskan fitur Tema Dasar CC WP
Bagian Memulai - Persyaratan * Uraikan persyaratan untuk menginstal Tema Dasar WordPress CC, yaitu - Versi WordPress - Versi PHP - Composer, dll. - Panduan Penginstalan * Uraikan cara pengguna dapat menggunakan zip untuk menginstal Tema WordPress CC * Uraikan cara pengguna dapat memulai dengan meng-clone tema dasar WP dari GitHub. * Menjelaskan cara pengguna dapat menginstal dependensi dalam project. * Jelaskan cara pengguna dapat mengonfigurasi dependensi Queulat. * Jelaskan cara pengguna dapat mengaktifkan tema di lingkungan pengembangan WordPress lokal mereka.
Panduan Penggunaan - Ringkasan * Jelaskan istilah tema turunan * Nyatakan keuntungan menggunakan tema turunan. * Beri tahu pengguna bahwa cara yang direkomendasikan untuk mengedit tema WP Base adalah melalui Tema Turunan. * Soroti fakta bahwa Tema Dasar WP harus diinstal dan diaktifkan sebelum pengguna dapat membuat tema turunan.
Menggunakan Tema Anak - Menjelaskan bagaimana pengguna dapat membuat tema turunan dari Tema Dasar WP menggunakan starter. Gunakan video untuk menjelaskan cara pengguna membuat tema turunan dari pemicu.
Penyesuaian Di subbagian yang tercantum di bawah, kami menguraikan cara pengguna dapat menggunakan WordPress Customizer dan Panel Admin WordPress untuk melakukan penyesuaian. Kami juga akan menyertakan penggunaan ilustrasi grafis untuk membuat deskripsi kami lebih intuitif. - Sesuaikan deskripsi situs atau baris tag. - Menu Navigasi Kustom - Menyesuaikan CSS - Menambahkan Halaman - Menambahkan Postingan - Widget - Menambahkan dan menghapus widget dari Panel Admin WordPress - Menambahkan widget menggunakan Penyesuai dengan pratinjau langsung
Bagian Penyesuaian Lanjutan - Bagian Penyesuaian CSS * Jelaskan komponen yang membentuk gaya tema: - CC Vocabulary - Bulma - Sass * Jelaskan cara menyiapkan Sass dalam project. Penjelasan tersebut harus menyertakan informasi tentang: (i)Lokasi file sass dalam struktur project (ii)Skrip npm yang dapat digunakan untuk membuat dan melihat sass * Menjelaskan bagaimana pengguna dapat menyesuaikan gaya sass dalam tema turunan, yaitu melalui penginstalan dependensi npm tertentu * Menjelaskan cara class komponen (class-component.php) digunakan untuk menyesuaikan gaya komponen tertentu
- Bagian Hook
Ringkasan
- Menjelaskan istilah hook
- Jelaskan mengapa pengguna perlu memanfaatkan hook.
- Uraikan jenis hook yang tersedia.
Menggunakan Tindakan
- Mencantumkan tindakan yang tersedia di tema WP Base dan posisinya
- Jelaskan cara menerapkan tindakan ini.
*Menggunakan Filter - Cantumkan filter yang tersedia dalam tema dan jelaskan cara menerapkannya
Memperbarui Bagian tema - Menjelaskan cara pengguna dapat mengupdate tema.
Bagian Pemberian Lisensi * Menjelaskan pemberian lisensi project dan artinya kepada orang-orang yang mungkin ingin menggunakan Tema Dasar CC WP dalam project pribadi mereka.
Bagian Penyumbang * Tambahkan panduan berkontribusi yang mendetail * Menguraikan Kode Etik * Komunitas: berikan informasi tentang saluran komunitas Creative Commons dan cara kontributor dapat berpartisipasi, dll.