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:
- Open Food Facts
- Redactor técnico:
- FutureOfDocs
- Nombre del proyecto:
- Documenta la API de Open Food Facts
- Duración del proyecto:
- Larga duración (5 meses)
Project description
La primera vez que escuché sobre la “Temporada de documentos” fue a través de un correo electrónico que recibí del instructor de un curso sobre documentación de la API de REST que tomé hace algunos meses. Aunque me gustó mucho la idea, decidí que solo me postularía a un proyecto si realmente podía identificarme con él. Esto era algo que haría además de mi trabajo habitual, y si lo hiciera, debe ser divertido y significativo.
Cuando leí la descripción de Open Food Facts, supe que había encontrado el proyecto. Me encanta cuidar mi cuerpo y mi salud a través del ejercicio y la comida. Realmente creo que la nutrición es una de las claves para tener una vida feliz, y todos deberíamos poder tomar mejores decisiones, lo cual solo es posible si tenemos suficiente información sobre los alimentos y los cosméticos que usamos. Open Food Facts pone esta información a nuestra disposición, y quiero contribuir a esta iniciativa increíble.
Durante los últimos tres años, trabajé como redactora técnica en una empresa de desarrollo de software especializada en la automatización de procesos y lanzamientos. Entre otras, hemos implementado una API de REST con Swagger que permite a los desarrolladores comunicarse con nuestras aplicaciones a través de solicitudes a la API. Ayudé a los equipos de desarrollo a escribir mejores descripciones para las solicitudes o respuestas, y juntos identificamos qué información necesitan nuestros clientes para proporcionarla de forma clara y concisa.
Revisé el sitio actual de la API de Open Food Facts y creo que podemos reestructurar y mejorar la documentación para que sea más fácil de usar (páginas General, READ y WRITE). Además, me encantaría configurar, junto con los equipos de desarrollo, una forma de generar la documentación de la API automáticamente a partir del código (esto lleva tiempo, por eso propongo una colaboración a largo plazo).
Todos sabemos que el aspecto es importante ;). Por eso, también podemos modificar el CSS y el logotipo de la API de REST para alinear la IU de Swagger con la documentación del usuario.
Será un placer trabajar contigo en este proyecto.