Writing guidelines

metadata dernière mise à jour le 15 04 2025 statut linguistique à traduire en allemand et en anglais pdf version en bref l’information de cette section suffit pour la rédaction d’une première fiche pour les personnes plus expérimentées ou pour une information précise, le reste du document est consultable en tout temps wiki·swiss respecte les 3 f il doit être facile d’accès, facile d’utilisation et facile à comprendre cela nécessite notamment une information bien structurée et de manière uniforme ou la prise en compte de différents handicaps ou difficultés utiliser le modèle de fiche pour rédiger votre fiche dès le départ dans la bonne structure ( docid\ ey2 9wo4pnlqk42vcvl7c ) ecrire en “je”, pas en “tu” ou “vous” quand cela n’est pas souhaitable, recourir à la forme impersonnelle appliquer les lignes directrices falc, notamment utilisation de mots simples (niveau b2), phrases courtes, phrases actives plutôt que passives utiliser partout où c’est pertinent les structures “workflow”, “callout”, “checkboxes” et “tabs” (voir exemples dans section 4 2) ne pas utiliser différentes polices d'écriture, ni différentes tailles de police ou d’interlignes, ni notes de bas de page l’utilisation de couleurs est soumise à des règles particulières comme souvent, le plus simple est d’apprendre en se basant sur des exemples de fiches existantes philosophie focus sur le comment , pas le quoi l’objectif final de wiki·swiss est de permettre à la population d’exercer au mieux ses droits et de réduire sa charge administrative associée pour cette raison, wiki·swiss se concentre sur le comment ? plutôt que le quoi ? ou le pourquoi ? dans le contexte des retraites par exemple, wiki·swiss ne cherche pas à répondre à la question “quel est le fonctionnement du système à 3 piliers ?” mais plutôt à “comment m’assurer que tout est ok avec mon 1er pilier ?” des descriptions explicatives sont bien sûr possibles, mais uniquement comme moyen pour atteindre l’objectif de fournir une marche à suivre (“how to”) les trois f pour atteindre l’objectif final, il est nécessaire que wiki·swiss soit triplement facile facile d’accès, facile d’utilisation et facile à comprendre la facilité d’accès correspond à la facilité de trouver (i) le guide wiki swiss et (ii) le contenu précis recherché la facilité d’utilisation correspond à la facilité de s’orienter et de naviguer dans l’information mise à disposition la facilité de compréhension correspond à la facilité de comprendre l’information présentée de sorte à pouvoir satisfaire son besoin informationnel les trois f couvrent les trois étapes effectuées par le public cible à la recherche d’une information (i) accéder ⇒ (ii) naviguer ⇒ (iii) comprendre concrètement, cela implique les éléments suivants pour la rédaction de fiches objectifs objectifs implications pour la mise en oeuvre implications pour la mise en oeuvre facilité d’accès applications des bonnes pratiques de référencement naturel (seo), incl mots clés et formulation hyperliens internes pour connecter les différents contenus ensemble facilité d’utilisation concision, selon la devise “aussi court que possible, aussi long que nécessaire” format uniforme entre les contenus (incl structure identique) facilité de compréhension recours au langage falc bonne mise en page de l’information recours à des images, tableaux, diagrammes et vidéos prise en compte de différents handicaps cognitifs, visuels ou auditifs (normes wcag 2 2) le reste de ce guide présente en détails les différents éléments pertinents pour la rédaction de fiches rédaction générale ecriture en falc le texte doit être rédigé en langue facile à lire et à comprendre (falc) les lignes directrices complètes sont en développement voici une synthèse des points les plus importants dans le contexte de wiki·swiss di di mension bonnes pratiques bonnes pratiques mots utiliser des mots faciles (niveau b2) eviter des mots difficiles si ce n’est pas possible, les expliquer utiliser le même mot pour parler de la même chose dans tout le document eviter les initiales et acronymes eviter les mots de langue étrangère, sauf s’ils sont très connus renoncer aux métaphores et langage figuré phrases phrases courtes phrases positives à préférer aux négatives phrases actives à préférer aux phrases passives donner des exemples de la vie de tous les jours structure placer les informations dans un ordre le plus intuitif et simple possible aérer le texte ecriture en “je” les textes doivent être rédigés à la 1ère personne du singulier (“je”) quand cela n’est pas possible, il faut recourir à la forme impersonnelle par exemple ✅ “est ce que j’ai le droit au chômage ?” ✅ “comment fonctionne le service militaire ?” ❌ “comment pouvez vous obtenir des prestations complémentaires ?” ❌ “comment peux tu contester une facture ?” pas d’écriture inclusive, mais écriture épicène simple les règles suivantes s’appliquent pas de formes contractées inclusives il faut par conséquent renoncer au point médian (·), au point ( ), au tiret ( ), à la parenthèse ou à la barre oblique pas d’écriture inclusive en doublets (par ex les travailleurs et les travailleuses) l’écriture épicène est possible, pour autant que le texte reste aussi concis et léger que possible en ligne avec le falc ✅ les “contribuables”, les “droits humains” au lieu de “droits de l’homme” ❌ “les personnes étudiantes” au lieu de “les étudiants” le féminin générique est possible à la place du masculin générique (= toute la fiche est rédigée du point de vue d’une narratrice en je), pour autant que la mention suivante figure dans la section 1 “dans cette fiche” “l’utilisation du féminin est choisie pour des fins de lisibilité et inclut toute la population” comme le suggèrent ces règles, wiki·swiss accorde beaucoup d’importance à l’objectif d’égalité des genres sous jacent à l’écriture inclusive a la lumière de la recherche scientifique actuelle et des exigences falc, wiki·swiss a néanmoins effectué une pesée d’intérêts et tranché en faveur de son objectif de compréhensibilité et simplification maximale, tout en suivant attentivement les développements en la matière aspects linguistiques en anglais par convention, le contenu en anglais est rédigé en anglais britannique ( british english ) cela inclut notamment ise instead of ize (e g organise, not organize) our instead of or (e g colour, not color) re instead of er (e g centre, not center) structure générale 👉🏼 voir modèle de fiche pour commencer à rédiger une fiche ( docid\ ey2 9wo4pnlqk42vcvl7c ) titres (a) niveau de titre il y a 4 niveaux de titre possibles le titre de la fiche, ou titre niveau 0 le titre niveau 1 (1) le titre niveau 2 (1 1) le titre niveau 3 (1 1 1) leur utilisation suit les règles suivantes t0 et t1 sont obligatoires t2 et t3 sont optionnels, à utiliser en fonction du contexte t3 doit être utilisé avec parcimonie un nombre anormalement élevé de t3 dans une fiche peut suggérer qu’il vaudrait mieux diviser la fiche (👉 voir plus bas) (b) questions les titres de fiches doivent être formulées autant que possible comme des questions par exemple pour le titre d’une fiche ✅ “ai je le droit au chômage ?” ❌ “conditions pour avoir le droit au chômage” pour les titres à l’intérieur de la fiche, ça dépend la priorité est de les formuler de manière aussi claire et concise que possible dans l’idéal, ils doivent être formulés comme des questions une formulation non interrogative mais qui serait plus claire et concise doit être privilégiée (c) emoticône (emoji) si un emoji pertinent par rapport au thème de l’article existe, il peut être utilisé en début de titre ✅ par ex “⏳pendant combien de temps ai je droit au chômage ?” seulement 1 emoji par titre est admis ❌ “⚠️ délais de recours ⚠️” pour l’utilisation d’emoji dans le texte, se référer à la section "corps de texte" structure de la fiche le tableau suivant présente la structure générique à utiliser pour chaque fiche voici un exemple avec la fiche “💥assurance responsabilité civile (rc)” rassembler ou diviser ? faut il concentrer toutes les questions et informations sur une seule page, ou la diviser en plusieurs fiches ? la meilleure réponse à cette question sera celle qui permettra d’atteindre au mieux les objectifs de facilité d’accès, d’utilisation et de compréhension de l’information cela dépend notamment de la nature de la chose expliquée ainsi que de la quantité d’informations dans l’exemple de l’assurance responsabilité civile, l’information est suffisamment simple pour tout condenser sur une seule fiche, suffisamment structurée selon les questions principales (3 1 3 6) dans l’exemple de l’assurance chômage, la complexité de l’information est telle qu’il a été jugée préférable de diviser l’information en fiches séparées dans le cas de fiches séparées, il est important d’appliquer les 2 règles d’intégration intégration verticale regrouper les fiches dans la même rubrique du guide (par ex “assurance chômage”), et avoir une page de rubrique offrant un rapide aperçu de toutes les fiches existantes intégration horizontale connecter les fiches entre elles par des liens hyperliens il faut distinguer les hyperliens internes des hyperliens externes s’agissant des hyperliens internes, le principe général est de connecter autant que possible les contenus existants entre eux pour faciliter l’utilisation du guide cela implique notamment chaque fois que notre fiche mentionne un contenu couvert par une autre fiche, un lien vers cette autre fiche doit être ajoutée chaque fois que le contenu d’une autre fiche est pertinente pour compléter ou contextualiser notre fiche, un hyperlien qui y mène doit être ajouté cela vaut particulièrement pour les contenus sous divisés en plusieurs plus petites fiches (voir intégration horizontale dans section précédente) s’agissant des hyperliens externes autant que possible, les hyperliens externes doivent être données dans la section “pour aller plus loin” et pas dans les autres sections mise en page médias externes il est techniquement possible d’intégrer les médias suivants vidéos (depuis le compte youtube de wiki·swiss) images ( jpg, png ou gif) fichiers à télécharger il n’est hélas pas encore techniquement possible d’intégrer les médias suivants des fichiers son directement écoutables (en streaming) structuration de l’information les fonctionnalités pour structurer l’information sont un des principaux instruments de wiki·swiss dans son objectif de rendre l’information administrative facilement utilisable et compréhensible certaines de ces fonctionnalités ne peuvent pas être utilisées dans word ou google docs si vous souhaitez signaler leur utilisation, vous pouvez laisser un commentaire dans le document voici les fonctionnalités les plus importantes, à utiliser systématiquement https //docs archbee com/editor blocks#bl8jj fournit des explications détaillées sur chaque fonctionnalité “workflow” le “workflow” est l’outil phare pour toutes les marche à suivre de wiki·swiss ils permettent d’expliquer un processus étape par étape a toujours utiliser dans ces cas de figure “callout” encadré à utiliser pour ajouter une information, rendre attentif à un élément important, etc a utiliser avec modération listes avec cases à cocher (“checkboxes”) a utiliser chaque fois que des conditions à remplir sont listées par souci d’uniformité, wiki·swiss a décidé d’appliquer la convention suivante les cases sont déjà cochées, pour signifier que la condition doit être remplie le texte doit être remis en noir au lieu de gris, pour davantage de lisibilité “tabs” chaque “tab” doit être numéroté avec les emojis 1️⃣ 9️⃣ une contrainte le texte en titre du “tab” doit être très court (1 3 mots) sinon, utiliser un autre procédé (“callout”, sous fiche, etc ) voici d’autres fonctionnalités utiles “vertical split” utile pour comparer deux situations ou régimes les tableaux ⚠️ max 5 colonnes pour 1 tableau (en raison de la lecture sur smartphone) les listes à puces et listes numérotées traditionnelles https //docs archbee com/editor blocks#bl8jj fournit des explications détaillées sur chaque fonctionnalité corps de texte les opérations de mise en page suivantes ne sont techniquement pas possibles il ne faut donc pas les utiliser changer la police d’écriture changer la taille de la police d’écriture interlignes particuliers ou variables notes de bas de page ou de fin de document exposants ou indices infobulles (tooltips) les opérations de mise en page suivantes sont techniquement possibles gras italique surligné barré utilisation d’émoticônes (emoji) ⚠️ couleur de police d’écriture ⚠️ surlignage du texte en couleur ⚠️ les opérations marquées avec un ⚠️ font l’objet de règles particulières ⚠️ utilisation d’émoticônes les emojis 0️⃣ 9️⃣ et 🅰️ &🅱️sont à utiliser uniquement dans les situations décrites plus haut des emojis utiles et conseillés sont notamment ⚠️💡👉🏼✅❌🔴🟡🟢📞📧📨📮🔎 pas d’informalité les 😉, 😂, 😘 et autres 🙃 sont à proscrire c’est clair ? 😜 en général, les emojis doivent être utilisés avec prudence et modération ⚠️ couleur de police d’écriture & surlignage du texte en couleur le texte peut être écrit dans un ton de gris plus clair que le noir pour indiquer qu’il s’agit d’une information secondaire (par ex une note sous une image) cela peut être utile puisqu’il n’est pas possible de modifier la taille de la police autrement, le surlignage est à préférer au changement de couleur de police de manière générale, il est conseillé d’utiliser les couleurs avec modération en raison des défis qu’elles posent avantage des “codes couleurs” peuvent aider à structurer l’information défi peut complexifier l’information plutôt que la simplifier si trop de couleurs sont utilisées (4+) défi les couleurs doivent être lisibles en mode clair ou en mode sombre sur le navigateur défi selon la norme wcag 2 2, le contraste des couleurs doit être supérieur à 4 5 1 pour que le texte soit lisible par des personnes souffrant de handicaps visuels typography 👉 for writing visual aspects, refer to the guide docid 8r22wjvm5r0jujp3rkwqw