Documentação do programa
Qualquer texto escrito, ilustração ou vídeo que descreva um software ou programa para seus usuários é denominado program or software document. O usuário pode ser qualquer um, desde um programador, analista de sistema e administrador até o usuário final. Em vários estágios de desenvolvimento, vários documentos podem ser criados para diferentes usuários. De fato,software documentation é um processo crítico no processo geral de desenvolvimento de software.
Na programação modular, a documentação torna-se ainda mais importante porque diferentes módulos do software são desenvolvidos por diferentes equipes. Se qualquer pessoa que não seja a equipe de desenvolvimento quiser ou precisar entender um módulo, uma documentação boa e detalhada tornará a tarefa mais fácil.
Estas são algumas diretrizes para a criação dos documentos -
A documentação deve ser do ponto de vista do leitor
O documento deve ser inequívoco
Não deve haver repetição
Os padrões da indústria devem ser usados
Os documentos devem ser sempre atualizados
Qualquer documento desatualizado deve ser eliminado após o devido registro da eliminação
Vantagens da Documentação
Estas são algumas das vantagens de fornecer documentação do programa -
Mantém o controle de todas as partes de um software ou programa
A manutenção é mais fácil
Outros programadores além do desenvolvedor podem compreender todos os aspectos do software
Melhora a qualidade geral do software
Auxilia no treinamento do usuário
Garante a descentralização do conhecimento, cortando custos e esforços caso as pessoas saiam do sistema abruptamente
Documentos de exemplo
Um software pode ter muitos tipos de documentos associados a ele. Alguns dos mais importantes incluem -
User manual - Descreve instruções e procedimentos para usuários finais usarem os diferentes recursos do software.
Operational manual - Enumera e descreve todas as operações realizadas e suas interdependências.
Design Document- Oferece uma visão geral do software e descreve os elementos de design em detalhes. Ele documenta detalhes comodata flow diagrams, entity relationship diagramsetc.
Requirements Document- Possui uma lista de todos os requisitos do sistema, bem como uma análise de viabilidade dos requisitos. Pode ter casos de usuários, cenários da vida real, etc.
Technical Documentation - É uma documentação dos componentes de programação reais, como algoritmos, fluxogramas, códigos de programa, módulos funcionais, etc.
Testing Document - Ele registra plano de teste, casos de teste, plano de validação, plano de verificação, resultados de teste, etc. O teste é uma fase de desenvolvimento de software que precisa de documentação intensiva.
List of Known Bugs- Todo software tem bugs ou erros que não podem ser removidos porque foram descobertos muito tarde ou são inofensivos ou exigirão mais esforço e tempo do que o necessário para serem corrigidos. Esses bugs são listados com a documentação do programa para que possam ser removidos posteriormente. Também auxiliam os usuários, implementadores e pessoal de manutenção caso o bug seja acionado.