A documentação do sistema consiste em material escrito usado para descrever as aplicações de um sistema de hardware ou software. A documentação pode ser exibida como manuais impressos, cartões flash, páginas da Web ou texto de ajuda na tela. A documentação do sistema é um componente vital do sucesso de qualquer sistema de computador. No entanto, muitos desenvolvedores têm dificuldade em criar documentação suficiente para seus produtos. Diferentes tipos de documentação têm objetivos diferentes, portanto, o conteúdo de qualquer documentação dependerá do seu público-alvo.
Documentação do projeto
O objetivo da documentação do projeto descreve o projeto como um todo. A documentação do projeto oferece aos executivos, gerentes e funcionários uma visão ampla dos métodos, recursos e objetivos propostos pelo projeto. Os documentos da proposta do projeto mostram aos executivos as metas e o orçamento do projeto. As especificações técnicas descrevem os requisitos de hardware e software para os projetos. O plano do projeto detalha as etapas que os programadores, técnicos e projetistas executarão para atingir os objetivos do projeto.
Documentação de teste
Os documentos de teste ilustram os planos para testar o produto antes de seu lançamento. O departamento de garantia de qualidade desenvolve planos de teste para usuários internos "alfa" e testadores "beta" externos.A documentação do teste inclui instruções de teste - como um conjunto específico de etapas que os testadores devem seguir - para determinar se o produto está funcionando conforme planejado. Funcionários de QA também coletam logs de problemas, listas de bugs e relatórios de testadores.
Documentação da equipe
A troca de idéias entre os membros da equipe é vital para o sucesso de um projeto. A documentação da equipe registra essas trocas para uso no projeto atual e em projetos futuros. Planos de equipe, cronogramas e atualizações de status são os principais componentes da documentação da equipe. Listas de verificação ajudam os gerentes de projeto a ver quais tarefas a equipe concluiu. As atas das reuniões da equipe permitem que os gerentes acompanhem vários problemas, sugestões e tarefas entre os membros da equipe.
Documentação do usuário
O elemento mais importante da documentação do sistema é o conteúdo que chega ao cliente. A documentação do usuário deve estar livre de jargões excessivamente técnicos e conter linguagem clara e concisa. O manual do usuário é normalmente o principal componente da documentação do usuário, mas os usuários também contam com outras fontes. Recursos de treinamento - incluindo manuais e vídeos - podem ajudar os usuários a entender de maneira rápida e fácil como o sistema funciona. Quando o sistema não funciona como esperado, um guia de solução de problemas pode ajudar o usuário a encontrar e resolver o problema.
