Cara, eu ia usar um sistema no meu SaaS e pela doc tão ruim, fui para um concorrente que é até mais caro
agora mesmo tou apanhando com uma outra documentação nesse exato momento.


Junto tou escrevendo uma para meu sistema, tou escrevendo com ajuda do ChatGPT, entrego pra ele o endpoint, explico o que faz, inputs e output e peço ajuda dele para explicar isso como se fosse para uma pessoa não técnica, isso tem me ajudado bastante eu ter mais clareza na documentação.

Também entrego testes unitários para ele ter ainda mais contexto sobre a rota.

Logo mais vou começar a melhorar a doc de um parceiro comercial que tenho, e vou seguir isso que tenho feito no meu.

Eu não usaria a ChatGPT nisso. Ela pode gerar coisas que você é obrigado a revisar depois.

Para rotas, eu gosto de embutir a documentação no próprio código e usar uma ferramenta para gerar os exemplos posteriormente.

Mas se está dando certo para você, qual mal tem? Só espere que quem for usar seu produto tenha o mesmo entendimento que você.

Sim, tem que revisar, com gpt ou sem, tem que revisar.

Cara, eu ia usar um sistema no meu SaaS e pela doc tão ruim, fui para um concorrente que é até mais caro agora mesmo tou apanhando com uma outra documentação nesse exato momento. Junto to...