feat (project): first instructions

templates/2023/project/README.md

@@ -1,26 +1,25 @@
-# Template para Entrega do Trabalho
+# Modelo de Apresentação dos Projetos
 
 No repositório do projeto, deve haver um arquivo com dados básicos do projeto e da equipe na raiz, uma pasta para cada etapa de entrega, conforme templates a seguir:
 
-* [Entrega Parcial](parcial/)
-* [Entrega Prévia](previa/)
-* [Entrega Final](final/)
-
-# Estrutura de Arquivos e Pastas
+* [Projeto 1](project-1/)
+* [Projeto 2](project-2/)
+* [Projeto Final](project-final/)
 
 A seguir é apresentada a estrutura de pastas esperada no repositório do projeto:
 
 ~~~
-├── README.md  <- apresentação do projeto
+├── README.md      <- apresentação do projeto
 │
-├── parcial       <- entrega parcial
+├── project-1      <- primeira entrega - modelo conceitual e lógico
 │
-├── previa        <- entrega prévia
+├── project-2      <- segunda entrega - implementação e consultas parciais 
 │
-└── final         <- entrega final
+└── project-final  <- entrega final
 ~~~
 
-# Modelo o arquivo `README.md` que fica na raiz
+# Modelo para Apresentação do Grupo e Trabalho
+> *arquivo `README.md` que fica na raiz*
 
 # Projeto `<Título do Projeto>`
 
@@ -32,8 +31,6 @@ A seguir é apresentada a estrutura de pastas esperada no repositório do projet
 * `<nome completo>` - `<RA>`
 * `<nome completo>` - `<RA>`
 
-# Etapas
+## Resumo do Projeto
+> Texto resumindo o projeto.
 
-* [Entrega Parcial](parcial/)
-* [Entrega Prévia](previa/)
-* [Entrega Final](final/)

templates/2023/project/project-1/README.md

@@ -0,0 +1,68 @@
+# Modelo para Apresentação do Projeto 1 - Modelo Conceitual e Lógico
+
+## Slides da Apresentação
+> Coloque aqui o link para o PDF da apresentação
+
+## Motivação e Contexto
+
+> Descrição do tema do projeto, incluindo motivação e contexto gerador.
+
+## Bases de Dados
+> Elencar as bases de dados fonte utilizadas no projeto.
+
+título da base | link | breve descrição
+----- | ----- | -----
+`<título da base>` | `<link para a página da base>` | `<breve descrição da base>`
+
+## Modelo Conceitual
+
+> Coloque aqui a imagem do modelo conceitual em ER ou UML, como o exemplo a seguir:
+> ![ER Taxi](images/er-taxi.png)
+
+## Modelos Lógicos
+
+> Coloque aqui o modelo lógico relacional dos bancos de dados relacionados ao modelos conceitual. Sugere-se o formato a seguir.
+
+> Exemplo de modelo lógico relacional
+~~~
+PESSOA(_Código_, Nome, Telefone)
+ARMÁRIO(_Código_, Tamanho, Ocupante)
+  Ocupante chave estrangeira -> PESSOA(Código)
+~~~
+
+## Perguntas de Pesquisa/Análise
+
+> Liste aqui as perguntas de pesquisa/análise. Nem todas as perguntas precisam de implementação associada. É possível haver perguntas em que a solução é apenas descrita para demonstrar o potencial da base. Abaixo são ilustradas três perguntas, mas pode ser um número maior a critério da equipe.
+
+#### Pergunta/Análise 1
+> * Pergunta 1
+>   
+>   * Explicação sucinta da análise que será feita.
+
+#### Pergunta/Análise 2
+> * Pergunta 2
+>   
+>   * Explicação sucinta da análise que será feita.
+
+#### Pergunta/Análise 3
+> * Pergunta 3
+>   
+>   * Explicação sucinta da análise que será feita.
+
+### Perguntas/Análise Propostas mas Não Implementadas
+
+#### Pergunta/Análise 1
+> * Pergunta 1
+>   
+>   * Explicação em linhas gerais de como a base pode ser usada para responder esta pergunta e a sua relevância.
+
+#### Pergunta/Análise 2
+> * Pergunta 2
+>   
+>   * Explicação em linhas gerais de como a base pode ser usada para responder esta pergunta e a sua relevância.
+
+#### Pergunta/Análise 3
+> * Pergunta 3
+>   
+>   * Explicação em linhas gerais de como a base pode ser usada para responder esta pergunta e a sua relevância.
+