SayRyan
commented
1 week ago @luisfesantos , @DanielFBononi e @LucasCotrim2003
Mano, tô esperando a entrega da documentação. Comecei a fazer o README, mas preciso da documentação para dar continuidade, pois o dedinho vai começar a avaliar os projetos. Bora agilizar essa parada aí
@luisfesantos , @DanielFBononi e @LucasCotrim2003
Como documentação, eu acredito que o README deva ter as seguintes características:
Uma introdução que diga para que o software está sendo feito, o que se espera dele, um resumo das principais features do sistema e coisas assim. Uma imagem de alguma tela do projeto também pode ser interessante. 1.1 Uma subsessão com o(s) link(s) de deploy
Um sumário com links para cada sessão do README
Tecnologias utilizadas no desenvolvimento. Talvez seja bom separar por stack, como Infraestrutura, Back-End, Front-End e, se tiver, DevOps (CI/CD).
Caso tenha, uma descrição dos ambientes (dev, staging e produção) e um exemplo de variáveis de ambiente para desenvolvimento local (um arquivo .env.example no código já pode ser o suficiente)
Uma descrição detalhada de como subir o ambiente no computador
Requisitos não funcionais, como por exemplo os relacionados a design e qualquer outro
Requisitos funcionais, como cadastro, login e etc
Regras de negócio associadas aos requisitos funcionais O.B.S.: Caso se queira separar ainda mais não tem problema. Por exemplo, podem separar os requisitos funcionais por página, os não funcionais (seriam os requisitos de produtos, portabilidade, confiabilidade, padrões, implementações, éticos, legais, de integração e qualquer outro que queriam esmiuçar)
Diagramas de casos de uso (linkados/tageados com os seus respectivos requisitos funcionais)
Diagrama de classes caso o tenha e qualquer outro diagrama que se queria colocar
Padrões adotados no projeto (decidir se se coloca aqui ou em algum requisito não funcional).
Contatos dos integrantes
Possíveis observações/soluções para algum problema que quem for usar o sistema pode enfrentar (seja na hora de configurar o ambiente ou seja na hora de utilizar o software mesmo).