Proyecto Arduino

En esta página, se incluyen los detalles de un proyecto de redacción técnica aceptado para la temporada de Documentos de Google.

Resumen del proyecto

Organización de código abierto:

Arduino

Redactor técnico:

AghaSaad04

Nombre del proyecto:

Documenta las bibliotecas de terceros

Duración del proyecto:

Duración estándar (3 meses)

Project description

Soy un escritor técnico experimentado. Escribo documentación de software de alta calidad, guías de usuario, manuales, análisis de algoritmos, documentación de proyectos y artículos de investigación desde hace más de tres años. En este proyecto, documentaré todas las bibliotecas de terceros. Mi objetivo es documentar las bibliotecas creadas y compartidas por Arduino para que los desarrolladores puedan aprovechar todo su potencial. Realizaré las siguientes tareas:

Documenta el funcionamiento de la biblioteca. Documenta cómo mejorar las bibliotecas para que se adapten a las necesidades requeridas.

Por ejemplo

La biblioteca NESController de Arduino realmente debe estar bien documentada. Sus funciones, compatibilidad, ejemplos y aplicaciones deben agregarse a la documentación para los colaboradores. El uso ya se menciona en la documentación, que se puede mejorar en mayor medida. Nbiot-arduino es una biblioteca de Arduino para acceder a los módulos NBIoT. Se puede mejorar la documentación extendiendo las opciones de uso, compilación y prueba, y depuración. También se deben incluir ejemplos que contengan fragmentos de código. La biblioteca más destacada de Arduino, ArduinoJson, está bien documentada con ejemplos que muestran cómo usar la biblioteca en varias estaciones, una referencia de la API que contiene la descripción de cada clase y función, preguntas frecuentes que responden a casi todas las preguntas y el Asistente de ArduinoJson, que escribe programas para sus usuarios. Del mismo modo, se debe realizar una documentación detallada para todas las bibliotecas cuya documentación debe mejorarse y ampliarse. Como tengo experiencia en el campo de la Internet de las cosas (IoT), tengo los conocimientos básicos sobre los microcontroladores. Tengo competencia en varios lenguajes de programación, incluidos Python, Java, C, C++, HTML5, JavaScript y C#. Me interesa mucho contribuir a Arduino con mis habilidades de redacción técnica y mis conocimientos sobre electrónica, microcontroladores y programación. Tengo muchas ganas de aprender más y mejorar mis habilidades y conocimientos.

Usaré Markdown para darle estilo a todos mis textos debido a su sintaxis fácil de usar y a su amplio conjunto de funciones.

Plantilla

Esta es una de las plantillas que se pueden usar para la documentación. Se puede modificar y agregar secciones nuevas según los requisitos del documento.

$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: [e-mail]

License
-------
This section will tell about the license of the project.
This project is licensed under the BSD.

Compromiso de tiempo y comunicación

Dedicaré más de 45 horas a la semana, pero, en caso de que haya algún inconveniente, compensaré esas horas los fines de semana.Durante el período de vinculación con la comunidad, hablaré sobre los medios de comunicación y finalizaré las reuniones semanales, los medios y el horario para esas reuniones con mi mentor. Mantendré a mi mentor al tanto de mi trabajo y le enviaré los detalles correspondientes por correo electrónico. Prefiero usar Team Viewer para comunicarse, ya que es fácil de usar con muchas funciones, como compartir pantallas, etcétera.

Planes futuros

Mis planes futuros son muy claros después de GSoD'19. Seguiré contribuyendo a la organización en otros proyectos. Intentaré que sea perfecto en todos los aspectos, desde la perspectiva de la documentación hasta la de la seguridad. Si tengo la oportunidad, seguramente asistiré a cualquier reunión de la organización.

Términos y Condiciones

Acepto solemnemente que trabajaré de la misma manera que expliqué anteriormente y, en caso de aborto espontáneo, seré responsable. Comprendo la dedicación que requiere este proyecto y te aseguro que le dedicaré toda la temporada para poder ofrecerte el mejor trabajo.

Gracias por leer toda la propuesta. Comunícate conmigo si tienes más preguntas.