Guia de Especificao de Caso de Uso

Metodologia CELEPAR
Agosto 2009
Sumrio de Informaes do Documento
Documento: guiaEspecificacaoCasoUso.odt Nmero de pginas: 10
Verso Data Mudanas Autor
1.0 09/10/2007 Criao Danielle Mayer
1.0 02/05/2008 Alterao. Marcos Chiarello
1.0 01/06/2009 Alterao. Danielle Mayer
1.0 17/08/2009 Reviso
Marcos Chiarello e Danielle
Mayer
Sumrio
1 Introduo.........................................................................................................................................4
1.1 Viso Geral ..............................................................................................................................4
2 Detalhar casos de uso.......................................................................................................................4
2.1 Detalhar o Fluxo de Eventos.....................................................................................................4
2.1.1 Fluxo de Eventos Estrutura............................................................................................5
2.1.2 Principal............................................................................................................................5
2.1.2.1 Sub-Fluxo..................................................................................................................5
2.1.3 Alternativos (excees).....................................................................................................5
2.2 Detalhar pr-condies e ps-condies..................................................................................6
2.3 Regras de Negcio....................................................................................................................7
2.4 Orientao sobre a especificao de casos de uso de relatrios...............................................8
2.4 Lembretes e Dicas para detalhar um Caso de Uso....................................................................9
4
1 INTRODUO
Este guia tem por objetivo orientar a atuao do Analista de Requisitos no momento de
realizar o Detalhamento dos Requisitos.
1.1 Viso Geral
Especificar requisitos consiste em detalhar os cenrios que compem os casos de uso
previamente identificados no modelo de caso de uso. A especificao de caso de uso descreve o
comportamento do sistema e o produto final das atividades do Analista de Requisitos, alm de
orientar todo o desenvolvimento tambm permite validar a compreenso dos requisitos antes do
inicio do desenvolvimento do software.
Esta especificao demonstra a ao do ator e a respectiva resposta esperada, apresenta o
comportamento da aplicao isenta dos detalhes ligados a UI (User Interface), no abordando
aspectos ligados arquitetura ou codificao.
2 DETALHAR CASOS DE USO
2.1 Detalhar o Fluxo de Eventos
Um caso de uso formado por um conjunto de cenrios, podendo ser realizado por
diversas maneiras. Um cenrio, ou instncia de um Caso de Uso, a descrio de uma das maneiras
pelas quais este pode ser realizado e normalmente h diversos cenrios para um mesmo caso de uso.
Cada cenrio descreve modos alternativos de comportamento do sistema, suas falhas ou
casos excepcionais. Cenrio uma seqncia de aes e interaes que ocorrem sob certas
condies.
O Fluxo de Eventos de um caso de uso contm informaes derivadas da modelagem de
casos de uso. O analista deve se preocupar em descrever o qu acontece entre o usurio e o
sistema, sem, entretando, informar como essa interao ocorre.
METODOLOGIA DE DESENVOLVIMENTO - CELEPAR
5
As diretrizes para o contedo do fluxo de eventos so:
Descrever como o Caso de Uso comea e termina;
Descrever como as informaes so trocadas entre o ator e o Caso de Uso;
Evite terminologia vaga, como: "por exemplo", "etc" e "informaes";
Durante o detalhamento do fluxo de eventos todos os "o qu" devem ser
respondidos;
Descrever quando o Caso de Uso utiliza as informaes armazenadas, ou mesmo s
armazena no sistema;
No descrever detalhes de projeto (como ser implementado).
Sempre que necessrio deve-se refinar o glossrio, adicionando novos termos identificados
durante a especificao dos Casos de Uso.
2.1.1 Fluxo de Eventos Estrutura
As principais partes do fluxo de eventos so o fluxo principal, sub-fluxos e os
alternativos (excees).
2.1.2 Principal
O fluxo principal deve abordar o que ocorre quando o caso de uso executado, levando em
considerao os passos que o ator deve executar para realiza-lo. Durante a definio dos passos do
fluxo principal podero ser identificados passos opcionais, que podero ser especificados como
Sub-Fluxos do prprio fluxo principal ou mesmo Fluxos Alternativos caracterizados por excees.
2.1.2.1 Sub-Fluxo
Caso o fluxo principal fique muito extenso, este pode ser divido em sub-fluxos. Sendo este
um segmento de comportamento no Caso de Uso, com uma finalidade clara e atmica no sentido
de que realiza todas ou nenhuma das aes descritas.
2.1.3 Alternativos (excees)
METODOLOGIA DE DESENVOLVIMENTO - CELEPAR
6
Os fluxos alternativos abordam o comportamento de carter excepcional em relao ao
normal e tambm as variaes do comportamento. Voc pode pensar nos fluxos de eventos
alternativos como "desvios" do fluxo principal, alguns dos quais voltaro ao fluxo principal e
alguns finalizaro a execuo do caso de uso.
medida que detalhado o fluxo principal, deve-se identificar os fluxos alternativos. Para
auxiliar nesta identificao observe as seguintes questes:
Existem respostas diferentes, dependendo da ao do Ator? (por exemplo, o Ator
informa um nmero de carto invlido enquanto utiliza um caixa eletrnico) ;
Quais operaes de negcio podem afetar a operacionalizao do Caso de Uso? (o
Ator requisita ao caixa eletrnico mais dinheiro do que est disponvel na sua
conta) ;
O que poderia dar errado? (no h conexo de rede disponvel quando necessria
uma transao) .
Para esclarecer onde um fluxo de eventos alternativo se encaixa na estrutura,
necessrio descrever:
Onde o comportamento alternativo pode ser inserido no fluxo de eventos principal;
Qual a condio que precisa ser atendida para que o comportamento alternativo
inicie;
Como e onde o fluxo de eventos principal retomado, ou como o Caso de Uso
termina.
Tanto o fluxo de eventos principal quanto os fluxos de eventos alternativos devem ser
estruturados em passos e sub-fluxos.
2.2 Detalhar pr-condies e ps-condies
Uma pr-condio uma restrio sobre quando um Caso de Uso pode comear e no o
evento que inicia o caso de uso. Uma pr-condio num Caso de Uso descreve o estado, e no
aes, em que o sistema deve estar para este possa ser iniciado.
A situao mais comum, que sinaliza uma pr-condio, a necessidade do usurio j ter
METODOLOGIA DE DESENVOLVIMENTO - CELEPAR
7
sido autenticado.
Uma ps-condio lista os possveis estados, e no aes, em que o sistema pode
apresentar quando finalizado. O sistema deve estar num desses estados.
As ps-condies so asseres que se aplicam ao final da execuo do Caso de uso, elas mostram
o estado que o sistema pode apresentar aps o seu trmino.
2.3 Regras de Negcio
As regras de negcio so tipos especiais de obrigaes, so requisitos de como os negcios,
incluindo suas ferramentas de negcios, devem operar. Elas podem ser leis e regulamentos impostos
ao negcio, como um todo, ou mesmo, especfico para um determinado Caso de Uso.
As regras de negcio devem ser claras evidenciando onde e quando devem ser aplicadas.
Podendo ser classificadas de vrias formas, embora seja comum separ-las em regras de restrio e
de derivao.
Regras de restrio: Especificam polticas e condies que restringem o comportamento e
a estrutura de objetos.
Regras de estmulo e resposta: Restringem o comportamento especificando quando e se as
condies devem ser verdadeiras para que o comportamento seja disparado. Esse tipo de
regra afeta o fluxo de trabalho de um Caso de Uso. possvel mostrar um caminho
condicional ou alternativo atravs dos fluxos do Caso de Uso.
Exemplo:
Quando um pedido cancelado este deve ser finalizado retornando a situao do
Estoque.
Regras de restrio de operao: Especificam as condies que devem ser verdadeiras
antes e aps uma operao para garantir que esta seja executada corretamente. Esse tipo de
regra geralmente convertida em pr-condies e ps-condies ou em um caminho
condicional ou alternativo em um fluxo de trabalho.
Exemplo: Enviar o pedido somente se o cliente possui endereo de entrega.
Regras de restrio de estrutura: Especificam polticas ou condies sobre classes,
objetos e seus relacionamentos que no podem ser violados. Esse tipo de regra afeta as
relaes entre instncias de classes conceituais. Elas so expressas pela existncia de uma
METODOLOGIA DE DESENVOLVIMENTO - CELEPAR
8
associao entre classes; s vezes como uma multiplicidade na associao.
Exemplo: Um pedido se refere a um produto no mnimo.
Regras de derivao: Especificam polticas ou condies para deduzir ou calcular fatos de
outros fatos.
Regras de deduo: Especificam que se determinados fatos so verdadeiros, uma
concluso pode ser deduzida. Esse tipo de regra implica em um mtodo que precisa ser
refletido em um estado de atividade do fluxo e eventualmente em uma operao.
Exemplo:
- Um Cliente um Bom Cliente se e somente se as faturas no pagas, enviadas a esse
Cliente, tm menos de 30 dias.
- O resultado da avaliao dos alunos deve ser classificado da seguinte maneira:
O Aluno considerado aprovado se atingir mdia igual ou superior a 7.0;
O Aluno considerado em Recuperao se atingir mdia maior ou igual a 5.0 e
inferior a 7.0;
O Aluno considerado reprovado se atingir mdia menor que 5.0.
Regras de clculo: Derivam seus resultados pela forma de processar algoritmos, uma
variante mais sofisticada de regras de deduo. Esse tipo de regra semelhante a regra de
deduo, contudo, o mtodo deve ser mais formal e semelhante a um algoritmo.
Exemplo:
- O preo lqido de um Produto calculado da seguinte maneira: preo do produto *
(1+porcentagem de imposto/100);
- A avaliao dos alunos dever ser calculado pela mdia aritmtica de suas notas.
2.4 Orientao sobre a especificao de casos de uso de relatrios
A Especificao de Caso de Uso de relatrios no difere de uma Especificao de Caso de
Uso de formulrio. Esta especificao deve abordar o que ocorre quando o Caso de Uso acionado,
descrevendo mecanismo de seleo do relatrio (se houver) e quais informaes este relatrio
apresentar e o layout desejado.
Na Especificao de Caso de Uso tambm deve ser esclarecido o tipo do relatrio
METODOLOGIA DE DESENVOLVIMENTO - CELEPAR
9
(operacional/online ou analtico/batch). Se for analtico, informar se o relatrio ser agendado
por data ou se ser um agendamento repetitivo.
Para agendamento por data, informar a data e hora em que o relatrio deve ser
disparado.
Para agendamento repetitivo, informar a periodicidade (DIRIO, SEMANAL,
MENSAL) e o horrio a ser disparado.
Independente do tipo de agendamento, deve-se tambm informar como o relatrio ser
recuperado atravs de alguma funcionalidade ou encaminhamento por email. No caso de
relatrios enviados por email configurar tambm o assunto do email, geralmente colocando o nome
do relatrio e a data de gerao.
Os relatrios analticos gerados ficam disponveis no servidor por 15 dias(tempo padro)
mas este prazo pode ser configurado de acordo com a necessidade da aplicao. Sendo assim, se o
tempo necessrio for maior que o padro, este deve ser informado na Especificao de Caso de Uso.
importante ressaltar que de acordo o padro adotado pela CELEPAR os relatrios so
criados no formato PDF, permitindo que o usurio final possa apenas imprim-los ou salv-los, sem
permisso para alteraes.
2.4 Lembretes e Dicas para detalhar um Caso de Uso
1. Escreva os passos numa seqncia lgica, conforme acontece a interao Ator/Sistema;
2. Use gramtica simples. Uma sentena mal formulada torna o passo difcil de se entender;
3. Mantenha os passos curtos e objetivos. Escrever com muito detalhe, em tudo, deixa o Caso
de Uso extenso e a leitura cansativa e confusa;
4. Numere os passos, isso clarifica a especificao e facilita a comunicao;
5. A cada passo, cite quem vai realizar a ao. Exemplo;
1 Ator: Informa os dados solicitados;
2 Sistema: Verifica e valida as informaes.
6. Relacione, se for o caso, as regras de negcio com os passos. Exemplo;
1 Ator: Informa o valor para a retirada;
2 Sistema: Verifica saldo [R1].
METODOLOGIA DE DESENVOLVIMENTO - CELEPAR
10
...
Regras de Negcio.
[R1] necessrio haver fundos, em conta, suficientes para a retirada.
7. A especificao de caso de uso de anlise deve dizer o qu o sistema deve fazer (quais
servios so disponibilizados pelo sistema), e no como ser implementado (chamadas de
mtodos).
8. Lembre-se de que um Ator tem um objetivo e o Sistema deve ajuda-lo a atingir este
objetivo.
9. Inicie a especificao do fluxo principal com o cenrio de sucesso, escreva todos os passos
que levam o Ator a alcanar este objetivo. Depois inclua todas as excees (possibilidades
de falhas).
10.Importante: Identifique todas as possibilidades de falha antes de iniciar a construo, pois
identific-las durante a programao mais oneroso para o projeto.
11.Verifique se cada especificao de caso de uso, possue sua correspondncia no Modelo de
Casos de Uso.
12.Independente do passo que est sendo especificado, fluxo principal, sub-fluxo ou o fluxo
alternativo, ser descrito uma das seguintes aes:
Uma interao entre o Ator e o Sistema (Ator informa o CPF);
Uma validao (Sistema valida o CPF);
Uma mudana/atualizao interna (Sistema atualiza os dados do cadastro).
METODOLOGIA DE DESENVOLVIMENTO - CELEPAR