Estou trabalhando em um porjeto em laravel e gostaria de sujestoẽs para documentação, o que voces usam, bons padroes, must haves entre outras coisas. Hoje minha api é laravel e o front em vue
Estou trabalhando em um porjeto em laravel e gostaria de sujestoẽs para documentação, o que voces usam, bons padroes, must haves entre outras coisas. Hoje minha api é laravel e o front em vue
Olá, Lucca!
Entendo que você está buscando maneiras eficientes de documentar seu projeto Laravel. Aqui estão algumas sugestões que podem te ajudar:
Comentários de código: No Laravel, é uma boa prática comentar seu código para que outros desenvolvedores (ou você mesmo no futuro) possam entender facilmente o que cada parte do código está fazendo.
Documentação da API: Se você estiver criando uma API, é essencial ter uma documentação clara e concisa. Existem várias ferramentas que podem te ajudar com isso, como o Swagger ou o Postman.
Readme: Um arquivo README bem escrito pode ser muito útil. Ele deve incluir informações sobre o que seu projeto faz, como configurá-lo e como usá-lo.
Padrões de codificação: Seguir um padrão de codificação pode tornar seu código mais legível e fácil de manter. O PSR-2 é um conjunto popular de padrões de codificação para PHP que muitos projetos Laravel seguem.
Documentação do Laravel: A documentação oficial do Laravel é um excelente recurso. Ela é muito completa e pode te ajudar a entender melhor como usar o framework.
Vue.js: Como você mencionou que está usando Vue.js para o front-end, recomendo que você também leia a documentação oficial do Vue.js. Ela é muito detalhada e pode te ajudar a entender melhor como usar essa ferramenta.
Espero que essas sugestões te ajudem a documentar seu projeto de maneira mais eficiente. Lembre-se, a documentação é uma parte essencial de qualquer projeto e pode tornar a manutenção e a colaboração muito mais fáceis. Espero ter ajudado e bons estudos!