Você está na página 1de 19

Documento de Requisitos de

Software
Clínica Veterinária

Versão 1.1 - Abril de 2022


Documento de Requisitos de Software

Ficha Técnica

Equipe Responsável pela Elaboração


Liliana Terrazas Balderrama <documento de requisitos>

Público Alvo
Este manual destina-se a usuários (funcionários) que terão acesso ao Software do Petshop

Histórico de Revisões
Data Versão Descrição Autor

31/03/22 1.0 Documento de Requisitos Inicial Liliana Terrazas Balderrama

03/04/22 1.1 Documento de Requisitos Liliana Terrazas Balderrama

Versão 1.1 - Patrocínio, abril de 2022

Modelo utilizado nas aulas da disciplina de Engenharia de Software – IFTM


Campus Patrocínio
Documento de Requisitos

Sumário
INTRODUÇÃO 5

Visão geral deste documento 6

Escopo do produto
Missão do produto
Convenções, termos e abreviações 7
1.Identificação dos Requisitos 8
2.Prioridades dos Requisitos 9
Referências 9

CAPÍTULO 1 - DESCRIÇÃO GERAL DO SISTEMA 8

Abrangência e sistemas relacionados 8


Descrição dos usuários 8
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) 9

<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
<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


[NF001] <Nome do requisito> C3 . P2
[NF…] <Nome do requisito> C3 . P2
Confiabilidade C3 . P2
[NF…] <Nome do requisito> C3 . P2
Desempenho C3 . P2
[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
Versão 1.1 abril / 2022
Documento de Requisitos

Versão 1.1 abril / 2022


Documento de Requisitos

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ÁRIOC4 .


P2

<Identificador de uma interface> C4 . P2


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

<Identificador de outra interface> C4 . P2

… C4 . P2

CAPÍTULO 5 - DIAGRAMAS DA UML

Diagrama(s) de caso de uso

Diagrama(s) de pacote

Diagrama(s) de pacote de serviços

Versão 1.1 abril / 2022


Documento de Requisitos Introdução – P1 / 5

Introdução

O objetivo deste trabalho está associado a primeira entrega do projeto, para pôr em prática
alguns métodos e ferramentas utilizados para desenvolvimento do software. Entregando a
documentação e as especificações dos requisitos do software
Este documento especifica o sistema de uma clínica Veterinária 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.

Escopo do produto
O projeto da Clínica Veterinária será um sistema de gerenciamento personalizado para
a clínica. Terá como principais características o gerenciamento de seus clientes e
animais, agendar consultas de atendimento dando assistência veterinária. 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.

Missão do produto
Sistematizar o gerenciamento do estabelecimento, informatizando os processos de
atendimento e manutenção; isso de forma que o usuário interaja facilmente com um
sistema confiável adaptado ao ambiente em questão. O sistema permitirá um
acompanhamento pelo gestor e funcionário pra gerenciar os dados da Clínica
Veterinária.

Visão geral deste documento


Este documento trata de especificar com bom grau de detalhamento os requisitos a
serem implementados pela equipe de desenvolvimento, 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. Para ajudar os desenvolvedores na implementação do
sistema, é definida uma seção que detalha todos os casos de uso funcionais e não-
funcionais. Através delas se têm, com alto grau de precisão, o modo de funcionamento
de todos os casos de uso As demais seções apresentam a especificação do sistema de
Gerenciamento da Clínica Veterinária e estão organizadas como descrito abaixo.
 Seção 2– Controlar os atendimentos realizados e a realizar, manter agendamentos e
cadastros de informações em uma empresa de PetShop. Possibilitando aos
funcionários o acesso a qualquer tempo e hora aos dados de atendimentos futuros e
também daqueles já realizados dando mais comodidade ao cliente e a empresa.
 Seção 3 – Requisitos funcionais (casos de uso): cadastro que deverá cadastrar o
cliente, veterinário, e o animal, contendo o nome, endereço, após o cadastro o
usuário poderá incluir no sistema. Após o cadastro com sucesso o funcionário
verificará disponibilidade do veterinário para agendamento de consulta havendo
disponibilidade irá cadastrar o atendimento e incluir o animal agendando o horário
para atendimento. Em seguida o funcionário receberá o pagamento e imprimir o
comprovante do valor pago pela consulta. O funcionário terá acesso para gerenciar
os dados, alterar e excluir dados. Já o veterinário terá acesso apenas aos cadastros
dos clientes e a agenda das consultas.
 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.

Versão 1.1 abril / 2022


Documento de Requisitos Introdução – P1 / 5

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.

Número Sigla Definição


de
Ordem

1 Case Computer-Aided Software Engineering


2 HTML HMTL (hyper text markup language) é a linguagem de
marcação mais popular na internet.
3 HD Disco rígido
4 IDE Integrated Development Environment ou Ambiente de
Desenvolvimento Integrado
5 RAM Memória principal
6 SGBD Sistema de Gerenciamento de Banco de Dados
7 UML Unified Modeling Language linguagem de notação
8 J2ME Java 2 Micro Edition

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:
[Cadastro. RF01] está descrito em uma subseção chamada “Cadastro de dados”, em um
bloco identificado pelo número [RF01].
[Login. RF02] está descrito em uma subseção chamada “Cadastro de dados”, em um bloco
identificado pelo número [RF02].
[Cadastrar Cliente. RF03] está descrito em uma subseção chamada “Cadastro de dados”,
em um bloco identificado pelo número [RF03].
[Cadastrar Animal. RF04] está descrito em uma subseção chamada “Cadastro de dados”,
em um bloco identificado pelo número [RF04].
[Cadastrar Veterinário. RF05] está descrito em uma subseção chamada “Cadastro de
dados”, em um bloco identificado pelo número [RF05].
[Cadastrar Atendimento. RF06] está descrito em uma subseção chamada “Cadastro de
dados”, em um bloco identificado pelo número [RF06].
[Incluir Cliente. RF07] está descrito em uma subseção chamada “Inclusão de dados”, em
um bloco identificado pelo número [RF07].
Versão 1.1 abril / 2022
Documento de Requisitos Introdução – P1 / 5
[Incluir Veterinário. RF08] está descrito em uma subseção chamada “Inclusão de dados”,
em um bloco identificado pelo número [RF08]
[Verificar Disponibilidade do Veterinário. RF09] está descrito em uma subseção chamada
“Inclusão de dados”, em um bloco identificado pelo número [RF09]
[Incluir Animal. RF10] está descrito em uma subseção chamada “Inclusão de dados”, em
um bloco identificado pelo número [RF10]
[Agendar Consulta. RF11] está descrito em uma subseção chamada “Inclusão de dados”,
em um bloco identificado pelo número [RF11]
[Realizar Consulta. RF12] está descrito em uma subseção chamada “Inclusão de dados”,
em um bloco identificado pelo número [RF12]
[Receber Pagamento. RF13] está descrito em uma subseção chamada “Pagamento”, em
um bloco identificado pelo número [RF13]
[Consultar Pagamento. RF14] está descrito em uma subseção chamada “Pagamento”, em
um bloco identificado pelo número [RF14]
[Imprimir Comprovante de Pagamento. RF15] está descrito em uma subseção chamada
“Pagamento”, em um bloco identificado pelo número [RF15]
[Gerenciar Dados. RF16] está descrito em uma subseção chamada “Gerenciamento de
dados”, em um bloco identificado pelo número [RF16]
[Consultar Dados. RF17] está descrito em uma subseção chamada “Gerenciamento de
dados”, em um bloco identificado pelo número [RF17]
[Alterar Dados. RF18] está descrito em uma subseção chamada “Gerenciamento de
dados”, em um bloco identificado pelo número [RF18]
[Excluir Dados. RF19] está descrito em uma subseção chamada “Gerenciamento de
dados”, em um bloco identificado pelo número [RF19]
[Gerar Relatório dos Dados. RF20] está descrito em uma subseção chamada
“Gerenciamento de dados”, em um bloco identificado pelo número [RF20]

Requisito não funcional


[O sistema deverá possuir cores que evite o cansaço da visão. RNF01] está descrito na
seção de requisitos não funcionais de Usabilidade, em um bloco identificado por [RNF01].
[O sistema deverá possuir fontes que facilite a leitura dos textos, incluindo tamanhos que
evitem o cansaço da visão RNF02] está descrito na seção de requisitos não funcionais de
Usabilidade, em um bloco identificado por [RNF02].

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.
 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.
Versão 1.1 abril / 2022
Documento de Requisitos Introdução – P1 / 5

Referências

1. Sommerville, Ian. Software Engineering. Pearson, 2010.


2. Referencia do glossario

Versão 1.1 abril / 2022


Documento de Requisitos de Software Descrição geral do sistema – C1. P10 / 7

Capítulo
Descrição geral do sistema
O sistema deve permitir que o usuário cadastre clientes, consulte altere e exclua
consultas para obter controle diariamente da clínica Veterinária.
O software serve para auxiliar no gerenciamento e controle dos serviços e agendas de
uma Clínica Veterinária tendo como objetivos específicos proporcionar funcionalidades
de modo a disponibilizar informações aos clientes e possibilitar a interação do cliente
com a empresa por meio de um sistema. Informatizar cadastros de clientes e animais e
estabelecer um vínculo entre ambos. Informatizar a agenda de atendimentos;

Abrangência e sistemas relacionados


As principais funcionalidades do sistema da clínica Veterinária são:
I. Login o usuário deverá logar no sistema para poder acessá-lo.
II. Cadastro de cliente é uma funcionalidade que permitirá cadastrar clientes novos.
III. Cadastro de animais é uma funcionalidade que permitirá cadastrar animais novos.
IV. Cadastro de veterinário é uma funcionalidade que permitirá cadastrar veterinários
novos.
V. Consulta de dados é uma funcionalidade que irá permitir o usuário consultar, alterar
dados ou excluir um cliente já cadastrado no banco de dados do sistema.
VI. Inserir dados é uma funcionalidade que irá permitir o usuário consultar, alterar
dados, inserir ou excluir um cliente já cadastrado no banco de dados do sistema.
VII. Agendar Consulta é uma funcionalidade que permitirá agendar, verificar
disponibilidade de horário, alterar e excluir consultas.
VIII. Gerar relatório o sistema irá permitir ao usuário a emissão de um relatório das
consultas agendadas e realizadas.

Descrição dos usuários (Atores)


Ator Definição
Usuário Funcionário que utiliza o sistema
Gestor Funcionário responsável pelo gerenciamento e manutenção do sistema
Veterinário Funcionário que utiliza o sistema para gerenciar as consultas agendadas

1. Usuário
Este usuário será o funcionário responsável em cadastrar o cliente que atenderá na
clínica veterinária, cadastrando o cliente inserindo os dados obrigatoriamente, cliente já
cadastrado o funcionário agendará a consulta e receberá o valor da consulta,
imprimindo o pagamento, manipulará os dados caso seja necessário e excluí-los quando
for preciso.

2. Gestor
Este usuário será o gerente que fará controle das consultas agendadas tendo acesso à
todo o sistema gerando no final um relatório contendo as consultas realizadas e a serem
Versão 1.1 abril / 2022
Documento de Requisitos de Software Descrição geral do sistema – C1. P11 / 7
realizadas.

3. Veterinário
Este usuário será o funcionário responsável em consultar os animais, no sistema terá
acesso apenas aos cadastros dos clientes e animais, tendo acesso as agendas das
consultas realizadas e a serem realizadas.

Versão 1.1 abril / 2022


Documento de Requisitos Requisitos funcionais – C2. P12 / 8

Capítulo
Requisitos Funcionais (casos de uso)
Requisitos Funcional Descrição Subsecção
ou Não
Funcional
RF001, RF002, Requisito Cadastrar funcionário Cadastro de dados
RF003, RF004, Funcional login, cliente, animal,
RF005, RF06 veterinário e
atendimento.
RF07, RF8, Requisito Incluir cliente, incluir Inclusão de Dados
RF09, RF10, Funcional veterinário, verificar
RF11, RF12 disponibilidade, do
veterinário, incluir
animal, agendar
consulta, realizar
Consulta.
RF13 Requisito Receber, consultar e Pagamento
Funcional imprimir os
comprovantes de
pagamento.

RF14, Requisito Gerenciar, consultar, Gerenciamento de Dados


RF15,RF16, Funcional alterar, excluir e gerar
RF17, RF18, relatório de dados.
RF19, RF20

[
[Receber Pagamento. RF13] está descrito em uma subseção chamada “Pagamento”, em
um bloco identificado pelo número [RF13]
[Consultar Pagamento. RF14] está descrito em uma subseção chamada “Pagamento”, em
um bloco identificado pelo número [RF14]
[Imprimir Comprovante de Pagamento. RF15] está descrito em uma subseção chamada
“Pagamento”, em um bloco identificado pelo número [RF15]
[Gerenciar Dados. RF16] está descrito em uma subseção chamada “Gerenciamento de
dados”, em um bloco identificado pelo número [RF16]
[Consultar Dados. RF17] está descrito em uma subseção chamada “Gerenciamento de
dados”, em um bloco identificado pelo número [RF17]
[Alterar Dados. RF18] está descrito em uma subseção chamada “Gerenciamento de
dados”, em um bloco identificado pelo número [RF18]
Versão 1.1 Abril/ 2022
Documento de Requisitos Requisitos funcionais – C2. P13 / 8
[Excluir Dados. RF19] está descrito em uma subseção chamada “Gerenciamento de
dados”, em um bloco identificado pelo número [RF19]
[Gerar Relatório dos Dados. RF20] está descrito em uma subseção chamada
“Gerenciamento de dados”, em um bloco identificado pelo número [RF20]

[RF001] <Cadastrar Funcionário>


O usuário acessará o sistema através do login e poderá cadastrar inserindo nome,
endereço e dados sobre o cliente novo. Cadastro de dados pessoais (nome, telefone,
endereço, RG e CPF.)
Ator: Funcionário, Gestor e Veterinário

Prioridade: þ Essencial  Importante  Desejável

[RF002] <Login>

O usuário deverá logar no sistema para poder acessá-lo. Realizando um cadastro ele
terá seu login e senha para acessar os sistema
Ator: Funcionário, Gestor e Veterinário

Prioridade: þ Essencial  Importante  Desejável

[RF003] <Cadastrar Cliente>


O usuário poderá realizar cadastros de clientes novos inserindo dados
Ator: Funcionário

Prioridade:  Essencial þ Importante  Desejável

[RF004] <Cadastrar Animal>


O usuário poderá realizar cadastros de animais novos inserindo Cadastro pessoal do
animal (nome do animal, nome do dono, raça, pelagem, idade, sexo)
Ator: Funcionário

Prioridade:  Essencial þ Importante  Desejável

[RF005] <Cadastrar Veterinário>


O usuário poderá realizar cadastros de Veterinários novos inserindo novos profissionais
no banco de dados
Ator: Funcionário

Prioridade: þ Essencial  Importante  Desejável

[RF006] <Cadastrar Atendimento>


O usuário poderá realizar cadastros do atendimento verificando disponibiladdae do
veterinário para agendar nova consulta.
Versão 1.1 Abril/ 2022
Documento de Requisitos Requisitos funcionais – C2. P14 / 8
Ator: Funcionário

Prioridade:  Essencial þ Importante  Desejável

[RF007] <Incluir Cliente>


O usuário poderá realizar cadastros de clientes novos inserindo dados
Ator: Funcionário

Prioridade:  Essencial þ Importante  Desejável

[RF008] <Incluir Veterinário>


O usuário poderá realizar cadastros de clientes novos inserindo dados
Ator: Funcionário

Prioridade:  Essencial þ Importante  Desejávelz

[RF009] <Incluir Animal>


O usuário poderá realizar cadastros de clientes novos inserindo dados
Ator: Funcionário

Prioridade:  Essencial þ Importante  Desejável

[RF010] <Incluir Consulta>


O usuário poderá realizar cadastros de clientes novos inserindo dados
Ator: Funcionário

Prioridade: þ Essencial  Importante  Desejável

Versão 1.1 Abril/ 2022


Documento de Requisitos Requisitos funcionais – C2. P15 / 8

[RF011] <Receber Pagamento>


O usuário poderá realizar cadastros de clientes novos inserindo dados
Ator: Funcionário

Prioridade: þ Essencial  Importante  Desejável

[RF012] <Consultar Pagamento>


O usuário poderá realizar cadastros de clientes novos inserindo dados
Ator: Funcionário

Prioridade:  Essencial þ Importante  Desejável

[RF013] <Imprimir Pagamento>


O usuário poderá realizar cadastros de clientes novos inserindo dados
Ator: Funcionário

Prioridade:  Essencial þ Importante  Desejável

V[RF014] <Consultar Pagamento>


O usuário poderá realizar cadastros de clientes novos inserindo dados
Ator: Funcionário

Prioridade:  Essencial þ Importante  Desejável

O sistema deve permitir que o usuário altere informações do cadastro de um proprietário

Versão 1.1 Abril/ 2022


Documento de Requisitos Requisitos não funcionais – C3. P16 / 10

Capítulo
Requisitos Não Funcionais
<Esta seção deve conter os requisitos não funcionais do sistema. Para uma melhor
organização deste documento, utilize as subseções abaixo para agrupar os requisitos
não funcionais relacionados. Naturalmente, o número e tipo de subseções utilizadas
depende do sistema que está sendo especificado e não é preciso utilizar todas elas.
Simplesmente elimine as subseções para as quais não for encontrado nenhum requisito.
Os requisitos não funcionais devem ser identificados com um identificador único, da
mesma maneira que os requisitos funcionais (casos de uso). Inicie a numeração com o
identificador NF001 e prossiga incrementando os números a medida que forem
surgindo novos requisitos não funcionais. Reinicie a numeração em cada subseção.
Forneça também um nome para o requisito, como foi feito para os requisitos
funcionais.
Descreva o requisito, assinale a sua prioridade e, em seguida, caso o requisito esteja
relacionado a um caso de uso ou a um grupo de casos de uso específicos, utilize o
campo “Caso(s) de uso associado(s):” para identificar o(s) caso(s) de uso
correspondente(s). Se for um requisito não funcional do sistema como um todo, esse
campo não precisa ser utilizado.>

Usabilidade
Esta seção descreve os requisitos não funcionais associados à facilidade de uso da
interface com o usuário, material de treinamento e documentação do sistema.

[NF001] <Nome do requisito>


<Descreva o requisito não funcional e substitua um dos símbolos abaixo por , para
indicar a sua prioridade.>

Prioridade:  Essencial  Importante  Desejável

<Opcional> Caso(s) de uso associado(s): <use este campo para identificar a que
caso(s) de uso o requisito de usabilidade está relacionado.>

[NF…] <Nome do requisito>


<Utilize os mesmos campos mostrados no bloco anterior para descrever este e os
demais requisitos não funcionais de usabilidade.>

Confiabilidade
Esta seção descreve os requisitos não funcionais associados à freqüência, severidade de
falhas do sistema e habilidade de recuperação das mesmas, bem como à corretude do
sistema.

[NF…] <Nome do requisito>


<Utilize os mesmos campos mostrados na seção 4.1 para descrever este e os demais
requisitos não funcionais de confiabilidade.>

Desempenho
Versão <x.y> <mes / ano>
Documento de Requisitos Requisitos não funcionais – C3. P17 / 10
Esta seção descreve os requisitos não funcionais associados à eficiência, uso de
recursos e tempo de resposta do sistema.

[NF…] <Nome do requisito>


<Utilize os mesmos campos mostrados na seção 4.1 para descrever este e os demais
requisitos não funcionais de desempenho.>

Segurança
Esta seção descreve os requisitos não funcionais associados à integridade, privacidade e
autenticidade dos dados do sistema.

[NF…] <Nome do requisito>


<Utilize os mesmos campos mostrados na seção 4.1 para descrever este e os demais
requisitos não funcionais de segurança.>

Distribuição
Esta seção descreve os requisitos não funcionais associados à distribuição da versão
executável do sistema.

[NF…] <Nome do requisito>


<Utilize os mesmos campos mostrados na seção 4.1 para descrever este e os demais
requisitos não funcionais de distribuição.>

Padrões
Esta seção descreve os requisitos não funcionais associados a padrões ou normas que
devem ser seguidos pelo sistema ou pelo seu processo de desenvolvimento.
<Se você mencionar documentos relacionados, não esqueça de listá-los na seção 1.3.>

[NF…] <Nome do requisito>


<Utilize os mesmos campos mostrados na seção 4.1 para descrever este e os demais
requisitos não funcionais de adequação a padrões.>

Hardware e software
Esta seção descreve os requisitos não funcionais associados ao hardware e software
usados para desenvolver ou para executar o sistema.

[NF…] <Nome do requisito>


<Utilize os mesmos campos mostrados na seção 4.1 para descrever este e os demais
requisitos não funcionais de hardware e software.>

Versão <x.y> <mes / ano>


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

Capítulo 5
DIAGRAMAS DA UML

Diagrama(s) de Caso de Uso

Versão <x.y> <mes / ano>


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

Diagrama(s) de Pacotes

Diagrama de Pacotes de Serviços

Versão <x.y> <mes / ano>

Você também pode gostar