Documentação em Markdown
Documento global do workspace e documentos por coleção.
Documento do workspace
O caminho Documentação do workspace oferece um documento Markdown geral do projeto: visão, convenções, links internos, etc.
Documento por coleção
Dentro de cada coleção você pode editar o Markdown associado à API (descrição, guias, exemplos). O editor geralmente inclui pré-visualização e, em equipes, controle de versão ou conflitos semelhantes aos demais documentos.
Boas práticas
- Estruture com cabeçalhos claros (
##,###). - Vincule a ambientes e evidências ao descrever fluxos end-to-end.
- Mantenha o conteúdo alinhado com o OpenAPI e as coleções importadas.