Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan proyek
- Organisasi open source:
- CERN-HSF
- Penulis teknis:
- LuckInTheRain
- Nama project:
- Dokumentasi ROOT: Menganalisis, Melakukan Restrukturisasi, dan Menulis Ulang
- Durasi project:
- Berjalan lama (5 bulan)
Project description
Project ini terdiri dari empat fase:
1.) Menganalisis dokumentasi ROOT saat ini
Dokumen ROOT lengkap (situs web, panduan pengguna, referensi C++, tutorial, dll.) dianalisis dan diperiksa sesuai dengan kriteria berikut: penyusunan struktur, modularisasi, standardisasi, mekanisme akses, konsistensi, jenis informasi yang digunakan, persiapan khusus kelompok target, dan keterbacaan. Tujuannya adalah menciptakan konsep manajemen informasi dan matriks untuk penataan dan pedoman untuk menstandarkan konten.
2.) Menentukan metode untuk menyusun dokumentasi perangkat lunak dengan tim ROOT
DITA (Darwin Information Typing Architecture), standar OASIS untuk dokumentasi software (https://www.oasis-open.org/committees/dita/) dipresentasikan kepada tim ROOT. Fokus utamanya adalah memahami cara menyusun konten khusus software dan cara jenis informasi dasar seperti “konsep”, “tugas”, dan “referensi” digunakan untuk menulis dokumentasi software.
3.) Penyusunan ulang dan pengaturan ulang dokumentasi ROOT
Berdasarkan hasil dari dua langkah pertama, dokumentasi ROOT disusun ulang dan dimodularisasi sesuai dengan grup target, peran, dan kasus penggunaan, serta kontennya ditetapkan ke elemen yang sesuai (situs web, panduan pengguna, referensi C++, tutorial, dll.) dan jenis konten. Karena informasi yang tersedia sangat luas, struktur referensi yang konsisten juga harus dibuat. Tujuannya adalah untuk memberikan ringkasan yang komprehensif dan menunjukkan cara yang jelas kepada pengguna tentang cara menggunakan ROOT untuk kebutuhan mereka. Selain itu, pengantar ringkas yang tidak berorientasi pada fisika juga disediakan.
4.) Menulis ulang dokumentasi ROOT
Bagian utama dokumentasi, terutama Panduan Pengguna, ditulis ulang sesuai dengan pendekatan DITA. Aturan penyusunan dan penulisan dicatat dalam Panduan Gaya untuk memastikan konsistensi dalam dokumen di masa mendatang. Tujuannya adalah untuk memungkinkan tim ROOT memperluas dan mengelola dokumentasi ROOT sendiri pada masa mendatang.
Perkiraan jadwal waktu (5 bulan):
Tahap 1: Menganalisis dokumentasi ROOT saat ini: 3 minggu.
Tahap 2: Mendefinisikan metode untuk menyusun dokumentasi perangkat lunak dengan tim ROOT: 2 minggu.
Tahap 3: Penyusunan ulang dan pengaturan ulang dokumentasi ROOT: 4 minggu.
Fase 4: Menulis ulang dokumentasi ROOT: 11 minggu.