-
Notifications
You must be signed in to change notification settings - Fork 73
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat (project/template): partial and final template of the project
- Loading branch information
Showing
3 changed files
with
451 additions
and
246 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,247 +1,5 @@ | ||
| # Modelo de Apresentação do Projeto | ||
| # Templates das Entregas do Trabalho | ||
|
|
||
| # Estrutura de Arquivos e Pastas | ||
|
|
||
| A estrutura aqui apresentada é uma simplificação daquela proposta pelo [Cookiecutter Data Science](https://drivendata.github.io/cookiecutter-data-science/). Também será aceito que o projeto adote a estrutura completa do Cookiecutter Data Science e isso será considerado um diferencial. A estrutura geral é a seguinte e será detalhada a seguir: | ||
|
|
||
| ~~~ | ||
| ├── README.md <- apresentação do projeto | ||
| │ | ||
| ├── data <- dados usados pelo jogo (se houver) | ||
| │ | ||
| ├── notebooks <- Jupyter notebooks ou equivalentes | ||
| │ | ||
| ├── src <- projeto em Java (preferencialmente projeto no Eclipse) | ||
| │ │ | ||
| │ ├── src <- arquivos-fonte do projeto (.java) | ||
| │ │ | ||
| │ ├── bin <- arquivos em bytecode (.class) | ||
| │ │ | ||
| │ └── README.md <- instruções básicas de instalação/execução | ||
| │ | ||
| └── assets <- mídias usadas no projeto | ||
| ~~~ | ||
|
|
||
| Na raiz deve haver um arquivo de nome `README.md` contendo a apresentação do projeto, como detalhado na seção seguinte. | ||
|
|
||
| ## `data` | ||
|
|
||
| Arquivos de dados usados no projeto, quando isso ocorrer. Por exemplo, se o jogo lê mapas de labirintos que estão em arquivo-texto, coloque os arquivos aqui (mesmo que você mantenha uma cópia no diretório do código). | ||
|
|
||
| ## `notebooks` | ||
|
|
||
| Testes ou prototipos relacionados ao projeto que tenham sido executados no Jupyter. Por exemplo, coloque aqui uma cópia dos testes feitos nas Exceptions. | ||
|
|
||
| ## `src` | ||
|
|
||
| Projeto em Java, preferencialmente em Eclipse, incluindo todos os arquivos de dados e bibliotecas necessários para a sua execução. Dentro dessa pasta sugerimos que você mantenha uma estrutura equivalente ao Eclipse, com uma subpasta `src` onde estarão os fontes e outra subpasta `bin` onde estarão os bytecodes. | ||
|
|
||
| Acrescente na raiz um arquivo `README.md` com as instruções básicas de instalação e execução. | ||
|
|
||
| ## `assets` | ||
|
|
||
| Qualquer mídia usada no seu projeto: vídeo, imagens, animações, slides etc. Coloque os arquivos aqui (mesmo que você mantenha uma cópia no diretório do código). | ||
|
|
||
| # Modelo para Apresentação do Projeto | ||
|
|
||
| Este é um guia de como produzir documentação em Markdown. Para entender como criar documentos em Markdown no Github, veja o material/vídeo: | ||
| [Guia de Uso do Markdown](https://github.com/mc-unicamp/oficinas/tree/master/docs). | ||
|
|
||
| Vide detalhes sobre o Markdown em: [Mastering Markdown](https://guides.github.com/features/mastering-markdown/). | ||
|
|
||
| E mais especificamente sobre tabelas em: [Organizing information with tables](https://help.github.com/en/articles/organizing-information-with-tables) | ||
|
|
||
| Segue abaixo o modelo de como deve ser documentado o projeto e cada componente do projeto. Tudo o que for indicado entre `<...>` indica algo que deve ser substituído pelo indicado. No modelo são colocados exemplos ilustrativos, que serão substituídos pelos do seu projeto. | ||
|
|
||
| Para a construção dos diagramas, devem ser usados modelos disponíveis em: [Diagramas de Classes, Interfaces e Componentes](https://docs.google.com/presentation/d/1ML3WrnDtzh-4wqLmdXN9au1TBIwEqo7TIbMLNOYSMAI/edit?usp=sharing) | ||
|
|
||
| # Modelo para Apresentação do Projeto | ||
|
|
||
| # Projeto `<Título do Projeto/Jogo>` | ||
|
|
||
| # Descrição Resumida do Projeto/Jogo | ||
|
|
||
| > <Descreva resumidamente o jogo e seu propósito.> | ||
| # Equipe | ||
| * `<nome completo>` - `<RA>` | ||
|
|
||
| # Vídeos do Projeto | ||
|
|
||
| ## Vídeo da Prévia | ||
| > <Coloque um link para o vídeo da prévia do projeto.> | ||
| ## Vídeo do Jogo | ||
| > <Coloque um link para o vídeo em que é demonstrada a versão final do jogo. Esse vídeo deve ter em torno de 5 minutos. Este vídeo não apresenta slides, nem substitui a apresentação final do projeto, que será feita por conferência. Ele mostra apenas o jogo em funcionamento.> | ||
| # Slides do Projeto | ||
|
|
||
| ## Slides da Prévia | ||
| `<Coloque um link para os slides da prévia do projeto.>` | ||
|
|
||
| ## Slides da Apresentação Final | ||
| `<Coloque um link para os slides da apresentação final do projeto.>` | ||
|
|
||
| ## Relatório de Evolução | ||
|
|
||
| > <Relatório de evolução, descrevendo as evoluções do design do projeto, dificuldades enfrentadas, mudanças de rumo, melhorias e lições aprendidas. Referências aos diagramas e recortes de mudanças são bem-vindos.> | ||
| # Destaques de Código | ||
|
|
||
| > <Escolha trechos relevantes e/ou de destaque do seu código. Apresente um recorte (você pode usar reticências para remover partes menos importantes). Veja como foi usado o highlight de Java para o código.> | ||
| ~~~java | ||
| // Recorte do seu código | ||
| public void algoInteressante(…) { | ||
| … | ||
| trechoInteressante = 100; | ||
| } | ||
| ~~~ | ||
|
|
||
| # Destaques de Pattern | ||
| `<Destaque de patterns adotados pela equipe. Sugestão de estrutura:>` | ||
|
|
||
| ## Diagrama do Pattern | ||
| `<Diagrama do pattern dentro do contexto da aplicação.>` | ||
|
|
||
| ## Código do Pattern | ||
| ~~~java | ||
| // Recorte do código do pattern seguindo as mesmas diretrizes de outros destaques | ||
| public void algoInteressante(…) { | ||
| … | ||
| trechoInteressante = 100; | ||
| } | ||
| ~~~ | ||
|
|
||
| > <Explicação de como o pattern foi adotado e quais suas vantagens, referenciando o diagrama.> | ||
| # Conclusões e Trabalhos Futuros | ||
|
|
||
| > <Apresente aqui as conclusões do projeto e propostas de trabalho futuro. Esta é a oportunidade em que você pode indicar melhorias no projeto a partir de lições aprendidas e conhecimentos adquiridos durante a realização do projeto, mas que não puderam ser implementadas por questões de tempo. Por exemplo, há design patterns aprendidos no final do curso que provavelmente não puderam ser implementados no jogo -- este é o espaço onde você pode apresentar como aplicaria o pattern no futuro para melhorar o jogo.> | ||
| # Documentação dos Componentes | ||
|
|
||
| O vídeo a seguir apresenta um detalhamento de um projeto baseado em componentes: | ||
|
|
||
| [](https://youtu.be/1LcSghlin6o) | ||
|
|
||
| # Diagramas | ||
|
|
||
| ## Diagrama Geral do Projeto | ||
|
|
||
| > <Apresente um diagrama geral de organização da organização do seu sistema. O formato é livre. A escolha de um ou mais estilos arquiteturais será considerado um diferencial.> | ||
| > <Faça uma breve descrição do diagrama.> | ||
| ## Diagrama Geral de Componentes | ||
|
|
||
| ### Exemplo 1 | ||
|
|
||
| Este é o diagrama compondo componentes para análise: | ||
|
|
||
|  | ||
|
|
||
| ### Exemplo 2 | ||
|
|
||
| Este é um diagrama inicial do projeto de jogos: | ||
|
|
||
|  | ||
|
|
||
| ### Exemplo 3 | ||
|
|
||
| Este é outro diagrama de um projeto de vendas: | ||
|
|
||
|  | ||
|
|
||
| Para cada componente será apresentado um documento conforme o modelo a seguir: | ||
|
|
||
| ## Componente `<Nome do Componente>` | ||
|
|
||
| > <Resumo do papel do componente e serviços que ele oferece.> | ||
|  | ||
|
|
||
| **Ficha Técnica** | ||
| item | detalhamento | ||
| ----- | ----- | ||
| Classe | `<caminho completo da classe com pacotes>` <br> Exemplo: `pt.c08componentes.s20catalog.s10ds.DataSetComponent` | ||
| Autores | `<nome dos membros que criaram o componente>` | ||
| Interfaces | `<listagem das interfaces do componente>` | ||
|
|
||
| ### Interfaces | ||
|
|
||
| Interfaces associadas a esse componente: | ||
|
|
||
|  | ||
|
|
||
| Interface agregadora do componente em Java: | ||
|
|
||
| ~~~java | ||
| public interface IDataSet extends ITableProducer, IDataSetProperties { | ||
| } | ||
| ~~~ | ||
|
|
||
| ## Detalhamento das Interfaces | ||
|
|
||
| ### Interface `<nome da interface>` | ||
|
|
||
| `<Resumo do papel da interface.>` | ||
|
|
||
| ~~~ | ||
| <Interface em Java.> | ||
| ~~~ | ||
|
|
||
| Método | Objetivo | ||
| -------| -------- | ||
| `<id do método em Java>` | `<objetivo do método e descrição dos parâmetros>` | ||
|
|
||
| ## Exemplo: | ||
|
|
||
| ### Interface `ITableProducer` | ||
|
|
||
| Interface provida por qualquer fonte de dados que os forneça na forma de uma tabela. | ||
|
|
||
| ~~~java | ||
| public interface ITableProducer { | ||
| String[] requestAttributes(); | ||
| String[][] requestInstances(); | ||
| } | ||
| ~~~ | ||
|
|
||
| Método | Objetivo | ||
| -------| -------- | ||
| `requestAttributes` | Retorna um vetor com o nome de todos os atributos (colunas) da tabela. | ||
| `requestInstances` | Retorna uma matriz em que cada linha representa uma instância e cada coluna o valor do respectivo atributo (a ordem dos atributos é a mesma daquela fornecida por `requestAttributes`. | ||
|
|
||
| ### Interface `IDataSetProperties` | ||
|
|
||
| Define o recurso (usualmente o caminho para um arquivo em disco) que é a fonte de dados. | ||
|
|
||
| ~~~java | ||
| public interface IDataSetProperties { | ||
| public String getDataSource(); | ||
| public void setDataSource(String dataSource); | ||
| } | ||
| ~~~ | ||
|
|
||
| Método | Objetivo | ||
| -------| -------- | ||
| `getDataSource` | Retorna o caminho da fonte de dados. | ||
| `setDataSource` | Define o caminho da fonte de dados, informado através do parâmetro `dataSource`. | ||
|
|
||
| # Plano de Exceções | ||
|
|
||
| ## Diagrama da hierarquia de exceções | ||
| `<Elabore um diagrama com a hierarquia de exceções como detalhado abaixo>` | ||
|
|
||
|  | ||
|
|
||
| ## Descrição das classes de exceção | ||
|
|
||
| `<Monte uma tabela descritiva seguindo o exemplo>:` | ||
|
|
||
| Classe | Descrição | ||
| ----- | ----- | ||
| DivisaoInvalida | Engloba todas as exceções de divisões não aceitas. | ||
| DivisaoInutil | Indica que a divisão por 1 é inútil. | ||
| DivisaoNaoInteira | Indica uma divisão não inteira. | ||
| Cada template a seguir corresponde a uma entrega do trabalho: | ||
| * [Entrega Parcial](entrega-parcial.md) | ||
| * [Entrega Final](entrega-final.md) |
Oops, something went wrong.