Skip to content

Styleguide

Matti Schneider edited this page Mar 26, 2024 · 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.

Memos

Format in English

  • Title
    • Write a short declarative sentence to highlight the key change.
    • 140 characters maximum.
    • Use the name of the service as the subject.
    • Write in the present tense.
    • Prefer active phrasings over passive (“Meta expands reach” rather than “Reach expanded by Meta”).
    • Describe the policy change, not the name of the document. This information will be given in the metadata below.
    • Use no punctuation.
    • Do not put a link in the title because in some reuse contexts the entire title is a link to the memo.
  • Service ‧ Terms Type · Jurisdiction · Date Modified
  • Body text
    • Describe changes in a neutral, objective, non-judgmental manner.
      • Write in the past tense (e.g., “added”, “removed”…).
      • Bolden the most important point.
      • Do not repeat the date, it is already in the metadata.
    • Systematically add a link to the diff on this action verb.
      • Title of the link: “See the change”.
      • Avoid verbs like “announce”, because most of the time the changes detected are not announced.
    • Do not hesitate to quote the new text.
      • Do not italicise citations, use quotes.
      • Minimise the length of citations because legal text is often very wordy.
      • Only quote the text before modification if it is strictly necessary to understand the change, to reduce the risk of confusion and length.
    • If you write in a different language than the detected change, always look for citations in the version of the document that matches the language of writing if it exists instead of translating them yourself.
  • Contextualisation (optional)
    • Body text in a new paragraph: contextualisation with external links to the most authoritative sources available.
    • For example, explain which wider problems are tackled by this policy change, or give a historical perspective on the change.

Example

Meta expands reach against child exploitation

Facebook · Community Guidelines · June 13, 2022

The section on child exploitation for both Facebook and Instagram expanded to cover not only publications that exploit minors, but also “any activity” related to such acts.

This opens up the question of moderation of private discussions, as social platforms show difficulties in managing content related to child abuse —as recently as late March, the New York Times showed that moderation remains very light in this area, even though platforms are supposed to list this type of content and report it to authorities.

Source: June 23, 2022 Memo on French Elections.

Format en français

  • Titre
    • Rédiger une courte phrase déclarative pour mettre en avant le changement clé.
    • 140 caractères maximum.
    • Utiliser le nom du service comme sujet.
    • Écrire au présent.
    • Préférer les formulations actives aux formulations passives (« Meta étend la portée de… » plutôt que « La portée de… est étendue par Meta »).
    • Décrire le changement de conditions et non le nom du document. Cette information sera donnée dans les métadonnées.
    • Ne pas mettre de ponctuation.
    • Ne pas mettre de lien dans le titre parceque dans certains contextes de réutilisation le titre en entier est un lien vers le mémo.
  • Service ‧ Type de termes · Juridiction · Date de modification
  • Corps du texte
    • Décrire les changements de manière neutre et objective, sans jugement.
      • Écrire au passé composé (par exemple : « a ajouté », « a retiré »…).
      • Mettre en gras le point le plus important.
      • Ne pas rappeler la date, elle est déjà dans les métadonnées.
    • Ajouter systématiquement un lien vers le diff sur ce verbe d’action.
      • Titre du lien : « Voir le changement ».
      • Éviter les verbes « annoncer » et équivalents, car la plupart du temps les changements détectés ne sont justement pas annoncés.
    • Ne pas hésiter à citer le nouveau texte.
      • Ne pas mettre les citations en italique, utiliser des guillemets. En anglais, les guillemets sont “” (sans espace) en anglais et « » en français (avec espace insécable).
      • Minimiser la longueur des citations car le texte juridique est souvent très verbeux.
      • Ne citer le texte avant modification que s'il est strictement nécessaire à la compréhension du changement, pour réduire les risques de confusion et la longueur.
    • Si vous écrivez dans une langue différente de celle de la modification détectée, recherchez toujours les citations dans la version du document qui correspond à la langue d'écriture (si elle existe) au lieu de les traduire vous-même.
  • Contextualisation (optionnel)
    • Corps du texte dans un nouveau paragraphe : contextualisation avec liens externes vers les sources les plus autoritatives possible.
    • Par exemple, expliquer quels problèmes plus larges sont traités par ce changement de politique, ou donner une perspective historique.

Exemple

Meta élargit ses zones d’action face à l’exploitation d’enfants

Facebook · Community Guidelines · 13 juin 2022 ­ La partie relative à l’exploitation d’enfants s’élargit pour couvrir non seulement les publications d’exploitation de mineurs, mais aussi « toute activité » relative à ce type d’actes. Meta a modifié les mêmes éléments dans les règles de communauté de Facebook et d’Instagram.

Cela ouvre la question de la modération des discussions privées, alors que les plateformes sociales ont des difficultés récurrentes dans la gestion des contenus relatifs aux violences sur enfants — fin mars encore, le New York Times montrait que la modération reste très légère dans ce domaine, quand bien même les plateformes sont censées répertorier ce type de contenu et le signaler aux autorités.

Source : Mémo du 23 juin 2022, Édition France Élections.

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.

Tweets

Langue

  • Si le changement concerne un document en anglais, tweeter en anglais et en français.
  • Si le changement concerne un document en français, tweeter en français uniquement.
  • Veiller au bon emploi des guillemets. En anglais, les guillemets sont “” (sans espace) en anglais et « » en français (avec espace insécable).

Format

${emoji} ${description}
${lien vers le changement}
#TermsSpotting ${autres hashtags spécifiques}
${capture d'écran du changement}
  • Ouvrir le message par un emoji en rapport avec le changement détecté.
    • Si le tweet est écrit dans les deux langues, mettre le même émoji pour les deux.
  • Décrire le changement de manière neutre et objective, sans jugement.
  • Utiliser le nom du service accompagné d’un #.
  • Insérer le lien vers le changement présenté après un retour de ligne. Si le changement est conséquent, copier le lien depuis la balise latérale au niveau du changement visible dans l’illustration.
  • 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.
  • Après un retour de ligne, conclure le tweet par #TermsSpotting.
  • 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, de préférence dans un tweet en réponse au premier.

Visibilité

  • 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é.
  • Si le changement est susceptible d’être repris et partagé par des personnalités publiques, des organisations de la société civile ou des médias, identifier les comptes dans l’image d'illustration. S’il est impossible d'identifier certains comptes, les mentionner en réponse au tweet.
  • 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 la structure l’origine de la poursuite.