Esta página contém os detalhes de um projeto de redação técnica aceito para a temporada de documentos do Google.
Resumo do projeto
- Organização de código aberto:
- Fatos nutricionais abertos
- Redator técnico:
- FutureOfDocs
- Nome do projeto:
- Documente a API Open Food Facts
- Duração do projeto:
- De longa duração (5 meses)
Project description
Eu ouvi pela primeira vez a "Temporada de Documentos" por um e-mail que recebi do instrutor de um curso sobre a documentação da API REST que fiz há alguns meses. Embora eu realmente gostasse da ideia, decidi que só me candidataria a um projeto se pudesse realmente me identificar com ele. Isso era algo que eu faria além do meu trabalho regular e, se fizesse, deve ser divertido e significativo.
Quando li a descrição do Open Food Facts, sabia que tinha encontrado esse projeto. Adoro cuidar do meu corpo e da minha saúde com exercícios e alimentação. Eu realmente acho que a nutrição é uma das chaves para uma vida feliz e todos nós devemos ser capazes de fazer escolhas melhores, o que só é possível se tivermos informações suficientes sobre a comida e os cosméticos que usamos. O Open Food Facts coloca essas informações à nossa disposição, e quero contribuir com essa iniciativa incrível.
Nos últimos três anos, trabalhei como redator técnico em uma empresa de desenvolvimento de software especializada em automação de processos e lançamentos. Entre outros, implementamos uma API REST com Swagger que permite que os desenvolvedores se comuniquem com nossos aplicativos por meio de solicitações de API. Ajudei as equipes de desenvolvimento a escrever descrições melhores para as solicitações/respostas e, juntos, identificamos quais informações nossos clientes precisam para fornecê-las de maneira clara e concisa.
Estive analisando o site atual da Open Food Facts API e acho que podemos reestruturar e aprimorar a documentação para torná-la mais fácil de usar (páginas gerais, READ, WRITE). Além disso, eu adoraria criar, em conjunto com as equipes de desenvolvimento, uma forma de gerar a documentação da API automaticamente a partir do código (isso leva tempo, por isso estou propondo uma colaboração de longa duração).
Como todos sabemos, a aparência é importante ;) Por isso, também podemos ajustar o CSS e o logotipo da API REST para alinhar a interface swagger com a documentação do usuário.
Espero trabalhar com você neste projeto.