Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- FOLIO
- Penulis teknis:
- gallinita
- Nama proyek:
- Perluasan Dokumentasi Pengguna Akhir Aplikasi FOLIO
- Durasi proyek:
- Jangka panjang (5 bulan)
Project description
Untuk proyek ini, saya berencana mengerjakan pembuatan dan pembaruan dokumentasi FOLIO yang ditargetkan pada pengguna akhir. Karena FOLIO adalah sistem manajemen perpustakaan, pengguna akhir adalah staf perpustakaan. Saat ini, wiki FOLIO (https://wiki.folio.org/) berisi beberapa dokumentasi, tetapi minim dan tidak dalam format yang mudah dicerna yang dibuat dengan mempertimbangkan staf perpustakaan. Dokumentasi baru yang dibuat dari project ini akan dihosting di pusat informasi dokumentasi tertentu, yang akan dapat diakses dari aplikasi FOLIO, dan berisi alur kerja yang relevan dengan sistem dan pengguna library-nya. Serangkaian dokumentasi awal akan dipublikasikan di situs, dimulai dengan fungsi sirkulasi dan cadangan kursus. Saya ingin berkontribusi sebanyak mungkin pada dokumentasi selama proyek yang "berjalan panjang" ini.
Saat melihat proyek dokumentasi FOLIO, saya berbicara dengan Marcia Borensztajn tentang kebutuhan FOLIO dan situasi dokumentasi saat ini. Seperti yang disebutkan di atas, dokumentasi FOLIO perlu diperbarui, diperluas, dan dikerjakan ulang agar berhasil membantu penggunanya. Dokumentasi perlu dibuat untuk mencerminkan proses perpustakaan standar dan, karena FOLIO terdiri dari berbagai "aplikasi" yang bekerja sama, sistem perlu dijelaskan secara keseluruhan. Karena saya adalah seorang pustakawan, saya sangat familier dengan jenis skenario dan alur kerja yang kemungkinan akan dialami oleh pengguna FOLIO dan memerlukan bantuan. Marcia sedang berupaya membuat basis pengetahuan dokumentasi baru menggunakan markdown, Git, dan Hugo. Dari proyek ini, dokumentasi baru tentang FOLIO akan dibuat dan berfungsi sebagai kerangka kerja untuk masa depan.