Se usó la API de Cloud Translation para traducir esta página.

Proyecto Arduino

Esta página contiene 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
Escritor 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. Hace más de tres años que 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. En este proyecto, documentaré todas las bibliotecas de terceros. Intento documentar las bibliotecas que son de Arduino y las que contribuyeron para que todo su potencial se exponga a los desarrolladores. Realizaré las siguientes tareas:

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

Por ejemplo

La biblioteca NESController de Arduino tiene que estar bien documentada. Sus funciones, compatibilidad, ejemplos y aplicaciones deben agregarse a la documentación para sus 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 módulos de NBIoT. Su documentación se puede mejorar si se extienden 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, ya que en la documentación se incluyen ejemplos que muestran cómo usar la biblioteca en varias estaciones, Referencia de API que contiene la descripción de cada clase y función, Preguntas frecuentes que responde prácticamente todas las preguntas y el Asistente AduinoJson que escribe programas para sus usuarios. Del mismo modo, se debe brindar documentación detallada para todas las bibliotecas cuya documentación se debe mejorar y extender. Con experiencia en el campo de la Internet de las cosas (IoT), tengo conocimientos básicos sobre microcontroladores. Tengo conocimientos en varios lenguajes de programación, como Python, Java, C, C++, HTML5, JavaScript y C#. Estoy muy interesado y dispuesto a contribuir con Arduino a través de mis habilidades de escritura técnica y mis conocimientos sobre electrónica, microcontroladores y programación. Quiero 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 su amplio conjunto de funciones.

Template

Esta es una de las plantillas que se pueden usar para la documentación. Se puede modificar y se pueden agregar nuevas secciones 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: project@google-groups.com

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

Compromiso de tiempo y comunicación

Daré más de 45 horas a la semana, pero en caso de contratiempos, compensaré esas horas los fines de semana.Durante el período de vinculación comunitaria, analizaré los medios de comunicación y finalizaré las reuniones semanales, los medios y el tiempo para esas reuniones con mi mentor. Mantendré a mi mentor al tanto de mi trabajo y le enviaré los detalles de mi trabajo por correo electrónico. Prefiero el Visualizador de equipo para comunicarme, ya que es fácil de usar con muchas funciones, como pantallas compartidas, etcétera.

Planes para el futuro

Mis planes futuros están muy claros después del GSoD 2019. También 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. Seguramente, asistiré a cualquier reunión de la organización si alguna vez tengo la oportunidad.

Términos y Condiciones

Estoy solemnemente de acuerdo en que trabajaré de la misma manera que expliqué anteriormente y, en caso de un aborto espontáneo, seré responsable de rendir cuentas. Comprendo la dedicación necesaria para este proyecto y te aseguro que dedico toda la temporada a este proyecto para poder proporcionar el mejor trabajo.

Gracias por leer toda la propuesta. No dudes en comunicarte conmigo si tienes más consultas.