Dicas, Notas e Avisos fornecem informações importantes que estão ligadas diretamente ou indiretamente ao tópico em discussão. O Confluence possui o recurso de adicionar lembretes ao longo do documento de forma a chamar a atenção para algo, dar alguma observação ou informação que precise ser destacada. Para isso possui cinco recursos, a Dica, Informação, Aviso, Nota e Exemplo.
Dica
É um tipo de nota que auxilia o usuário a aplicar técnicas e procedimentos descritos no texto. Utilizada para sugerir ao usuário, a melhor forma de realizar o procedimento ou utilizar a funcionalidade, por exemplo.
Ao utilizar dicas no texto:
- Mantenha o texto curto e relevante.
- Não introduza tópicos ou elabore material conceitual.
- Caso seja muito extensa utilize a macro "Expandir"
Padrão visual de dica:
Dica:
- Adicione a macro Tip ou Dica.
- Inclua o título "Dica:" na macro.
- Escreva o texto que deseja dentro do campo.
Informação
Indica informação neutra ou positiva que enfatiza ou suplementa pontos importantes do texto. As informações que podem ser aplicadas somente em casos especiais. Por exemplo, configurações de equipamentos, detalhes de uma versão específica, entre outros.
Ao utilizar notas no texto:
- Utilize uma nota para reforçar informações ou casos especiais.
- Mantenha a nota curta e relevante.
- Nunca utilize uma nota para citar informações de segurança.
- Se o seu texto requer muitas notas, considere reorganizar o texto.
- Caso a informação muito extensa utilize a macro "Expandir".
Padrão visual de nota:
- Adicione a macro Info ou Informação.
- Escreva o texto que deseja dentro do campo.
Obs.: Esta macro não dispõe de título tendo em vista seu ícone ser intuitivo.
Nota
Uma nota contém informação importante que é essencial para completar uma tarefa, ou proteger o sistema de algum dano. Os usuários podem desconsiderar uma nota e ainda completar o procedimento, mas não podem fazer o mesmo para avisos.
Utilize avisos nos seguintes casos:
- Quando você descrever uma situação que possui potencial para causar algum dano irreversível para os dados do sistema.
- Quando um procedimento possui alguma restrição de usuário.
Ao utilizar avisos no texto:
- Seja direto, e deixe claro a importância do cumprimento do aviso.
- Insira o aviso antes da informação que pode causar dano.
- Caso seja muito extensa utilize a macro "Expandir" .
Padrão visual de nota:
- Adicione a macro Note ou Nota.
- Escreva o texto que deseja dentro do campo.
Obs.: Esta macro não dispõe de título tendo em vista seu ícone ser intuitivo.
Aviso
Utilize este recurso quando for necessário informar ao usuário que aquela informação é indispensável para o correto funcionamento do sistema, para dar alguma restrição, ou destacar algo que seja de extrema importância.
Padrão visual de aviso:
- Adicione a macro Aviso ou Warning.
- Escreva o texto que deseja dentro do campo.
Obs.: Esta macro não dispõe de título tendo em vista seu ícone ser intuitivo. Caso seja muito extensa utilize a macro "Expandir"
Exemplo
É usado para facilitar o entendimento do que está sendo escrito.
Utilize o exemplo nos seguintes casos:
- Quando o texto for complexo, havendo necessidade de colocar um exemplo prático do que foi escrito.
- Quando houver necessidade de aplicar um modelo do que foi escrito, seja por meio de texto ou imagem.
Padrão visual de exemplo:
- Adicione a macro Panel ou Painel.
- Inclua o título "Exemplo" na macro.
- Escreva o texto ou uma pequena imagem que deseja dentro do campo.
Considerações:
- Não utilize mais de um exemplo, salvo situações comparativas.
- Não utilize exemplos com nomes reais ou situações que podem induzir o usuário a aplicar o que foi sugerido, como, por exemplo, percentuais de impostos.
- Quando necessário, é permitido utilizar, sem excessos, exemplos no meio da frase: .. "como, por exemplo,..."
- Caso seja muito curto, utilize a palavra exemplo "Ex:" abreviada ao final da frase: "Insira o formato da data. Ex: dd/mm/aaaa"
Caso seja muito extensa utilize a macro "Expandir"