A documentação dos programas é um aspecto sumamente importante, tanto no desenvolvimento da aplicação como na manutenção da mesma. Muita gente não faz esta parte do desenvolvimento e não se dá conta de que perde a possibilidade da reutilização de parte do programa em outras aplicações, sem necessidade de conhecer o código no dedo.

A documentação de um programa começa com a construção do mesmo e finaliza justo antes da entrega do programa ou aplicação ao cliente. Mesmo assim, a documentação que se entrega ao cliente terá que coincidir com a versão final dos programas que compõem a aplicação.

Uma vez concluído o programa, os documentos que se devem entregar são um guia técnico, um guia de uso e de instalação.

Tipos de documentação

A documentação que se entrega ao cliente se divide claramente em duas categorias, interna e externa:

• Interna: É aquela que se cria no mesmo código, já pode ser em forma de comentários ou de arquivos de informação dentro da aplicação.
• Externa: É aquela que se escreve em cadernos ou livros, totalmente alheia à aplicação em si. Dentro se esta categoria também se encontra a ajuda eletrônica.

A guia técnica

No guia técnico ou manual técnico se refletem o design do projeto, a codificação da aplicação e as provas realizadas para seu correto funcionamento. Geralmente este documento está desenhado para pessoas com conhecimentos de informática, geralmente programadores.

O principal objetivo é o de facilitar o desenvolvimento, a correção e a futura manutenção da aplicação de uma forma rápida e fácil.

Este guia está composto por três seções claramente diferenciadas:

• Caderno de carga: É onde fica refletido a solução ou design da aplicação.
  Esta parte do guia é unicamente destinada aos programadores. Deve estar realizado de tal forma que permita a divisão do trabalho.
• Programa fonte: É onde se inclui a codificação realizada pelos programadores. Este documento pode ter, por sua vez, outra documentação para sua melhor compreensão e pode ser de grande ajuda para a manutenção ou o desenvolvimento melhorado da aplicação. Este documento deve ter uma grande clareza em sua escritura para sua fácil compreensão.
• Provas: é o documento onde se especificam o tipo de provas realizadas ao longo de todo o projeto e os resultados obtidos.

O guia de uso

É o que comumente chamamos o manual do usuário. Contem a informação necessária para que os usuários utilizem corretamente a aplicação.

Este documento é feito através do guia técnico, porém se suprimem os tecnicismos e se apresenta de forma que seja entendível para o usuário que não seja experiente em informática.

Um ponto a ter em conta em sua criação é que não deve fazer referência a nenhuma seção do guia técnico e no caso de que faça uso de algum tecnicismo deve ir acompanhado de um glossário ao final da mesma para sua fácil compreensão.

O guia de instalação

É o guia que contém a informação necessária para implementar tal aplicação.
Dentro deste documento encontram-se as instruções para o andamento do sistema e as normas de utilização do mesmo.

Dentro das normas de utilização incluem-se também as normas de segurança, tanto as físicas como as referentes ao acesso à informação.