Kontributor WordPress Mencari Sponsor untuk Meningkatkan Dokumen Pengembang Gutenberg

Pengembang WordPress Milana Cap dan Jonathan Bossenger memulai penggalangan dana untuk meningkatkan dokumentasi pengembang Gutenberg. Percakapan dimulai kemarin ketika Cap tweeted tentang bagaimana dokumentasi sering diabaikan ketika perusahaan mempekerjakan kontributor penuh waktu untuk bekerja di WordPress.

“Ketika komunitas Anda tidak dapat mempelajari perangkat lunak Anda, maka Anda tidak memiliki kontributor,” kata Cap. “Dokumentasi dan tutorial jauh lebih penting untuk proyek Perangkat Lunak Sumber Terbuka daripada yang disadari orang.”

Pertama kali Cap mulai meminta dokumentasi Gutenberg adalah pada Community Summit di Paris, 2017. Sejak saat itu, dia berusaha mengarahkan perhatian komunitas ke sana.

“Ada banyak lubang dalam dokumentasi editor blok untuk pengembang tetapi yang paling jelas adalah bagaimana memulainya,” kata Cap. “Awal dokumentasi untuk pengembang tidak mengatakan apa-apa tentang memulai. “Itu hanya mengatakan apa yang dapat Anda lakukan dengan blok tetapi tidak _how_. Pengembang junior, pengembang khusus PHP dan siapa saja yang dimaksud dengan dokumentasi itu, tidak tahu bagaimana tampilan kode blok, di mana harus meletakkannya, bagaimana memasukkannya, dll, apalagi bagaimana membangun blok khusus dengan komponen khusus dan pengaturan.”

Bagian dari tantangan mendokumentasikan editor blok adalah bahwa ia sedang dalam pengembangan aktif. Peningkatan dan penyempurnaan terus-menerus didorong ke plugin Gutenberg dan melacak apa yang tersedia atau tidak saat ini di inti tidak selalu mudah. Karena WordPress akan segera memperkenalkan pencarian direktori blok, ini adalah saat yang tepat untuk memformalkan dokumentasi pembuatan blok.

“Contoh kode sangat tidak ada di semua dokumen,” kata Cap. “Contoh paling mendasar ada, tetapi bagaimana benar-benar membangun sesuatu yang dapat digunakan tidak ada. Jadi, di halaman pertama ini kami dikirim ke tutorial tetapi tutorial itu tidak dioptimalkan untuk orang yang belum pernah membuat blok sebelumnya. Setelah itu, saya telah dan akan gagal membangun blok tersebut.”

Marcus Kazmierczak dan tim kontributor dokumentasi sedang mencoba untuk membangun kembali tutorial di buku pegangan editor blok resmi. Masalah GitHub yang berfokus pada mengatasi kesenjangan dalam dokumentasi pengembang saat ini adalah rumah bagi diskusi aktif tentang cara terbaik untuk menulis ulang dokumen untuk orang-orang yang baru memblokir pengembangan.

“Ini adalah awal yang sangat baik tetapi masih banyak pekerjaan yang harus dilakukan,” kata Cap. “Dokumentasi lengkap ditulis oleh orang-orang yang mengetahui dan memahami React dan Gutenberg tetapi 'dikutuk dengan pengetahuan.' Mereka tidak memiliki banyak waktu untuk memahami betapa banyak orang lain tidak tahu dan dalam detail apa dokumentasi harus ditulis. Sejujurnya, saya tidak berpikir mereka harus menghabiskan waktu mereka untuk itu. Kami memiliki Tim Dokumentasi dan kami bersedia untuk terjun, tetapi semacam jembatan diperlukan.”

Masalah dengan Dokumentasi Pengembang Gutenberg: Tidak Ramah untuk Pendatang Baru

“'Masalah' seperti yang saya lihat dengan dokumentasi editor blok adalah, tidak seperti dokumentasi WordPress lainnya, ini ditulis untuk pengembang JavaScript berpengalaman, dan tidak ditujukan untuk pemula," kata Bossenger. “Saya juga harus menunjukkan, ini sama sekali bukan pukulan pada orang-orang yang telah menyusun dokumentasi saat ini, dan saya menghargai setiap dan semua pekerjaan yang telah mereka lakukan sejauh ini, itu hanya membutuhkan tinjauan serius dan perbaikan. ”

Bossenger mengatakan di masa lalu WordPress membuatnya sangat mudah bagi siapa saja dengan pengetahuan PHP yang terbatas untuk membuat plugin atau tema dengan cepat menggunakan action dan filter hooks. Sangat mudah untuk melihat kode dan memahami apa yang seharusnya dilakukan.

“JavaScript modern, dan khususnya React, adalah ketel ikan yang sangat berbeda,” kata Bossenger. “Ini membutuhkan tingkat pengetahuan yang lebih dalam tentang cara kerja React, termasuk terminologi dan praktik baru. JavaScript modern juga bisa sangat membingungkan, terutama jika ini adalah pertama kalinya Anda melihat hal-hal seperti fungsi panah, atau pernyataan if yang kurang bertele-tele.

“Jika yang paling dekat Anda bekerja dengan JavaScript di WordPress telah menggunakan jQuery, beralih ke pengembangan Gutenberg berbasis React masih membutuhkan beberapa pembelajaran di pihak Anda.”

Setelah mengambil dua kursus sebelum dia dapat membuat apa pun untuk editor, satu di React dan satu di Gutenberg, Bossenger mengatakan bahwa buku pegangan Editor Blok saat ini tidak ditulis untuk pengembang yang tidak memiliki pengalaman dalam React dan JavaScript modern. Dia percaya perlu restrukturisasi untuk menjelaskan konsep baru dengan lebih baik dan menyesuaikan pola yang lebih mudah dikonsumsi oleh pendatang baru. Dia menyoroti buku pegangan Pengembang Plugin sebagai contoh di mana bab-bab mengikuti struktur dan menggunakan terminologi yang lebih seperti buku teks, perlahan-lahan memperkenalkan konsep baru kepada pembaca.

“Saya berpendapat bahwa sangat mungkin bagi seseorang yang tidak memiliki plugin atau pengetahuan PHP, dipersenjatai dengan buku pegangan ini dan Google, untuk membuat plugin sederhana untuk memenuhi persyaratan spesifik mereka dengan cukup cepat,” kata Bossenger. “Saat ini buku pegangan editor blok tidak kondusif untuk ini.”

Bossenger tidak sendirian dalam pendapatnya tentang dokumentasi saat ini. Peter Tasker di Delicious Brains baru-baru ini menerbitkan tutorial tentang membuat blok Gutenberg khusus. Bahkan setelah bekerja dengan React secara penuh selama setahun terakhir, dia menemukan bahwa dokumen editor blok resmi "ada di mana-mana" dan sulit untuk diuraikan.

Setelah Cap berkomentar tentang kurangnya perusahaan yang mensponsori pekerjaan penuh waktu pada dokumentasi, Bossenger menguji air dengan tweet menanyakan apakah mereka berdua mungkin dapat mengumpulkan dana untuk meningkatkan dokumen Gutenberg.

“Sama seperti Tim Editor Blok (dan tim Make lainnya), Tim Dokumentasi kekurangan staf,” kata Cap. “Kami tidak dapat mendedikasikan beberapa anggota untuk belajar terlebih dahulu dan kemudian menulis dokumentasi tentang pengembangan dengan editor blok. Ini adalah alasan utama untuk tweet saya. Anda akan melihat kontributor bersponsor di seluruh inti tetapi tidak dalam dokumentasi dan saya berani mengatakan bahwa keduanya sama pentingnya.”

Sebelum meluncurkan penggalangan dana mereka, Cap dan Bossenger berencana untuk membaca dokumentasi yang ada, menunjukkan lubang yang jelas, dan mengidentifikasi pertanyaan yang belum terjawab bagi mereka yang baru mengembangkan editor blok.

“Setelah kami memiliki rencana, kami dapat memprediksi berapa banyak waktu yang dibutuhkan untuk setiap bagian,” katanya. “Dengan rencana ini, kami akan mencari sponsor. Saya pikir akan ada opsi untuk menyumbang bahkan sebelum itu, tetapi tidak ada yang pasti saat ini.”

Blok adalah batas baru pengembangan WordPress. Berinvestasi dalam dokumentasi dan tutorial yang solid untuk pemula dapat berdampak besar pada perluasan ekosistem blok. Ini juga secara tidak langsung menguntungkan pengguna karena mereka berakhir dengan direktori blok yang lebih beragam untuk dipilih saat menyesuaikan situs WordPress mereka.

Bossenger dan Cap saat ini sedang mengerjakan rencana untuk dokumen sebelum mengumumkan penggalangan dana mereka. Sementara itu, siapa pun yang ingin berkontribusi untuk meningkatkan dokumentasi pembuatan blok dapat mengikuti diskusi GitHub.