Títulos e sumários devem conter o máximo de informações sobre o texto a que se refere, de modo que ajude os leitores a localizar a informação rapidamente.
Para procedimentos em documentações no formato de FAQ, utilize perguntas que representam a pergunta do leitor.
Errado Correto Criando um novo documento Como Criar um Novo Documento no Confluence?
Nas demais situações, utilize uma frase nominal, evite títulos ambíguos de uma palavra apenas. Estes tipos de tópicos não tem sentido quando vistos fora do contexto.
Errado Correto Autenticação Opções de Autenticação do Sistema.
- Mantenha os títulos curtos, porém tão significativos quanto possível.
- Posicione a palavra mais importante primeiro.
Evite utilizar gerúndios, porém caso um tópico possua um gerúndio, mantenha todos os outros tópicos no mesmo padrão.
Errado Correto Definindo instancias do servidor da aplicação
Visualizando informações do servidor
Implantação de aplicativos
Definir Instâncias do Servidor da Aplicação
Visualizar Informações do Servidor
Implantar uma Aplicação
Tipografia de Títulos
Os títulos devem possuir tamanho de letras e cores diferentes de acordo com o seu nível.
O padrão a ser utilizado é o mesmo disponível na ferramenta para construção de manual (Confluence).
Capitalização e Pontuação
- Não use pontuação no final de um título
- Capitalize a primeira letra de cada palavra do título, exceto pronomes, artigos e preposições.
Numeração
Não enumere os títulos.