Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- Creative Commons
- Penulis teknis:
- JackieBinya
- Nama proyek:
- Panduan penggunaan tema dasar WordPress
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Selama fase pendaftaran penulis teknis dari GSOD-2020, saya melakukan beberapa interaksi dengan Hugo Solar, yang merupakan mentor dari proyek dokumentasi tema dasar Creative Commons WordPress.
Dalam kontak awal saya dengannya, saya mencari bantuan untuk memahami tujuan pembuatan panduan penggunaan tema dasar WordPress. Dia sangat membantu dan dengan cepat membuat saya setuju dengan proyek tersebut. Semua interaksi berturut-turut yang kami lakukan setelahnya adalah tentang menyempurnakan tujuan dokumentasi tema Dasar WordPress.
Ketika saya mencapai tahap, saya merasa bahwa saya memahami persyaratan dan tujuan proyek, kemudian membuat draf proposal untuk CC WordPress Base Theme Usage Guide.
Proposal dibuat menggunakan template resmi Creative Commons untuk pendaftaran peserta magang. Ini memberikan informasi tentang sinopsis proyek, struktur proyek yang diusulkan, dan tata letak dokumentasi Tema Dasar WordPress yang baru serta informasi tentang jadwal dan hasil kerja untuk fase pembuatan dokumen.
Hugo Solar kemudian meninjau draf proposal saya dan memberi saya masukan untuk melakukan peningkatan. Sepanjang proses ini, dia selalu ada untuk menjawab pertanyaan tentang proyek tersebut.
Saya menerapkan masukan yang diberikan dan proposal terakhir saya untuk dokumentasi Pembuatan Badan D&I tersedia di link di bawah sebagai Dokumen Google
https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing
Sebagai alternatif, ringkasan singkat proposal saya, dan dapat dilihat di bawah:
Creative Commons - Panduan penggunaan tema dasar WordPress Proposal yang disiapkan oleh Jacqueline Binya, 28 Juni 2020
Sinopsis Proyek Tujuan utama proyek ini adalah untuk membuat dokumentasi yang beragam, intuitif, menarik, dan dipresentasikan dengan indah yang berhadapan dengan komunitas untuk Tema Dasar WordPress Creative Commons.
Rencana Proyek Masalah Saat ini, tema Dasar WordPress Creative Commons tidak memiliki dokumentasi, ini bertindak sebagai penghalang untuk pemanfaatan tema yang efektif dalam komunitas. Tujuan saya adalah membuat panduan penggunaan lengkap untuk tema dan juga menerapkan abstraksi dalam codebase tema WP Base saat ini untuk mempermudah penggunaan tema.
Solusi Buat dokumen futuristik menggunakan kerangka kerja modern seperti Gatsby. Gatsby memiliki pemicu yang dapat kita gunakan untuk mem-bootstrap dokumentasi Tema Dasar WordPress yang baru. Contoh pemicunya adalah gatsby-"/>-starter yang siap digunakan dengan dukungan untuk pengoptimalan mesin telusur (SEO), markdown, dan Algolia ( alat yang digunakan untuk mengintegrasikan penelusuran di situs statis). Selain itu, setiap situs buatan Gatsby dapat dioptimalkan dengan mudah untuk mengintegrasikan internasionalisasi dan aksesibilitas. Dalam membuat dokumentasi, tujuan saya adalah membuatnya seintuitif mungkin dengan: - menulis dokumen dengan cara yang mudah dipahami dan berhati-hati untuk menghindari ambiguitas dan penggunaan jargon teknis yang berlebihan dan kompleks. - dengan menyertakan ilustrasi grafis dan media dalam dokumentasi untuk digunakan sebagai alat bantu visual dalam pembelajaran. - menggunakan contoh yang menunjukkan cara menjalankan tugas umum, misalnya penyesuaian.
Abstraksi yang saya harap akan mencakup memastikan bahwa sebagian besar fungsi inti dari WP Base Theme, misalnya hook, dapat dimanfaatkan oleh pengguna dari Panel Admin WordPress. Selain itu, saya ingin membuat tema anak pemula untuk WP Base Theme di repositori terpisah. Memiliki tema anak awal akan memberikan pengalaman orientasi yang lebih lancar dan cepat bagi pengguna baru. Setelah selesai dan disetujui, dokumentasi akan dipublikasikan dan dihosting secara online.
Struktur yang diusulkan untuk Panduan Penggunaan Tema Dasar CC WordPress - Dokumentasi yang diusulkan akan dibagi menjadi beberapa bagian yang berbeda yang tercantum di bawah ini. Item sub-daftar di bawah setiap bagian yang diusulkan memberikan detail lebih lanjut tentang konten sebenarnya yang akan ditemukan di masing-masing bagian.
Bagian Ringkasan - Menguraikan definisi, maksud, dan fitur Tema Dasar WordPress Creative Commons(CC). * Definisi: Jelaskan secara singkat Tema Dasar CC WP. * Niat: Menguraikan maksud/ tujuan dari Tema Dasar CC WP * Fitur: Menguraikan 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 menggunakan zip untuk menginstal Tema WordPress CC * Uraikan cara pengguna dapat memulai dengan meng-clone tema dasar WP dari GitHub. * Menguraikan cara pengguna menginstal dependensi dalam project. * Menjelaskan bagaimana pengguna dapat mengonfigurasi Queulat dependensi. * Menjelaskan bagaimana pengguna dapat mengaktifkan tema di lingkungan pengembangan WordPress lokal mereka.
Panduan Penggunaan - Ringkasan * Menjelaskan istilah tema anak * Sebutkan keuntungan menggunakan tema turunan. * Menginformasikan pengguna bahwa cara yang disarankan untuk mengedit tema Dasar WP adalah melalui Tema Anak. * Soroti fakta bahwa WP Base Theme harus diinstal dan diaktifkan sebelum pengguna dapat membuat tema anak.
Menggunakan Tema Anak-Anak - Jelaskan bagaimana pengguna dapat membuat tema turunan dari Tema Dasar WP menggunakan pemicu. Gunakan video untuk menjelaskan cara pengguna membuat tema anak dari awal.
Penyesuaian Dalam sub-bagian yang tercantum di bawah, kami menjelaskan bagaimana pengguna dapat menggunakan penyesuai WordPress dan Panel Admin WordPress untuk membuat penyesuaian. Kami juga akan menyertakan penggunaan ilustrasi grafis untuk membuat deskripsi menjadi lebih intuitif. - Sesuaikan deskripsi situs atau tagline. - 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 Menyesuaikan CSS * Menjelaskan komponen yang membentuk gaya tema: - CC Kosakata - Bulma - Sass * Menjelaskan cara penyiapan Sass dalam project. Penjelasan harus mencakup informasi tentang: (i)Lokasi file sass dalam struktur project (ii)Skrip npm yang dapat digunakan untuk mem-build dan menonton sass * Menjelaskan bagaimana pengguna kemudian dapat menyesuaikan gaya sass di tema turunan, yaitu melalui penginstalan dependensi npm tertentu * Menjelaskan cara penggunaan class komponen (class-component.php) untuk menyesuaikan gaya komponen tertentu
- Bagian Hook
Ringkasan
- Menjelaskan istilah hook
- Jelaskan mengapa pengguna perlu memanfaatkan hook.
- Jelaskan jenis hook yang tersedia.
Menggunakan Tindakan
- Cantumkan tindakan yang tersedia di tema WP Base dan pemosisiannya
- Jelaskan bagaimana tindakan ini dapat diterapkan.
*Menggunakan Filter - Buat daftar filter yang tersedia di tema dan jelaskan cara menerapkannya
Memperbarui Bagian tema - Menjelaskan bagaimana pengguna dapat memperbarui tema.
Bagian Pemberian Lisensi * Menjelaskan pemberian lisensi project dan artinya bagi orang-orang yang mungkin ingin menggunakan CC WP Base Theme dalam project pribadi mereka.
Bagian Berkontribusi * Tambahkan panduan berkontribusi yang mendetail * Uraikan Kode Etik * Komunitas: berikan informasi tentang saluran komunitas Creative Commons dan cara kontributor dapat berpartisipasi, dll.