Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- Arduino
- Penulis teknis:
- AghaSaad04
- Nama project:
- Mendokumentasikan library pihak ketiga
- Durasi project:
- Durasi standar (3 bulan)
Project description
Saya adalah penulis teknis berpengalaman. Saya telah menulis dokumentasi software, panduan pengguna, manual, analisis algoritma, dokumentasi project, makalah riset berkualitas tinggi selama lebih dari tiga tahun. Dalam project ini, saya akan mendokumentasikan semua library pihak ketiga. Saya ingin mendokumentasikan library yang dibuat dan disumbangkan oleh Arduino sehingga semua potensinya dapat diekspos kepada developer. Saya akan menyelesaikan tugas-tugas berikut:
Mendokumentasikan cara kerja library Mendokumentasikan cara Meningkatkan library agar dapat mengakomodasi kebutuhan yang diperlukan
Misalnya
Library NESController Arduino benar-benar perlu didokumentasikan dengan baik. Fitur, kompatibilitas, contoh, dan aplikasinya harus ditambahkan dalam dokumentasi untuk kontributornya. Penggunaan telah disebutkan dalam dokumentasi yang dapat ditingkatkan lebih jauh lagi. Nbiot-arduino adalah Library Arduino untuk mengakses modul NBIoT. Dokumentasinya dapat ditingkatkan dengan memperluas Opsi Penggunaan, Build & Pengujian, Debug. Contoh yang berisi cuplikan kode juga harus disertakan. Library Arduino yang paling banyak diberi bintang, ArduinoJson, didokumentasikan dengan baik sebagai contoh yang menunjukkan cara menggunakan library di berbagai stasiun, Referensi API yang berisi deskripsi setiap class dan fungsi, FAQ yang menjawab hampir setiap pertanyaan, dan AduinoJson Assistant yang menulis program untuk penggunanya disertakan dalam dokumentasi. Demikian pula, dokumentasi mendalam harus dilakukan untuk semua library yang dokumentasinya perlu ditingkatkan dan diperluas. Dengan pengalaman di bidang Internet of Things (IoT), saya memiliki pengetahuan dasar tentang mikrokontroler. Saya mahir 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, mikrokontroler, pemrograman. Saya ingin mempelajari lebih lanjut serta meningkatkan keterampilan dan pengetahuan saya.
Saya akan menggunakan Markdown untuk penataan gaya semua tulisan saya karena sintaks yang mudah digunakan dan serangkaian fitur yang luas.
Template
Ini adalah salah satu template yang dapat digunakan untuk dokumentasi. Struktur 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 memberikan lebih dari 45 jam seminggu, tetapi jika terjadi masalah, saya akan mengganti jam tersebut pada akhir pekan.Selama periode ikatan komunitas, saya akan mendiskusikan sarana komunikasi dan akan menyelesaikan pertemuan mingguan, sarana, dan waktu untuk pertemuan tersebut dengan mentor saya. Saya akan terus memberi tahu mentor saya tentang pekerjaan saya; akan membagikan detail pekerjaan saya melalui email kepada mentor saya. Saya akan lebih memilih Team Viewer untuk berkomunikasi, karena mudah digunakan dengan banyak fitur seperti berbagi layar, dll.
Rencana Mendatang
Rencana masa depan saya sangat jelas, setelah GSoD'19. Saya juga akan terus berkontribusi pada organisasi dalam project lain. Saya akan mencoba membuatnya sempurna dalam semua aspek, mulai dari perspektif dokumentasi hingga perspektif keamanan. Saya pasti akan menghadiri rapat organisasi jika ada kesempatan.
Persyaratan & Ketentuan
Saya benar-benar 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 project ini. Saya pastikan bahwa saya akan mendedikasikan seluruh musim untuk project ini sehingga saya dapat memberikan karya terbaik.
Terima kasih telah membaca seluruh proposal. Hubungi kami jika ada pertanyaan lebih lanjut.