Documentação de Software

FACULDADE DE PIMENTA BUENO - FAP
SISTEMAS DE INFORMAÇÃO

LEVANTAMENTO DE DOCUMENTAÇÃO DE SOFTWARE

Trabalho apresentado a Faculdade de Pimenta Bueno, como requisito parcial para obtenção de nota na disciplina de Estágio Supervisionado II, ministrado pelo prof. Marcos Siqueira, referente a atividade do mês de Fevereiro de 2014.

PIMENTA BUENO
2014
Documentação de Software

Você já imaginou construirmos uma casa sem uma planta? O que você faria se um dia esta mesma casa apresentasse um problema estrutural (digamos algo chato, como um vazamento de água de origem desconhecida)? Derrubaria parte por parte do imóvel até encontrar o problema? Recorreria à demolição (e posterior reconstrução) completa e faria tudo novamente? Creio que esta seja uma analogia adequada quando tratamos de documentação de software. Da mesma forma que os imóveis e demais construções de grande complexidade, a engenharia de software também requer uma gama de documentos que preparam o programador não só para a construção do software, como também para a devida manutenção do mesmo. A documentação de software tem, em sua essência, duas principais funções: permitir a boa direção/manutenção/atualização na criação de programas por parte dos desenvolvedores e assegurar, através destes mesmos documentos, exatamente os objetivos e funções do software ao cliente, em forma de uma diversidade de documentos que variam em forma e objetivos. Se tentarmos ser um pouco mais específicos, poderemos subdividir a documentação em algumas partes:

Requisitos de software

Neste documento, resumidamente, estarão presentes exatamente quais as funções do software, ou seja, o que ele faz ou pretende fazer. Este documento se aplica especialmente no início da fase de desenvolvimento, quando as partes envolvidas (a empresa de desenvolvimento e seu cliente) descrevem em acordo quais serão as tarefas que o software deverá ser capaz de executar e, ao mesmo tempo, asseguram o cliente