Oniria Documento de Requisitos

(1)

DoppelSoft

Oniria – Documento de Requisitos

Grupo: Matheus “Feral” Luck Lucas

Feral 01/01/2010

(2)

2 Histórico de Revisões

Data Versão Descrição Autor

04/10/2010 v1.0 Versão inicial do Documento de Requisitos

Matheus “Feral” Luck Lucas

(3)

3 Conteúdo

Histórico de Revisões ... 2

1. Introdução ... 4

1.1 Objetivos desse documento ... 4

1.2 Problema Identificado ... 4

1.3 Solução do Problema ... 4

1.4 Escopo do Produto ... 5

1.4.1 Nome do Produto e Principais Componentes ... 5

1.4.2 Missão do Produto ... 5

1.4.3 Limites do Produto ... 6

1.4.4 Benefícios do Produto ... 6

1.5 Referências ... 6

1.6 Definições e Siglas ... 7

1.7 Visão Geral do Documento ... 7

2. Requisitos Específicos... 8

2.1 Não-Funcionais ... 8

2.1.1 Requisitos de Processo ... 8

2.1.2 Requisitos de Usabilidade ... 8

2.1.3 Requisitos de Performance ... 8

2.1.4 Requisitos de Manutenabilidade ... 8

2.1.5 Requisitos de Documentação ... 9

2.1.6 Requisitos Externos ... 9

2.2 Funcionais ... 9

3. Casos de Uso ... 11

4. Diagrama de Casos de Uso ... 40

(4)

4 1. Introdução

1.1 Objetivos desse documento

O levantamento e a descrição detalhada dos requisitos é parte essencial do desenvolvimento de um software. Ele servirá como um dos principais conjuntos de diretrizes para guiar a construção das funcionalidades do softare, bem como adequá- las apropriadamente às necessidades do cliente. Para isso, serão detalhados não apenas os requisitos que definem as regras gerais de construção da ferramenta, mas também aspectos intrínsecos das funcionalidades, bem como a descrição dos Casos de Uso, que servirão para definir o fluxo de cada aspecto e função desfrutado pelo cliente no software que será desenvolvido com o auxílio deste documento.

1.2 Problema Identificado

Escritores, profissionais ou não, de obras de ficção de diversas mídias (escrita, ilustrada etc) geralmente produzem uma grande quantidade de personagens, alocados nos elencos de cada enredo que desenvolvem. Esses personagens possuem características próprias, que precisam ser devidamente detalhadas e revisadas, o que gera um volume de informação que não pode ser fragmentado ou perdido durante o processo de concepção da obra (ou de continuações), e que portanto precisa ser devidamente catalogado. Outra questão é a checagem de consistências, tanto internas quanto externas aos personagens, que precisa sempre ser fortemente revisada antes que uma obra possa ser concluída - ou mesmo iniciada; e executar essa checagem exige uma consulta a todas as informações disponíveis a respeito de dado personagem, ou a respeito de toda a sua árvore de relações e interações no cenário em que se insere.

Em suma, existe uma forte necessidade de organizar as informações geradas e/ou observadas durante a concepção de personagens para obras de ficção; do contrário, podem haver atrasos, dificuldades no levantamento de idéias ou surgimento de inconsistências e perda de verossimilhança em relação ao cenário.

1.3 Solução do Problema

A questão de organização e parte da de levantamento conjunto de informações pode ser bastante atenuada com a criação de uma base de dados capaz de catalogar os personagens criados pelo autor. Porém, para que a solução seja consistente e abrangente, é necessário ainda levar em consideração a seguinte hierarquia: Autor-

>Obra->Elenco->Personagem. O sistema deve ser capaz de não apenas catalogar informações dos personagens e permitir fácil acesso a elas, mas permitir ainda classificação e alocação desses personagens para Elencos, e desses para Obras, que são associadas a seu respecivo Autor e co-Autores. Cada uma dessas entidades possui ainda um conjunto de características próprias que também precisam ser catalogadas.

(5)

5

Para completar a solução, é necessário um conjunto de ferramentas básico para listar as conexões entre esses personagens, elencos e obras (i.e que personagens se relacionam com determinado outro personagem, em determinada obra).

1.4 Escopo do Produto

O Oniria - nome inspirado na palavra grega Oneiros, "sonho" - é uma ferramenta desenvolvida para servir ao mesmo tempo como sistema de catalogação e auxílio à criação de personagens e elencos para obras de ficção. O que antes seria um conjunto de anotações dispersas ou informações semi-conexas na mente do autor, pode através dessa ferramenta ser devidamente catalogado e descrito, ficando registrado para futura referência. O programa oferece a catalogação e descrição dos 4 tipos de entidades necessários: Autores, Obras, Elencos e Personagens, oferecendo a cada uma um conjunto de ferramentas de catalogação adequado. Para personagens, o sistema oferece a catalogação de informações específicas que vão desde descrição física a até perfil psicológico, bem como relacionamento/parentesco com outros personagens cadastrados. Há ainda a opção de anexar um repertório de imagens e textos referentes ao personagem. Para Elencos, é possível fazer uma descrição geral sobre o propósito do elenco, informações gerais, e tanto associar personagens a ele como associar o próprio elenco a uma ou mais obras. Estas, por sua vez, são catalogadas com uma descrição geral, gênero, recomendação de público, elencos participantes, autores e co- autores, bem como obras relacionadas. Por fim, os Autores são catalogados com uma lista de informações básicas, além de eventuais perfil e biografia. Tudo isso é estocado em um banco de dados interno.

A ferramenta Oniria provê ainda a geração de listas e relatórios de interações e relacionamentos, seja entre personagens, elencos, obras, autores ou outras combinações entre estes.

O software é disponível offline, mediante instalação no computador do usuário.

Inicialmente, está sendo desenvolvido para a plataforma PC, sistema Microsoft Windows. Devido, porém, à escolha de linguagem e framework, está prevista a possibilidade da criação de versões portadas para outras plataformas.

1.4.1 Nome do Produto e Principais Componentes Nome do Produto: Oniria

Componentes principais:

- Software instalável: Oniria - Character Organization Framework [Windows Version]

1.4.2 Missão do Produto

(6)

6

Prover um conjunto de ferramentas para auxiliar autores de obras de ficção, permitindo maior organização de informações e componentes de sua obra, evitando que informações sejam perdidas e servindo indiretamente como auxílio à produtividade criativa.

1.4.3 Limites do Produto

O auxílio de produtividade dá-se apenas na forma de uma forma facilitada de organização e pelas facilidades adicionadas pela geração de relatório de interações e inter-comunicações. A ferramenta não age de forma ativa no processo criativo, nem oferece funcionalidades ou recursos para atuar diretamente nesse processo.

Trata-se apenas de uma ferramenta de organização, sendo as vantagens do ponto de vista criativo meras consequências dessa melhor organização.

A princípio, ainda, o software não está disponível em formato web, o que expandiria ainda mais suas funcionalidades, em especial se fosse integrado a alguma forma de rede social ou de compartilhamento estilo web 2.0.

1.4.4 Benefícios do Produto

Numeração Benefício

1 Sistema intuitivo e organizado de catalogação de elementos para obras de ficção 2 Organização de informações individuais de Personagens, Elencos, Obras e Autores 3 Centralização de informações que normalmente seriam dispersas e/ou difíceis de

associar ou comparar

4 Geração de relatório de interações e intercomunicações entre Personagens, Elencos, Obras e Autores

5 Suporte ao armazenamento de arquivos associados, como imagens e documentos de texto

1.5 Referências

 Plano de Projeto

http://www.cin.ufpe.br/~mll3/Oniria/

 Site da Disciplina de Engenharia de Software e Sistemas ~if682 http://www.cin.ufpe.br/~if682

 Livro texto da disciplina de Engenharia de Software e Sistemas

SOMMERVILLE, Ian. Software Engineering, Addison Wesley, 7ª Edição.

(7)

7 1.6 Definições e Siglas

Sigla Definição

NF.PR-XX Requisito Não-funcional de Processo NF.US-XX Requisito Não-Funcional de Usabilidade NF.PF-XX Requisito Não-Funcional de Performance NF.MN-XX Requisito Não-Funcional de Manutenabilidade NF.DC-XX Requisito Não-Funcional de Documentação

NF.RE-XX Requisito Não-Funcional de Restrições Econômicas F-XX Requisito Funcional

1.7 Visão Geral do Documento

O documento está dividido em 4 seções, que descrevem os seguintes pontos:

 Seção 1: Introdução ao documento, que mostra os objetivos, problema identificado, o escopo do produto e referências.

 Seção 2: Descreve os requisitos do sistema, divididos em requisitos Não- Funcionais (tanto do cliente como da equipe) e Funcionais.

 Seção 3: Descreve os casos de uso, assim como seus atores e fluxos de eventos.

 Seção 4: Representação gráfica dos casos de uso por meio do diagrama.

(8)

8 2. Requisitos Específicos

2.1 Não-Funcionais

Esse sub-conjunto de requisitos descrevem restrições sobre o sistema, mas que não atuam diretamente sobre suas funcionalidades. Elas relacionam-se a expectativas em relação à performance do sistema, usabilidade, procedimentos usuais da equipe de desenvolvimento ou restrições econômicas.

2.1.1 Requisitos de Processo

Identificação Descrição

NF.PR-01 O Software deve ser desenvolvido em C++, utilzando o framework Qt para interfaces. O banco de dados usado será MySQL.

NF.PR-02 O Software deverá funcionar na plataforma Windows (XP, Vista e 7).

NF.PR-03 Deve-se fazer o possível para minimizar o esforço de migração para outras plataformas (Linux, Mac, Web, Mobile).

2.1.2 Requisitos de Usabilidade

NF.US-01 O Software deve possuir instalação automática, via auto-extrator.

NF.US-02 A interface do programa deve ser limpa e amigável ao usuário

NF.US-03 As diferentes ferramentas e opções devem ser organizadas de forma que seja intuitivo ao usuário onde está e como usar cada função

2.1.3 Requisitos de Performance

NF.PF-01 O framework principal deve ser capaz de funcionar em um netbook simples (Atom N270, 1GB RAM)

NF.PF-02 O crescimento de espaço em disco ocupado pelo banco de dados não pode exceder facilmente um disco de 80GB

2.1.4 Requisitos de Manutenabilidade

NF.MN-01 O software deverá ser desenvolvido de forma modular, de acordo com os agrupamentos de casos de uso, a fim de que a correção de erros e melhoria de recursos seja facilitada.

NF.MN-02 O código deverá estar bem-documentado, o suficiente para uso e aprimoramento por autores não-familiarizados

(9)

9

2.1.5 Requisitos de Documentação

NF.DC-01 Deverá ser gerado manual escrito e tutorial do sistema, em HTML, para ser disponibilizado em conjunto com a ferramenta.

NF.DC-02 A documentação deve ser constituída de modo a ser facilmente expansível

2.1.6 Requisitos Externos

NF.RE-01 Os custos de distribuição e implantação do software devem ser nulos ou mínimos, de forma a viabilizar distribuição livre

2.2 Funcionais

Os requisitos Funcionais listam e descrevem as funcionalidades esperadas para o software descrito nesse documento. Eles tanto expressam as necessidades dos stakeholders (clientes, usuários etc) como o próprio comportamento previsto para o sistema em cumprimento às expectativas geradas frente às necessidades do cliente e dos usuários-alvo. A listagem de requisitos funcionais expressa ainda sua prioridade dentro do desenvolvimento do sistema.

Identificação Descrição Prioridade

F-01 Cadastrar Autor Essencial

F-02 Editar dados do Autor Essencial

F-03 Deletar Autor Essencial

F-04 Editar Biografia do Autor Desejável

F-05 Cadastrar Obra Essencial

F-06 Editar dados da Obra Essencial

F-07 Deletar Obra Essencial

F-08 Associação/Desassociação de Obra a Autor Essencial F-09 Inserir Entrada no Repositório da Obra (Texto) Importante F-10 Deletar Entrada no Repositório da Obra (Texto) Importante F-11 Inserir Entrada no Repositório da Obra (Imagem) Desejável F-12 Deletar Entrada no Repositório da Obra (Imagem) Desejável

F-13 Cadastrar Elenco Essencial

F-14 Editar dados do Elenco Essencial

F-15 Deletar Elenco Essencial

F-16 Associação/Desassociação de Elenco a Obra Essencial F-17 Inserir Entrada no Repositório do Elenco (Texto) Essencial F-18 Deletar Entrada no Repositório do Elenco (Texto) Essencial F-19 Inserir Entrada no Repositório do Elenco (Imagem) Importante F-20 Deletar Entrada no Repositório do Elenco (Imagem) Importante

F-21 Cadastrar Personagem Essencial

F-22 Editar dados do Personagem Essencial

F-23 Deletar Personagem Essencial

F-24 Associação/Desassociação de Personagem a Elenco Essencial

(10)

10

F-25 Associação/Desassociação de Personagem a Obra Essencial

F-26 Determinar relação entre Personagens Essencial

F-27 Inserir Entrada no Repositório do Personagem (Texto) Essencial F-28 Deletar Entrada no Repositório do Personagem (Texto) Essencial F-29 Inserir Entrada no Repositório do Personagem (Imagem) Essencial F-30 Deletar Entrada no Repositório do Personagem (Imagem) Essencial F-31 Gerar relatório de conectividade Personagem-Personagem Essencial F-32 Gerar relatório de conectividade Personagem-Elenco Essencial F-33 Gerar relatório de conectividade Personagem-Obra Importante F-34 Gerar relatório de conectividade Elenco-Obra Desejável F-35 Gerar relatório de conectividade Elenco-Elenco Desejável

F-36 Gerar anotação no banco do autor Desejável

F-37 Editar anotação no banco do autor Desejável

F-38 Deletar anotação no banco do autor Desejável

F-39 Visualizar Autores Essencial

F-40 Visualizar Obras Essencial

F-41 Visualizar Elencos Essencial

F-42 Visualizar Personagens Essencial

F-43 Janela principal de visualização Essencial

F-44 Menus Drop-Down de Entidade Essencial

F-45 Exportar/Importar Personagem Importante

F-46 Exportar/Importar Elenco Importante

F-47 Exportar/Importar Obra Desejável

F-48 Exportar/Importar Autor Desejável

(11)

11 3. Casos de Uso

Identificação Nome Estado

CSU-01 Cadastrar Autor Aguardando Validação

Referências: F-01

Autor: Matheus “Feral” Luck Lucas

Criado em: 04/10/2010 Revisado em: --

Atores

Usuário (Autor), Banco de dados Usuários

Autor Entradas

Nome do autor a ser cadastrado Pré-Condições

 Programa devidamente inicializado

 Autor não exista no sistema Fluxo Principal de Eventos

 Operação feita por um usuário 1. Usuário abre o menu de Autor 2. Seleciona a opção “Criar novo Autor”

3. Usuário informa o nome do autor desejado, no campo mostrado em pop-up na tela.

4. Banco de dados verifica que não existe autor com aquele nome, e cria a entrada no banco de dados.

5. Aquele Autor criado fica disponível na lista de Autores, e torna-se o Autor aberto no momento. As demais opções disponíveis para “Autor” ficam habilitadas.

Fluxo Alternativo de Eventos

 Operação feita por um usuário, com Autor já existente 1. Usuário abre o menu de Autor

2. Seleciona a opção “Criar novo Autor”

3. Usuário informa o nome do autor desejado, no campo mostrado em pop-up na tela.

4. Banco de dados verifica que existe autor com aquele nome. Não cria a entrada no banco de dados.

5. Um pop-up informa o usuário de que o Autor já existe, e pergunta se o usuário deseja prosseguir com um novo nome ou cancelar a operação.

Fluxo de Erro

 Nome inválido: O usuário é informado na própria interface que não é possível entrar com o dado fornecido no passo 3 de ambos os fluxos descritos acima.

Ele é informado do erro e a operação pode ser repetida, até que um nome válido seja dado, ou que a operação seja cancelada.

(12)

12

Saída e Pós-Condições

 Um novo Autor é cadastrado no sistema

 Ocorre algum erro na operação

 Usuário cancela a operação manualmente

CSU-02 Editar dados de Autor Aguardando Validação

Atores

Autor Entradas

Autor a ser editado, Dados a serem atualizados: Nome e/ou Sexo e/ou Pseudônimo e/ou Iniciais e/ou Foto e/ou Assinatura e/ou Marca d’Água

Pré-Condições

 Autor exista no sistema Fluxo Principal de Eventos

 Operação feita por um usuário 1. Usuário abre o menu de Autor 2. Seleciona a opção “Editar Autor”

3. Usuário seleciona o autor desejado, entre as opções exibidas em um pop-up.

4. Banco de dados captura os dados existentes do autor, e o perfil do autor é exibido na tela, com os campos editáveis.

5. O usuário edita os campos que desejar, e em seguida confirma a operação.

 Fluxos alternativos dependem apenas da quantidade de campos a serem editados.

Fluxo de Erro

 Dado inválido: O usuário é informado na própria interface que não é possível entrar com o dado fornecido no passo 5 do fluxo descritos acima. Ele é informado do erro e a operação pode ser repetida, até que um dado válido seja digitado, ou que a operação seja cancelada.

 Os dados são editados e o usuário confirma a operação

(13)

13

CSU-03 Deletar Autor Aguardando Validação

Atores

Autor Entradas

Autor a ser Deletado Pré-Condições

 Operação feita por um usuário 1. Usuário abre o menu de Autor 2. Seleciona a opção “Deletar Autor”

4. O programa pede confirmação para deletar permanentemente o autor, em um pop-up.

5. Com a confirmação do usuário, as entradas referentes àquele Autor são eliminadas do banco de dados. Todos os Personagens, Obras e Elencos daquele Autor são marcados como “Sem Autor”, no campo “Autor”.

 O usuário cancela a operação em qualquer ponto (seja saindo dos menus dos passos 1 e 2 ou cancelando as janelas em 3 e 4).

Fluxo de Erro

 Qualquer erro possível nessa operação é um erro de integridade do sistema e/ou do banco de dados, portanto independe do usuário. Não há erros previstos para essa operação.

 O Autor é devidamente deletado

CSU-04 Editar Biografia do Autor Aguardando Validação

Atores

Autor

(14)

14

Entradas

Autor cuja biografia será editada, Dados da Biografia Pré-Condições

 Operação feita por um usuário 1. Usuário abre o menu de Autor 2. Seleciona a opção “Editar Biografia”

4. O banco de dados busca o autor desejado, e a tela exibe na tela a biografia atual dele (por padrão, ela é vazia até que tenha sido editada ao menos uma vez).

5. O usuário preenche a biografia, e depois confirma a operação de salvar as alterações.

6. O banco de dados registra a operação.

 A única variância será de autor e de biografia.

 Para o caso de primeiro acesso à biografia, esta estará com texto vazio.

Fluxo de Erro

 Qualquer erro possível nessa operação é um erro de integridade do sistema e/ou do banco de dados, portanto independe do usuário. Não há erros previstos para essa operação.

 A biografia editada é salva

CSU-05 Cadastrar Obra Aguardando Explanação

Atores

Autor Entradas

A serem elicitadas Pré-Condições

 A serem elicitadas Fluxo Principal de Eventos

 A ser elicitado Fluxo Alternativo de Eventos

 A ser elicitado

(15)

15

Fluxo de Erro

 A ser elicitado Saída e Pós-Condições

 A serem elicitadas

CSU-06 Editar Dados da Obra Aguardando Explanação

Atores

Autor Entradas

 A ser elicitado Fluxo de Erro

CSU-07 Deletar Obra Aguardando Explanação

Atores

Autor Entradas

 A ser elicitado

(16)

16

Identificação Nome Estado

CSU-08 Associação/Desassociação de Obra a Autor Aguardando Explanação Referências: F-08

Atores

Autor Entradas

CSU-09 Inserir Entrada no Repositório da Obra (Texto)

Aguardando Explanação Referências: F-09

Atores

Autor Entradas

A serem elicitadas

(17)

17

CSU-10 Deletar Entrada no Repositório da Obra (Texto)

Atores

Autor Entradas

CSU-11 Inserir Entrada no Repositório da Obra (Imagem)

Atores

(18)

18

Autor Entradas

CSU-12 Deletar Entrada no Repositório da Obra (Imagem)

Atores

Autor Entradas

(19)

Entradas

CSU-23 Deletar Personagem Aguardando Explanação

Atores

Autor Entradas

CSU-24 Associação/Desassociação de Personagem a Elenco

(25)

25

Atores

Autor Entradas

CSU-25 Associação/Desassociação de Personagem a Obra

Atores

Autor Entradas

(26)

Entradas

CSU-34 Gerar relatório de conectividade Elenco- Obra

Atores

Autor Entradas

CSU-35 Gerar relatório de conectividade Elenco- Elenco

(31)

31

Atores

Autor Entradas

CSU-36 Gerar anotação no banco do autor Aguardando Explanação Referências: F-36

Atores

Autor Entradas

(32)

Fluxo de Erro

CSU-43 Janela principal de visualização Aguardando Explanação Referências: F-43

Atores

Autor Entradas

CSU-44 Menus Drop-Down de Entidade Aguardando Explanação Referências: F-44

Atores

Autor Entradas

 A ser elicitado

(36)

36

CSU-45 Exportar/Importar Personagem Aguardando Explanação Referências: F-45

Atores

Autor Entradas

CSU-46 Exportar/Importar Elenco Aguardando Explanação

Atores

Autor Entradas

A serem elicitadas

(37)

37

CSU-47 Exportar/Importar Obra Aguardando Explanação

Atores

Autor Entradas

CSU-48 Exportar/Importar Autor Aguardando Explanação

Atores

Usuário (Autor), Banco de dados

(38)

38

Usuários Autor Entradas

(39)

39

CSU-49 Selecionar Autor Ativo Aguardando Explanação

Atores

Autor Entradas

(40)

40 4. Diagrama de Casos de Uso

(Obs: Algumas ligações estão simplificadas devido à falta de espaço na ferramenta gráfica para expressar toda a conectividade dos casos de uso; em síntese, todos eles atuam através do Usuário (autor) sobre o Baco de Dados);