Um dos aspectos que mais diferencia os projetos é o fato de possuírem ou não uma documentação, especialmente uma que seja bem feita e se mantenha atualizada.
Documentar os processos, estruturas, entidades, raciocínios e tantos outros fatores que compõe um projeto complexo e alto nível é extremamente importante e está diretamente relacionado com manter aquele projeto conforme os anos passam e a equipe que desenvolve muda.
Nesta aula falaremos sobre como utilizar duas ferramentas muito poderosas para gerar uma documentação automática, permitindo com que nós, devs, direcionemos os esforços apenas para o que importa: construir e manter o código da nossa aplicação.
- NestJS + Swagger: https://docs.nestjs.com/openapi/introduction
- NestJS + Compodoc: https://docs.nestjs.com/recipes/documentation
- JSDocs: https://jsdoc.app/index.html
 |
|---|
| Paulo Salvatore |