Documentao do Projeto de PI/Pr-TCC

<Nome do Projeto>

Aluno: <Nome do Aluno>

Perodo:

Cel. Fabriciano - MG

<Data>
1Introduo
A introduo tem por finalidade apresentar o problema que se vai estudar, acenar para seu estgio de
desenvolvimento e para a relevncia da pesquisa realizada. Deve conter os seguintes itens: a)
apresentao sumria do estgio de desenvolvimento do assunto mediante referncia a tudo que j
se escreveu sobre ele; b) referncia s possibilidades de contribuio da pesquisa agora
desenvolvida, sem anunciar solues ou concluses a que se chegou; e c) delimitao clara do
campo da pesquisa e colocao das partes componentes do corpo do trabalho, justificando-as
brevemente.

Cumpre observar que a introduo deve ser bem cuidada. Tem caractersticas principais a brevidade
e a segurana, isto , deve acenar para o histrico da questo, sem reconstitui-lo; deve referir-se s
partes do corpo do trabalho a largos traos, sem maiores desenvolvimentos; deve, ainda, despertar
confiana com relao seriedade e validade da pesquisa, o aluno de que o examinador colhe a
primeira imagem.

2Descrio do Mini-mundo do Projeto (Dispensvel para projetos do

1 perodo)
Esta parte faz referncia s atividades da empresa ou do ramo ao qual o produto se destina,
descreve os processos da empresa no dia a dia e descreve os problemas atuais vividos pela empresa
em funo de no ter informaes em tempo hbil.

3Delimitao do Projeto

6.1 Lista de funes do Projeto

Foi identificada a seguinte lista de funes para este produto:

Nmero Tipo Nome da funo Descrio Tempo Tempo
de ordem estimado realizado

Tipo: 1 Cadastro 2 Controle 3 - Relatrio

6.2 Restries do Projeto (Limites do Produto)

Tudo aquilo que o produto no realizar

SIGI no ir gerar automaticamente Recibos de alugueis;

SIGI no ir fazer comunicao com os dois escritrios;
SIGI no ir gerar automaticamente opo de vendas;
SIGI no ter ajuda on-line;
SIGI no ter comunicao com a Internet.

2
 6.3 Anlise de Risco do Projeto (Dispensvel para os alunos do 1, 2 e 3 perodos)

Descreve possveis riscos de projeto, a probabilidade de surgir esses riscos e as estratgias

propostas para a reduo deles

Exemplo:
Riscos Probabilidade Estratgias reduo de riscos
ocorrer
Dificuldades para aprendizagem de Mdia Disponibilizar contato com algum
linguagem de programao conhecedor da linguagem.
No ter disponveis softwares Baixa Buscar softwares alternativos
necessrios

6.4 Necessidades de hardware e software

Descreve o hardware e os softwares de apoio exigidos para realizar o desenvolvimento

4Cronograma do Projeto
O cronograma a seguir apenas um exemplo, desenvolva o seu cronograma conforme a
necessidade de seu projeto.

O projeto seguir as seguintes etapas, distribudas conforme a tabela abaixo:

1. Desenvolvimento da Proposta;

2. Levantamento e Especificao dos Requisitos do sistema;

3. Anlise do sistema (com construo da documentao necessria);

4. Projeto do sistema (projeto de interface, projeto de banco de dados, etc);

5. Implementao dos cadastros;

6. Implementao das funes de controle;

7. Implementao dos relatrios;

8. Testes do sistema;

9. Documentao final.

Cronograma fsico (baseado nos itens citados anteriormente).

Itens\Ms Ago Set Out Nov Dez Jan Fev Mar Abr Mai Jun Jul
1
2
3
4
5
6
7
8
9

3
5Custo Total do Projeto (Dispensvel para os alunos do 1, 2 e 3
perodos)
Faa uma estimativa (em reais) de quanto voc julga que seu sistema custaria

6Documentao do Projeto

6.1 Glossrio Definies e Siglas

Todas a Siglas e Termos prprios do negcio. Exemplo

SIGE Sistema Integrado de Gerncia Empresarial;

6.2 Materiais de Referncia

Todos os materiais e documentos que servem de referncia para os requisitos e os modelos do

projeto seguem alguns exemplos abaixo

Tipos de Material Referncia

Atas de Entrevistas Entrevistas realizadas com funcionrios da empresa na data ...
Documento Ficha de cadastro de clientes
Relatrio Plano do Projeto

6.3 Requisitos de Software (Dispensvel para o 2 e 3 perodos)

Deve ser feita uma descrio mais detalhada de todos os Requisitos Funcionais do Produto.
Utilizaremos para isso o modelo abaixo. Neste item tambm devem ser acrescentados todos os
diagramas que pode ajudar a entender cada funo

Descrio dos Atores

Alm de descrever o papel do ator no sistema deve-se tambm incluir a freqncia de uso (diria,
semanal, mensal, bimestral, etc) de cada ator e a proficincia (habilidade) em informtica (baixa,
mdia, alta) esperada para cada um.

Num. Nome Descrio Freqncia Proficincia

de Uso em
Informtica
1 Administrador Os administradores so os usurios que Diria Alta
tm acesso ao mdulo administrativo. Eles
tm como objetivo realizar tarefas de
caracterstica gerencial, como por exemplo
cadastro de novas lojas, consultar dados
estatsticos a respeito do sistema, etc.
2

Casos de Uso

4
Acrescentar o diagrama de casos de uso

Requisitos Funcionais

Segue exemplos de descries de cadastro, controle e relatrio

[RF001] Efetuar Login

Usurio identifica-se no sistema para ter disposio os servios personalizados oferecidos pelo
mesmo. Essa identificao feita atravs de um loginame e de uma senha escolhida pelo usurio no
momento do cadastro.

Pr condies:
1. Pr condies: Usurio est no conjunto de usurios efetivos.

Fluxo principal:
1. O sistema recebe os dados necessrios para efetuar o login do usurio.
2. Os dados so validados pelo sistema e o usurio tem acesso aos recursos
personalizados deste.

Fluxos secundrios de eventos:

Dados fornecidos invlidos

- Campos no preenchidos: O usurio poder no preencher todos os campos necessrios.
Ao tomada: Uma mensagem referente ao campo a ser preenchido ser exibida.

Usurio Inexistente
- Login ou senha inexistentes.
Ao tomada: Uma mensagem ser exibida informando ao usurio que o campo est incorreto.
Exemplo: Cadastro de Cliente

Pr-condies:
1. O sistema est em modo de cadastro

Fluxo Principal:
1. O Sistema exibe a interface de Cadastro de Clientes
2. O Balconista informa a opo desejada

Fluxo alternativo Insero de Cliente

1. O Balconista informa os dados do cliente.
2. O Balconista aciona o comando Salvar.
3. O Sistema armazena os dados do cliente.

Fluxo alternativo Alterao de Cliente

1. O Balconista seleciona o cliente que deseja alterar.
2. O Balconista informa os dados a serem alterados no cliente.
3. O Balconista aciona o comando Salvar.
4. O Sistema altera os dados do cliente.

Fluxo alternativo Excluso de Cliente

1. O Balconista seleciona o cliente que deseja excluir.
2. O Sistema verifica se existem vendas realizadas para o cliente.
3. Se houver vendas para o cliente:

5
 3.1. O Sistema emite uma mensagem de Erro e cancela (aborta) a excluso.
4. Se no houver vendas para o cliente:
4.1. O Sistema exclui o cliente.

Obs.: Na excluso fundamental que estejam claras as verificaes (as restries) que precisam ser
feitas antes da excluso. No caso anterior eu verifiquei se existiam vendas para o cliente antes de
excluir.

Exemplo de descrio de um controle: Vendas

Pr-condies
1. Os clientes esto previamente cadastrados
2. As mercadorias esto previamente cadastradas
3. O sistema est no modo de vendas.

Fluxo Principal
1. O Balconista seleciona o cliente para o qual se est realizando a venda.
2. Para cada mercadoria da venda:
2.1. O Balconista seleciona a mercadoria
2.2. O Balconista informa a quantidade vendida da mercadoria
2.3. O Sistema totaliza o preo da mercadoria no preo total da venda
2.4. O Sistema d baixa no estoque da mercadoria vendida
3. O Balconista informa a forma de pagamento selecionada pelo cliente
4. Se a venda for a prazo
4.1. O sistema insere as parcelas de contas a receber
5. O Balconista encerra a venda

Exemplo de um relatrio: Relatrio de Estoque

Pr-condies:
1. O sistema est em modo de emisso de relatrios

Fluxo principal:
1. O Gerente aciona o comando Gerar Relatrio
2. Para cada mercadoria cadastrada:
2.1. O sistema exibe nome seguido do saldo da mercadoria (soma as compras e subtrai as
vendas da mercadoria).

Devem ser documentadas todas as funes relacionadas aos casos de uso;

Requisitos No Funcionais (Dispensvel para os alunos do 1, 2 e 3 perodos)

<Na seqncia exemplos de requisitos no funcionais. Use aqueles que forem aplicveis ao seu
projeto e inclua outros se necessrio>

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] Interface com o Usurio

O sistema deve prover uma interface amigvel e intuitiva, ....
Prioridade: Importante.
Confiabilidade
Esta seo descreve os requisitos no funcionais associados freqncia, severidade de falhas do
sistema e habilidade de recuperao das mesmas, bem como a corretude do sistema.

6
[NF001] Tempo de Retorno aps Falha
Aps uma falha que indisponibilize temporariamente o acesso ao site, o sistema deve voltar ao ar em
no mximo 3 dias.
Prioridade: Importante.

[NF002] Disponibilidade
O sistema deve estar disponvel 24 horas por dia, sete dias por semana. Caso seja necessria
alguma manuteno no site, faz-lo em uma verso para testes, no disponvel para os usurios, e
ento aplicar as mudanas na verso disponvel para os usurios.
Prioridade: Essencial.
Desempenho
Esta seo descreve os requisitos no funcionais associados eficincia, uso de recursos e tempo
de resposta do sistema.

[NF001] Nmero de Acessos

O sistema deve ser capaz de atender em mdia 80.000 visitantes por dia, ou seja, aproximadamente
um usurio por segundo, mas deve tambm ser capaz de atender em mdia a 3 usurios por
segundo em picos de acesso.
Prioridade: Essencial

[NF002] Tempo de Resposta para os Usurios

O tempo mximo de resposta do sistema a uma consulta simples de um usurio deve ser de at 1
minuto e 30 segundos, para operaes simples como exibio de pginas de cadastro ou alterao
de dados 5 segundos. Para os estabelecimentos, o tempo de resposta para exibio de informaes
de produto deve ser de ate 5 segundos e para outras paginas ate 8 segundos. Para o administrador,
no h restrio de tempo de resposta.
Prioridade: Desejvel.

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

[NF001] Privacidade de Acesso

O administrador, para ter acesso ao sistema, deve informar login e senha de identificao. Tambm
devem se identificar os usurios que desejaremos servios personalizados ou alterao de dados
cadastrais.
Prioridade: Essencial.

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.

[NF001] Padro de Codificao

A implementao do Sistema ser feita baseada no Padro de Codificao Java e no Guia de Fatores
de Qualidade de Orientao a Objetos e Java da Qualiti Software Processes.
Prioridade: Desejvel.

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

7
[NF001] Linguagem de Implementao
O sistema dever ser implementado em Java, utilizando os conceitos de programao orientada a
objetos. Alm disso, a interfaces ser implementada em HTML contendo cdigo JavaScript e JSP.
Prioridade: Importante.

[NF002] Banco de Dados

O banco de dados utilizado ser o Oracle.

Prioridade: Importante.

[NF003] Ferramentas
O sistema ser desenvolvido com auxlio das seguintes ferramentas case: Rational Rose para anlise
e projeto em UML, JBuilder 7.0 para desenvolvimento de cdigo Java, Microsoft Office 2000 Premium
para confeco dos artefatos.
Prioridade: Importante.

[NF004] Plataforma de Funcionamento

O sistema independente de plataforma, conforme caractersticas da linguagem Java, ressaltando-se
que a referente linguagem possui pequenos problemas de compatibilidade em alguns poucos casos.
Prioridade: Essencial.

[NF005] Interface Hardware X Software

[NF006] Restries de Hardware

Compatibilidade

[NF001] Arquivos
O sistema deve seguir um padro de gerao de arquivos compatveis com o sistema de Gesto de
Clientes.
Prioridade: Essencial.

Diagrama de Classes (Dispensvel para os alunos do 1, 2 e 3 perodos)

Construa o diagrama de classes do seu sistema

Diagramas de Seqncia (Dispensvel para os alunos do 1, 2 e 3 perodos)

Todas as Funcionalidades de Cadastro, Controle e Relatrio devero ser acompanhadas dos

Diagramas de Seqncia correspondentes

8
 6.4 Projeto de Dados

Anexar o Diagrama de Entidade Relacionamento (DER) do sistema.

Dicionrio de Dados Completo (Exemplos)

ENTIDADE: CIDADE
Nome do Tipo Tam Descrio Mscara Regra Valores
Atributo Validao Vlidos
CdCidade integer 5 Cdigo da Cidade 99999 >0
NmCidade varchar 40 Nome da Cidade @! not null
SgEstado char 2 Sigla do Estado @! not null

ENTIDADE: BAIRRO
Nome do Tipo Tam Descrio Mscara Regra Valores
Atributo Validao Vlidos
CdBairro integer 5 Cdigo do Bairro 99999 >0
NmBairro varchar 40 Nome do Bairro @! not null

Faa um dicionrio completo

6.5 Projeto de Interface

Mostrar o layout de interface de um Cadastro, um Controle e um Relatrio.

7Anlise Conclusiva sobre o Projeto

Apresentar e discutir as dificuldades encontradas para a elaborao e desenvolvimento do projeto.

8Referncias Bibliogrficas

9Apndice
Todo material desenvolvido pelo prprio aluno, uma informao complementar, com o intuito de
complementar argumentao e desenvolvimento do projeto.

10 Anexo
Documento no elaborado pelo autor, que serve de fundamentao, comprovao e ilustraes.
Exemplo: documento usado como suporte para estabelecer requisitos e os modelos do projeto no
sub-tpico do captulo 6 que trata de Materiais de Referncia.