A organização é a forma como pedaços de informações são reunidos de forma coerente e que faça sentido para o usuário.

É necessário organizar informações em um tópico assim como dois ou mais tópicos são organizados entre si. Uma boa organização facilita as manutenções e alterações na documentação.

Informações bem organizadas são fáceis de localizar, especialmente quando fica claro para o usuário a forma como a documentação está organizada. Também facilita a reutilização por parte dos escritores.

Para uma boa organização, siga as orientações abaixo:

1. Organize a informação em tópicos discretos por tipo

Tópicos são pedaços pequenos, discretos e significativos de informações com um título.

Um tópico precisa ser longo o suficiente para cobrir um assunto adequadamente, e fazer sentido se lido separadamente. Porém, tópicos em geral são curtos e, portanto, mais localizáveis, contento apenas a informação que os usuários precisam.

Em geral, informações técnicas possuem três tipo de tópicos:

Organize a informação em tópicos de acordo com o tipo para mantê-los discretos e mantenha a consistência da estrutura em todos os tópicos, para o que o usuário saiba o que esperar.

2. Organize tarefas por ordem de uso

Os usuários geralmente completam procedimentos em uma certa ordem, por conta disto, a informação deve ser arranjada para acompanhar esta ordem. 

Se para o usuário executar no procedimento de instalação é necessário realizar configurações, os tópicos devem ser arranjados para que o procedimento de configuração preceda o procedimento instalação. 

Organizar as tarefas de forma lógica é importante não somente a nível de tópicos, mas também em relação aos passos e sentenças de cada tópico de tarefa.

3. Organize tópicos para fácil localização

Além de organizar os tópicos por ordem de uso, você precisa encaixar conceitos e tópicos de referência na estrutura do texto de modo que faça sentido para o usuário.

Se o conceito e tópicos de referência estão associados a uma tarefa em particular, você pode colocá-los no tópico da tarefa. No entanto, alguns conceitos e referências não pressupõe uma tarefa ou não se adequam a estrutura do tópico de tarefa, nesses casos, você dever organizar os tópicos para fácil localização.

Tópicos de conceito ou referência são geralmente organizados em ordem alfabética, mas pode ser utilizada outra organização como por categoria, de acordo com o que facilitar a experiência do usuário.

4. Separe informações contextuais de outros tipos de informações

Informações contextuais explicam as janelas e campos do produto, assim como controles que o usuário irá utilizar. Essa informação pode incluir sintaxes para um campo, condições para quando um controle é habilitado, o que o controle faz, ou até como usar a janela de um produto. 

Utilizá-las em tarefas pode tornar o tópico longo e torna difícil para o usuário entender o sentido do procedimento.

5. Organize a informação de forma consistente

Organizar a informação de forma consistente auxilia o usuário a se familiarizar com a estrutura da informação, de forma que achem a informação facilmente, porque o usuário saberá qual informação irão localizar e onde achar.

6. Providencie um número apropriado de subitens para cada ramo

Se um esquema de navegação contém um ramo que possui somente um subitem, este esquema pode ter um problema de organização, porque se há somente um coisa a falar a nível de subitem, provavelmente o mesmo não é necessário.

Ramos podem conter um somente um subitem, apenas quando o mesmo apresentar um tópico que é separado do ramo mas ainda assim é logicamente subordinado ao mesmo. Por exemplo, se seus procedimentos possuem exemplos longos, você pode separá-los em tópicos.

Assegure-se que cada subitem é logicamente subordinada ao tópico pai.

7. Enfatize pontos principais; subordine pontos secundários

Você pode utilizar enfatização e subordinação para distinguir pontos principais de informação de suporte. Usuários precisam de uma forma de distinguir as tarefas principais das secundárias; senão perdem o foco do ponto principal.

Utilize as técnicas abaixo para enfatizar o ponto principal:

• Localização: Colocar tópicos primeiro ou palavras é a melhor forma de enfatizar um ponto: no título, na introdução, na primeira sentença ou primeira palavra.
• Introdução: Uma introdução ou overview deve indicar para o usuário porque a informação é importante e como a mesma é relevante. 
• Repetição e reforço: Repetição ajuda o usuário a não esquecer um ponto, mas a repetição efetiva apresenta a informação em mais de uma forma, como texto, exemplos e ilustrações.
• Detalhes: Dê mais detalhes sobre um tópico importante e poucos detalhes num tópico menos importante.

8. Revele como as partes se encaixam

Quando usuário encontra uma informação pela primeira vez, ele geralmente quer vê-la como parte de um todo.

Para isso utilize:

• Painéis de navegação ou site map.
• Tópicos de overview que deixam claro o relacionamento dos subtópicos.
• Transições e links entre tópicos que transmitam relacionamento de um tópico com o outro.
• Breadcrumbs com a lista de tópicos visitados.
• Botões que levem o usuário ao tópico anterior ou próximo tópico.