Documento de visão
1. Introdução
Este documento consiste na descrição oficial do escopo do projeto Questmark, o qual refere-se a uma plataforma que possibilitará a criação de formulários escritos em Markdown e o compartilhamento do mesmo para diversos usuários.
1.1 Propósito
Manter uma visão comum para os envolvidos e informar o leitor a finalidade do projeto Questmark ao expor as ideias necessárias para seu desenvolvimento.
1.2 Escopo
Projeto desenvolvido por estudantes do curso de Engenharia de Software da Universidade de Brasília.
Questmark é uma plataforma que possibilita a criação de questionários a partir da linguagem de marcação Markdown, que proporciona ao usuário a oportunidade de compartilhar suas perguntas com terceiros e visualizar em um dashboard o todas respostas que foram dadas em seu questionário.
1.3 Definições, acrônimos e abreviações
UnB: Universidade De Brasília.
FGA: Faculdade do Gama - Campus da Universidade de Brasília localizado no Gama.
MDS: Disciplina de Métodos de Desenvolvimento de Software.
EPS : Disciplina de Engenharia de Produto de Software.
Markdown: Linguagem de marcação que converte texto comum em páginas web.
1.4 Referências
- IBM Knowledge Center - Documento de Visão: A estrutura de tópicos do documento de visão. Disponível em: https://www.ibm.com/support/knowledgecenter/pt-br/SSWMEQ_4.0.6/com.ibm.rational.rrm.help.doc/topics/r_vision_doc.html. Acesso em 4 de set. de 2019;
- Disponível em: https://github.com/fga-eps-mds/2018.2-Lino/blob/master/docs/documento-de-visao.md. Acesso em 4 de set. de 2019;
- Disponível em: https://fga-eps-mds.github.io/2018.2-IndicaAi//docs/2018/08/24/vision-doc.html. Acesso em 4 de set. de 2019;
- Disponível em: https://fga-eps-mds.github.io/2019.1-ADA/#/docs/product/vision_document. Acesso em 6 de set. de 2019;
1.5 Visão geral
O atual documento tem como objetivo representar para os membros e os interessados, de forma explicativa, às informações gerais do projeto, os requisitos do software, os envolvidos e usuários, a visão geral do produto e seus recursos.
2. Posicionamento
2.1 Oportunidade de Negócio
Atualmente, o Markdown é amplamente utilizada na plataforma de versionamento Github para criação de documentos estáticos, por conta de sua fácil utilização, e nada muito além dessa função. O projeto Questmark, possui como objetivo atribuir ao Markdown mais uma comodidade possibilitando a criação de formulários, algo que até o presente momento não é factível de se fazer com o mesmo.
2.2 Descrição do Problema
|
Informações do Produto |
| O problema |
Markdown não permite a criação de formulários |
| Afeta |
Usuários que possuem familiaridade com Markdown |
| Cujo Impacto é |
Possibilitar a criação de formulários em Markdown |
| Uma boa solução seria |
Uma plataforma voltada especialmente à criação e compartilhamento de formulários em Markdown de forma descomplicada |
2.3 Instrução de posição do produto
|
Instrução de posição do produto |
| Para |
Qualquer usuário que possua familiaridade com a linguagem de marcação |
| Que |
Oferece uma forma simples, elegante e rápida de criar questionários |
| Questmark é |
Plataforma para criar questionários |
| Que |
Converte Markdown para um formulário |
| Diferente do |
Google Forms |
| Nosso produto |
Oferece mais uma usabilidade para a linguagem de marcação |
3. Descrição dos envolvidos e dos Usuários
Os envolvidos no projeto serão os membros da equipe da turma de MDS, que irão desempenhar papeis de desenvolvimento e de gestão com auxílio do monitor.
O projeto tem como alvo programadores que desejam utilizar markdown, tanto para tarefas simples quanto tarefas mais elaboradas.
Dentre os artefatos que o Questmark propõe, os principais são a possibilidade de editar markdown com visualização em tempo real e elaborar questionários compartilháveis para serem respondidos.
3.1 Resumo dos Envolvidos
| Nome |
Descrição |
Responsabilidades |
| Equipe de desenvolvimento e gestão de software |
Estudantes da disciplina de Métodos de Desenvolvimento de Software |
Desenvolvimento do software descrito no documento, assim como a gestão da equipe |
| Monitor |
Estudante que já cursou a disciplina de Métodos de Desenvolvimento de Software |
Foi designado pelo professor e auxiliará a equipe, especialmente na parte da gestão do projeto |
| Orientador |
Professor da disciplina de Métodos de Desenvolvimento de Software |
Orientar a equipe em eventuais dúvidas problemas |
3.2 Resumo dos Usuários
| Nome |
Descrição |
Responsabilidade |
| Programadores |
Aqueles que utilizam Markdown para a elaboração de HTML |
Utilizar a plataforma via Web, criar e editar textos em Markdown e/ou criar questionários com a linguagem |
3.3 Principais Necessidades dos Usuários e dos Envolvidos
Os usuários irão utilizar o Questmark, via página Web, sempre que desejarem criar ou editar textos em Markdown, elaborar questionários e visualizar suas respostas. Também poderão responder questionários já existentes, caso possuam link de compartilhamento ou o iFrame do Questmark esteja disponível.
3.4 Perfis dos Envolvidos
3.4.1 Equipe de desenvolvimento e gestão de software
| Perfil |
-- |
| Representantes |
Danillo Souza, Gustavo Nogueira, Lucas Lopes, Luiz Gustavo , Miguel Santos, Nícalo Ribeiro |
| Descrição |
Desenvolvimento do software e gestão do projeto |
| Tipo |
Graduandos da disciplina de Métodos de Desenvolvimento de Software da UnB - Campus Gama |
| Responsabilidades |
Desenvolver e testar o software, gerir o projeto |
| Critérios de Sucesso |
Realizar a entrega do produto ao final do semestre |
| Envolvimento |
Alto |
| Problemas/Comentários |
Falta do apoio de integrantes da turma de EPS, compensado em parte pelo auxílio do monitor da disciplina; Inexperiência com as tecnologias utilizadas |
3.4.2 Monitor
| Perfil |
-- |
| Representantes |
Filipe Toyoshima |
| Descrição |
Auxiliará especialmente na gestão do projeto, suprindo a falta de membros da disciplina de EPS |
| Tipo |
Monitor da disciplina de EPS |
| Responsabilidades |
Monitorar e auxiliar a equipe de desenvolvimento e gestão |
| Critérios de Sucesso |
Auxiliar a equipe de desenvolvimento e gestão a cumprirem os prazos para a entrega do produto |
| Envolvimento |
Baixo/Médio |
| Problemas/Comentários |
Realizar o auxílio de acordo com o tempo disponível |
3.4.3 Orientador
| Perfil |
-- |
| Representantes |
Professor Mestre Joenio Costa |
| Descrição |
Professor da disciplina de Métodos de Desenvolvimento de Software (MDS) na UnB-Campus Gama |
| Tipo |
Orientador e avaliador do projeto |
| Responsabilidades |
Avaliar a equipe de desenvolvimento e gestão e sanar eventuais dúvidas |
| Critérios de Sucesso |
Observar o sucesso da equipe/projeto |
| Envolvimento |
Médio |
| Problemas/Comentários |
-- |
3.5 Perfis dos Usuários
3.5.1 Programadores
| Perfil |
-- |
| Representantes |
Programadores que utilizam Markdown |
| Descrição |
Programadores que queiram criar, editar e elaborar questionários em Markdown |
| Tipo |
Programadores que necessitam de ferramentas para o uso de markdown |
| Responsabilidades |
Interagir com a ferramenta web, utilizando seus recursos |
| Critérios de Sucesso |
Utilizar os recursos de maneira fluida |
| Envolvimento |
Alto |
| Problemas/Comentários |
-- |
3.5.2 Respondente
| Perfil |
-- |
| Representantes |
Aqueles que irão responder os questionários |
| Descrição |
Usuários que irão responder os questionários, caso possuam link de compartilhamento |
| Tipo |
Usuários que chegaram ao questionário via link de compartilhamento |
| Responsabilidades |
Responder o questionário |
| Critérios de Sucesso |
Responder e enviar o questionário |
| Envolvimento |
Médio |
| Problemas/Comentários |
Além de responderem os questionários,os respondentes eventualmente podem se interessar usufruírem das ferramentas disponibilizadas |
3.6 Principais necessidades dos Usuários ou dos Envolvidos
| Necessidade |
Prioridade |
Preocupação |
Solução Proposta |
Solução Atual |
| Criar questionários via Markdown |
Alta |
Falta de conhecimento em Markdown |
Disponibilizar em HTML o que foi escrito em Markdown |
Utilizando um código open source que faz Markdown para HTML automaticamente |
| Compartilhar o questionário |
Alta |
Falta de interesse ou esquecimento de tal possibilidade |
Após a criação do questionário, criar um link de compartilhamento para que esse seja respondido |
A partir de um link compartilhável ou de um iFrame em uma página qualquer |
| Editar textos em markdown com visualização em tempo real |
Média |
Problemas na visualização simultânea |
Permitir que o usuário escreva em markdown e visualize simultaneamente o resultado |
Plugins e outros sites que fazem isso |
4. Visão Geral do produto
4.1 Perspectiva do Produto
A plataforma Questmark visa facilitar a escrita de códigos HTML utilizando Markdown, visando a elaboração de questionários. Além disso, permite o compartilhamento dos questionados criados e a visualização de suas respostas em uma dashboard.
4.2 Resumo dos recursos
| Benefício para o cliente |
Recursos de suporte |
| Fornece um editor de texto com resultados simultâneos |
A plataforma Questmark proverá um editor de texto para a escrita de Markdown e mostrará os resultados simultaneamente |
| Elaboração de questionários |
Ao criar um questionário em Markdown na plataforma, um código HTML será gerado, permitindo sua edição ou compartilhamento |
| Permitir o compartilhamento dos questionários |
Caso seja de interesse do usuário, o questionário criado terá um link compartilhável para ser respondido |
| Fornecer uma dashboard para a visualização das respostas |
Ao logar na plataforma, o usuário terá acesso a uma dashboard e poderá visualizar as respostas de seus questionários |
| Fornecer uma dashboard para a edição dos questionários |
Ao logar na plataforma, o usuário terá acesso a uma dashboard e poderá editar os questionários criados |
5. Recursos do Produto
Na plataforma Questmark, é possível :
* Editar textos em Markdown
* Visualizar em tempo real a edição do Markdown
* Elaborar questionários
* Receber o HTML do questionário criado
* Compartilhar questionários para serem respondidos
* Visualizar as respostas dos questionários
* Editar os questionários
6. Restrições
- Uso da Internet
- Uso de navegador web
- Conhecimentos básicos em Markdown
Histórico de Revisão
| Data |
Versão |
Modificação |
Autor(es) |
| 04/09/2019 |
0.1 |
Abertura do documento |
MDS(Todos) |
| 04/09/2019 |
0.2 |
Adição do tópico 1 |
Danillo Souza |
| 05/09/2019 |
0.3 |
Revisão do Tópico 1, Template do Tópico 2 |
Nícalo Ribeiro |
| 05/09/2019 |
0.4 |
Adição do tópico 3 e seus subtópicos |
Nícalo Ribeiro |
| 06/09/2019 |
0.5 |
Adição dos tópicos 4, 5 e 6 |
Nícalo Ribeiro |
| 06/09/2019 |
0.6 |
Adição do tópico 2 e seus subtópicos |
Danillo Souza |
| 07/09/2019 |
0.7 |
Adição de proposta de solução do tópico 3.6 |
Gustavo Nogueira |
| 17/09/2019 |
0.8 |
Adição do diagrama de casos de uso no tópico 5 |
Gustavo Nogueira |
| 15/10/2019 |
0.9 |
Remoção do diagrama de casos de uso. O mesmo se encontra no documento de arquitetura |
Gustavo Nogueira |
| 10/11/2019 |
1.0 |
Ortografia revisada. Informações pertinentes ao projeto foram atualizadas. Tópicos redundantes removidos. |
Danillo Souza |