Las interfaces y la documentación de Discourse se están revisando y editando actualmente para alinearse con estas directrices. Estamos trabajando para lograr una alineación completa lo más rápido posible.
Al escribir para Discourse, tenga en cuenta las siguientes directrices para dar formato al texto. Estas directrices se aplican al texto en todas las áreas, especialmente en la documentación y la interfaz de usuario de Discourse.
Mayúsculas
Al escribir documentación o texto de la interfaz de usuario, utilice por defecto el estilo de oración (es decir, se capitaliza la primera letra de la frase y nada más).
Recordatorios importantes:
- Los encabezados, títulos y nombres de categorías utilizan el estilo de oración.
- Los nombres de las funciones de Discourse no se capitalizan, con solo las siguientes excepciones:
- Explorador de datos
No utilice ningún otro formato para los nombres de las funciones, incluyendo negrita, cursiva, comillas invertidas, comillas o cualquier otra cosa.
Las excepciones de mayúsculas incluyen:
- Las siglas siempre deben capitalizarse adecuadamente.
- Los nombres de productos y marcas deben capitalizarse según sus directrices de marca.
- Los nombres de plugins y temas deben capitalizarse adecuadamente.
- Al referirse a elementos de menú, etiquetas de botones u opciones de formulario, capitalice la primera letra de la primera palabra; por ejemplo, “Haga clic en el botón Nuevo tema para empezar a escribir”.
- Si algo está capitalizado en la interfaz de usuario por una buena razón, utilice la misma capitalización al escribir documentación sobre ello.
- Las categorías y las ‘slugs’ de URL siempre están en minúsculas.
En caso de duda, utilice el estilo de oración.
Puntos
No utilice un punto para lo siguiente:
- Tooltips, subtítulos de imágenes u otros elementos de la interfaz de usuario con una sola frase
- Etiquetas de botones
- Elementos de menú
- Elementos de lista que no incluyan un verbo
Sí utilice un punto para lo siguiente:
- Frases regulares
- Tooltips, subtítulos de imágenes u otros elementos de la interfaz de usuario con más de una frase
- Elementos de lista que incluyan un verbo
- Texto alternativo (
alt) de la imagen
Advertencia para los elementos de lista: Si está escribiendo una lista con elementos mixtos (es decir, algunos requieren un punto y otros no), utilice puntos para todos ellos.
Énfasis
Para enfatizar palabras, utilice por defecto la cursiva. También puede utilizar negrita si cree que encaja en el contexto.
Comillas invertidas
Utilice comillas invertidas (``) para código en línea, URLs de ejemplo y nombres de configuraciones. No las utilice para ningún otro propósito.
Bloques de código
Al incluir bloques de código, especifique el lenguaje de codificación siempre que sea posible añadiéndolo inmediatamente después de la valla de apertura (las tres comillas invertidas iniciales), por ejemplo, ```css.
