-
Notifications
You must be signed in to change notification settings - Fork 30
Styleguide
Matti Schneider edited this page May 19, 2022
·
15 revisions
- The name of the product is “Open Terms Archive”.
- Open Terms Archive is a brand name, not a common noun. It does not have a determiner.
- It is singular. It is not “Open Terms Archives”.
- It has spaces. It is not “OpenTermsArchive”.
- As often as possible, non-breakable spaces should be used to separate the three words, in order to avoid line breaks in the middle of the name.
- While the “OTA” abbreviation can be used in internal documents and discussions, it is not used publicly (at least not by us).
- OTA enables activists to identify misleading terms.
- The Open Terms Archive enables activists to identify misleading terms.
- OpenTermsArchive enables activists to identify misleading terms.
+ Open Terms Archive enables activists to identify misleading terms.
- Open Terms Archive est un nom féminin, car il s'agit de l'archive, la base de données.
- OTA permet aux parlementaires de suivre l'application de leurs lois.
- L’Open Terms Archive permet aux parlementaires de suivre l'application de leurs lois.
- OpenTermsArchive permet aux parlementaires de suivre l'application de leurs lois.
+ Open Terms Archive permet aux parlementaires de suivre l'application de leurs lois.
Les emails transactionnels et les formulaires utilisent un layout « blanc » et les contenus écrits par des humains (par exemple les Mémos ou les invitations aux démos) utilisent un layout « noir ».
Pour faciliter la cohérence des styles des campagnes emails, il faut toujours dupliquer le brouillon disponible correspondant au type de mail que vous souhaitez envoyer. Pensez à reporter les évolutions apportées au template sur le brouillon correspondant et dans toutes les langues.
- Titre
- Service · Document · Date de modification
- Corps du texte
- Description des changements au passé composé (par exemple « a ajouté », « a retiré »…).
- Lien systématique vers le diff sur le verbe d’action. Titre du lien : « Voir le changement ». On évite les verbes « annoncer » et équivalents, car la plupart du temps les changements détectés ne sont justement pas annoncés.
- Citations bienvenues, mais on essaie de minimiser leur longueur car le texte juridique est souvent très verbeux.
- Mettre en gras le point le plus important.
- Ne pas mettre les citations en italique.
- Pour la version anglaise, chercher les citations dans la version originale.
- Contextualisation (optionnel)
- Corps du texte dans un nouveau paragraphe : contextualisation avec liens externes, vers les sources les plus autoritatives possible.