O que é documentação de software?
Software refere-se a rotinas e programas desenvolvidos para um sistema de computador que permitem o uso para executar tarefas ou interagir com o computador. O software pode ser fornecido pelo fabricante como um componente do sistema ou criado como aplicativos separados pelo fabricante ou por terceiros. Documentação é uma descrição de um produto e como usá-lo. A documentação do software descreve os aplicativos e como usá-los.
A documentação impressa do software, às vezes referida como manuais de software, geralmente é configurada como um livro, com uma página de título, índice, corpo e índice, e geralmente possui alguns componentes típicos. O primeiro componente que a maioria dos usuários precisa é de um guia de instalação, e são fornecidos guias separados para os vários sistemas operacionais em que o software trabalha, conforme necessário. O guia de instalação lista as especificações necessárias para executar o software, incluindo sistemas operacionais de computador, RAM, espaço no disco rígido, uma conexão com a Internet e 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, DVD ou 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, são geralmente explicados.
Um guia de “início rápido” costuma ser a próxima parte da documentação do software impresso usada. Pegando onde o guia de instalação termina, o guia Início 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, conforme o software específico. Um método popular para aplicativos orientados a tarefas é uma introdução baseada em projeto, na qual o usuário aprende a funcionalidade básica do software enquanto realiza algumas mini-lições.
Outros elementos que se esperaria encontrar na documentação impressa do software incluem um detalhamento completo dos recursos, com ênfase nos recursos novos para a 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 "avançados". Jogos e outros aplicativos de software podem incluir dicas ou dicas na documentação.
A documentação impressa do software não é o único tipo. Em primeiro lugar, a documentação impressa também pode estar disponível online ou em pdf. Documentação adicional também pode estar disponível na forma de dicas de ferramentas e telas de ajuda no próprio aplicativo, FAQs - listas de perguntas freqüentes, além de respostas, artigos pesquisáveis, treinamento na web, vídeos e outros formatos.
A documentação do software varia bastante na qualidade, e isso é particularmente verdade nos manuais de software. Os bons podem ser excelentes, enquanto os 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 do software.