Skip to content

Styleguide

Jump to bottom
air-rilke edited this page May 25, 2022 · 15 revisions

Product name

Common to all languages

  • 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).

English examples

- 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.

Exemples en français

  • 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.

Habillage des courriels

Utilisation des différents layouts

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 ».

Cohérence des styles

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.

Redaction des mémos

Format

  • 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.

Convention universelle de rédaction des tweets présentant les changements signifiants détectés par OTA-bot

  • Si le changement concerne un document en anglais, il est nécessaire de tweeter en anglais et en français.
  • Si le service en ligne concerné par la détection possède un compte twitter, il est préférable de l’identifier dans le corps du tweet et/ou dans l’illustration.
  • Ouvrir le message par un emoji en rapport avec le changement détecté. Si le tweet est écrit dans les deux langues, mettre deux emojis similaires mais différents dans la mesure du possible.
  • Favoriser la vue « rich diff » de GitHub pour la capture d’écran servant à illustrer le changement. Pour une meilleure visibilité, agrandir le texte ou réduire la fenêtre avant de faire la capture d’écran. Cela permettra de circonscrire la largeur de l’image. Répondre au tweet exposant le changement avec un lien direct vers la page présentant ledit changement sur Github.
  • Lorsque le changement présenté fait écho à une décision de justice, à celle d’une autorité administrative indépendante ou celle d’une organisation internationale, identifier le compte de l’association (s’il s’agit d’une asso) à l’origine de la poursuite judiciaire et/ou de l’aai, de l’organisation internationale.
  • Ne pas hésiter à apporter du contexte au changement présenté avec le renvoi vers un article de presse en ligne si la situation le permet.
  • Si le changement détecté est susceptible de concerner une communauté d’utilisateurs actifs sur Twitter, veiller à employer des hashtags utilisés par ladite communauté. e.g https://twitter.com/OpenTerms/status/1524777316034953217?s=20&t=CO7MP39f4uZfftob7XzBQg
Clone this wiki locally