Do ponto de vista do usuário, uma documentação completa possui todas as informações necessárias. Se eles precisam de informações para solução ou uma explicação dos códigos de erro ou um passo específico em um procedimento e esta informação não estiver lá, então a documentação está incompleta para eles.

Um assunto é coberto completamente quando toda a informação relevante é descrita, cada assunto é abordado em detalhes suficientes e toda a informação prometida está incluída.

Para desenvolver um documento completo é necessário identificar previamente o que deve ser incluído, para isso:

• Conhecer o seu público, conforme já abordado nos demais tópicos, para determinar até que nível deverá detalhar a informação ou qual informação deverá fornecer.
• Entender o propósito da informação que você está criando, por exemplo, os usuários estarão executando alguma tarefa? Aprendendo algum conceito?
• Entender o que o usuário está tentando realizar e quando. Isso irá ajudá-lo a saber quais informações são relevantes e quando precisam da informação, porque o fornecimento de informações na hora errada as tornam irrelevantes.

Para tornar a informação completa, siga estas orientações:

1. Cubra todos os tópicos que suportam as tarefas do usuário e apenas esses.

Para garantir que cobriu todos os tópicos, avalie as perguntas abaixo:

• Você cobriu todas as tarefas principais?
• Você descreveu todas as sub-tarefas que o usuário precisa para realizar as tarefas principais?
• Você explicou as razões e condições relacionadas a tarefas opcionais?
• Você explicou o que fazer se acontecer algo errado?
• Quando necessário você explicou os conceitos, algum processo ou esclareceu os benefício na introdução de um tópico? Lembrando que são conceitos e não informações internas do produto.

2. Detalhe cada tópico apenas com a informação que o usuário precisa.

Coloque apenas as informações necessárias para realizar tarefa. Falta de informação impossibilita o usuário de executar a tarefa, já informação a mais torna a execução da tarefa mais lenta, dificulta o entendimento e localização.

Novamente, é importante saber qual a sua audiência e escrever apenas o que é necessário para essa audiência realizar a tarefa.

Um desafio na escrita da documentação é atender públicos alvos com níveis de conhecimento diferentes, nesses caso utilize algumas das abordagens abaixo:

• Crie tópicos separados de conceito, tarefas e tópicos relacionados. Crie link entre o tópico de tarefa e tópico de conceito e referência, para que o usuário tenha fácil acesso ao que precisa.
• Inclua referências de pesquisa online, mesmo em documentações impressas, para o usuário mais novo.
• Crie uma documentação única, mas separe os tópicos em tópicos avançados para o usuário avançado e tutoriais para os iniciantes, de forma, que isso fique claro para todos os tipos de usuários.
• Integre a informação mas deixe graficamente claro para o usuário a diferença entre os níveis de experiência.

3. Use padrões de informação para garantir a cobertura necessária.

Um padrão é um dispositivo operacional que você pode utilizar para criar uma documentação consistente.

Utilize um padrão de organização da informação, ele ajuda a focar na escrita e garantir que escreveu tudo que é necessário, por exemplo, todo tópico de tarefa contém:

1. Título.
2. Introdução.
3. Pré-requisitos.
4. Passos da tarefa.
5. Links para documentação relacionada.

4. Apenas repita a informação quando o usuário tiver algum benefício.

Repetição é bom quando enfatiza ou reforça um ponto ou evita que o usuário precise acessar outro tópico ou página, minimizando o esforço para acessar uma informação relacionada. Repetição também é boa quando não sabemos onde o usuário irá preencher a informação.