Le interfacce utente e la documentazione di Discourse sono attualmente in fase di revisione e modifica per essere allineate a queste linee guida. Stiamo lavorando per raggiungere il pieno allineamento il più rapidamente possibile.
Quando scrivi per Discourse, prendi nota delle seguenti linee guida per la formattazione del testo. Queste linee guida si applicano al testo in tutte le aree, in particolare alla documentazione e all’interfaccia utente di Discourse.
Maiuscole
Quando scrivi documentazione o testo dell’interfaccia utente, utilizza per impostazione predefinita il case del titolo (cioè, la prima lettera della frase è maiuscola e nient’altro).
Promemoria importanti:
- Titoli, intestazioni e nomi delle categorie utilizzano il case del titolo.
- I nomi delle funzionalità di Discourse non sono maiuscoli, con solo le seguenti eccezioni:
Non utilizzare altre formattazioni per i nomi delle funzionalità, inclusi grassetto, corsivo, backtick, virgolette o qualsiasi altra cosa.
Le eccezioni per le maiuscole includono:
- Le sigle devono essere sempre maiuscole in modo appropriato.
- I nomi di prodotti e marchi devono essere maiuscoli secondo le loro linee guida del marchio.
- I nomi di plugin e temi devono essere maiuscoli in modo appropriato.
- Quando si fa riferimento a elementi del menu, etichette di pulsanti o opzioni di modulo, capitalizzare la prima lettera della prima parola, ad esempio “Fai clic sul pulsante Nuovo argomento per iniziare a scrivere”.
- Se qualcosa è maiuscolo nell’interfaccia utente per un buon motivo, utilizza la stessa capitalizzazione quando scrivi la documentazione al riguardo.
- Le slug di categorie e URL sono sempre minuscole.
In caso di dubbio, usa il case del titolo.
Punti
Non usare un punto per quanto segue:
- Suggerimenti, didascalie di immagini o altri elementi dell’interfaccia utente con una sola frase
- Etichette dei pulsanti
- Elementi del menu
- Elementi dell’elenco non contenenti un verbo
Usa un punto per quanto segue:
- Frasi normali
- Suggerimenti, didascalie di immagini o altri elementi dell’interfaccia utente con più di una frase
- Elementi dell’elenco contenenti un verbo
- Testo
altdell’immagine
Avvertenza per gli elementi dell’elenco: Se stai scrivendo un elenco con elementi misti (cioè, alcuni richiedono un punto e altri no), usali tutti per tutti.
Enfasi
Per enfatizzare le parole, usa per impostazione predefinita il corsivo. Puoi anche usare il grassetto se ritieni che si adatti al contesto.
Backtick
Usa i backtick (``) per il codice inline, gli URL di esempio e i nomi delle impostazioni. Non usarli per nessun altro scopo.
Blocchi di codice
Quando includi blocchi di codice, specifica il linguaggio di codifica ove possibile aggiungendolo immediatamente dopo la recinzione di apertura (i tre backtick iniziali), ad esempio ```css.
