Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- Infrastruktur LLVM Compiler
- Penulis teknis:
- DR87
- Nama project:
- Menyusun ulang indeks dokumentasi dan panduan gaya dokumentasi LLVM
- Durasi project:
- Durasi standar (3 bulan)
Project description
Project ini mencakup tugas berikut:
a.) Menyusun ulang halaman indeks dokumentasi untuk memberikan pengalaman yang lebih mudah digunakan. Tugas ini akan melibatkan evaluasi halaman saat ini dan menyusun ulang berdasarkan kombinasi riset independen, wawancara SME, dan masukan pengguna. Opsi yang mungkin dilakukan mencakup merevisi deskripsi singkat, menyusun ulang halaman yang ada, dan/atau menambahkan lapisan (halaman) tambahan melalui model pengungkapan informasi progresif. Opsi kedua akan mengurangi jumlah link di halaman indeks utama untuk memudahkan pengguna menemukan informasi/panduan tertentu. Misalnya, indeks dapat menyertakan link ke halaman terpisah untuk Desain & Ringkasan LLVM, Panduan Pengguna, Dokumentasi Subsistem, dan Dokumentasi Proses Pengembangan.
b.) Memperbarui panduan gaya LLVM Sphinx untuk kontributor open source. Tugas ini akan mencakup mengevaluasi panduan saat ini, mengidentifikasi kesenjangan melalui riset independen dan wawancara SME, serta memperbarui panduan berdasarkan persyaratan yang disepakati. Pembaruan dapat mencakup pengaturan ulang tata letak panduan, penambahan konten baru, dan penyisipan link ke halaman yang relevan, seperti panduan kontributor. Tujuan akhirnya adalah mempermudah sukarelawan untuk mulai berkontribusi sesegera mungkin.