Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- moja global
- Penulis teknis:
- Anthony
- Nama project:
- Dokumentasi Kode Alat Pelaporan
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Dengan adanya kesempatan untuk mendokumentasikan Alat Pelaporan untuk organisasi Moja Global, saya mengusulkan untuk mengembangkan 6 jenis dokumentasi yang akan digunakan oleh berbagai audiens untuk mencapai tujuan yang berbeda. Hal ini dirangkum di bawah ini:
1)Panduan Penyiapan Lingkungan
1.1) Target Audiens Engineer Sistem
1.2) Tujuan Membantu Engineer Sistem menyiapkan lingkungan build dan eksekusi lokal untuk Alat Pelaporan.
1.3) Format Artikel Cara yang menetapkan serangkaian langkah berurutan yang harus dilakukan Engineer Sistem untuk menyiapkan lingkungan yang akan kondusif untuk mem-build dan menjalankan Alat Pelaporan.
2)Panduan Build
2.1) Engineer Sistem Target Audiens
2.2) Tujuan Membantu Teknisi Sistem membuat komponen Alat Pelaporan dari kode sumber
2.3) Format Artikel Petunjuk yang menentukan serangkaian langkah berurutan yang harus diambil System Engineer untuk mendapatkan dan mengompilasi Kode Sumber Alat Pelaporan.
3) Panduan Pemasangan
3.1) Engineer Sistem Target Audiens
3.2) Tujuan Membantu Engineer Sistem menginstal komponen Alat Pelaporan yang baru dibuat
3.3) Format Artikel Cara yang menjelaskan serangkaian langkah berurutan yang harus dilakukan Engineer Sistem untuk men-deploy Alat Pelaporan di lingkungan yang baru disiapkan.
4)Panduan Operasi
4.1) Integrator Sistem Target Audiens
4.2) Tujuan Membantu Teknisi Sistem menjalankan instance Alat Pelaporan yang baru diinstal
4.3) Format Artikel Cara yang menentukan serangkaian langkah berurutan yang harus dilakukan System Integrator untuk mengupload dan memproses Database Output Flux pada instance Alat Pelaporan yang sedang berjalan.
Panduan Operasi Mengaktivasi dan memproses Database Output Flux di Alat Pelaporan
5)Panduan Pengguna
5.1) Target Audiens Pengguna Akhir
5.2) Tujuan Membantu Pengguna Akhir memahami berbagai fitur yang disematkan pada Alat Pelaporan dan bagaimana fitur tersebut harus digunakan.
5.3) Format Artikel Petunjuk yang menentukan serangkaian langkah berurutan yang harus dilakukan Pengguna Akhir untuk memanfaatkan Fungsi Alat Pelaporan dengan benar.
6) Panduan Pengembangan
6.1) Target Audiens Programmer
6.2) Tujuan Membantu Pengguna Akhir memahami berbagai fitur yang disematkan pada Alat Pelaporan dan bagaimana fitur tersebut harus digunakan.
6.3) Format Artikel Referensi yang menjelaskan: a)elemen desain utama yang membentuk alat b)dekomposisi fungsional elemen di atas c)elemen eksekusi dari elemen yang didekomposisi secara fungsional d)organisasi kode sumber / library alat e)visi dan arah jangka panjang untuk peningkatan berkelanjutan f)area berikutnya yang logis untuk peningkatan
Dan tutorial singkat yang menjelaskan bagaimana kode dapat disesuaikan dengan keadaan tertentu pengguna