Bu sayfada, Google Dokümanlar Sezonu için kabul edilen bir teknik yazım projesinin ayrıntıları yer almaktadır.
Proje özeti
- Açık kaynak kuruluşu:
- Arduino
- Teknik yazar:
- AghaSaad04
- Proje adı:
- Üçüncü taraf kitaplıklarını belgeleme
- Proje uzunluğu:
- Standart uzunluk (3 ay)
Proje açıklaması
Deneyimli bir teknik yazarım. Üç yıldan uzun süredir yüksek kaliteli yazılım dokümanları, kullanıcı kılavuzları, talimatlar, algoritma analizleri, proje dokümanları ve araştırma makaleleri yazıyorum. Bu projede, tüm üçüncü taraf kitaplıklarını belgeleyeceğim. Arduino tarafından oluşturulan ve katkıda bulunulan kitaplıkları, tüm potansiyellerinin geliştiricilere gösterilmesi için belgelemeyi amaçlıyorum. Aşağıdaki görevleri tamamlayacağım:
Kitaplığın işleyişini belgeleyin Kitaplıkların gerekli ihtiyaçları karşılayacak şekilde nasıl iyileştirileceğini belgeleyin
Örneğin
Arduino'nun NESController kitaplığının iyi bir şekilde belgelenmesi gerekiyor. Özellikleri, uyumluluğu, örnekleri ve uygulamaları, katkıda bulunanlar için dokümanlara eklenmelidir. Kullanımdan daha fazla yararlanılabileceği dokümanda belirtilmiş. Nbiot-arduino, NBIoT modüllerine erişmek için kullanılan bir Arduino kitaplığıdır. Kullanım, Derleme ve Test, Hata Ayıklama seçenekleri genişletilerek dokümanları iyileştirilebilir. Kod snippet'leri içeren örnekler de eklenmelidir. Arduino'nun en çok yıldız alan kitaplığı ArduinoJson, kitaplığın çeşitli istasyonlarda nasıl kullanılacağını gösteren örnekler, her sınıf ve işlevin açıklamasını içeren API Referansı, neredeyse her soruyu yanıtlayan SSS ve kullanıcıları için program yazan ArduinoJson Asistanı gibi dokümanlar içerir. Benzer şekilde, dokümanlarının iyileştirilmesi ve genişletilmesi gereken tüm kitaplıklar için ayrıntılı dokümanlar hazırlanmalıdır. Nesnelerin İnterneti (IoT) alanında deneyimli olduğum için mikro denetleyiciler hakkında temel düzeyde bilgi sahibiyim. Python, Java, C, C++, HTML5, JavaScript, C# gibi çeşitli programlama dillerinde bilgi sahibiyim. Teknik yazım becerilerim ve elektronik, mikrodenetleyiciler ve programlama hakkındaki bilgi birikimimle Arduino'ya katkıda bulunmak istiyorum ve bu konuda oldukça ilgimi çekiyorum. Daha fazla bilgi edinmek, becerilerimi ve bilgi birikimimi geliştirmek istiyorum.
Kolay kullanılan söz dizimi ve kapsamlı özellik seti nedeniyle tüm yazılarımın stili için Markdown'ı kullanacağım.
Şablon
Bu, dokümanlar için kullanılabilecek şablonlardan biridir. Dokümanın şartlarına göre değiştirilebilir ve yeni bölümler eklenebilir.
$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.
Zaman taahhüdü ve iletişim
Haftada 45 saatten fazla zaman ayıracağım ama herhangi bir terslik durumunda bu saatleri hafta sonları telafi edeceğim.Toplulukla bağ kurma dönemi boyunca iletişim yöntemlerini tartışacak ve mentorumla bu toplantıların nasıl yapılacağı ile ilgili haftalık toplantıları sonuçlandıracağım. İşimle ilgili gelişmeleri mentorumla paylaşacağım ve iş ayrıntılarımı e-postayla mentoruma göndereceğim. Ekran paylaşma gibi birçok özellikle kullanımı kolay olduğundan iletişim için Ekip Görüntüleyici'yi tercih ederim.
Gelecek Planları
GSoD'19'dan sonra gelecek planlarım çok net. Diğer projelerde de kuruluşa katkıda bulunmaya devam edeceğim. Belgelemeden güvenlik yaklaşımına kadar her açıdan en iyisini yapmaya çalışacağım. Fırsat buldukça kuruluşun toplantılarına katılacağım.
Şartlar ve Koşullar
Yukarıda açıklandığı şekilde çalışacağımı ve herhangi bir yanlışlık durumunda sorumlu tutulacağımı ciddiyetle kabul ediyorum. Bu proje için gereken özveriyi anlıyorum. En iyi çalışmayı sunabilmek için tüm sezonumu bu projeye adadığımdan emin olabilirsiniz.
Teklifin tamamını okuduğunuz için teşekkür ederiz. Başka sorunuz olursa lütfen bana ulaşın.