Documento de Visão
Histórico de Revisão
| Data | Versão | Descrição | Autores |
|---|---|---|---|
| 28/08/2018 | 0.1 | Abertura de documento | Mikhaelle Bueno, Marcos Vinícius Rodrigues, Fabiana Luiza V.P.Ribas, Michel Camargo |
| 28/08/2018 | 0.2 | Itens atualizados 1.1, 1.2, 1.3, 1.4, 1.5, 2.1, 2.2, 2.3 | Mikhaelle Bueno, Marcos Vinícius Rodrigues, Fabiana Luiza V.P.Ribas |
| 29/08/2018 | 0.3 | Itens atualizados 3.1, 3.2, 3.4.2, 3.4.3, 3.7 | Gustavo Duarte Moreira |
| 29/08/2018 | 0.4 | Itens atualizados 3.4.1, 3.5, 4.1, 4.2, 4.3 | Mikhaelle Bueno, Fabiana Luiza V.P.Ribas |
| 30/08/2018 | 0.5 | Itens atualizados 3.6 | Michel Camargo |
| 30/08/2018 | 0.6 | Itens atualizados 5.1, 6.1, 6.2, 6.3, 6.4, 7 | Adrielly Rodrigues |
| 30/08/2018 | 0.7 | Adisão do sumário e Linkamento dos tópicos | Adrielly Rodrigues |
| 30/08/2018 | 0.8 | Itens atualizados 3.6 | Michel Camargo |
| 30/08/2018 | 0.9 | Itens atualizados 8, 9.1, 9.2 | Mikhaelle Bueno |
| 04/09/2018 | 1.0 | Itens atualizados 1.1, 1.2, 1.5, 2.1, 4.1 | Mikhaelle Bueno |
| 04/09/2018 | 1.1 | Revisão do documento | Gustavo Duarte Moreira |
| 24/11/2018 | 1.2 | Refatoração do documento com adequação aos novos requisitos. | Michel Martins de Camargo |
Sumário
- Introdução
- 1.1 Propósito
- 1.2 Escopo
- 1.3 Definições, acrônimos e abreviações
- 1.4 Referências
- 1.5 Visão Geral
- Posicionamento
- Descrição da Parte Interessada e do Usuário
- Visão Geral do Produto
- Recursos do Produto
- Restrições
- Faixas de Qualidade
- Precedência e Prioridade
- Outros Requisitos do Produto
1:Introdução
1.1 Propósito
O NaturalSearch é uma ferramenta para navegação e pesquisa que, por meio dos projetos culturais registrados no site VerSalic visa encontar documentos correlacionados e facilitar a investigação dos dados dos projetos. Quando uma pesquisa é realizada o resultado dos projetos e propostas similares serão retornando em forma de grafos.
1.2 Escopo
Na essência, todos os sites de busca e pesquisa funcionam da mesma forma: montam um banco de dados com diversos textos com milhões de linhas e mostram os resultados/textos que têm a ver com a palavra/dados que você digitou na tela de procura. Cada site usa fórmulas específicas para ordenar os resultados de uma pesquisa. O jeito mais comum,é colocar no topo da lista as páginas que contém a maior quantidade de palavras pesquisadas. Entretanto com o NaturalSearch, que é o projeto a ser desenvolvido, haverá um sistema de visualização de conteúdos similares. Os dados serão consultados na base do Sistema de Apoio às Leis de Incentivo à Cultura – SALIC, por meio de sua API, para que eles sejam tratados e passados para o banco de dados da aplicação. Os dados disponibilizados pela API são atualizados e retornados, através de grafos, tornando a pesquisa mais interessante e eficiente. O grafo irá permitir uma visualização mais intuitiva das correlações entre os dados.
1.3 Definições, acrônimos e abreviações
| Abreviação | Definição |
|---|---|
| SALIC | Sistema de Apoio às Leis de Incentivo à Cultura |
| MDS | Métodos de Desenvolvimento de Software |
| EPS | Engenharia de Produto de Software |
1.4 Referências
1.5 Visão Geral
Neste documento estão descritas as funções, os objetivos do projeto, perfis de usuário, equipe do projeto e características técnicas da aplicação. Está organizado em: posicionamento, descrição da parte interessada e do usuário, visão geral e recursos do produto, restrições, faixas de qualidade, procedência e prioridade, requisitos e documentação do produto e apêndice.
2: Posicionamento
2.1 Oportunidade de Negócios
O NaturalSearch facilitará a pesquisa de projetos e propostas da Lei Rouanet entregando uma visualização de forma mais clara dos projetos que se relacionam, proporcionando uma melhor experiência na navegação da plataforma por dispor as informações mais relevantes de forma inteligente.
2.2 Instrução do Problema
| Problema | Os resultados de pesquisa em formato de lista são pouco intuitivos e a visualização dos dados não é eficiente. |
| Funçoes Afetadas | Desperdício de tempo para conseguir relacionar os dados coletados na pesquisa. |
| Efeito | O usuário encontra dificuldade em visualizar as informações relevantes. |
| Solução | Utilizar a exibição em grafos para filtrar de maneira mais eficiente os dados e oferecer ao usuário uma visualização mais intuitiva dos resultados mais relevantes e correlacionados. |
2.3 Instrução de Posição do Produto
| Público Alvo | Usuários do site de busca da API Salic interessados em coletar informações correlacionadas de projetos e proponentes. |
| Carências | Resultados relevantes e exibição intuitiva. |
| Solução | NaturalSearch. |
| Descrição da Solução | Através da visualização em grafos a aplicação será capaz de entregar um resultado de busca mais eficiente e intuitivo. Possibilitando interação de forma fácil. |
| Diferenciais | Metodos de buscas mais inteligentes com retorno de resultados correlacionados em forma de grafo. |
3: Descrição da Parte Interessada e do Usuário
3.1 Resumo da Parte Interessada
| Nome | Descrição | Responsabilidade |
|---|---|---|
| Equipe | Composta por graduandos em Engenharia de Software 2°2018 pela Universidade de Brasília, no Campus Gama, discentes das disciplinas de Métodos de Desenvolvimento de Software e Engenharia de Produto de Software. | Desenvolver e gerir o software. |
| Clientes | Interessados em realizar pesquisas de maneira mais eficientes de projetos culturais que recebem incentivos fiscais do Minstério da Cultura, por meio de visualização em grafos. |
3.2 Resumo do Usuário
| Nome | Descrição | Parte interessada |
|---|---|---|
| Cidadão | Pessoa interessada em visualizar informações de forma intuitiva e simples por meio de grafos. | Usuário |
3.3 Ambiente do Usuário
O acesso aos serviços da aplicação poderá ser feito por navegadores de internet, como o Mozilla Firefox, Google Chrome, Apple Safari.
3.4 Perfis das Partes Interessadas
3.4.1 Usuário do Serviço
| Representantes | Jornalistas, Produtores culturais e Público da Lei Rouanet. |
| Descrição | Cidadão que deseja pesquisar sobre os projetos e suas informações. |
| Tipo | Usuário informal. |
| Responsabilidades | Utilizar a aplicação e obter dados disponibilizados em forma de grafos. |
| Critérios de Sucesso | Quando o usuário achar informações relevantes a sua pesquisa. |
| Envolvimento | Baixo - O usuário não está envolvido diretamente na execução do projeto. |
| Comentários ou Problemas | A aplicação depende de divulgação. Os usuários não serão atendidos se não houver divulgação da plataforma. |
3.4.2 Equipe de Desenvolvimento
| Representantes | Adrielly Rodrigues de Jesus, Fabiana Luiza V. P. Ribas, Gustavo Duarte Moreira, Marcos Vinícius Rodrigues da Conceição, Michel Martins de Camargo, Mikhaelle de Carvalho Bueno; |
| Descrição | Desenvolvedores |
| Tipo | Grupo de Estudadntes da Faculdade do Gama (FGA), matriculados na disciplina de MDS. |
| Responsabilidades | Elaborar documentação base sobre o contexto do projeto.Desenvolver o projeto. |
| Critérios de Sucesso | Aplicar metodologias ágeis ao longo do processo e obter um produto que satisfaça a necessidade do cliente. |
| Envolvimento | Alto |
| Comentários ou Problemas | — |
3.4.3 Equipe de Gestão de Projetos
| Representantes | Filipe Coelho Hilário Barcelos, Igor Araújo de Sousa, Shermam Tácia da Costa Lima; |
| Descrição | Gerentes de Projeto |
| Tipo | Grupo de Estudadntes da Faculdade do Gama (FGA), matriculados na disciplina EPS |
| Responsabilidades | Gerenciar, supervisionar e manter a equipe de desenvolvimento a fim de que as metodologias ágeis sejam aplicadas e o produto seja entregue ao cliente no final. |
| Critérios de Sucesso | Aplicar metodologias ágeis ao longo do processo e obter um produto que satisfaça a necessidade do cliente. |
| Envolvimento | Alto |
3.5 Perfis dos Usuários
| Representantes | Usuário |
| Descrição | Cidadão que deseja pesquisar informações sobre os projetos da Lei Rouanet |
| Tipo | Usuário informal |
| Responsabilidade | Utilizar a aplicação e obter dados da Lei Rouanet |
| Critério de sucesso | Quando o usuário achar informações relevantes a sua pesquisa |
| Envolvimento | Baixo - O usuário não está envolvido diretamente na execução do projeto |
| Comentários ou Problemas | A aplicação depende de divulgação. Os usuários não serão atendidos se não houver divulgação da plataforma |
3.6 Principais Necessidades da Parte Interessada ou do Usuário
| Necessidade | Prioridade | Interesse | Solução Atual | Solução Proposta |
|---|---|---|---|---|
| Exibir resultados de pesquisa por relevância de forma intuitiva através de grafos | Alta | Facilitar a vizualização dos dados | Exibição dos resultados de forma linear | Através de grafos relacionar os resultados de forma a evidenciar os mais relevantes para a pesquisa |
| Exibir nos resultados de pesquisa resultados semelhantes ao tema pesquisado | Alta | Linkar resultados da pesquisa de acordo com o tema pesquisado exibindo resultados correlatos | Resultados de pesquisa somente sobreo que foi pesquisado | Sistema de pesquisa de resultados baseado em conteúdo |
3.7 Alternativas e Concorrência
Não foram encontradas aplicações que realizem pesquisas e mostrem resultados por meio de grafos.
4: Visão Geral do Produto
4.1 Perspectiva do produto
O sistema NaturalSearch tem a finalidade de retornar os resultados mais relevantes, com resultados que se assemelham, a pesquisa feita pelo usuário sobre projetos da Lei Rouanet. Para o cumprimento do propósito do sistema, ele deverá acessar os dados da API do site Versalic obtendo os dados que contém informações como, tipo, valor solicitado, valor aprovado, municípo, ano, situação do projeto, além dos detalhes das etapas, objetivos, sinopse, entre outras informações sobre o projeto, que possibilitará o processamento e retornar recomendações, em forma de grafo, que se relacionem com o resultado do que foi pesquisado.
4.2 Resumo das Capacidades
| Benefício para o cliente | Recursos de Suporte |
|---|---|
| Rápido retorno do resultado de busca | Pesquisa no banco de dados do NaturalSearch |
| Satisfação com o resultado de busca obtido | Grafos |
4.3 Licenciamento e Instalação
A distribuição do software esta submetida a licença do MIT. A licença é aberta quanto a visualização, permissão para modificação e utilização do software.
5: Recursos do produto
5.1 Facilidade na Obtenção das Informações Reunidas
O NaturalSearch deve consultar os dados apresentados na API do SALIC, passando para o próprio banco de dados orientado a grafos para então ser mostrado, de forma que os usuários possam efetuar suas pesquisas com rapidez e eficácia através da aplicação. Sendo, ainda, de fácil acesso e uso para todos os tipos de usuário.
6: Restrições
6.1 Restrições de Design
O sistema deve ter uma interface de fácil uso, que seja intuitiva de forma a não necessitar de conhecimento prévio para uso.
6.2 Restrições de Escopo
O projeto faz parte de uma disciplina com vida útil de 4 meses do curso de Engenharia de Software da Universidade de Brasília, sendo assim a implementação dos principais requisitos tem um tempo limitado para serem realizados.
6.3 Restrições de Uso
Para a utilização do NaturalSearch o usuário deve estar em conexão com a internet, para que o sistema tenha acesso aos dados do banco necessários para a conclusão da pesquisa. Caso o usuário não tenha esse pré-requisito o sistema não será capaz de concluir a consulta. Para a obtenção dos dados a API Salic deve estar no ar, de forma que a indisponibilidade da mesma impossibipilita a obtenção e tratamento dos dados.
6.4 Restrições de Implementação
O sistema será desenvolvido utilizando a linguagem Python, HTML, CSS, JavaScript, BootStrap. A sistema gerenciador de banco de dados utilizado será o Neo4J.
7: Faixas de Qualidade
A aplicação será via web, para maior eficiência, devido a maior parte dos usuários terem mais acessibilidade a um browser(ex: Google Chrome, Mozilla Firefox, Safari, etc.) do que um aparelho mobile. Contudo, o NaturalSearch também deve se adequar às telas de smartphones e tablets, para que não haja transtornos ao ser utilizado.
8: Precedência e Prioridade
A principal prioridade é utilizar a estrutura de grafos para organização dos dados da API do Versalic para construir o banco de dados do NaturalSearch o que permitirá um retorno do resultado de pesquisa eficiente e o retorno do resultado de pesquisa no site em forma de grafos que além de utilizar as palavras chaves também retornara projeto correlacionados aos pesquisados, em segundo plano fica o design do site que deverá ser bastante intuitivo.
9: Outros Requisitos do Produto
9.1 Requisitos do Sistema
O usuário deverá ter acesso a internet para acessar a página web do NaturalSearch
9.2 Requisitos de Desempenho
O sistema será acessível a grande parte dos aparelhos que tem os requisitos do sistema e suprirá grande parte da necessidade de tráfego do site. Como o projeto contará com uma base de dados própria, o desempenho do aparelho não influênciará no retorno de resultados, mas poderá influenciar na visualização dos resultados em forma de grafos.