Cette page contient les détails d'un projet de rédaction technique accepté pour 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 (3 mois)
Project description
Je suis un rédacteur technique expérimenté. J'écris depuis plus de trois ans une documentation logicielle de haute qualité, des guides utilisateur, des manuels, des analyses d'algorithmes, une documentation de projet et un document de recherche. Dans ce projet, je vais documenter toutes les bibliothèques tierces. Mon but est de documenter les bibliothèques créées par Arduino et d'y avoir contribué afin de présenter tout leur potentiel aux développeurs. Je vais accomplir les tâches suivantes:
Documenter le travail de la bibliothèque Documenter comment améliorer les bibliothèques pour qu’elles répondent aux besoins requis
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 inclus dans la documentation à l'attention de ses contributeurs. L'utilisation est déjà mentionnée dans la documentation, qui peut être améliorée dans une plus grande mesure. Nbiot-arduino est une bibliothèque Arduino permettant d'accéder aux modules NBIoT. Vous pouvez améliorer sa documentation en étendant ses options d'utilisation, de compilation, de test et de débogage. Des exemples contenant des extraits de code doivent également être inclus. ArduinoJson, la bibliothèque la plus vedette d'Arduino, est bien documentée comme des exemples illustrant comment l'utiliser dans différentes stations, une documentation de référence de l'API contenant la description de chaque classe et fonction, des FAQ 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. Grâce à mon expérience dans le domaine de l'Internet des objets (IoT), j'ai des connaissances de base sur les microcontrôleurs. Je maîtrise plusieurs langages de programmation, dont Python, Java, C, C++, HTML5, JavaScript et C#. Je suis très intéressé(e) et je souhaite contribuer à Arduino grâce à mes compétences en rédaction technique, ainsi qu'à mes connaissances sur l'électronique, les microcontrôleurs et la programmation. J'ai hâte d'en savoir plus et d'améliorer mes compétences et mes connaissances.
J'utiliserai Markdown pour styliser toute mon écriture en raison de sa syntaxe facile à utiliser et de son ensemble complet de fonctionnalités.
Template
Il s'agit de l'un des modèles pouvant être utilisés pour la documentation. Vous pouvez le modifier et y ajouter de nouvelles sections 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 en temps et communication
Je donnerai plus de 45 heures par semaine mais en cas d'incident, je compenserai ces heures le week-end.Pendant la période de lien avec la communauté, je discuterai des moyens de communication et finaliserai les réunions hebdomadaires, les moyens et le temps de ces réunions avec mon mentor. Je tiendrai mon mentor au courant de mon travail ; je partagerai les détails de mon travail par e-mail à mon mentor. Je préférerais utiliser le lecteur d'équipe pour communiquer, car il est facile à utiliser avec de nombreuses fonctionnalités telles que le partage d'écran, etc.
Projets futurs
Mes projets sont très clairs après la GSoD 2019. Je continuerai aussi à contribuer à l'organisation dans d'autres projets. Je vais essayer de le rendre parfait dans tous les aspects, du point de vue de la documentation à la perspective de la sécurité. Si jamais j'en ai l'occasion, j'assisterai certainement à toutes les réunions de l'organisation.
Conditions d'utilisation
J'accepte solennellement de travailler de la même manière que celle que j'ai décrite ci-dessus et en cas de fausse couche, je serai tenu responsable. Je comprends le dévouement requis pour ce projet, je vous assure que je consacre toute ma saison à ce projet afin de pouvoir fournir le meilleur travail.
Merci d'avoir lu l'ensemble de la proposition. N'hésitez pas à me contacter si vous avez d'autres questions.