Não cada um tem escrito documentação do software , mas todo mundo já leu a documentação do software que deixou muito a desejar. Quando estamos olhando para encontrar informações sobre um pedaço de software, nós queremos saber o que faz, o que os sistemas operacionais e outros programas que ele trabalha, como podemos obtê-lo , e quanto custa . Coisas que você precisa
Um pedaço de software
Show Mais instruções
Diferentes tipos de documentação de software
1

escrever o que o software faz . Após a leitura deste documento , o leitor deve ser capaz de determinar se ele necessita de software . Certifique-se de incluir todas as capacidades , o que muitas vezes pode ser uma lista de todas as funcionalidades do software.
2

explicar como o software funciona em relação a outras peças de software. Isso pode mencionar outras peças de software que são considerados ser competitors.Be -se de delinear o que este software faz de forma diferente do que os outros .
3

Delinear os tipos de interfaces e códigos que são utilizados no software . Esta seção deve deixar o leitor saber que tipo de conhecimento que um usuário deve ter para trabalhar com este pedaço de software. Esta parte da documentação do software é usado por programadores e outros técnicos.
4

Faça um documento para o usuário do software de modo que qualquer um que lê vai ser capaz de começar a usar o programa. Estes tipos de documentação pode ser tutoriais. Eles também podem ser listas de comandos ou índices de onde os usuários podem encontrar as informações relevantes .
5

Escrever documentação que as pessoas de vendas pode usar quando eles estão vendendo o software.Make certeza de que você tenha incluído todas as capacidades e pontos de venda do software.