Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- Arduino
- Penulis teknis:
- AghaSaad04
- Nama proyek:
- Library pihak ketiga dokumen
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Saya seorang penulis teknis yang berpengalaman. Saya telah menulis dokumentasi perangkat lunak berkualitas tinggi, panduan pengguna, buku manual, analisis algoritma, dokumentasi proyek, makalah penelitian selama lebih dari tiga tahun. Dalam proyek ini, saya akan mendokumentasikan semua pustaka pihak ketiga. Saya ingin mendokumentasikan library yang dibuat dan dikontribusikan oleh Arduino sehingga semua potensinya dapat dimanfaatkan oleh developer. Saya akan menyelesaikan tugas berikut:
Mendokumentasikan cara kerja library Dokumen cara meningkatkan kualitas library agar dapat mengakomodasi kebutuhan yang diperlukan
Contoh:
Perpustakaan NESController Arduino benar-benar harus didokumentasikan dengan baik. Fitur, kompatibilitas, contoh, dan aplikasi-nya harus ditambahkan dalam dokumentasinya untuk para kontributor. Penggunaan telah disebutkan dalam dokumentasi yang dapat ditingkatkan secara lebih baik. Nbiot-arduino adalah Library Arduino untuk mengakses modul NBIoT. Dokumentasinya dapat ditingkatkan dengan memperluas Usage, Build & Test, Debug Options-nya. Contoh yang berisi cuplikan kode juga harus disertakan. Perpustakaan Arduino yang paling berbintang. ArduinoJson didokumentasikan dengan baik sebagai contoh yang menunjukkan cara menggunakan perpustakaan di berbagai stasiun, Referensi API yang berisi deskripsi setiap class dan fungsi, FAQ yang menjawab hampir setiap pertanyaan, dan Asisten AduinoJson yang menulis program untuk penggunanya disertakan dalam dokumentasi. Demikian pula, dokumentasi mendalam harus dilakukan untuk semua library yang dokumentasinya perlu ditingkatkan dan diperluas. Karena berpengalaman di bidang Internet of Things (IoT), saya memiliki pengetahuan dasar tentang pengontrol mikro. Saya memiliki kemahiran dalam berbagai bahasa pemrograman termasuk Python, Java, C, C++, HTML5, JavaScript, C#. Saya sangat tertarik dan bersedia berkontribusi pada Arduino melalui keterampilan menulis teknis dan pengetahuan tentang elektronik, pengontrol mikro, dan pemrograman. Saya ingin belajar lebih banyak serta meningkatkan keterampilan dan pengetahuan saya.
Saya akan menggunakan Markdown untuk menata gaya semua tulisan saya karena sintaks yang mudah digunakan dan seperangkat fitur yang luas.
Template
Ini adalah salah satu {i>template<i} yang dapat digunakan untuk dokumentasi. Perubahan ini dapat diubah dan bagian baru dapat ditambahkan sesuai dengan persyaratan dokumen.
$projectName/Library Name
--------
In this section, I will give background information of the library,
what does this library use, on what languages and framework it is based on,
what are the dependencies of this library/project where it will be used
Features
--------
I will add features of the project here like
- this library creates connection between server and client
- Make things faster
Installation
------------
In this section I will add the installation procedure and dependencies that
needs to be installed.
Install $project by running:
install project
Contribute
----------
For the contributors, I will add this section in documentation.
- Issue Tracker: github.com/$project/$project/issues
- Source Code: github.com/$project/$project
Support
-------
This section can also be added
If you are having issues, please let us know.
We have a mailing list located at: project@google-groups.com
License
-------
This section will tell about the license of the project.
This project is licensed under the BSD.
Komitmen waktu dan komunikasi
Saya akan memberi waktu lebih dari 45 jam per minggu, tetapi jika terjadi kesalahan, saya akan memberikan kompensasi pada jam kerja tersebut di akhir pekan.Selama periode ikatan komunitas, saya akan membahas sarana komunikasi dan akan menyelesaikan pertemuan mingguan, sarana, dan waktu untuk pertemuan tersebut dengan mentor saya. Saya akan selalu memberikan informasi terbaru kepada mentor tentang pekerjaan saya; dan akan membagikan detail pekerjaan saya melalui email kepada mentor. Saya lebih memilih Viewer Tim untuk berkomunikasi, karena mudah digunakan dengan banyak fitur seperti berbagi layar, dll.
Rencana Mendatang
Rencana masa depan saya sangat jelas, setelah GSoD '19. Saya akan tetap berkontribusi ke organisasi di proyek lain juga. Saya akan berusaha membuatnya sempurna di semua aspek, mulai dari perspektif dokumentasi hingga perspektif keamanan. Saya pasti akan menghadiri rapat organisasi apa pun jika ada kesempatan.
Persyaratan & Ketentuan
Saya sangat setuju bahwa saya akan bekerja dengan cara yang sama seperti yang telah saya jelaskan di atas dan jika terjadi keguguran, saya akan dimintai pertanggungjawaban. Saya memahami dedikasi yang diperlukan untuk proyek ini, saya meyakinkan Anda bahwa saya mendedikasikan seluruh musim untuk proyek ini sehingga saya dapat memberikan pekerjaan terbaik.
Terima kasih telah membaca seluruh proposal. Harap hubungi kami jika ada pertanyaan lebih lanjut.