Documento de Requisitos

(1)

Documento de Requisitos

Versão 1.0

Relatu

Equipe:

Antônio Loureiro Severien Hugo França Rodrigo Siqueira de Sousa Yuri Cesar Pereira

(2)

Histórico de Alterações

Data Alteração Autor

8/11/07 Versão Final als2, rss4, vmf, ycssp

(3)

Índice

1. Introdução...4

1.1 Convenções, termos e abreviações...4

1.1.1 Identificação dos requisitos...4

1.1.2 Prioridades dos requisitos...4

2. Atores...5

3. Requisitos Funcionais...6

3.1 [RFOC001] Visualizar Ocorrência...6

3.2 [RFOC002] Adicionar Ocorrência...7

3.3 [RFOC003] Finalizar Ocorrência...8

3.4 [RFOC004] Incluir Comentário...8

3.5 [RFOC005] Alterar Estado da Ocorrência...9

3.6 [RFOC006] Encaminhar Ocorrência...9

3.7 [RFOC005] Verificar Ocorrência...10

4. Requisitos não-funcionais...10

4.1 Usabilidade...10

4.1.1 [NFUS001] Funcionamento nos Navegadores...10

4.1.2 [NFUS002] Teclas de Atalho...11

4.2 Desempenho...11

4.2.1 [NFDM001] Tempo de Processamento...11

(4)

1. Introdução

Este documento especifica os requisitos da solução Relatu, fornecendo aos desenvolvedores as informações necessárias para o projeto e implementação, assim como para a realização dos testes e homologação da aplicação.

1.1 Convenções, termos e abreviações

A correta interpretação deste documento exige o conhecimento de algumas convenções e termos específicos e abreviações, que são descritos a seguir.

1.1.1 Identificação dos requisitos

Os requisitos são identificados com um identificador único. A numeração inicia com o identificador [RFXX001] ou [NFXX001] e prossegue sendo incrementada à medida que forem surgindo novos requisitos. O XX indica o nome da subseção em que o requisito está.

A nomenclatura dos fluxos secundários é dada por uma sigla e por um número.

A sigla é FA para fluxos alternativos e FE para fluxos de erro. O número é um

seqüencial que inicia de 001. Um exemplo de fluxo alternativo é [FA001] e de fluxo de erro é [FE001]. A nomenclatura reinicia a cada requisito.

Por convenção, a referência a requisitos é feita através do identificador do requisito na subseção. Para referenciar os fluxos secundários fora do requisito que o define é necessário utilizar o identificador do requisito e o identificador do fluxo, por exemplo, [RFRD016].[FA001].

(5)

2. Atores

Essa seção apresenta todos os atores da aplicação. Cada ator representa um papel particular de usuário da aplicação. Porém, além de representar pessoas, os atores também podem ser dispositivos de hardware ou até outras aplicações que devam trocar informações com a aplicação a ser desenvolvida. A lista a seguir descreve brevemente cada ator da aplicação.

Ator Descrição

Administrador

O administrador do sistema é responsável pelas atividades que mantém o sistema e outras

atividades como encaminhar ocorrências, visualizar ocorrências, entre outras.

Usuário

Usuário responsável pela implementação do software, acompanhamento de uma equipe de desenvolvimento, depende do perfil ao qual foi

atribuído. Podem encaminhar ocorrências, visualizar ocorrências e alterar a senha entre

outras que está descrito em cada perfil relacionado.

Temporizador Sub-sistema responsável por verificar se há novas ocorrências cadastradas na base de

dados.

Servidor de e-mail Sistema de correio para troca de mensagens eletrônicas via internet.

(6)

3. Requisitos Funcionais

Essa seção apresenta todos os requisitos funcionais da aplicação.

Segue diagrama de Casos de Uso contemplando todos os requisitos funcionais:

Opções Gerais

Esta subseção apresenta todos os requisitos funcionais que servem de apoio aos requisitos principais do sistema.

(7)

3.1 [RFOC001] Visualizar Ocorrência

Descrição: Este caso de uso é responsável pela visualização das ocorrências que foram encaminhadas ao usuário.

Ator(es): Usuario

Pré-Consição: O usuário deve ter efetuado o login.

Pós-Condição: Nenhuma Fluxo de Eventos Principal:

1. O sistema exibe uma lista de ocorrências relacionados ao usuário logado, ou seja, as ocorrências encaminhadas a ele, e tambem exibe as opções de Visualizar, Encaminhar, Incluir Comentário e Alterar Estado da Ocorrência.

2. O usuario seleciona o registro desejado.

3. O usuario seleciona a opção de visualizar.

4. O sistema exibe as informações do registro escolhido.

Fluxos Secundários:

[FA001]

No passo 4, o usuário seleciona a opção de Encaminhar Ocorrência.

1. O sistema inicia o caso de uso UC006 - Encaminhar Ocorrência.

[FA002]

No passo 4, o usuário seleciona a opção de Incluir Comentário.

1. O sistema inicia o caso de uso UC004 – Incluir Comentário.

[FA003]

No passo 4, o usuário seleciona Alterar Estado da Ocorrência.

1. O sistema inicia o caso de uso UC005 – Alterar Estado da Ocorrência.

3.2 [RFOC002] Adicionar Ocorrência

Descrição: Este caso de uso é responsável por cadastrar uma nova ocorrência ao sistema.

Atores: Usuraio

Pré-condição: O usuário deve ter sido autenticado no sistema para a sessão corrente.

Pós-condição: A ocorrência é adicionada ao conjunto de ocorrências mantidas pelo sistema.

(8)

Fluxo de eventos principal:

1. O usuário informa o assunto e a descrição da ocorrência.

2. O sistema persiste a ocorrência e a data e hora de seu cadastro.

Fluxo de eventos secundários:

[FA001]

Se o usuário deixar de informar um dos campos, o sistema exibe uma mensagem de erro e cancela a operação.

3.3 [RFOC003] Finalizar Ocorrência

Descrição: Este caso de uso é responsável por finalizar a ocorrência, desta forma fechando o ciclo de vida da ocorrência.

Atores: Administrador

Pós-Condição: A ocorrência é excluida do conjunto de ocorrências mantidas pelo sistema.

Fluxo de Eventos Principal:

1. Includes UC001 – Visualizar Ocorrência.

2. O administrador visualiza a ocorrência selecionada.

3. O administrador seleciona finalizar ocorrência.

4. O sistema finaliza a ocorrência.

3.4 [RFOC004] Incluir Comentário

Descrição: Este caso de uso é responsável pela inclusão de um comentário a uma ocorrência. Os comentários podem servir para acrescentar mais informações, reportar dúvidas ou fazer algum esclarecimento. O comentário acompanha a ocorrência até sua finalização.

Atores: Usuário

Pré-condição: Nenhuma

Pós-condição: O comentário é adicionado ao conjunto de comentários da ocorrência

1. O usuário insere os comentários relativos à ocorrência;

2. O sistema registra os comentários.

(9)

[FA001]

Se o usuário tentar informar um comentário vazio, o sistema exibe uma mensagem de erro e cancela a operação.

3.5 [RFOC005] Alterar Estado da Ocorrência

Descrição: Este caso de uso é responsável por alterar o estado da ocorrência para pendente, em andamento ou finalizada.

Atores: Usuario

Pós-Condição: O sistema atualiza a ocorrência com os novos dados.

Fluxo de Eventos Principal:

1. O sistema exibe um filtro para consultar as ocorrências.

2. O usuário informa os dados necessário para a operação de consulta.

a. O sistema retorna os resultados de acordo com os campos de dados preenchidos, caso nenhum seja preenchido o sistema retorna todos os registros de ocorrências relacionados a ele.

3. O usuário seleciona o registro que deseja alterar.

4. O usuário seleciona o novo estado da ocorrência.

3.6 [RFOC006] Encaminhar Ocorrência

Descrição: Este caso de uso é responsável por encaminhar a ocorrência para os usuarios do sistema.

Atores: Servidor de Email Pré-Condição: Nenhuma

Pós-Condição: O estado da ocorrência é alterado.

1. O usuário informa o email do usuário ao qual a ocorrência será encaminhada;

2. O sistema autentica o email informado pelo usuário no passo 1 (Verifica se há outro usuário cadastrado com o email);

3. O sistema altera o estado da ocorrência, adicionando a informação do encaminhamento;

(10)

4. O sistema envia um email ao endereço informado no passo 1, notificando ao dono do endereço que este tem uma nova ocorrência.

1. Se não existir algum usuário com o e-mail informado, o sistema exibe uma mensagem de erro;

2. Se o e-mail informado pertencer ao próprio usuário autenticado que está realizando a operação, o sistema exibe uma mensagem de erro;

3. Se houver falha na comunicação com o servidor de e-mail, o sistema exibe uma mensagem de erro.

3.7 [RFOC005] Verificar Ocorrência

Descrição: Este caso de uso é responsável por verificar se existem novas ocorrências cadastradas na base de dados.

Atores: Temporizador, Servidor de Email Pré-Consição: Nenhuma

Pós-Condição: Nenhuma Fluxo de Eventos Principal:

1. O Temporizador verifica se há novas ocorrências no banco.

2. O Sistema se comunica com o Servidor de Email.

[FA001]

No passo 2, caso não haja novas ocorrências o sistema não faz nada.

4. Requisitos não-funcionais

Nesta seção estão descritos os requisitos não funcionais da solução Relatu.

4.1 Usabilidade

Esta seção descreve os requisitos não-funcionais associados à facilidade de uso da aplicação.

4.1.1 [NFUS001] Funcionamento nos Navegadores

O sistema deverá funcionar nos navegadores Internet Explorer e Firefox da mesma forma.

(11)

Requisitos funcionais associados:

[RFOC001], [RFOC002], [RFOC003], [RFOC004], [RFOC005], [RFOC006], [RFOC007]

4.1.2 [NFUS002] Teclas de Atalho

Deverá ser possível a utilização de teclas de atalho para manipulação do sistema.

4.2 Desempenho

Esta seção descreve os requisitos não-funcionais associados à eficiência, uso de recursos e tempo de resposta da aplicação.

4.2.1 [NFDM001] Tempo de Processamento

O sistema não deverá demorar mais de 5 segundos para processar informações, seja ela qual for.