Tipos de Documentação de Software

Índice:

Anonim

Se você já viu um diretório de computador em uma unidade de rede em sua empresa chamado "documentos de software" ou "guias de software" e consultou os documentos que tinha permissão para visualizar, provavelmente percebeu que o número de documentos e tipos de documentos para software é numerosos. Também parece que alguns documentos colocados em uma categoria se aplicam a outras categorias também. Documentos de software são usados ​​em todos os estágios de um ciclo de vida típico de software, de modo que é um bom lugar para investigar o tipo de documentos criados.

Proposta

Uma proposta de software especifica os requisitos do sistema de software e delineia a finalidade do software e os problemas que ele resolve. Ele também especificará o tempo estimado que o projeto de software levará e outros fatores que afetam a proposta.

Estudo de viabilidade

O estudo de viabilidade geralmente ocorre no início do projeto. Esta etapa determina se a fábrica de software satisfaz as necessidades de negócios do cliente. O resultado de um estudo de viabilidade decide se um projeto irá adiante ou não.

Análise de Requisitos

Uma análise de requisitos fornece os meios para traduzir os requisitos de negócios em soluções de software automatizadas. Um consultor externo ou gerenciamento de empresa geralmente executa essa tarefa. Os requisitos traduzem requisitos de negócios em especificações reais de hardware, software e componentes.

Documentos de design

Documentos de design fornecem a base para o desenvolvimento de software começar em um nível técnico. Como o nome sugere, vários projetos gráficos e textuais para bancos de dados, interfaces, comunicações, desenvolvimentos da Web e outros aspectos do software serão projetados antes que a codificação possa ser iniciada.

Codificando Documentos

Os documentos de codificação referem-se ao código-fonte real usado para a programação do software. O código pode ser escrito em qualquer número de linguagens de computador disponíveis, incluindo Java, C ++, PHP e centenas de outros idiomas de computador, dependendo do sistema usado.

Documentos de teste

Equipes de teste e desenvolvedores criam documentos de teste em vários estágios do ciclo de vida do software. Os desenvolvedores criam documentos de teste de unidade para seu próprio código. A equipe de teste ou outras pessoas não diretamente associadas ao código realizam testes de integração e testes de requisitos de negócios.

Guias do usuário e marketing

Guias do usuário fornecem instruções sobre como o novo software funciona. Se o sistema for grande e complexo, os guias do usuário geralmente são apoiados por cursos formais de treinamento para a equipe. Documentos de marketing ilustram os benefícios do novo sistema de software para clientes em potencial.

Licenças de Software

A emissão de licenças de software torna o uso legal do software no que diz respeito ao usuário final. Os usuários usam o software sob os termos de uma licença de software emitida pela empresa de criação. Nem todos os softwares têm termos de licenciamento estritos, e isso é particularmente verdadeiro no caso do código aberto. Geralmente, os sistemas de software possuem algum tipo de documento de licenciamento que especifica como e onde o software pode ser usado.