Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan proyek
- Organisasi open source:
- OpenELIS Global
- {i>Technical writer <i}(Penulis teknis):
- Areesha
- Nama project:
- Dokumentasi OpenELIS untuk pengguna akhir
- Durasi project:
- Durasi standar (3 bulan)
Project description
Kami ingin mendesain ulang dan meningkatkan dokumentasi yang ditampilkan kepada pengguna untuk OpenELIS. I-TECH bermaksud merevolusi cara pengguna OpenELIS mendapatkan bantuan berdasarkan kebutuhan spesifik konteks mereka. Saat ini, petunjuk penggunaan OpenELIS terdapat dalam satu manual pengguna yang dapat dianggap membosankan dan memakan waktu untuk dinavigasi. Beberapa pengguna, terutama pengguna baru, senang memiliki akses ke berbagai materi yang dapat mereka jelajahi dan pelajari. Pengguna lain, terutama mereka yang lebih berpengalaman dan familier dengan produk digital tertentu, seperti OpenELIS, ingin dengan cepat menemukan dan menggunakan sumber daya tertentu untuk menyelesaikan tugas entri data atau pelaporan. Aktivitas tertentu akan mencakup:
Mengonversi Manual Pengguna yang ada (sudah tidak berlaku) menjadi library bantuan tugas yang komprehensif dan terbaru serta tutorial tertulis tentang semua fungsi saat ini (termasuk fungsi yang lebih baru, seperti pengelolaan pengujian, pemindaian kode batang, entri batch, dan impor hasil penganalisis), termasuk tag metadata untuk membantu mengindeks informasi;
Mengembangkan / Memperbarui materi bantuan versi bahasa Inggris
Memberikan akses kepada pengguna ke daftar “10 Teratas” alat kerja yang paling sering diakses.
Buat panduan gaya dan dokumen konvensi coding