Esta página contém os detalhes de um projeto de escrita técnica aceito para a temporada de documentos do Google.
Resumo do projeto
- Organização de código aberto:
- OpenMRS.org
- Redator técnico:
- Ayeshmantha
- Nome do projeto:
- Como desenvolver documentação do GithHub amigável para a API REST
- Duração do projeto:
- Duração padrão (3 meses)
Project description
O objetivo principal do projeto é desenvolver uma documentação interativa em que os usuários finais possam interagir com as APIs com opções de teste e, enquanto isso, ter uma descrição mais descritiva e autoexplicativa que explique para os técnicos e não técnicos em qual situação usar o endpoint.
O ambiente de estilo atual é ótimo, mas, para quem não é técnico, ainda é mais difícil ter uma ideia diretamente sem a documentação adequada. A ideia principal seria colocar esse ambiente e essa documentação em um só lugar com uma boa representação. Com a ajuda de JS, HTML e CSS.