Projeto OpenMRS.org

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:
OpenMRS.org
Redator técnico:
Ayeshmantha
Nome do projeto:
Como desenvolver uma documentação do GitHub fácil de usar para a API REST
Duração do projeto:
Duração padrão (três 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, ao mesmo tempo, ter uma descrição mais descritiva e autoexplicativa que explique para pessoas técnicas e não técnicas em quais situações é preciso usar o endpoint.

O ambiente atual é ótimo, mas ainda assim é mais difícil ter uma ideia sem a documentação adequada para quem não é técnico. A ideia principal é ter esse ambiente e a documentação do Swagger em um só lugar com uma boa representação. Com a ajuda de JS, HTML e CSS.