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