README.md

Nome do Projeto

Visão Geral da Solução

descritivo da solução

Mapa de produtos (se existir)

links para os produtos

---

Notas para criação do Template

O nome do repositório deve refletir a nomenclatura de negócio. O repositório deve estar dividido em diretórios de acordo com as responsabilidades técnicas. Utilizar as mesmas nomenclaturas definidas a seguir (caso haja necessidade de novas nomenclaturas, documentar aqui) :

• documentacao - documentação
• app - aplicativo mobile
• frontend - aplicação web
• backend - aplicação backend

Exemplo de repositório de um único produto:

Nome do repositório: gestao

Diretórios:

• documentacao
• frontend
• backend

Caso o projeto da solução exija mais de um produto, os produtos devem ser dividos em diretórios com a mesma organização interna definida acima. Com a exceção da documentação que poderá continuar no primeiro nível para comtemplar documentos pertinentes a todos os produtos.

Exemplo de repositório com dois produto:

Nome do repositório: tceduca

Diretórios:

• documentacao
• gestao
  • frontend
  • backend

• painel
  • frontend
  • backend
  • app

Organização da Documentação

• requisitos
• gerencia

Estrutura do README.MD dos módulos

Obrigatóriamente deve existir um README.MD em cada módulo. Consultar em: app