Esta página contém os detalhes de um projeto de redação técnica aceito para a Google Season of Docs.
Resumo do projeto
- Organização de código aberto:
- Open Food Facts
- Redator técnico:
- FutureOfDocs
- Nome do projeto:
- Documentar a API Open Food Facts
- Duração do projeto:
- De longa duração (5 meses)
Project description
Ouvi falar da "Temporada de documentos" pela primeira vez em um e-mail do instrutor de um curso sobre a documentação da API REST que fiz há alguns meses. Embora eu tenha gostado muito da ideia, decidi que só me candidataria a um projeto se pudesse me identificar com ele. Era algo que eu faria além do meu trabalho normal, e se eu fizesse, teria que ser divertido e significativo.
Quando li a descrição do Open Food Facts, soube que tinha encontrado o projeto. Adoro cuidar do meu corpo e da minha saúde com exercícios e alimentação. Acredito que a nutrição é uma das chaves para uma vida feliz, e todos nós precisamos fazer escolhas melhores, o que só é possível se tivermos informações suficientes sobre os alimentos e cosméticos que usamos. O Open Food Facts disponibiliza essas informações, e eu quero contribuir com essa iniciativa incrível.
Nos últimos três anos, tenho trabalhado como redatora técnica em uma empresa de desenvolvimento de software especializada em automação de processos e lançamentos. Dentre outras coisas, implementamos uma API REST com o 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 são necessárias para que nossos clientes as forneçam de maneira clara e concisa.
Tenho analisado o site atual da API Open Food Facts e acho que podemos reestruturar e aprimorar a documentação para torná-la mais fácil de usar (páginas gerais, LEITURA e ESCRITA). Além disso, gostaria de configurar, junto com as equipes de desenvolvimento, uma maneira 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.
Todos sabemos que a aparência é importante ;) Por isso, também podemos ajustar o CSS e o logotipo da API REST para alinhar a interface do Swagger com a documentação do usuário.
Será um prazer trabalhar com você neste projeto.