O que é documentação de software?
Software refere -se a rotinas e programas desenvolvidos para um sistema de computador que permite que o uso execute tarefas ou interaja com o computador. O software pode ser fornecido pelo fabricante como um componente do sistema, ou criado como aplicativos separados pelo fabricante ou terceiros. A documentação é uma descrição de um produto e como usá -lo. A documentação do software descreve aplicativos de software e como usá -los. O primeiro componente que a maioria dos usuários precisa é um guia de instalação e os guias separados são fornecidos para os vários sistemas operacionais em que o software funciona, conforme necessário. O guia de instalação lista as especificações necessárias para executar o software, incluindo sistemas operacionais (s) de computador, RAM, espaço do disco rígido, um conectio à Internetn, e quaisquer outros requisitos ou complementos, como periféricos. Isso é seguido com instruções passo a passo para instalação, que podem ser de um CD-ROM, um DVD ou um download, por exemplo. Quaisquer recursos incomuns do instalador e explicação de opções de instalação personalizadas, como locais alternativos ou instalações simplificadas, geralmente são explicadas.
Um guia de "início rápido" geralmente é a próxima parte da documentação de software impressa usada. A captura de onde o guia de instalação sai, o guia de partida rápido ajuda o usuário a iniciar o software e suas operações básicas. Esta seção pode ser organizada de várias maneiras, como combina com o software específico. Um método popular para aplicativos orientados a tarefas é uma introdução baseada em projetos na qual o usuário aprende a funcionalidade básica do software enquanto conclui algumas mini-lições.
Outros elementos que se expulsariat para encontrar na documentação de software impresso inclui uma execução completa dos recursos, com ênfase nos recursos novos na versão mais recente; uma lista de atualizações desde as versões anteriores, possivelmente incluindo bugs corrigidos; informações sobre como obter suporte técnico; explicações de mensagens de erro; e informações para usuários avançados ou "poder". Jogos e outros aplicativos de software podem incluir folhas de trapaça ou dicas em sua documentação.
A documentação de software impressa não é o único tipo. Primeiro de tudo, a documentação impressa também pode estar disponível on -line ou como um PDF. A documentação adicional também pode estar disponível na forma de dicas de ferramentas e telas de ajuda no próprio aplicativo, perguntas frequentes - listas de perguntas frequentes, além de respostas, artigos pesquisáveis, treinamento na web, vídeos e outros formatos.
A documentação do software varia bastante em qualidade, e isso é particularmente verdadeiro nos manuais de software. Os bons podem ser excelentes, enquanto oOS que não são bem executados podem deixar os usuários com muitas perguntas. Também existem usuários que não se preocupam em pesquisar na documentação antes de fazer perguntas nos fóruns do fabricante de software.