O que é documentação?

Instruções para usar um dispositivo ou programa de computador. A documentação pode aparecer em uma variedade de formas, sendo as mais comuns manuais. Quando você compra um produto de computador (hardware ou software), quase sempre vem com um ou mais manuais que descrevem como instalar e operar o produto. Além disso, muitos produtos de software incluem uma versão online da documentação que você pode exibir na tela ou imprimir em uma impressora. Um tipo especial de documentação online é um sistema de ajuda, que tem a documentação embutida no programa. Os sistemas de ajuda são freqüentemente chamados de sensíveis ao contexto porque exibem informações diferentes dependendo da posição do usuário (contexto) no aplicativo.

A documentação geralmente é dividida nas seguintes categorias:

instalação: Descreve como instalar um programa ou dispositivo, mas não como usá-lo.

referência: Descrições detalhadas de itens específicos apresentados em ordem alfabética. A documentação de referência é projetada para pessoas que já estão um pouco familiarizadas com o produto, mas precisam de lembretes ou informações muito específicas sobre um determinado tópico.

tutorial: Ensina o usuário a usar o produto. Os tutoriais avançam em um ritmo mais lento do que os manuais de referência e geralmente contêm menos detalhes.

Um lamento frequente dos usuários de computador é que sua documentação é inescrutável. Felizmente, essa situação está melhorando, em grande parte graças aos avanços nos sistemas de ajuda e tutoriais online. Essas formas de documentação tornam muito mais fácil fornecer as informações específicas de que um usuário precisa, quando ele ou ela precisa.