Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- FOLIO
- Penulis teknis:
- gallinita
- Nama project:
- Penambahan Dokumentasi Pengguna Akhir untuk Aplikasi FOLIO
- Durasi proyek:
- Berjalan lama (5 bulan)
Project description
Untuk project ini, saya berencana untuk membuat dan memperbarui dokumentasi FOLIO yang ditargetkan untuk pengguna akhir. Karena FOLIO adalah sistem pengelolaan perpustakaan, pengguna akhir adalah staf perpustakaan. Saat ini, wiki FOLIO (https://wiki.folio.org/) berisi beberapa dokumentasi, tetapi jumlahnya minimal dan tidak dalam format yang mudah dipahami yang dibuat dengan mempertimbangkan staf perpustakaan. Dokumentasi baru yang dibuat dari project ini akan dihosting di basis pengetahuan dokumentasi tertentu, yang akan dapat diakses dari aplikasi FOLIO, dan berisi alur kerja yang relevan dengan sistem dan pengguna library-nya. Kumpulan dokumentasi awal akan dipublikasikan di situs, dimulai dengan fungsi sirkulasi dan reservasi kursus. Saya ingin berkontribusi sebanyak mungkin pada dokumentasi selama project “jangka panjang” ini.
Dalam meninjau project dokumentasi FOLIO, saya berbicara dengan Marcia Borensztajn tentang kebutuhan FOLIO dan situasi dokumentasi saat ini. Seperti disebutkan di atas, dokumentasi FOLIO perlu diperbarui, diperluas, dan dikerjakan ulang agar berhasil membantu penggunanya. Dokumentasi perlu dibuat untuk mencerminkan proses library standar dan, karena FOLIO terdiri dari berbagai “aplikasi” yang bekerja sama, sistem perlu dijelaskan secara keseluruhan. Sebagai pustakawan, saya sangat memahami jenis skenario dan alur kerja yang mungkin akan dihadapi pengguna FOLIO dan memerlukan bantuan. Marcia sedang berupaya membuat pusat informasi dokumentasi baru menggunakan markdown, Git, dan Hugo. Dari project ini, dokumentasi baru tentang FOLIO akan dibuat dan berfungsi sebagai framework untuk masa mendatang.