generated from ICEI-PUC-Minas-PMV-ADS/WebApplicationProject-Template
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit dbc6b31
Showing
22 changed files
with
490 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,52 @@ | ||
# TÍTULO DO PROJETO | ||
|
||
`CURSO` | ||
|
||
`DISCIPLINA` | ||
|
||
`SEMESTRE` | ||
|
||
Descrever resumidamente, em um ou dois parágrafos, o projeto que está sendo desenvolvido. | ||
|
||
## Integrantes | ||
|
||
* Nome completo do aluno 1 | ||
* Nome completo do aluno 2 | ||
* Nome completo do aluno 3 | ||
* Nome completo do aluno 4 | ||
|
||
## Orientador | ||
|
||
* Nome completo do professor 1 | ||
|
||
## Instruções de utilização | ||
|
||
Assim que a primeira versão do sistema estiver disponível, deverá complementar com as instruções de utilização. Descreva como instalar eventuais dependências e como executar a aplicação. | ||
|
||
# Documentação | ||
|
||
<ol> | ||
<li><a href="docs/01-Documentação de Contexto.md"> Documentação de Contexto</a></li> | ||
<li><a href="docs/02-Especificação do Projeto.md"> Especificação do Projeto</a></li> | ||
<li><a href="docs/03-Metodologia.md"> Metodologia</a></li> | ||
<li><a href="docs/04-Projeto de Interface.md"> Projeto de Interface</a></li> | ||
<li><a href="docs/05-Arquitetura da Solução.md"> Arquitetura da Solução</a></li> | ||
<li><a href="docs/06-Template padrão do Site.md"> Template padrão do Site</a></li> | ||
<li><a href="docs/07-Programação de Funcionalidades.md"> Programação de Funcionalidades</a></li> | ||
<li><a href="docs/08-Plano de Testes de Software.md"> Plano de Testes de Software</a></li> | ||
<li><a href="docs/09-Registro de Testes de Software.md"> Registro de Testes de Software</a></li> | ||
<li><a href="docs/10-Apresentação do Projeto.md"> Apresentação do Projeto</a></li> | ||
<li><a href="docs/11-Referências.md"> Referências</a></li> | ||
</ol> | ||
|
||
# Hospedagem | ||
|
||
* Insira o endereço eletrônico público de acesso ao conteúdo publicado. | ||
|
||
# Armazenamento do Código-Fonte | ||
|
||
* <a href="src/README.md">Código Fonte</a> | ||
|
||
# Armazenamento da Apresentação | ||
|
||
* <a href="presentation/README.md">Apresentação da solução</a> |
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 |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# Introdução | ||
|
||
Texto descritivo com a visão geral do projeto abordado. Inclui o contexto, o problema, os objetivos, a justificativa e o público-alvo do projeto. | ||
|
||
## Problema | ||
Nesse momento você deve apresentar o problema que a sua aplicação deve resolver. No entanto, não é a hora de comentar sobre a aplicação. | ||
|
||
Descreva também o contexto em que essa aplicação será usada, se houver: empresa, tecnologias, etc. Novamente, descreva apenas o que de fato existir, pois ainda não é a hora de apresentar requisitos detalhados ou projetos. | ||
|
||
Nesse momento, o grupo pode optar por fazer uso de ferramentas como Design Thinking, que permite um olhar de ponta a ponta para o problema. | ||
|
||
> **Links Úteis**: | ||
> - [Objetivos, Problema de pesquisa e Justificativa](https://medium.com/@versioparole/objetivos-problema-de-pesquisa-e-justificativa-c98c8233b9c3) | ||
> - [Matriz Certezas, Suposições e Dúvidas](https://medium.com/educa%C3%A7%C3%A3o-fora-da-caixa/matriz-certezas-suposi%C3%A7%C3%B5es-e-d%C3%BAvidas-fa2263633655) | ||
> - [Brainstorming](https://www.euax.com.br/2018/09/brainstorming/) | ||
## Objetivos | ||
|
||
Aqui você deve descrever os objetivos do trabalho indicando que o objetivo geral é desenvolver um software para solucionar o problema apresentado acima. | ||
|
||
Apresente também alguns (pelo menos 2) objetivos específicos dependendo de onde você vai querer concentrar a sua prática investigativa, ou como você vai aprofundar no seu trabalho. | ||
|
||
> **Links Úteis**: | ||
> - [Objetivo geral e objetivo específico: como fazer e quais verbos utilizar](https://blog.mettzer.com/diferenca-entre-objetivo-geral-e-objetivo-especifico/) | ||
## Justificativa | ||
|
||
Descreva a importância ou a motivação para trabalhar com esta aplicação que você escolheu. Indique as razões pelas quais você escolheu seus objetivos específicos ou as razões para aprofundar em certos aspectos do software. | ||
|
||
O grupo de trabalho pode fazer uso de questionários, entrevistas e dados estatísticos, que podem ser apresentados, com o objetivo de esclarecer detalhes do problema que será abordado pelo grupo. | ||
|
||
> **Links Úteis**: | ||
> - [Como montar a justificativa](https://guiadamonografia.com.br/como-montar-justificativa-do-tcc/) | ||
## Público-Alvo | ||
|
||
Descreva quem serão as pessoas que usarão a sua aplicação indicando os diferentes perfis. O objetivo aqui não é definir quem serão os clientes ou quais serão os papéis dos usuários na aplicação. A ideia é, dentro do possível, conhecer um pouco mais sobre o perfil dos usuários: conhecimentos prévios, relação com a tecnologia, relações | ||
hierárquicas, etc. | ||
|
||
Adicione informações sobre o público-alvo por meio de uma descrição textual, diagramas de personas e mapa de stakeholders. | ||
|
||
> **Links Úteis**: | ||
> - [Público-alvo](https://blog.hotmart.com/pt-br/publico-alvo/) | ||
> - [Como definir o público alvo](https://exame.com/pme/5-dicas-essenciais-para-definir-o-publico-alvo-do-seu-negocio/) | ||
> - [Público-alvo: o que é, tipos, como definir seu público e exemplos](https://klickpages.com.br/blog/publico-alvo-o-que-e/) | ||
> - [Qual a diferença entre público-alvo e persona?](https://rockcontent.com/blog/diferenca-publico-alvo-e-persona/) |
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 |
---|---|---|
@@ -0,0 +1,91 @@ | ||
# Especificações do Projeto | ||
|
||
<span style="color:red">Pré-requisitos: <a href="1-Documentação de Contexto.md"> Documentação de Contexto</a></span> | ||
|
||
Definição do problema e ideia de solução a partir da perspectiva do usuário. É composta pela definição do diagrama de personas, histórias de usuários, requisitos funcionais e não funcionais além das restrições do projeto. | ||
|
||
Apresente uma visão geral do que será abordado nesta parte do documento, enumerando as técnicas e/ou ferramentas utilizadas para realizar a especificações do projeto | ||
|
||
## Personas | ||
|
||
Pedro Paulo tem 26 anos, é arquiteto recém-formado e autônomo. Pensa em se desenvolver profissionalmente através de um mestrado fora do país, pois adora viajar, é solteiro e sempre quis fazer um intercâmbio. Está buscando uma agência que o ajude a encontrar universidades na Europa que aceitem alunos estrangeiros. | ||
|
||
Enumere e detalhe as personas da sua solução. Para tanto, baseie-se tanto nos documentos disponibilizados na disciplina e/ou nos seguintes links: | ||
|
||
> **Links Úteis**: | ||
> - [Rock Content](https://rockcontent.com/blog/personas/) | ||
> - [Hotmart](https://blog.hotmart.com/pt-br/como-criar-persona-negocio/) | ||
> - [O que é persona?](https://resultadosdigitais.com.br/blog/persona-o-que-e/) | ||
> - [Persona x Público-alvo](https://flammo.com.br/blog/persona-e-publico-alvo-qual-a-diferenca/) | ||
> - [Mapa de Empatia](https://resultadosdigitais.com.br/blog/mapa-da-empatia/) | ||
> - [Mapa de Stalkeholders](https://www.racecomunicacao.com.br/blog/como-fazer-o-mapeamento-de-stakeholders/) | ||
> | ||
Lembre-se que você deve ser enumerar e descrever precisamente e personalizada todos os clientes ideais que sua solução almeja. | ||
|
||
## Histórias de Usuários | ||
|
||
Com base na análise das personas forma identificadas as seguintes histórias de usuários: | ||
|
||
|EU COMO... `PERSONA`| QUERO/PRECISO ... `FUNCIONALIDADE` |PARA ... `MOTIVO/VALOR` | | ||
|--------------------|------------------------------------|----------------------------------------| | ||
|Usuário do sistema | Registrar minhas tarefas | Não esquecer de fazê-las | | ||
|Administrador | Alterar permissões | Permitir que possam administrar contas | | ||
|
||
Apresente aqui as histórias de usuário que são relevantes para o projeto de sua solução. As Histórias de Usuário consistem em uma ferramenta poderosa para a compreensão e elicitação dos requisitos funcionais e não funcionais da sua aplicação. Se possível, agrupe as histórias de usuário por contexto, para facilitar consultas recorrentes à essa parte do documento. | ||
|
||
> **Links Úteis**: | ||
> - [Histórias de usuários com exemplos e template](https://www.atlassian.com/br/agile/project-management/user-stories) | ||
> - [Como escrever boas histórias de usuário (User Stories)](https://medium.com/vertice/como-escrever-boas-users-stories-hist%C3%B3rias-de-usu%C3%A1rios-b29c75043fac) | ||
> - [User Stories: requisitos que humanos entendem](https://www.luiztools.com.br/post/user-stories-descricao-de-requisitos-que-humanos-entendem/) | ||
> - [Histórias de Usuários: mais exemplos](https://www.reqview.com/doc/user-stories-example.html) | ||
> - [9 Common User Story Mistakes](https://airfocus.com/blog/user-story-mistakes/) | ||
## Requisitos | ||
|
||
As tabelas que se seguem apresentam os requisitos funcionais e não funcionais que detalham o escopo do projeto. | ||
|
||
### Requisitos Funcionais | ||
|
||
|ID | Descrição do Requisito | Prioridade | | ||
|------|-----------------------------------------|----| | ||
|RF-001| Permitir que o usuário cadastre tarefas | ALTA | | ||
|RF-002| Emitir um relatório de tarefas no mês | MÉDIA | | ||
|
||
|
||
### Requisitos não Funcionais | ||
|
||
|ID | Descrição do Requisito |Prioridade | | ||
|-------|-------------------------|----| | ||
|RNF-001| O sistema deve ser responsivo para rodar em um dispositivos móvel | MÉDIA | | ||
|RNF-002| Deve processar requisições do usuário em no máximo 3s | BAIXA | | ||
|
||
Com base nas Histórias de Usuário, enumere os requisitos da sua solução. Classifique esses requisitos em dois grupos: | ||
|
||
- [Requisitos Funcionais | ||
(RF)](https://pt.wikipedia.org/wiki/Requisito_funcional): | ||
correspondem a uma funcionalidade que deve estar presente na | ||
plataforma (ex: cadastro de usuário). | ||
- [Requisitos Não Funcionais | ||
(RNF)](https://pt.wikipedia.org/wiki/Requisito_n%C3%A3o_funcional): | ||
correspondem a uma característica técnica, seja de usabilidade, | ||
desempenho, confiabilidade, segurança ou outro (ex: suporte a | ||
dispositivos iOS e Android). | ||
Lembre-se que cada requisito deve corresponder à uma e somente uma | ||
característica alvo da sua solução. Além disso, certifique-se de que | ||
todos os aspectos capturados nas Histórias de Usuário foram cobertos. | ||
|
||
## Restrições | ||
|
||
O projeto está restrito pelos itens apresentados na tabela a seguir. | ||
|
||
|ID| Restrição | | ||
|--|-------------------------------------------------------| | ||
|01| O projeto deverá ser entregue até o final do semestre | | ||
|02| Não pode ser desenvolvido um módulo de backend | | ||
|
||
|
||
Enumere as restrições à sua solução. Lembre-se de que as restrições geralmente limitam a solução candidata. | ||
|
||
> **Links Úteis**: | ||
> - [O que são Requisitos Funcionais e Requisitos Não Funcionais?](https://codificar.com.br/requisitos-funcionais-nao-funcionais/) | ||
> - [O que são requisitos funcionais e requisitos não funcionais?](https://analisederequisitos.com.br/requisitos-funcionais-e-requisitos-nao-funcionais-o-que-sao/) |
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 |
---|---|---|
@@ -0,0 +1,77 @@ | ||
|
||
# Metodologia | ||
|
||
<span style="color:red">Pré-requisitos: <a href="2-Especificação do Projeto.md"> Documentação de Especificação</a></span> | ||
|
||
Descreva aqui a metodologia de trabalho do grupo para atacar o problema. Definições sobre os ambiente de trabalho utilizados pela equipe para desenvolver o projeto. Abrange a relação de ambientes utilizados, a estrutura para gestão do código fonte, além da definição do processo e ferramenta através dos quais a equipe se organiza (Gestão de Times). | ||
|
||
## Controle de Versão | ||
|
||
A ferramenta de controle de versão adotada no projeto foi o | ||
[Git](https://git-scm.com/), sendo que o [Github](https://github.com) | ||
foi utilizado para hospedagem do repositório. | ||
|
||
O projeto segue a seguinte convenção para o nome de branches: | ||
|
||
- `main`: versão estável já testada do software | ||
- `unstable`: versão já testada do software, porém instável | ||
- `testing`: versão em testes do software | ||
- `dev`: versão de desenvolvimento do software | ||
|
||
Quanto à gerência de issues, o projeto adota a seguinte convenção para | ||
etiquetas: | ||
|
||
- `documentation`: melhorias ou acréscimos à documentação | ||
- `bug`: uma funcionalidade encontra-se com problemas | ||
- `enhancement`: uma funcionalidade precisa ser melhorada | ||
- `feature`: uma nova funcionalidade precisa ser introduzida | ||
|
||
Discuta como a configuração do projeto foi feita na ferramenta de versionamento escolhida. Exponha como a gerência de tags, merges, commits e branchs é realizada. Discuta como a gerência de issues foi realizada. | ||
|
||
> **Links Úteis**: | ||
> - [Tutorial GitHub](https://guides.github.com/activities/hello-world/) | ||
> - [Git e Github](https://www.youtube.com/playlist?list=PLHz_AreHm4dm7ZULPAmadvNhH6vk9oNZA) | ||
> - [Comparando fluxos de trabalho](https://www.atlassian.com/br/git/tutorials/comparing-workflows) | ||
> - [Understanding the GitHub flow](https://guides.github.com/introduction/flow/) | ||
> - [The gitflow workflow - in less than 5 mins](https://www.youtube.com/watch?v=1SXpE08hvGs) | ||
## Gerenciamento de Projeto | ||
|
||
### Divisão de Papéis | ||
|
||
Apresente a divisão de papéis entre os membros do grupo. | ||
|
||
> **Links Úteis**: | ||
> - [11 Passos Essenciais para Implantar Scrum no seu | ||
> Projeto](https://mindmaster.com.br/scrum-11-passos/) | ||
> - [Scrum em 9 minutos](https://www.youtube.com/watch?v=XfvQWnRgxG0) | ||
### Processo | ||
|
||
Coloque informações sobre detalhes da implementação do Scrum seguido pelo grupo. O grupo poderá fazer uso de ferramentas on-line para acompanhar o andamento do projeto, a execução das tarefas e o status de desenvolvimento da solução. | ||
|
||
> **Links Úteis**: | ||
> - [Project management, made simple](https://github.com/features/project-management/) | ||
> - [Sobre quadros de projeto](https://docs.github.com/pt/github/managing-your-work-on-github/about-project-boards) | ||
> - [Como criar Backlogs no Github](https://www.youtube.com/watch?v=RXEy6CFu9Hk) | ||
> - [Tutorial Slack](https://slack.com/intl/en-br/) | ||
### Ferramentas | ||
|
||
As ferramentas empregadas no projeto são: | ||
|
||
- Editor de código. | ||
- Ferramentas de comunicação | ||
- Ferramentas de desenho de tela (_wireframing_) | ||
|
||
O editor de código foi escolhido porque ele possui uma integração com o | ||
sistema de versão. As ferramentas de comunicação utilizadas possuem | ||
integração semelhante e por isso foram selecionadas. Por fim, para criar | ||
diagramas utilizamos essa ferramenta por melhor captar as | ||
necessidades da nossa solução. | ||
|
||
Liste quais ferramentas foram empregadas no desenvolvimento do projeto, justificando a escolha delas, sempre que possível. | ||
|
||
> **Possíveis Ferramentas que auxiliarão no gerenciamento**: | ||
> - [Slack](https://slack.com/) | ||
> - [Github](https://github.com/) |
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 |
---|---|---|
@@ -0,0 +1,35 @@ | ||
|
||
# Projeto de Interface | ||
|
||
<span style="color:red">Pré-requisitos: <a href="2-Especificação do Projeto.md"> Documentação de Especificação</a></span> | ||
|
||
Visão geral da interação do usuário pelas telas do sistema e protótipo interativo das telas com as funcionalidades que fazem parte do sistema (wireframes). | ||
|
||
Apresente as principais interfaces da plataforma. Discuta como ela foi elaborada de forma a atender os requisitos funcionais, não funcionais e histórias de usuário abordados nas <a href="2-Especificação do Projeto.md"> Documentação de Especificação</a>. | ||
|
||
## User Flow | ||
|
||
![Exemplo de UserFlow](img/userflow.jpg) | ||
|
||
Fluxo de usuário (User Flow) é uma técnica que permite ao desenvolvedor mapear todo fluxo de telas do site ou app. Essa técnica funciona para alinhar os caminhos e as possíveis ações que o usuário pode fazer junto com os membros de sua equipe. | ||
|
||
> **Links Úteis**: | ||
> - [User Flow: O Quê É e Como Fazer?](https://medium.com/7bits/fluxo-de-usu%C3%A1rio-user-flow-o-que-%C3%A9-como-fazer-79d965872534) | ||
> - [User Flow vs Site Maps](http://designr.com.br/sitemap-e-user-flow-quais-as-diferencas-e-quando-usar-cada-um/) | ||
> - [Top 25 User Flow Tools & Templates for Smooth](https://www.mockplus.com/blog/post/user-flow-tools) | ||
|
||
## Wireframes | ||
|
||
![Exemplo de Wireframe](img/wireframe-example.png) | ||
|
||
São protótipos usados em design de interface para sugerir a estrutura de um site web e seu relacionamentos entre suas páginas. Um wireframe web é uma ilustração semelhante do layout de elementos fundamentais na interface. | ||
|
||
> **Links Úteis**: | ||
> - [Protótipos vs Wireframes](https://www.nngroup.com/videos/prototypes-vs-wireframes-ux-projects/) | ||
> - [Ferramentas de Wireframes](https://rockcontent.com/blog/wireframes/) | ||
> - [MarvelApp](https://marvelapp.com/developers/documentation/tutorials/) | ||
> - [Figma](https://www.figma.com/) | ||
> - [Adobe XD](https://www.adobe.com/br/products/xd.html#scroll) | ||
> - [Axure](https://www.axure.com/edu) (Licença Educacional) | ||
> - [InvisionApp](https://www.invisionapp.com/) (Licença Educacional) |
Oops, something went wrong.