Documentação de Software

Documentação de um
Produto de Software

Projeto: xxxxxxxxx

Disciplina de Engenharia de Software III

Profa. Dra. Ana Paula Gonçalves Serra

Autores:
Xxxxxxxxxxxxxxxxxxxx
Xxxxxxxxxxxxxxxxxxxxx

2014 ÍNDICE

1. INTRODUÇÃO 3
2. REQUISITOS DO SISTEMA 3
2.1. REQUISITOS FUNCIONAIS 3
2.2. REQUISITOS NÃO-FUNCIONAIS 4
2.3. PROTÓTIPO (OPCIONAL) 4
3. ANÁLISE 5
3.1. DIAGRAMA DE CLASSES DE ANÁLISE (MODELO DO DOMÍNIO) 5
4. PROJETO 6
4.1. ARQUITETURA DO SISTEMA 6
4.2. REALIZAÇÃO DE CASOS DE USO 6
4.3. DIAGRAMA DE ATIVIDADES 7
4.4. DIAGRAMA DE ESTADOS 8
4.5. DIAGRAMA DE COMPONENTES (OPCIONAL) 8
4.6. MODELO DE DADOS (OPCIONAL) 9
5. IMPLEMENTAÇÃO (OPCIONAL) 9
6. TESTES 9
6.1. PLANO DE TESTES 9
6.2. EXECUÇÃO DO PLANO DE TESTES 9

1. Introdução
O objetivo deste capítulo é apresentar uma visão geral do sistema, ou seja, uma descrição do projeto a ser desenvolvido, pesquisas realizadas, processo de desenvolvimento de software utilizado, método de trabalho e ferramentas.

2. Requisitos do Sistema
Este capítulo tem como objetivo descrever os requisitos do sistema.
2.1. Requisitos Funcionais
Neste item devem ser apresentados os requisitos funcionais que especificam ações que um sistema deve ser capaz de executar, ou seja, as funções do sistema. Os requisitos funcionais geralmente são melhor descritos em diagramas de caso de uso, juntamente com o detalhamento dos atores e de cada caso de uso.
A seguir é apresentada a notação básica de um diagrama de caso de uso.

Notação básica do diagrama de caso de uso.

Cada ator do diagrama de caso de uso deve ser descrito de forma sucinta (2 linhas) e cada caso de uso deve ser especificado. A seguir são apresentados itens básicos para a especificação dos casos de uso do diagrama.
 Nome do Caso de Uso
 Breve descrição
 Atores envolvidos
 Fluxo Principal ou Básico
 Fluxos Alternativos
 Pré-condições
 Pós-condições;
2.2. Requisitos