Guia Completo de Documentação de Projetos de Software

Estudo de Viabilidade do Projeto

Este estudo abrange:

• Uma breve descrição do sistema proposto e suas características.
• Breve descrição dos requisitos de negócio para o sistema proposto.
• Proposta de organização da equipe de desenvolvimento e definição de responsabilidades.
• Custos do estudo, incluindo estimativas de datas para planejamento e entrega dos produtos.
• Estudo dos benefícios para o sistema.

Análise e Captura de Requisitos

Esta fase inclui:

• Análise do sistema atual (se houver) e levantamento de novos requisitos dos utilizadores.
• Descrição detalhada do sistema proposto.

Especificação do Sistema

A especificação do sistema detalha:

• Descrição geral do sistema.
• Requisitos de dados.
• Requisitos de telecomunicações.
• Requisitos de hardware.
• Plano de teste.

Design e Integração

Esta etapa compreende:

• Descrição detalhada do sistema: programas, módulos reutilizáveis e objetos.
• Arquivos e bancos de dados.
• Transações.
• Dicionário de Dados.
• Procedimentos.
• Sistema de carga e tempos de resposta.
• Interfaces (homem-máquina).
• Descrição dos comandos do sistema proposto.
• Projetos alternativos recomendados.
• Normas de programação e recomendações de projeto do programa.
• Técnicas de implantação recomendadas: codificação própria, compra de pacotes, terceirização, etc.

Plano de Testes de Programas

Este plano detalha os testes a serem realizados.

Codificação e Documentação

Esta fase inclui a criação e documentação de:

• Documentos do projeto final do sistema e de cada programa.
• Diagramas finais do sistema e dos programas.
• Descrição detalhada da lógica de cada programa.
• Descrição das entradas e saídas (quadros, telas, listas, etc.).
• Lista de programas contendo comentários.
• Cadeias de execução, se necessário (JCL, scripts, etc.).
• Resultados dos testes para cada unidade.
• Resultados dos testes para cada programa.
• Resultados dos testes de integração.
• Guia para os operadores do sistema.
• Programa de formação para os operadores.

Manual do Usuário do Sistema

O manual do usuário é um guia essencial para a operação do sistema.

Testes do Sistema

Esta fase de testes abrange:

• Plano de Teste do Sistema (atualizado).
• Relatório dos resultados do teste.
• Descrição dos ensaios, o resultado esperado e as medidas para corrigir desvios.

Documentação dos Resultados de Teste

Esta documentação inclui os resultados detalhados dos testes.

Instalação do Sistema

A fase de instalação detalha:

• Planos pormenorizados para contingências operacionais, falhas de sistema e recuperação.
• Plano de revisão pós-instalação.
• Relatório de instalação.
• Carta de aceitação do sistema.

Manutenção do Sistema

A manutenção envolve:

• Lista de falhas detectadas no sistema.
• Lista das melhorias solicitadas pelos usuários (que não dão origem a novos projetos).
• Rastreamento detalhado das mudanças no sistema.
• Ata da revisão periódica e aceitação dos níveis de suporte do sistema.