Bu sayfa, Google Dokümanlar Sezonu için kabul edilen bir teknik yazı projesinin ayrıntılarını içerir.
Proje özeti
- Açık kaynak kuruluşu:
- Arduino
- Teknik yazar:
- AghaSaad04
- Projenin adı:
- Belge üçüncü taraf kitaplıkları
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
Deneyimli bir teknik yazarım. Üç yıldan fazla bir süredir yüksek kaliteli yazılım belgeleri, kullanıcı kılavuzları, kılavuzlar, algoritma analizi, proje belgeleri ve araştırma makalesi yazıyorum. Bu projede tüm üçüncü taraf kitaplıklarını belgeleyeceğim. Amacım, Arduino tarafından üretilen ve katkıda bulunulan kitaplıkları belgeleyerek tüm potansiyellerinin geliştiricilere ulaşmasını sağlamak. Aşağıdaki görevleri yerine getireceğim:
Kütüphanenin çalışmasını belgeleme Kitaplıkların gerekli ihtiyaçları karşılayacak şekilde nasıl iyileştirileceğini belgeleyin
Örneğin
Arduino’nun NESController kitaplığının iyi belgelenmesi gerekir. Özellikleri, uyumluluğu, örnekleri ve uygulamaları, katkıda bulunanlar için dokümanlarına eklenmelidir. Kullanımdan zaten dokümanlarda bahsedilmiş ve bu şekilde daha büyük bir iyileştirme yapılabilir. Nbiot-arduino, NBIoT modüllerine erişmek için kullanılan bir Arduino Kütüphanesi'dir. Kullanım, Derleme ve Test Etme, Hata Ayıklama Seçeneklerini genişleterek dokümanları geliştirilebilir. Kod snippet'i içeren örnekler de eklenmelidir. Dokümanlarda Arduino’nun en yıldızlı kitaplığı ArduinoJson, kütüphanenin çeşitli istasyonlarda nasıl kullanılacağını gösteren örneklerle, her sınıf ve işlevin açıklamasını içeren API Referansı, neredeyse her sorunun yanıtını içeren SSS ve kullanıcıları için programlar yazan AduinoJson Asistanı yer almaktadır. Benzer şekilde, dokümanlarının iyileştirilmesi ve genişletilmesi gereken tüm kütüphaneler için kapsamlı dokümantasyon yapılmalıdır. Nesnelerin İnterneti (IoT) alanında deneyim sahibi olarak mikrodenetleyiciler hakkında temel bilgilere sahibim. Python, Java, C, C++, HTML5, JavaScript, C# gibi çeşitli programlama dillerinde yeterli bilgiye sahibim. Teknik yazma becerilerim, elektronik cihazlar, mikrodenetleyiciler ve programlama bilgim sayesinde Arduino'ya katkıda bulunmaya istekli ve istekliyim. Daha fazla bilgi edinmek, becerilerimi ve bilgilerimi geliştirmek istiyorum.
Kullanımı kolay söz dizimi ve kapsamlı özellikler nedeniyle yazılarımın stilini belirlemek için Markdown'ı kullanacağım.
Şablon
Bu, dokümanlar için kullanılabilecek şablonlardan biridir. Dokümanda değişiklik yapılabilir ve dokümanın gereksinimlerine göre 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 ancak herhangi bir aksilik olursa hafta sonları bu saatleri telafi edeceğim.Topluluk bağ dönemi boyunca iletişim yöntemlerini tartışacağım ve mentorumla bu toplantıların yapılması için gereken haftalık toplantıları, yöntemleri ve zamanı sonlandıracağım. Mentorumu çalışmam hakkında bilgilendireceğim ve çalışmayla ilgili ayrıntıları e-posta yoluyla mentoruma paylaşacağım. Ekran paylaşma gibi birçok özellikle kullanımı kolay olduğundan iletişim için Ekip Görüntüleyici'yi tercih ederim.
Gelecekteki Planlar
GSoD '19'dan sonra geleceğe dönük planlarım çok netti. Diğer projelerde de kuruma katkıda bulunmaya devam edeceğim. Bu platformu belgeleme ve güvenlik açısından her açıdan mükemmel hale getirmeye çalışacağım. Şahsen bu kuruluşun tüm toplantılarına kesinlikle katılacağım.
Şartlar ve Koşullar
Yukarıda açıkladığım gibi çalışacağımı ve herhangi bir düşük durumunda sorumlu tutulacağımı kesinlikle kabul ediyorum. Bu proje için ne kadar fedakarlık gerektiğini anladım. En iyi hizmeti 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.