Documento de Requisitos Biblioteca Virtual

19
FACI Documento de Requisitos Biblioteca Virtual Versão 0.1 – dezembro de 2012

Transcript of Documento de Requisitos Biblioteca Virtual

Page 1: Documento de Requisitos Biblioteca Virtual

FACI

Documento de RequisitosBiblioteca Virtual

Versão 0.1 – dezembro de 2012

Page 2: Documento de Requisitos Biblioteca Virtual

Documento de Requisitos

Ficha Técnica

Equipe Responsável pela ElaboraçãoAlan Tejeria Arantes <divisão-região><nome> <divisão-região><nome> <divisão-região><nome> <divisão-região>

Público AlvoEste manual destina-se ao gerenciamento de uma bilblioteca escolar.

Versão 0.1 – Belém/PA, dezembro de 2012.

Dúvidas, críticas e sugestões devem ser encaminhadas por escrito para o seguinte endereço postal:

[email protected]

Ou para o seguinte endereço eletrônico:

http://www.facebook.com/BiblitoecaVirtual

Recomendamos que o assunto seja identificado com o título desta obra. Alertamos ainda para a importância de se identificar o endereço e o nome completos do remetente para que seja possível o envio de respostas.

Windows e Microsof Word são marcas registradas da Microsoft Corporation

Page 3: Documento de Requisitos Biblioteca Virtual

Documento de Requisitos

Sumário

INTRODUÇÃO..................................................................................................P2

Visão geral deste documento....................................................................................P2

Convenções, termos e abreviações..........................................................................P2

1.Identificação dos Requisitos............................................................................P2

2.Prioridades dos Requisitos..............................................................................P2

Referências................................................................................................................P2

CAPÍTULO 1 - DESCRIÇÃO GERAL DO SISTEMA................................C1 . P2

Abrangência e sistemas relacionados...............................................................C1 . P2

Descrição dos usuários.....................................................................................C1 . P2

1.<Opcional> <Nome de um tipo específico de usuário>.............................C1 . P2

2.<Opcional> <Nome de outro tipo específico de usuário >.........................C1 . P2

3.…............................................................................................................C1 . P2

CAPÍTULO 2 - REQUISITOS FUNCIONAIS (CASOS DE USO)..............C2 . P2

<Nome de subseção para agrupar casos de uso correlacionados>................C2 . P2

[RF001] <Nome do caso de uso>................................................................C2 . P2

Fluxo de eventos principal....................................................................................................C2 . P2<Opcional> Fluxos secundários (alternativos e de exceção)..................................................C2 . P2

[RF…] <Nome de outro caso de uso>.........................................................C2 . P2

<Nome de outra subseção para agrupar outros casos de uso correlacionados>C2 . P2

….........................................................................................................................C2 . P2

CAPÍTULO 3 - REQUISITOS NÃO FUNCIONAIS....................................C3 . P2

Usabilidade.........................................................................................................C3 . P2

[NF001] <Nome do requisito>.....................................................................C3 . P2

[NF…] <Nome do requisito>.......................................................................C3 . P2

Confiabilidade.....................................................................................................C3 . P2

[NF…] <Nome do requisito>.......................................................................C3 . P2

Desempenho.......................................................................................................C3 . P2

Versão 0.1 12/2012

Page 4: Documento de Requisitos Biblioteca Virtual

Documento de Requisitos

[NF…] <Nome do requisito>.......................................................................C3 . P2

Segurança...........................................................................................................C3 . P2

[NF…] <Nome do requisito>.......................................................................C3 . P2

Distribuição.........................................................................................................C3 . P2

[NF…] <Nome do requisito>.......................................................................C3 . P2

Padrões...............................................................................................................C3 . P2

[NF…] <Nome do requisito>.......................................................................C3 . P2

Hardware e software...........................................................................................C3 . P2

[NF…] <Nome do requisito>.......................................................................C3 . P2

CAPÍTULO 4 - <OPCIONAL> DESCRIÇÃO DA INTERFACE COM O USUÁRIO..................................................................................................C4 . P2

<Identificador de uma interface>.......................................................................C4 . P2

1.<Opcional> Críticas da interface..............................................................C4 . P2

<Identificador de outra interface>.....................................................................C4 . P2

….........................................................................................................................C4 . P2

Versão 0.1 12/2012

Page 5: Documento de Requisitos Biblioteca Virtual

Documento de Requisitos Introdução – P1 / 1

Introdução

Este documento especifica o sistema Biblioteca Virtual, 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 do sistema.

Visão geral deste documento

Esta introdução fornece as informações necessárias para fazer um bom uso deste documento, explicitando seus objetivos e as convenções que foram adotadas no texto, além de conter uma lista de referências para outros documentos relacionados. As demais seções apresentam a especificação do sistema Biblioteca Virtual e estão organizadas como descrito abaixo.

Seção 2 – Descrição geral do sistema: apresenta uma visão geral do sistema, caracterizando qual é o seu escopo e descrevendo seus usuários.

Seção 3 – Requisitos funcionais (casos de uso): especifica todos os requisitos funcionais do sistema, descrevendo os fluxos de eventos, prioridades, atores, entradas e saídas de cada caso de uso a ser implementado.

Seção 4 – Requisitos não funcionais: especifica todos os requisitos não funcionais do sistema, divididos em requisitos de usabilidade, confiabilidade, desempenho, segurança, distribuição, adequação a padrões e requisitos de hardware e software.

Seção 5 – Descrição da interface com o usuário: apresenta desenhos, figuras ou rascunhos de telas do sistema.

Convenções, termos e abreviações

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

1. Identificação dos Requisitos

Por convenção, a referência a requisitos é feita através do nome da subseção onde eles estão descritos, seguido do identificador do requisito, de acordo com o esquema abaixo:

[nome da subseção.identificador do requisito]

Por exemplo, o requisito [Recuperação de dados.RF016] está descrito em uma subseção chamada “Recuperação de dados”, em um bloco identificado pelo número [RF016]. Já o requisito não funcional [Confiabilidade.NF008] está descrito na seção de requisitos não funcionais de Confiabilidade, em um bloco identificado por [NF008].

2. Prioridades dos Requisitos

Para estabelecer a prioridade dos requisitos foram adotadas as denominações “essencial”, “importante” e “desejável”.

Essencial é o requisito sem o qual o sistema não entra em funcionamento. Requisitos essenciais são requisitos imprescindíveis, que têm que ser implementados impreterivelmente.

Importante é o requisito sem o qual o sistema entra em funcionamento, mas de forma não satisfatória. Requisitos importantes devem ser implementados, mas, se não forem, o sistema poderá ser implantado e usado mesmo assim.

Versão 0.1 12/2012

Page 6: Documento de Requisitos Biblioteca Virtual

Documento de Requisitos Introdução – P2 / 2

Desejável é o requisito que não compromete as funcionalidades básicas do sistema, isto é, o sistema pode funcionar de forma satisfatória sem ele. Requisitos desejáveis são requisitos que podem ser deixados para versões posteriores do sistema, caso não haja tempo hábil para implementá-los na versão que está sendo especificada.

Referências

Documentos relacionados à Biblioteca Virtual e/ou mencionados nas seções a seguir:

1. Título; Número (se aplicável); Data; Instituição, divisão ou equipe responsável pelo documento; Link para o documento (se aplicável);

2. Título; Número (se aplicável); Data; Instituição, divisão ou equipe responsável pelo documento; Link para o documento (se aplicável);

3. …

Versão 0.1 12/2012

Page 7: Documento de Requisitos Biblioteca Virtual

Documento de Requisitos Descrição geral do sistema – C1. P1 / 1

Capítulo

Descrição geral do sistema

Biblioteca Virtual é um Software-aplicativo com o intuito de gerenciamento de Bibliotecas Escolares. Realizado em Java, utiliza um aplicativo Desktop e outro web.

Abrangência e sistemas relacionados

Biblioteca Virtual fará cadastro dos livros e dos steakehoders, além do sitema de agendamento de empréstimos. Utilizará os sistemas Netbeans para programação do aplicativo Desktop e Web, também o SQL Server 2008 para arquivamento das informações.

Descrição dos usuários

Efetivamente, há 3 usuários neste projeto

1. Usu1: Aluno/Tomador

A pessoa que será cadastrado na biblioteca para usufruir dos emprestimos dos livros.

2. Usu2: Funcionário/Cedente

Pessoa que trabalha na biblioteca, fazendo serviços administrativos, neste caso gerenciando as entradas e saídas dos livros.

3. Usu3: Administrador

Gerente com permissões de adicionar/excluir/alterar os dados tanto dos livros como das pessoas cadastradas, tendo acesso geral principalmente para o sistema de pessoas cadastradas.

Versão 0.1 12/2012

1

Page 8: Documento de Requisitos Biblioteca Virtual

Documento de Requisitos Requisitos funcionais – C2. P1 / 1

Capítulo

Requisitos funcionais (casos de uso)

Abaixo, os Requisitos Funcionais [RF] do programa Biblioteca Virtual:

Cadastros

[RF001] Cadastrar Funcionário

Administrador cadastra novo funcionário.

Ator: Administradores e Funcionários.

Prioridade: Essencial Importante Desejável

Relacionado: [Tela1] CadastroFuncionário: Ver imagem na Seção 5, IMG3.

Pré condições:

O funcionário não deve estar cadastrado no sistema.

O cadastro é realizado pelo Administrador do Sistema porém os campos relacionados com o acesso ao sistema (login e senha) o funcionário deverá digitar.

Entradas:

Nome;

CPF;

Cidade: Nome da cidade onde o funcionário mora;

Bairro;

Rua;

UF;

Login;

Senha;

Confirmação da senha: Para segurança da senha digitada.

Saídas: Inclusão do Funcionário no Banco de Dados.

Fluxo de eventos principal

Após o acesso ao programa Desktop, o Administrador entrará na tela Cadastrar Funiconário, digitará as informações de entrada e clicará no botão Ok para gravá-las, Cancelar para limpar a tela e reiniciar a operação ou Sair para fechar a tela sem salvar.

Fluxos secundários (alternativos e de exceção)

Versão 0.1 12/2012

2

Page 9: Documento de Requisitos Biblioteca Virtual

Documento de Requisitos Requisitos funcionais – C2. P2 / 2

ERRO:

Ocorrendo erro ao gravar as informações do funcionário, uma tela de aviso deve surgir, ao clicar em Ok, retorna-se a tela de cadastro.

[RF002] Cadastrar Livros

Administrador ou Funcionário cadastram novos livros

Ator: Administradores e Funcionários.

Prioridade: Essencial Importante Desejável

Relacionado: [Tela2] CadastroLivro: Ver imagem na Seção 5, foto 4.

Pré condições:

O livro não deve estar cadastrado no sistema.

O cadastro é realizado pelo Funcionário/Administrador do Sistema.

Entradas:

Nome;

Autor;

Titulo;

Editora;

Quantidade;

Foto;

Saídas: Inclusão do Livro no Banco de Dados.

Fluxo de eventos principal

Após o acesso ao programa Desktop, o Funcionário entrará na tela Cadastrar Livro, digitará as informações de entrada e clicará no botão Ok para gravá-las, Cancelar para limpar a tela e reiniciar a operação ou Sair para fechar a tela sem salvar.

Fluxos secundários (alternativos e de exceção)

ERRO:

Ocorrendo erro ao gravar as informações do livro, uma tela de aviso deve surgir, ao clicar em Ok, retorna-se a tela de cadastro.

[RF003] Cadastrar Alunos

Administrador ou Funcionário cadastram novos alunos.

Ator: Administradores, Funcionários e alunos.

Prioridade: Essencial Importante Desejável

Relacionado: [Tela3] CadastroAluno: Ver imagem na Seção 5, foto 5.

Versão 0.1 12/2012

Page 10: Documento de Requisitos Biblioteca Virtual

Documento de Requisitos Requisitos funcionais – C2. P3 / 3

Pré condições:

O aluno não deve estar cadastrado no sistema.

O cadastro é realizado pelo Funcionário/Administrador do Sistema, porém o aluno inserirá o login e senha.

Entradas:

Nome;

CPF;

Cidade: Nome da cidade onde o funcionário mora;

Bairro;

Rua;

UF;

Login;

Senha;

Confirmação da senha: Para segurança da senha digitada.

Saídas: Inclusão do aluno no Banco de Dados.

Fluxo de eventos principal

Após o acesso ao programa Desktop, o Funcionário entrará na tela Cadastrar Aluno, digitará as informações de entrada e clicará no botão Ok para gravá-las, Cancelar para limpar a tela e reiniciar a operação ou Sair para fechar a tela sem salvar.

Fluxos secundários (alternativos e de exceção)

ERRO:

Ocorrendo erro ao gravar as informações do aluno, uma tela de aviso deve surgir, ao clicar em Ok, retorna-se a tela de cadastro.

Consultas

[RF004] Consultar Livros Desktop

Ator: Administradores e Funcionários.

Prioridade: Essencial Importante Desejável

Relacionado: [Tela4] Consultar Livros: Ver imagem na Seção 5, foto 6.

Pré condições:

Ser Administrador ou Funiconário.

Entradas:

Nome;

Ou Titulo;

Versão 0.1 12/2012

Page 11: Documento de Requisitos Biblioteca Virtual

Documento de Requisitos Requisitos funcionais – C2. P4 / 4

Ou Autor;

Ou Editora;

Saídas: Lista dos livros correspondentes a pesquisa.

Fluxo de eventos principal

Após o acesso ao programa Desktop, o Administrador/Funcionário entrará na tela Consultar Livro, digitará ao menos uma informação de entrada e clicará no botão Ok para visualizar as Saídas, Cancelar para limpar a tela e reiniciar a operação ou Sair para fechar a tela.

Fluxos secundários (alternativos e de exceção)

ERRO:

Ocorrendo erro ao consultar o livro, uma tela de aviso deve surgir, ao clicar em Ok, retorna-se a tela de pesquisa.

[RF005] Consultar Livros Web

Ator: Alunos.

Prioridade: Essencial Importante Desejável

Relacionado: [Tela5] ConsultarLivroWeb: Ver imagem na Seção 5, foto 7.

Pré condições:

Ser aluno cadastrado no sistema.

Entradas:

Nome;

Ou Titulo;

Ou Autor;

Ou Editora;

Saídas: Lista dos livros correspondentes a pesquisa.

Fluxo de eventos principal

Após o acesso ao site do sistema, o Aluno entrará digitará ao menos uma informação de entrada e clicará no botão Ok para visualizar as Saídas, Cancelar para limpar a tela e reiniciar a operação ou Sair para fechar a tela.

Fluxos secundários (alternativos e de exceção)

ERRO:

Ocorrendo erro ao consultar o livro, uma tela de aviso deve surgir, ao clicar em Ok, retorna-se a tela de pesquisa.

Versão 0.1 12/2012

Page 12: Documento de Requisitos Biblioteca Virtual

Documento de Requisitos Requisitos funcionais – C2. P5 / 5

[RF006] Consultar Usuários

Para visualizar cadastros tanto de Administradores, Funcionários ou Alunos.

Ator: Administradores e Funcionários.

Prioridade: Essencial Importante Desejável

Relacionado: [Tela6] Consultar Usuário: Ver imagem na Seção 5, foto 8.

Pré condições:

Ser Administrador ou Funcionário.

Entradas:

Nome;

Ou CPF;

Ou Codigo;

Saídas: Informações do Funcionário correspondente.

Fluxo de eventos principal

Após o acesso ao programa Desktop, o Administrador/Funcionário entrará na tela Consultar Usuario, digitará ao menos uma informação de entrada e clicará no botão Ok para visualizar as Saídas, Cancelar para limpar a tela e reiniciar a operação ou Sair para fechar a tela.

Fluxos secundários (alternativos e de exceção)

ERRO:

Ocorrendo erro ao consultar o livro, uma tela de aviso deve surgir, ao clicar em Ok, retorna-se a tela de pesquisa.

[RF007] Emprestar Livro Desktop

Para transacionar o empréstimo de livro

Ator: Administradores e Funcionários.

Prioridade: Essencial Importante Desejável

Relacionado: [Tela7] Emprestar livro: Ver imagem na Seção 5, foto 9.

Pré condições:

Ser Administrador ou Funcionário.

Entradas:

Nome do livro;

Ou Autor do livro;

Ou Titulo do livro;

E Login do aluno;

Ou Nome do aluno;

Versão 0.1 12/2012

Page 13: Documento de Requisitos Biblioteca Virtual

Documento de Requisitos Requisitos funcionais – C2. P6 / 6

Saídas: Informações do Livro emprestado, do aluno Tomador e a data de devolução.

Fluxo de eventos principal

Após o acesso ao programa Desktop, o Administrador/Funcionário entrará na tela Emprestar livro, digitará ao menos uma informação de entrada do Livro e outra do Aluno e clicará no botão Ok para visualizar as Saídas, Cancelar para limpar a tela e reiniciar a operação ou Sair para fechar a tela.

Fluxos secundários (alternativos e de exceção)

ERRO:

Ocorrendo erro na transação, uma tela de aviso deve surgir, ao clicar em Ok, retorna-se a tela de pesquisa.

[RF008] Emprestar Livro Web

Para transacionar o empréstimo de livro via site.

Ator: Alunos.

Prioridade: Essencial Importante Desejável

Relacionado: [Tela8] Emprestar livro Web: Ver imagem na Seção 5, foto 10.

Pré condições:

Ser Aluno cadastrado no sistema.

Entradas:

Nome do livro;

Ou Autor do livro;

Ou Titulo do livro;

Saídas: Informações do Livro emprestado e a data de devolução.

Fluxo de eventos principal

Após o acesso ao site do programa, o aluno entrará na tela Emprestar livro, digitará ao menos uma informação de entrada do Livro e clicará no botão Ok para visualizar as Saídas, Cancelar para limpar a tela e reiniciar a operação ou Sair para fechar a tela.

Fluxos secundários (alternativos e de exceção)

ERRO:

Ocorrendo erro na transação, uma tela de aviso deve surgir, ao clicar em Ok, retorna-se a tela de pesquisa.

[RF009] Gerenciar Usuários

Gerenciamento dos participantes do sistema

Ator: Administradores.

Versão 0.1 12/2012

Page 14: Documento de Requisitos Biblioteca Virtual

Documento de Requisitos Requisitos funcionais – C2. P7 / 7

Prioridade: Essencial Importante Desejável

Relacionado: [Tela9] Gerenciar Usuários: Ver imagem na Seção 5, foto 11.

Pré condições:

Ser Administrador do sistema.

Entradas:

Login do Funcionário;

Ou nome

Saídas: Informações do Funcionário para possivel alteração ou esclusão do mesmo.

Fluxo de eventos principal

Após o acesso ao site do programa, o administrador entrará na tela Gerenciar Funcionários, digitará o login ou Nome para fazer a pelo Funcionário e clicará no botão Alterar para alterar as informações, Deletar para deletar o usuário do sistema ou Cancelar para limpar a tela.

ALTERAR: Leva em uma nova tela com as informações disponíveis do Funcionário. Após alterar estas informações, clica-se em OK para efetivar a alteração, em Cancelar para limpar a tela e reiniciar a operação ou Sair pra sair da tela sem salvar.

DELETAR: Ao clicar neste botão, surge uma caixa de confirmação da ação, se SIM, delete o usuário, se não, mantenha as informações.

Fluxos secundários (alternativos e de exceção)

ERRO:

Ocorrendo erro na transação, uma tela de aviso deve surgir, ao clicar em Ok, retorna-se a tela de gerenciamento.

Versão 0.1 12/2012

Page 15: Documento de Requisitos Biblioteca Virtual

Documento de Requisitos Requisitos não funcionais – C3. P1 / 1

Capítulo

Requisitos não funcionais

Devido ser um projeto simples, não há necessidade de requisitos não-funcionais.

Versão 0.1 12/2012

3

Page 16: Documento de Requisitos Biblioteca Virtual

Documento de Requisitos <Opcional> Descrição da interface com o usuário – C4. P1 / 1

Capítulo

Descrição da interface com o usuário

Esta seção contem desenhos ou rascunhos das telas do sistema que forem necessários ou convenientes para esclarecer algum dos requisitos do sistema.

Login

Primeira tela do aplicativo Desktop, entrada de login e senha.

IMG1: Críticas da interface

Login: tamanho 10.

Senha: tamanho 10.

1.1 – Imagem Login

Tela Escolha

Tela com os botões de direcionamento para as telas seguintes.

Versão 0.1 12/2012

4

Page 17: Documento de Requisitos Biblioteca Virtual

Documento de Requisitos <Opcional> Descrição da interface com o usuário – C4. P2 / 2

IMG2: Críticas da interface

Há tela Administrador e outra funcionário.

2.1 – Imagem Escolha Administrador

2.2 – Imagem Escolha Funcionário

Tela Cadastro Usuário

IMG3: Críticas da interface

Há tela Administrador e outra funcionário.

3.1 – Imagem Cadastro Aluno

2.2 - Funcionário

Tela Cadastro Livro

IMG4: Críticas da interface

4.1 – Imagem Cadastro Aluno

Tela Consulta Livro

IMG5: Críticas da interface

5.1 – Imagem Consulta Aluno

Versão 0.1 12/2012