As interfaces e a documentação do Discourse estão atualmente sendo revisadas e editadas para se alinharem a estas diretrizes. Estamos trabalhando para alcançar o alinhamento completo o mais rápido possível.
Ao escrever para o Discourse, observe as seguintes diretrizes para formatação de texto. Estas diretrizes se aplicam a textos em todas as áreas, especialmente na documentação e na interface do Discourse.
Capitalização
Ao escrever documentação ou texto da interface, use por padrão a capitalização de frase (ou seja, a primeira letra da frase é capitalizada e nada mais).
Lembretes importantes:
- Títulos, subtítulos e nomes de categorias usam capitalização de frase.
- Nomes de recursos do Discourse não são capitalizados, com apenas as seguintes exceções:
- Explorador de Dados
Não use nenhuma outra formatação para nomes de recursos, incluindo negrito, itálico, crases, aspas ou qualquer outra coisa.
Exceções de capitalização incluem:
- Acrônimos devem sempre ser capitalizados apropriadamente.
- Nomes de produtos e marcas devem ser capitalizados de acordo com suas diretrizes de marca.
- Nomes de plugins e temas devem ser capitalizados apropriadamente.
- Ao se referir a itens de menu, rótulos de botões ou opções de formulário, capitalize a primeira letra da primeira palavra - por exemplo, “Clique no botão Novo tópico para começar a escrever.”
- Se algo for capitalizado na interface por um bom motivo, use a mesma capitalização ao escrever documentação sobre isso.
- Slugs de categoria e URL são sempre minúsculos.
Na dúvida, use a capitalização de frase.
Pontos finais
Não use ponto final para o seguinte:
- Dicas de ferramentas, legendas de imagens ou outros elementos da interface com apenas uma frase
- Rótulos de botões
- Itens de menu
- Itens de lista que não incluem um verbo
Use ponto final para o seguinte:
- Frases regulares
- Dicas de ferramentas, legendas de imagens ou outros elementos da interface com mais de uma frase
- Itens de lista que incluem um verbo
- Texto
altde imagem
Observação para itens de lista: Se você estiver escrevendo uma lista com itens mistos (ou seja, alguns exigem ponto final e outros não), use pontos finais para todos eles.
Ênfase
Para enfatizar palavras, use por padrão itálico. Você também pode usar negrito se sentir que se encaixa no contexto.
Crases
Use crases (``) para código em linha, URLs de exemplo e nomes de configurações. Não os use para nenhum outro propósito.
Blocos de código
Ao incluir blocos de código, especifique a linguagem de programação sempre que possível, adicionando-a imediatamente após a cerca de abertura (as três crases iniciais) - por exemplo, ```css.
