Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- CERN-HSF
- Penulis teknis:
- LuckInTheRain
- Nama proyek:
- Dokumentasi AKAR: Menganalisis, Merestrukturisasi, dan Penulisan Ulang
- Durasi proyek:
- Jangka panjang (5 bulan)
Project description
Proyek ini terdiri dari empat fase:
1.) Menganalisis dokumentasi AKAR saat ini
Dokumen AKAR lengkap (situs web, panduan pengguna, referensi C++, tutorial, dll.) dianalisis dan diperiksa sesuai dengan kriteria berikut: penataan, modularisasi, standardisasi, mekanisme akses, konsistensi, jenis informasi yang digunakan, persiapan khusus kelompok target, dan pemahaman. Tujuannya adalah untuk menciptakan konsep untuk manajemen informasi dan matriks untuk penataan dan pedoman untuk standarisasi konten.
2.) Menentukan metode untuk menyusun dokumentasi perangkat lunak dengan tim AKAR
DITA (Darwin Information Typing Architecture), sebuah standar OASIS untuk dokumentasi software (https://www.oasis-open.org/committees/dita/) disajikan kepada tim AKAR. Fokus utamanya adalah memahami cara menyusun konten spesifik software dan bagaimana jenis informasi dasar sebagai "konsep", "tugas", dan "referensi" digunakan untuk menulis dokumentasi perangkat lunak.
3.) Restrukturisasi dan reorganisasi dokumentasi AKAR
Berdasarkan hasil dari dua langkah pertama, dokumentasi AKAR disusun ulang dan dimodularisasi sesuai dengan kelompok sasaran, peran dan kasus penggunaan dan konten 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 ditetapkan. Tujuannya adalah untuk memberikan gambaran menyeluruh dan untuk menunjukkan kepada pengguna cara yang jelas bagaimana mereka dapat menggunakan AKAR untuk kebutuhan mereka. Selain itu, pengantar ringkas berorientasi non-fisik disediakan.
4.) Menulis ulang dokumentasi AKAR
Bagian utama dari dokumentasi, terutama Panduan Pengguna, ditulis ulang sesuai dengan pendekatan DITA. Aturan penataan dan penulisan dicatat dalam Panduan Gaya untuk memastikan konsistensi dalam dokumen di masa mendatang. Tujuannya adalah agar tim AKAR dapat memperpanjang dan memelihara dokumentasi AKAR mereka sendiri di masa mendatang.
Perkiraan jadwal waktu (5 bulan):
Fase 1: Analisis dokumentasi AKAR saat ini: 3 minggu.
Fase 2: Mendefinisikan metode untuk menyusun dokumentasi perangkat lunak penulisan dengan tim AKAR: 2 minggu.
Fase 3: Restrukturisasi dan reorganisasi dokumentasi AKAR: 4 minggu.
Tahap 4: Menulis ulang dokumentasi AKAR: 11 minggu.