Os Tipos de Documentações de Software
Por Gabriel e Margareth
Descreve o tipo de documentação que deve ser produzida no
desenvolvimento de software.
Qualquer software deve ter uma quantidade razoável de
documentação.
Documentos de trabalho, manuais de usuário produzidos
profissionalmente.
Em geral, a maioria destes documentos é produzida por
engenheiros de software.
Uma parte considerável dos custos de um protejo pode ser
gasta com documentação.
TIPOS DE DOCUMENTAÇÃO
É produzida para que o processo de desenvolvimento do
software seja administrável.
Registram os processos de desenvolvimento e manutenção do
software.
Descrê o software que esta sendo desenvolvido.
Planos, estimativas e cronogramas, produzidos pro
gerentes.
Usados para prever e controlar o processo.
Relatórios
Descrevem como os recursos foram utilizados durante o
desenvolvimento do software
Padrões.
Estabelecem como o processo de ser implementado.
Podem ser organizacionais, nacionais, ou internacionais.
Documentação do Produto
Descreve o software produzido Tem vida longa e deve estar sempre atualizada em relação ao código Divide-se em: Documentação do usuário Documentação do sistema.
Descreve o software produzido Tem vida longa e deve estar sempre atualizada em relação ao código Divide-se em: Documentação do usuário Documentação do sistema.
Documentação do Usuário.
Deve levar em conta os diversos tipos de usuários. Exemplo: Usuários finais Usam o software para auxiliá-los em alguma tarefa Não estão interessados em detalhes técnicos ou administrativos. Administradores do sistema Responsáveis pela administração do software Ex: operadores, gerentes de rede, etc.
Deve levar em conta os diversos tipos de usuários. Exemplo: Usuários finais Usam o software para auxiliá-los em alguma tarefa Não estão interessados em detalhes técnicos ou administrativos. Administradores do sistema Responsáveis pela administração do software Ex: operadores, gerentes de rede, etc.
Documentação do Usuário
Descrição funcional do sistema Requisitos gerais do sistema Serviços fornecidos por ele Manual de introdução Apresenta uma introdução informal do sistema e descreve seu uso normal Deve explicar como começar a usar o sistema e como os usuários podem utilizar as facilidades oferecidas pelo sistema.
Descrição funcional do sistema Requisitos gerais do sistema Serviços fornecidos por ele Manual de introdução Apresenta uma introdução informal do sistema e descreve seu uso normal Deve explicar como começar a usar o sistema e como os usuários podem utilizar as facilidades oferecidas pelo sistema.
Referência
Comentários
Postar um comentário