Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Arduino
- Rédacteur technique:
- AghaSaad04
- Nom du projet:
- Documenter les bibliothèques tierces
- Durée du projet:
- Durée standard (trois mois)
Project description
Je suis rédacteur technique expérimenté. Je rédige des documentations logicielles, des guides utilisateur, des manuels, des analyses d'algorithmes, des documentations de projet et des articles de recherche de haute qualité depuis plus de trois ans. Dans ce projet, je vais documenter toutes les bibliothèques tierces. Mon but est de documenter les bibliothèques créées par Arduino et utilisées pour les aider à exposer tout leur potentiel aux développeurs. Je vais effectuer les tâches suivantes:
Documentez le fonctionnement de la bibliothèque. décrivez comment améliorer les bibliothèques pour qu'elles répondent aux besoins requis.
Par exemple
La bibliothèque NESController d'Arduino doit vraiment être bien documentée. Ses fonctionnalités, sa compatibilité, ses exemples et ses applications doivent être ajoutés à sa documentation pour ses contributeurs. L'utilisation est déjà mentionnée dans la documentation, mais elle peut être nettement améliorée. Nbiot-arduino est une bibliothèque Arduino permettant d'accéder aux modules NBIoT. La documentation peut être améliorée en étendant les options d'utilisation, de compilation et de test, et de débogage. Des exemples contenant des extraits de code doivent également être inclus. ArduinoJson, la bibliothèque la plus populaire d'Arduino, est bien documenté comme exemples montrant comment utiliser la bibliothèque dans différentes stations, la documentation de référence de l'API contenant la description de chaque classe et fonction, des questions fréquentes qui répondent à presque toutes les questions et l'assistant AduinoJson qui écrit des programmes pour ses utilisateurs sont inclus dans la documentation. De même, une documentation approfondie doit être réalisée pour toutes les bibliothèques dont la documentation doit être améliorée et étendue. Ayant de l'expérience dans le domaine de l'Internet des objets (IoT), je possède les connaissances de base des microcontrôleurs. Je maîtrise plusieurs langages de programmation, y compris Python, Java, C, C++, HTML5, JavaScript et C#. Je suis très intéressé(e) et disposé(e) à contribuer à Arduino grâce à mes compétences en rédaction technique et à mes connaissances en électronique, microcontrôleurs et programmation. Je suis impatient d'en apprendre davantage et de développer mes compétences et mes connaissances.
J'utiliserai Markdown pour styliser tout mon texte en raison de sa syntaxe facile à utiliser et de son ensemble complet de fonctionnalités.
Modèle
Il s'agit de l'un des modèles que vous pouvez utiliser pour la documentation. Il peut être modifié et de nouvelles sections peuvent être ajoutées en fonction des exigences du document.
$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.
Engagement de temps et communication
Je consacrerai plus de 45 heures par semaine, mais en cas de problème, je compenserai ces heures le week-end.Pendant la période de lien communautaire, je discuterai des moyens de communication et je finaliserai les réunions hebdomadaires, les moyens et les horaires de ces réunions avec mon mentor. Je tiens mon mentor informé de mon travail et je lui transmettrai les détails de mon travail par e-mail. Je préfère utiliser le lecteur d'équipe pour communiquer, car il est facile à utiliser avec de nombreuses fonctionnalités comme le partage d'écrans, etc.
Projets futurs
Mes projets futurs sont très clairs après le GSoD 2019. Je continuerai à contribuer à l'organisation dans d'autres projets. Je vais essayer de la rendre parfaite dans tous les aspects, de la documentation à la sécurité. Je participerai certainement à toutes les réunions de l'organisation si j'en ai l'occasion.
Conditions d'utilisation
Je m'engage solennellement à travailler de la même manière que je l'ai expliqué ci-dessus et, en cas d'avortement spontané, je serai tenu responsable. Je comprends l'engagement requis pour ce projet. Je vous assure que je consacre toute la saison à ce projet afin de pouvoir fournir le meilleur travail possible.
Merci d'avoir lu l'intégralité de la proposition. N'hésitez pas à me contacter si vous avez d'autres questions.