Esta página contiene los detalles de un proyecto de redacción técnico aceptado para Google Season of Docs.
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é hablar de "La temporada de documentos" 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 llegué hace unos meses. Aunque realmente me gustó la idea, decidí que solo me postularía para un proyecto si realmente me pudiera identificar con él. Era algo que hacía además de mi trabajo habitual y, si lo hacía, debía 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 de una vida feliz, y todos deberíamos poder tomar mejores decisiones, lo que solo es posible si contamos con 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 trabajé 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 a la API. Ayudé a los equipos de desarrollo a escribir mejores descripciones para las solicitudes y respuestas y, en conjunto, 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 generales, LEER y ESCRITURA). Además, me encantaría configurar, junto con los equipos de desarrollo, una manera de generar automáticamente la documentación de la API a partir del código (esto lleva tiempo, por eso les propongo una colaboración de larga duración).
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 Swgger con la documentación del usuario.
Estoy ansioso por trabajar contigo en este proyecto.