You are on page 1of 14

IFBA Camaari

Documento de Requisitos
Jewellery Bank

Verso1.0
03 de junho de 2015

Documento de Requisitos

Ficha Tcnica
Equipe Responsvel pela Elaborao
Ana Paula Campos Entrevistadora e progamadora
Victor Hugo Nascimento- Programador
Pblico Alvo
Este manual destina-se aos orientadores Joo Marcelo e Larissa Carneiro das disciplinas
de Linguagem de programao e Fundamentos de engenharia de software.

Verso 1.0
03 de junho de 2015
Dvidas, crticas e sugestes devem ser encaminhadas por escrito para o
seguinte endereo postal:
anapaulacams@outlook.com
Ou para o seguinte endereo eletrnico:
victor.hugonascimento@hotmail.com
Recomendamos que o assunto seja identificado com o ttulo desta obra.
Alertamos ainda para a importncia de se identificar o endereo e o nome
completos do remetente para que seja possvel o envio de respostas.

Windows e Microsof Word so marcas registradas da Microsoft Corporation

Documento de Requisitos

Sumrio
INTRODUO......................................................................................................................
Viso geral deste documento....................................................................................................................
Convenes, termos e abreviaes..........................................................................................................
1.Identificao dos Requisitos........................................................................................................
2.Prioridades dos Requisitos...........................................................................................................
Referncias................................................................................................................................................

CAPTULO 1 - DESCRIO GERAL DO SISTEMA.............................................C1 . P


Abrangncia e sistemas relacionados.............................................................................................C1 . P
Descrio dos usurios.....................................................................................................................C1 . P3
1. Gerente................................................................................................................................C1 . P4
2.Atendente ............................................................................................................................C1 . P5

CAPTULO 2 - REQUISITOS FUNCIONAIS (CASOS DE USO)..........................C2 . P6


Uso do sistema...................................................................................................................................C2 . P7
[RF001] Cadastro de Atendente..............................................................................................C2 . P8
[RF001.1] Incluso de usurios.........................................................................................C2 . P
[RF001.2] Excluso de usurios........................................................................................C2 . P
[RF002] Login de Atendente..................................................................................................C2 . P
[RF002.1] Problemas no Login.........................................................................................C2 . P
[RF002.2] Solues teis...................................................................................................C2 . P

CAPTULO 3 - REQUISITOS NO FUNCIONAIS.................................................C3 . P


Usabilidade........................................................................................................................................C3 . P
[NF001] <Nome do requisito>................................................................................................C3 . P
[NF] <Nome do requisito>..................................................................................................C3 . P
Confiabilidade...................................................................................................................................C3 . P
[NF] <Nome do requisito>..................................................................................................C3 . P
Desempenho......................................................................................................................................C3 . P

Verso <1.0>

<mes / ano>

Documento de Requisitos

[NF] <Nome do requisito>..................................................................................................C3 . P


Segurana..........................................................................................................................................C3 . P
[NF] <Nome do requisito>..................................................................................................C3 . P
Distribuio.......................................................................................................................................C3 . P
[NF] <Nome do requisito>..................................................................................................C3 . P
Padres..............................................................................................................................................C3 . P
[NF] <Nome do requisito>..................................................................................................C3 .
Hardware e software........................................................................................................................C3 .
[NF] <Nome do requisito>..................................................................................................C3 . P

Verso <1.0>

<mes / ano>

Documento de Requisitos

Introduo P1 / 1

Introduo
Este documento especifica o sistema Jewellery Bank, fornecendo aos desenvolvedores as
informaes necessrias para o projeto e implementao, assim como para a realizao dos
testes e homologao do sistema, juntamente com os processos de uso e aplicao.

Viso geral deste documento


Esta introduo fornece as informaes necessrias para fazer um bom uso deste documento,
explicitando seus objetivos e as convenes que foram adotadas no texto, alm de conter uma
lista de referncias para outros documentos relacionados. As demais sees apresentam a
especificao do sistema Jewellery Bank e esto organizadas como descrito abaixo.

Seo 2 Descrio geral do sistema: apresenta uma viso geral do sistema,


caracterizando qual o seu escopo e descrevendo seus usurios.

Seo 3 Requisitos funcionais (casos de uso): especifica todos os requisitos


funcionais do sistema, descrevendo os fluxos de eventos, prioridades, atores, entradas e
sadas de cada caso de uso a ser implementado.

Seo 4 Requisitos no funcionais: especifica todos os requisitos no funcionais do


sistema, divididos em requisitos de usabilidade, confiabilidade, desempenho, segurana,
distribuio, adequao a padres e requisitos de hardware e software.

Seo 5 Descrio da interface com o usurio: apresenta desenhos, figuras ou


rascunhos de telas do sistema.

Convenes, termos e abreviaes


Para a melhor perfomance funcional do sistema, necessrio o uso deste documento, com suas
respectivas funes e identificadores de todo o processo a seguir:

.1

Identificao dos Requisitos


Por conveno, a referncia a requisitos feita atravs do nome da subseo onde eles esto
descritos, seguido do identificador do requisito, de acordo com o esquema abaixo:
[nome da subseo.identificador do requisito]
Por exemplo, o requisito [Uso do sistema.RF001] est descrito em uma subseo chamada
Login de Atendente, em um bloco identificado pelo nmero [RF0002]. Prioridades dos
Requisitos
Para estabelecer a prioridade dos requisitos foram adotadas as denominaes essencial,
importante e desejvel.

Essencial o requisito sem o qual o sistema no entra em funcionamento. Requisitos


essenciais so requisitos imprescindveis, que tm que ser implementados impreterivelmente.

Importante o requisito sem o qual o sistema entra em funcionamento, mas de forma


no satisfatria. Requisitos importantes devem ser implementados, mas, se no forem, o
sistema poder ser implantado e usado mesmo assim.

Desejvel o requisito que no compromete as funcionalidades bsicas do sistema,


isto , o sistema pode funcionar de forma satisfatria sem ele. Requisitos desejveis so
requisitos que podem ser deixados para verses posteriores do sistema, caso no haja tempo
hbil para implement-los na verso que est sendo especificada.

Verso <1.0>

<mes / ano>

Documento de Requisitos

Introduo P2 / 2

Obs.: O sistema aqui, Jewellery Bank ser usada abreviadamente como JB.

Referncias
Documentos relacionados ao Jewellery Bank e/ou mencionados nas sees a seguir:
1. Ttulo; Nmero (se aplicvel); Data; Instituio, diviso ou equipe responsvel pelo
documento; Link para o documento (se aplicvel);
2. Ttulo; Nmero (se aplicvel); Data; Instituio, diviso ou equipe responsvel pelo
documento; Link para o documento (se aplicvel);
3.

Verso <1.0>

<mes / ano>

Documento de Requisitos

Descrio geral do sistema C1. P1 / 1

Captulo

Descrio geral do sistema


<Descreva aqui, em linhas gerais, os objetivos do sistema, comunicando o propsito da
aplicao e a importncia do projeto para todas as pessoas envolvidas.
Se for necessrio apresentar detalhes mais tcnicos sobre o sistema, voc tambm pode usar esta
seo para descrever em linhas gerais a arquitetura do sistema, indicando seus mdulos
principais, o uso (se existir) da Internet ou outra rede de comunicao, componentes on-line e
off-line, e a interao (se existir) com outros sistemas. Use um diagrama se achar conveniente.>

Abrangncia e sistemas relacionados


<Nesta seo, descreva em linhas gerais o que o sistema ir fazer (suas principais
funcionalidades) e o que ele no ir fazer (escopo negativo), deixando claro se o sistema ir
interagir com outros sistemas relacionados ou se ele independente e totalmente auto-contido.
As funcionalidades principais do sistema devem ser apenas citadas, para dar uma idia geral ao
leitor dos servios que sero fornecidos pelo sistema. Os detalhes sero fornecidos
posteriormente, na seo 3 deste documento. Funcionalidades que a princpio seriam da alada
do sistema e que no sero implementadas tambm devem ser listadas, registrando-se o motivo
pela qual elas no sero contempladas (porque sero fornecidas por outros sistemas
relacionados, por exemplo, ou porque sero implementadas apenas em projetos futuros).
Se o sistema for independente e totalmente auto-contido diga isso explicitamente, caso contrrio,
liste e descreva brevemente os outros sistemas com os quais este sistema deve interagir,
explicando, de maneira geral, quais os papis de cada um e o meio de comunicao entre eles.>

Descrio dos usurios


<Para efetivamente prover produtos e servios que atendam s necessidades dos usurios,
necessrio entender os desafios que eles enfrentam para executar suas funes. Esta seo deve
descrever os futuros usurios do sistema e os principais problemas que limitam sua
produtividade.
O grau de detalhamento necessrio nas descries depende do sistema que voc est
especificando. Em projetos onde a equipe j acumulou um bom conhecimento dos usurios, uma
breve descrio de suas caractersticas gerais suficiente. Em projetos onde no se tem muita
informao sobre os usurios do sistema, deve-se descrever as caractersticas especficas de cada
usurio nas subsees a seguir.
Descreva os aspectos gerais, relacionados a todos os usurios, aqui. Depois, se for necessrio,
descreva nas subsees abaixo as caractersticas especficas de cada usurio.>

.1

<Opcional> <Nome de um tipo especfico de usurio>


<Se for conveniente fornecer mais detalhes sobre um tipo especfico de usurio, use esta
subseo para descrev-lo.>

Verso <1.0>

<mes / ano>

Documento de Requisitos

.2

Descrio geral do sistema C1. P2 / 2

<Opcional> <Nome de outro tipo especfico de usurio >


<Prossiga no detalhamento das caractersticas dos usurios, descrevendo todos os tipos de
usurio que for necessrio, cada um em uma subseo.>

.3

Verso <1.0>

<mes / ano>

Documento de Requisitos

Requisitos funcionais C2. P1 / 1

Captulo

Requisitos funcionais (casos de uso)


<Nesta seo, apresente todos os requisitos funcionais, ou casos de uso, do sistema. Em sistemas
grandes comum haver muitos casos de uso e, para facilitar a visualizao deste documento,
voc pode agrup-los em subsees de casos de uso correlacionados. Os nomes das subsees
devem ser nicos e pequenos (3 palavras no mximo) e podem ser formados por palavras,
nmeros e/ou abreviaes.
Cada um dos casos de uso deve ser descrito em um bloco especfico, seguindo o modelo descrito
abaixo. O identificador do bloco deve conter o nmero do caso de uso (por exemplo, [RF001]) e
o seu nome. Se os casos de uso forem agrupados em subsees especficas, a numerao deles
deve ser reiniciada a cada subseo (dentro de uma mesma subseo, todo caso de uso deve ter
um nmero de identificao nico).
Quando a primeira verso deste documento for disponibilizada para a equipe de
desenvolvimento, os nomes das subsees e os nmeros dos casos de uso no devem ser
modificados ou reaproveitados, para no invalidar referncias externas feitas a eles.>

<Nome de subseo para agrupar casos de uso correlacionados>


<Utilize este espao para descrever caractersticas comuns dos casos de uso desta seo,
explicitando o motivo do seu agrupamento em uma seo nica.
Se todos os casos de uso desta seo estiverem relacionados com o mesmo ator voc pode
informar isso aqui, especificando qual o ator em questo, e eliminar o campo Ator: das
descries dos casos de uso feitas nos blocos a seguir.>

[RF001] <Nome do caso de uso>


<Opcional fornea uma pequena explicao do propsito do caso de uso (til quando o nome
do caso de uso no deixa suficientemente claro qual o seu objetivo) e o(s) seu(s) respectivo(s)
ator(es). Em seguida, substitua um dos smbolos abaixo por , para indicar a prioridade do
caso de uso.>
Ator: <informe o(s) ator(es) do caso de uso >
Prioridade:

Essencial

Importante

Desejvel

<Opcional> Interface(s) associada(s): <inclua aqui o(s) identificador(es) da(s) respectiva(s)


interface(s) do caso de uso (descrita(s) na Seo 5).>
Entradas e pr condies: <Liste aqui todas as entradas e/ou pr condies do caso de uso. Pr
condio de um caso de uso o estado em que o sistema deve estar para realizar o caso de uso.>
Sadas e ps condies: <Liste aqui todas as sadas e/ou ps condies do caso de uso. Ps
condio de um caso de uso a lista de possveis estados em que o sistema pode estar
imediatamente aps o trmino da realizao do caso de uso.>

Verso <1.0>

<mes / ano>

Documento de Requisitos

Requisitos funcionais C2. P2 / 2

Fluxo de eventos principal


<Descreva aqui o fluxo de eventos principal que ocorre durante a execuo do caso de uso.>

<Opcional> Fluxos secundrios (alternativos e de exceo)


<Fluxo secundrio XXX>
<Use este espao para descrever o fluxo secundrio XXX do caso de uso.>

<Fluxo secundrio YYY>


<Prossiga na descrio dos fluxos secundrios do caso de uso, descrevendo cada um deles
separadamente.>

[RF] <Nome de outro caso de uso>


<Utilize os mesmos campos mostrados no bloco anterior para descrever este e os demais
requisitos funcionais (casos de uso) desta subseo.>

<Nome de outra subseo para agrupar outros casos de uso


correlacionados>
<Prossiga de maneira similar subseo anterior para descrever quaisquer outras subsees que
forem usadas para agrupar requisitos funcionais.>

Verso <1.0>

<mes / ano>

Documento de Requisitos

Requisitos no funcionais C3. P1 / 1

Captulo

Requisitos no funcionais
<Esta seo deve conter os requisitos no funcionais do sistema. Para uma melhor organizao
deste documento, utilize as subsees abaixo para agrupar os requisitos no funcionais
relacionados. Naturalmente, o nmero e tipo de subsees utilizadas depende do sistema que est
sendo especificado e no preciso utilizar todas elas. Simplesmente elimine as subsees para as
quais no for encontrado nenhum requisito.
Os requisitos no funcionais devem ser identificados com um identificador nico, da mesma
maneira que os requisitos funcionais (casos de uso). Inicie a numerao com o identificador
NF001 e prossiga incrementando os nmeros a medida que forem surgindo novos requisitos no
funcionais. Reinicie a numerao em cada subseo. Fornea tambm 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 especficos, utilize o campo Caso(s) de uso
associado(s): para identificar o(s) caso(s) de uso correspondente(s). Se for um requisito no
funcional do sistema como um todo, esse campo no precisa ser utilizado.>

Usabilidade
Esta seo descreve os requisitos no funcionais associados facilidade de uso da interface com
o usurio, material de treinamento e documentao do sistema.

[NF001] <Nome do requisito>


<Descreva o requisito no funcional e substitua um dos smbolos abaixo por , para indicar a
sua prioridade.>
Prioridade:

Essencial

Importante

Desejvel

<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 no funcionais de usabilidade.>

Confiabilidade
Esta seo descreve os requisitos no funcionais associados freqncia, severidade de falhas do
sistema e habilidade de recuperao das mesmas, bem como corretude do sistema.

Verso <1.0>

<mes / ano>

Documento de Requisitos

Requisitos no funcionais C3. P2 / 2

[NF] <Nome do requisito>


<Utilize os mesmos campos mostrados na seo 4.1 para descrever este e os demais requisitos
no funcionais de confiabilidade.>

Desempenho
Esta seo descreve os requisitos no funcionais associados eficincia, uso de recursos e tempo
de resposta do sistema.

[NF] <Nome do requisito>


<Utilize os mesmos campos mostrados na seo 4.1 para descrever este e os demais requisitos
no funcionais de desempenho.>

Segurana
Esta seo descreve os requisitos no funcionais associados integridade, privacidade e
autenticidade dos dados do sistema.

[NF] <Nome do requisito>


<Utilize os mesmos campos mostrados na seo 4.1 para descrever este e os demais requisitos
no funcionais de segurana.>

Distribuio
Esta seo descreve os requisitos no funcionais associados distribuio da verso executvel
do sistema.

[NF] <Nome do requisito>


<Utilize os mesmos campos mostrados na seo 4.1 para descrever este e os demais requisitos
no funcionais de distribuio.>

Padres
Esta seo descreve os requisitos no funcionais associados a padres ou normas que devem ser
seguidos pelo sistema ou pelo seu processo de desenvolvimento.
<Se voc mencionar documentos relacionados, no esquea de list-los na seo 1.3.>

[NF] <Nome do requisito>


<Utilize os mesmos campos mostrados na seo 4.1 para descrever este e os demais requisitos
no funcionais de adequao a padres.>

Hardware e software
Esta seo descreve os requisitos no funcionais associados ao hardware e software usados para
desenvolver ou para executar o sistema.

Verso <1.0>

<mes / ano>

Documento de Requisitos

Requisitos no funcionais C3. P3 / 3

[NF] <Nome do requisito>


<Utilize os mesmos campos mostrados na seo 4.1 para descrever este e os demais requisitos
no funcionais de hardware e software.>

Verso <1.0>

<mes / ano>

Documento de Requisitos

<Opcional> Descrio da interface com o usurio C4. P1 / 1

Captulo

Descrio da interface com o usurio


<Esta seo deve conter desenhos ou rascunhos das telas do sistema que forem necessrios ou
convenientes para esclarecer algum dos requisitos do sistema. Para sistemas que possuem
prottipos ou verses j desenvolvidas possvel capturar as telas e apresentar figuras das
mesmas.
Use nomes e/ou nmeros para identificar cada interface e descreva-as em sees independentes.>

<Identificador de uma interface>


<Descreva a interface em questo, atravs de figuras, diagramas e/ou texto.

.1

<Opcional> Crticas da interface


<Voc pode fazer aqui a descrio de crticas simples de interface, como o tamanho e mscara de
campos, simplificando assim a descrio dos fluxos de exceo.>

<Identificador de outra interface>


<Prossiga no detalhamento das interfaces do sistema, descrevendo todas que for necessrio, cada
uma em uma subseo.>

Verso <1.0>

<mes / ano>