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:
- Open Food Facts
- Escritor técnico:
- FutureOfDocs
- Nombre del proyecto:
- Documentar la API de Open Food Facts
- Duración del proyecto:
- Larga duración (5 meses)
Project description
La primera vez que escuché hablar de "Season of Docs" fue a través de un correo electrónico que recibí del instructor de un curso sobre la documentación de la API de REST que realicé hace unos meses. Aunque me gustó mucho la idea, decidí que solo me postularía para un proyecto si realmente me identificaba con él. Era algo que hacía además de mi trabajo habitual, y, si lo hacía, debe ser divertido y significativo.
Cuando leí la descripción de Open Food Facts, supe que había encontrado ese 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 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 maravillosa iniciativa.
En los últimos tres años, estuve trabajando como escritor técnico en una empresa de desarrollo de software especializada en automatización de procesos y lanzamientos. Entre otras, implementamos una API de REST con Swagger que permite a los desarrolladores comunicarse con nuestras aplicaciones a través de solicitudes de API. Ayudé a los equipos de desarrollo a escribir mejores descripciones para las solicitudes y respuestas y, juntos, identificamos qué información necesitan nuestros clientes para proporcionarla de forma clara y concisa.
Estuve revisando 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 generales, LEÍDAS y ESCRITURAS). Además, me gustaría configurar, junto con los equipos de desarrollo, una forma de generar automáticamente la documentación de la API 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.
Estoy ansioso por trabajar contigo en este proyecto.