Comece por aqui para entender a proposta e o raciocínio por trás dela 😃

Tratando de uma documentação que o público alvo são desenvolvedores que realizam integrações com APIs, o GitHub é bem conhecido. Mesmo os mais iniciantes tem ou precisam ter viviência com a plataforma. Então mesmo sem um estudo prévio, aposto que manter a documentação próxima ao código, sempre será uma forma de facilitar a criação e atualização da mesma.

O GitHub também conta com um controle de versões que é essencial para garantir um processo de documentar mais seguro e com as revisões necessárias.

Foi dito também que o time de Tech Writers usa atualmente o markdown, então pensei em trazer um pouco desse conhecimento sobre.

Pensando em melhor organizar a proposta do case, cada exercício foi dividido em um arquivo markdown nesse reposítório.

• Exercício 1 (nomeado como 1-portal-desenvolvimento.md) - aqui você vai encontrar a análise feita e melhorias propostas.
• Exercício 2 (nomeado como 2-puglin-nuvemshop.md) - contém a proposta de reestruturação da documentação da Nuvemshop.
• Exercício 3 (nomeado como 3-doc-vtex.md) - possui a resposta das perguntas que buscam resolver os pontos a desenvolver, do relatório de algumas documentações da VTEX.

Observei e tentei incluir acessibilidade nas imagens e usar formas distintas de explicar um conteúdo.

Acredito que alguns passo a passo podem ser melhorados, como os copiados no exercício 2. Fiz algumas mudanças, mas com relação a conteúdo, entendo que precisaria conhecer mais o produto e ter acesso as páginas integralmente para avaliar com mais precisão.