Bom dia,
Existe alguma PSR que orienta como documentar um projeto?
Existe algum treinamento de documentação de projeto?
Existe algum livro que orienta como documentar um projeto?
Os mesmos questionamentos eu faço para APIs
Obrigado
Solucionado
Bom dia,
Existe alguma PSR que orienta como documentar um projeto?
Existe algum treinamento de documentação de projeto?
Existe algum livro que orienta como documentar um projeto?
Os mesmos questionamentos eu faço para APIs
Obrigado
Olá, Edson! Tudo bem?
Para documentar um projeto, temos a PSR-5, também conhecida como PHPDoc. Essa especificação define padrões para a documentação de código em PHP, incluindo informações sobre classes, métodos, propriedades e parâmetros. Vale lembrar que na página das PSRs, esta PSR em específica, está sendo tratada como "rascunho" ainda.
Sobre algum curso de documentação de APIs, temos o curso de:
O curso ensina como utilizar a ferramenta Swagger para criar documentação automatizada e interativa de APIs, tornando o processo de desenvolvimento e integração mais eficiente e eficaz.
No geral, para documentar um projeto há diversas ferramentas, pode ser usado: Especificação de requisitos funcionais e não funcionais, casos de uso, especificações de casos de uso, diagramas UML para classes e objetos, diagrama de sequência e etc.
Espero ter ajudado e bons estudos!
Obrigado professor Vinicius.
Sempre dando aquela força!
Forte abraço