DOCUMENTO DE ESPECIFICAO DE REQUISITOS

<Nome do projeto>

Logomarca do projeto

Responsvel: Wellington de Oliveira Acadmico de Cincia da Computao

Foz do Iguau, <data> de 2011.

Documento de Especificao de Requisitos Verso 1.0 Projeto: <Nome do Projeto>

Data de criao/ atualizao

Descrio da(s) Mudana(s) Ocorrida(s)

Autor

Verso do Documento

ID. Solicitao de Mudana

Documento de Especificao de Requisitos Verso 1.0 Projeto: <Nome do Projeto>

NDICE

1 Introduo.....................................................................................................................................4 1.1 Objetivos do documento........................................................................................................4 1.2 Escopo do projeto..................................................................................................................4 1.3 Definies, acrnimos e abreviaes....................................................................................4 2 Descrio geral do projeto............................................................................................................4 2.1 Perspectiva do produto..........................................................................................................4 2.2 Caractersticas do usurio......................................................................................................4 2.3 Funes e restries do produto...........................................................................................4 2.4 Suposies e dependncias....................................................................................................5 3 Requisitos de sistema....................................................................................................................5 3.1 Requisitos funcionais.............................................................................................................5 3.2 Requisitos no funcionais......................................................................................................6 3.3 Requisitos de persistncia......................................................................................................6 3.4 Requisitos e Diagramas UML...............................................................................................6 4 Descrio da Base de Dados.........................................................................................................7 4.1 Modelo Entidade-Relacionamento (MER)...........................................................................7 4.2 Descrio das tabelas.............................................................................................................7 4.3 Modelo Entidade-Relacionamento (MER)...........................................................................7 4.4 Modelo Relacional.................................................................................................................7 4.5 Dicionrio da Base de Dados................................................................................................7 4.6 Descrio das Consultas........................................................................................................8 4.7 Regras de Integridade............................................................................................................8 5 Apndices......................................................................................................................................8 6 Referncias....................................................................................................................................8

Documento de Especificao de Requisitos Verso 1.0 Projeto: <Nome do Projeto>

1
1.1

Introduo
Objetivos do documento

Este exemplo visa apresentar o formato e contedo mnimo necessrio para a descrio e especificao dos requisitos de um projeto de software. (Descre-ve se aqui os objetivos que se pretende alcanar atravs da elaborao deste documento em particular, levando em conta as caractersticas do projeto ao qual ele se aplica, descreve-se qual o pblico-alvo do documento, ou seja, quem dever ler e por quais razes) 1.2 Escopo do projeto

1.3

Descreve-se aqui claramente a abrangncia do projeto. Identificam-se os produtos a serem desenvolvidos por nome. Descreve-se em alto nvel aquilo que os produtos devero fazer, e se necessrio o que no devero fazer. Descreve-se qual ser a aplicao do software, quais sero os benefcios proporcionados, quais os objetivos que se pretende alcanar com ele. Definies, acrnimos e abreviaes Siglas, abreviaes e termos especficos do domnio da aplicao devem ser listados aqui.

2
2.1

Descrio geral do projeto

Perspectiva do produto Apresentar uma breve descrio de como os analistas e stakeholders visionam o projeto: Descrever o problema e o ambiente de negcio. Descrever como o sistema proposto poder dar suporte s atividades do negcio. Descrever como o sistema se integra ao ambiente e interage com outros sistemas relacionados (se for o caso).

2.2

Caractersticas do usurio

Identificar os stakeholders e sua influncia sobre o projeto. Caractersticas particulares dos diferentes perfis de usurios esperados devem ser descritas. E.g.: se o usurio um tcnico de laboratrio, um professor ou um aluno do colgio. 2.3 Funes e restries do produto

Inicialmente deve-se descrever os mtodos utilizados para a coleta (elicitao) de requisitos (entrevistas, anlise de documentao, normas, padres, etc).Apresentar e comentar os resultados do processo de elicitao (respostas a questionrios, cenrios descritos, etc). Observao: questionrios apresentados, atas de reunio e outros materiais produzidos podem ser includos nos apndices e referenciados aqui. Em seguida devem ser descritos os requisitos de usurio. Devem ser apresentados de forma que o cliente ou qualquer pessoa sem experincia em desevolvimento de software possa compreender. Utilizar um formato padro para representar todos os requisitos. Devem ser
Documento de Especificao de Requisitos Verso 1.0 Projeto: <Nome do Projeto>

claramente identificados e descritos, incluindo a racionalizao necessria para justificar cada um deles. A fonte de cada requisito deve ser apontada, e a correspondente especificao (requisitos do sistema) deve ser referenciada. Tabelas e diagramas podem ser utilizados de forma a complementar a documentao. Sugesto: utilizar linguagem natural estruturada. Exemplo:
2.3.1. Interface com o usurio 2.3.1.1. RF_1.1 - Barra de Tarefas A interface com o usurio deve conter uma barra de tarefas que permite acesso a cada um dos mdulos do programa. Esta barra dever conter um cone mnemnico associado ao mdulo correspondente. Ao clicar sobre o cone, o mdulo ser acionado. Justificativa: Uma barra de tarefas intuitiva na tela inicial do aplicativo facilita o entendimento da aplicao e agiliza o treinamento dos usurios iniciantes. Isto ser de extrema importncia porque previsto um ingresso constante de novos funcionrios na empresa, e estes devem iniciar imediatamente o uso do sistema. Fonte: Mariazinha, gerente do Departamento Financeiro das Casas Amazonas. Prioridade: Imprescindvel. 2.3.2. Mdulo de clculo dos juros 2.3.2.1. RF_2.1 Juros compostos O mdulo deve prover a funcionalidade de clculo de juros compostos. Bla bla... Justificativa: O vendedor precisa calcular os juros composto para informar ao cliente... Fonte: Pedrinho, chefe da Equipe de Vendas das Casas Amazonas. Prioridade: Necessrio.

2.4

Suposies e dependncias

Eventuais suposies e pr-requisitos necessrios realizao do projeto podem ser enunciados aqui. E.g.: se haver o equipamento necessrio e com desempenho suficiente para a implantao do sistema, se algum sistema operacional especfico ser necessrio, etc.

Requisitos de sistema

Esta a parte mais substancial do documento. Aqui devem ser especificados detalhadamente os requisitos do sistema, de forma estruturada. Estes requisitos podem documentar interfaces externas, descrever funcionalidades do sistema, estabelecer caractersticas de qualidade, bem como estabelecer restries de projeto e desempenho. Estas informaes devem ser suficientemente detalhadas de modo a permitir que a partir delas se realize o desenho e a implementao do sistema, bem como a elaborao e execuo de casos de teste. Cada um dos requisitos descritos nesta seo deve especificar uma descrio de cada entrada (estmulo) ao sistema, cada sada (resposta) correspondente e de todas as funes desempenhadas pelo sistema neste tratamento. Para complementar o texto, podem ser utilizados recursos como, por exemplo: Notao grfica (UML); DDL (design description language); Notao matemtica formal. 3.1 Requisitos funcionais Declarao de servios que o sistema deve prover. Como o sistema deve reagir determinadas entradas. Que validaes devem ser aplicadas s entradas. Qual a sequncia principal de operaes a ser realizada. Como o sistema deve se comportar em situaes particulares/anormais.
Documento de Especificao de Requisitos Verso 1.0 Projeto: <Nome do Projeto>

3.2

Requisitos no funcionais Restries aplicadas aos servios ou funes oferecidas pelo sistema, tais como: Restries temporais e de desempenho. Limites do sistema (nmero necessrio de usurios, volume de dados que a base deve suportar, etc) Padres, normas ou leis a serem seguidos.

3.3

Requisitos de persistncia Requisitos de armazenamento.

3.4

Requisitos e Diagramas UML

Como os requisitos tratam das funcionalidades do sistema e sabendo-se que estas podem ser representadas atravs de diagramas UML, esperado da equipe de engenharia de software a construo de diversos diagramas durante a fase de levantamento e anlise de requisitos. Tais diagramas serviro de base para a definio da arquitetura do sistema bem como, e especialmente, para uma implementao bem sucedida. O nvel de detalhes de cada diagrama varia de acordo com a necessidade e complexidade do requisito descrito. Importante ressaltar que cabe ao engenheiro de software, neste caso, arquiteto do sistema, tratar dos detalhes e especificidades dos diagramas a fim de fornecer o mximo de informao para o time de desenvolvimento (implementao). No que diz respeito a quais diagramas devem ser criados, considere-se os seguintes pressupostos: Requisitos implicam em funcionalidades do sistema que so descritas atravs de diagramas de casos de uso. Um diagrama de caso de uso descreve, ainda, as interaes entre usurio e sistema; Cada caso de uso descrito em um diagrama requer, pelo menos, um diagrama de sequncia. Este, por sua vez, tem seu foco na sequncia de mensagens trocadas por vrios objetos durante a execuo de um nico caso de uso. Neste ponto o arquiteto pode decidir por utilizar outros diagramas, como comunicao, atividades ou mquina de estados, dependendo do tipo de requisito sendo descrito e do foco desejado; Como um diagrama de sequncia descreve interaes entre objetos, se faz necessria a construo de diagramas de classes para representar todas as classes envolvidas em todos os casos de uso descritos pelos diagramas de sequncia. Cabe, ainda, ao arquiteto decidir sobre a necessidade ou no de diagramas de objetos; Diagramas de classes vem sempre acompanhados de diagramas de pacotes para \refletir a organizao do sistema, demonstrando como as classes devem ser agrupadas (logicamente); Caso haja, por exemplo, interao entre requisitos e colaboraes complexas envolvendo diversas classes/interfaces, pode-se incluir tambm diagramas de estrutura composta. Desta forma, esta seo do documento de requisitos deve contemplar um nmero mnimo de diagramas utilizados para descrever cada requisito/funcionalidade, juntamente com uma descrio textual, a fim de deixar bem claro o que se espera do sistema.

Documento de Especificao de Requisitos Verso 1.0 Projeto: <Nome do Projeto>

Descrio da Base de Dados

Fazer uma introduo do porque da descrio da base de dados.

4.1

Modelo Entidade-Relacionamento (MER) Entregar o desenho do modelo MER, contendo os principais dados a serem armazenados. Pode ser na ferramenta BRModelo ou a mo. Exemplo:

Figura 1: Modelo Entidade Relacionamento da Base de Dados.

4.2

Descrio das tabelas Gerar tabelas, de modo manual, j normalizadas. Montar descrio da estrutura das tabelas, segundo o modelo abaixo: Nome da Tabela: Descrio da Tabela Campo Descrio Nome do campo Descrever campo 4.3 Modelo Entidade-Relacionamento (MER) Entregar o desenho do modelo MER, contendo os principais dados a serem armazenados. Pode ser na ferramenta BRModelo ou a mo. Exemplo:

Figura 2: Modelo Entidade Relacionamento da Base de Dados.

4.4

Modelo Relacional Fazer uma introduo e apresentar o modelo relacional desenhado no dbdesigner/mysql workbench.

Figura 3: Modelo Relacional da Base de Dados.

4.5

Dicionrio da Base de Dados Fazer uma introduo e uma descrio para cada tabela gerada, colocando os dados, sua descrio, tipo do campo e formato. Segundo o modelo abaixo: Nome da Tabela: Descrio da Tabela Campo Descrio Nome do campo Descrever campo Tipo Colocar o tipo (char, Formato Se date 22/03/2010

Documento de Especificao de Requisitos Verso 1.0 Projeto: <Nome do Projeto>

int, date etc.) Exemplo: Cliente: Cliente a tabela que armazenar as informaes de todos os clientes da empresa, que j tiveram algum contato, mesmo que seja apenas por consulta de produtos via site. Atributo Descrio Campo Descrio Tipo Formato Id_cliente Campo chave Integer 0001 identificador de cada pessoa. nico e incrementado automticamente Nome Campo que Varchar(255) Maria de Souza armazenar o nome do cliente interessado. Dt_cont Data do 1. Contato Date 22/03/10 do cliente 4.6 Descrio das Consultas Fazer uma introduo e descrever as principais consultas Descrio da consulta, descrio do modo de apresentao (tela, relatrio etc.), dados necessrios e tabela de origem. Incluir no apndice o cdigo SQL da consulta. 4.7 Regras de Integridade Descrevere a regra de integridade, indicar o recurso utilizado para resoluo. Incluir no apndice o cdigo SQL da regra de integridade implementada.

Apndices

Qualquer material extra que eventualmente seja necessrio para complementar o texto deve ser inserido aqui. Resultados de questionrios, entrevistas e atas de reunio com os stakeholders so exemplos. Incluir o cdigo SQL da criao das tabelas, no se esquecer de separar os cdigos SQL para cada item implementado anteriormente.

Referncias

Todo e qualquer documento ou bibliografia relevante que tenha sido consultada para a elaborao da especificao de requisitos deve ser referenciado aqui: Livros, manuais, especificaes tcnicas, normas, leis, etc. [1] IEEE Recomended Practice for Software Requirements Specifications IEEE Std 830-1993, IEEE Computer Society, 1993.

Documento de Especificao de Requisitos Verso 1.0 Projeto: <Nome do Projeto>