Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- Infrastruktur Compiler LLVM
- Penulis teknis:
- DR87
- Nama proyek:
- Mengubah struktur indeks dokumentasi dan panduan gaya dokumentasi LLVM
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Proyek ini mencakup tugas-tugas berikut:
a.) Ubah struktur halaman indeks dokumentasi untuk memberikan pengalaman yang lebih mudah digunakan. Tugas ini akan melibatkan evaluasi halaman saat ini dan menyusun ulang halaman tersebut berdasarkan kombinasi penelitian independen, wawancara UKM, dan umpan balik pengguna. Opsi yang memungkinkan termasuk merevisi deskripsi singkat, menyusun ulang halaman yang ada, dan/atau menambahkan lapisan (halaman) tambahan melalui model pengungkapan informasi yang progresif. Yang kedua akan mengurangi jumlah link pada halaman indeks utama untuk mempermudah pengguna dalam menemukan informasi/panduan tertentu. Misalnya, indeks mungkin menyertakan tautan ke laman terpisah untuk Desain & Ikhtisar LLVM, Panduan Pengguna, Dokumentasi Subsistem, dan Dokumentasi Proses Pengembangan.
b.) Perbarui panduan gaya Sphinx LLVM untuk kontributor open source. Tugas ini akan mencakup mengevaluasi panduan saat ini, mengidentifikasi kesenjangan melalui penelitian independen dan wawancara UKM, serta memperbarui panduan berdasarkan persyaratan yang disepakati. Pembaruan dapat mencakup pengaturan ulang tata letak panduan, menambahkan konten baru, dan menyisipkan link ke halaman yang relevan, seperti panduan kontributor. Tujuan akhirnya adalah memudahkan sukarelawan untuk mulai berkontribusi sesegera mungkin.