Software documentação permeia o ciclo de vida do software. É a parte visível do processo de software. Sem ele , o software não pode ser mantida . Sem ele, os usuários não podem treinar e eles praticamente não pode usar o software. Sem ela novos desenvolvedores teriam que re- inventar a roda no desenvolvimento de software . Documentação do software é a manifestação mais importante de software. É o guia através do labirinto de software . Definição de Documentação Software
manuais técnicos, manuais de usuário e outras instruções que facilitam o uso e operação de um produto ou serviço de software constituem documentação do software. Esta documentação pode incluir se necessário, o código-fonte , códigos de erro e seus significados. Documentação de software também podem existir em formato electrónico, como um arquivo PDF , como um CD ou como um livro.
Documentação Software Padrões
O Instituto de engenharia elétrica e eletrônica (IEEE) criou normas para a documentação de software da indústria de software. Chamado IEEE 1063-2001 , "Standard para Software Documentação do usuário ", este documento detalha o conteúdo , arquitetura e importância de um manual de documentação do software. A Organização Internacional de Normalização ( ISO) ea Comissão Eletrotécnica Internacional (IEC) também estabeleceram padrões para a documentação de software. Seus padrões são chamados de ISO /IEC 18019-2004 e ISO /IEC TR 9294 . Dirigem-se a documentação do software e da sua gestão , respectivamente. Cada um desses padrões enfatiza que a documentação de software é uma parte integrante do ciclo de vida do software.
Funções de Documentação Software
Todos os processos de ciclo de vida de software no desenvolvimento de qualquer software são registados como documentação do software. Documentação de software serve como informação escrita sobre definições de requisitos , especificações gerais do sistema , especificação de cada componente e os planos de teste e manutenção abrangentes. Ferramentas de gerenciamento de configuração também são muito úteis na documentação do software.
Software Documentação para Desenvolvedores
A importância da documentação do software para desenvolvedores de software reside no fato de que a documentação do software contém informações sobre as operações do sistema de software . Esta informação torna possível reproduzir o software ou adaptá-lo às manutenção.A tipo de informação documentada é geralmente vale milhões para a empresa de software. Tais informações poderiam ser perdidos se não documentados como desenvolvedores de ir e vir.
Software Documentação para usuários finais
Documentação Software ajuda os usuários finais apreciar o software mais rápido.
manuais do usuário final facilitar a interação do usuário final com o computador. Um manual de treinamento é um exemplo de um manual orientado ao usuário . Ele reduz o tempo de aprendizagem para utilização produtiva do software , poupando o usuário final milhões de dólares. Documentos do usuário final também pode ser um manual de referência que detalha o funcionamento do sistema ou um guia do administrador do sistema que detalha como operar e manter o sistema.
