Clique aqui para acessar a checklist de documentação recuperável.

 

Recuperabilidade é a característica da informação que permite o usuário encontrar uma informação específica. Uma boa recuperabilidade garante que os usuários não fiquem perdidos em um labirinto de informações. Muitos elementos contribuem para uma boa recuperabilidade, por exemplo, sumários, índices, links, tópicos, marcadores, e painéis de navegação.

Se os usuários não podem encontrar o que procuram, não importa quanto precisa, completa ou orientada à tarefa a informação é.

Para desenvolver informações com boa recuperabilidade, siga estas orientações:

1. Facilite a navegação e pesquisa

Prover uma boa navegação, possibilita o usuário navegar entre tópico ou páginas e mantém o usuário orientado e consciente da localização corrente.

Mecanismos de busca são o métodos que os usuários mais utilizam e dependem para localizar a informação.

Quando você desenvolver informações técnicas inclua os itens abaixo para facilitar a navegação e pesquisa:

  • Mecanismos de busca visíveis em todas as páginas.
  • Links de navegação para página principal, item de nível superior e sumário. 
  • Deixe claro a localização atual, através de breadcrumbs ou áreas de navegação com o tópico atual selecionado.

2. Providencie um índice completo e consistente

Em documentação técnica, tanto online quanto impressa, em sistemas de ajuda ou na Web, os usuários geralmente vão para o índice primeiro para buscar informações. Você precisa prever quais informações os usuários irão procurar, e quais palavras eles esperam como indicadores para aquela informação.

Índices devem ter uma entrada para cada assunto importante que a documentação contém.

Siga as orientações abaixo para criar índices:

  • Indexe cada tarefa, conceito ou tópico de referência.
  • Inicie cada entrada do índice com um verbo ou substantivo especifico.
  • Evite entradas no índice que iniciem com termos genéricos, como usar, gerenciar, mudar.
  • Se utilizou níveis ponha pelo menos dois itens em cada nível.
  • Não indexe tópicos contextuais.
  • Não utilize muitas variações de uma mesma entrada, considere que será utilizado o mecanismo de busca.

3. Use um nível de detalhe apropriado no sumário

A informação é frequentemente subdividida em muitos níveis, com tópicos para cada subdivisão.

Um sumário deve providenciar não somente o principal assunto dos tópicos, mas permitir aos usuários ver facilmente a hierarquia destes tópicos.

Um sumário com boa qualidade tem no máximo 3 níveis de hierarquia, a menos que o usuário possa expandir as seções.

4. Utilize tamanho adequado para os textos

Poucas coisas em informações técnicas complexas são mais desencorajadoras do que longos blocos de texto, sem quebras de tópicos, gráficos ou outros elementos visuais.

Procure manter os parágrafos com três a cinco sentenças no máximo, mas lembre-se que a facilidade de entendimento depende no conteúdo e tamanho das sentenças, bem como a complexidade da estrutura da sentença.

5. Utilize links corretamente

Links são essenciais na escrita técnica, se você usar um conjunto apropriado de links, conseguirá aumentar a recuperabilidade das informações. Porém, se os links não são uteis, ou se você utilizar muitos ou poucos links, a leitura do usuário será interrompida sem razão.

Links proveem:

  • Informações sobre tópicos relacionados.
  • Navegação dentro do tópico corrente ou documento.
  • Navegação num site ou domínio.
  • Acesso a informação relacionada.

6. Crie links úteis

Outra consideração sobre links é o texto e estilo dos links. O texto do link deve deixar claro o tipo de informação que está sendo referenciada.

Siga as orientações abaixo para criar links úteis:

  • Garanta que a descrição do link descreve a informação ao qual está linkado.
  • Em links similares ou referências cruzadas, enfatize o texto que é diferente.
  • Minimize o esforço necessário para acessar a informação relacionada.
  • Evite links redundantes.
  • A informação linkada deve ser fácil de achar no tópico de destino.