Guide de rédaction

Le présent guide vise à donner au rédacteur les lignes directrices sur la manière de rédiger ou de modifier des articles de la dompe ne se prétend pas être exhaustif sur le sujet mais une référence quant aux exigences de base de LinuQ. Votre bon jugement fera le reste…. L'article est certes long mais il est indispensable de le lire jusqu'à la fin et vous évitera de subir les « foudres » des modérateurs :-)

Article (contenu/sujets traités)

La philosophie de la dompe est d'offrir un dépôt d'articles réputés être d'un relativement « bon » niveau technique et couvrant une grande variété de sujets. Il n'y a pas de restriction particulière sur les contenus publiés dans la mesure où ils ne font pas parties des contenus bannis dont la liste est détaillée plus loin.

Des articles sur tout sujet relié aux logiciels libres ou technologies libres! Avant de vous lancer dans la rédaction d'un article et d'y consacrer plusieurs heures de travail demandez-vous:

  • « Quel savoir vais-je apporter au lecteur / à la communauté ? »
  • « Est-ce que mon article a une portée extrêmement basique qui se trouve sans aucun problème sur Google ? »
  • « Pourquoi quelqu'un apprécierait-il plus le contenu de mon article qu'un autre traitant du sujet ? »

Écrire un article est un exercice très intéressant tant au niveau de l'exploration technique que rédactionnel et qui est un peu moins facile qu'il n'y paraît ! Il reste que c'est un excellent moyen d'approfondir ses connaissances sur une foule de sujets. Nul besoin d'avoir une connaissance ultra-approfondie d'un sujet pour se lancer dans l’aventure, avoir une base de départ et la curiosité de creuser un sujet au delà ses connaissance sont des pré-requis largement suffisants.

Nous vous en encourageons très fortement à sortir des sentiers maintes fois tracés et débroussailler des sujets ou des aspects de sujets qui sont peu voir pas du tout couverts ailleurs et il n'est pas souvent pas nécessaire d'aller chercher bien loin ou de piocher dans des sujets ésotériques <strike>comme vi</strike>…

Qu'est-ce qu'un « bon article » ?

Un « bon » article est un article qui:

  • inspire au lecteur une sensation de confiance (c'est vous l'expert ! à vous de savoir vulgariser) ;
  • est totalement objectif, cohérent dans son ensemble et ne comporte aucune explication farfelue ;
  • suit une démarche scientifique basée sur des informations exactes et vérifiables (citer les sources) ;
  • ne prend pas le raccourci du simplisme et démontre au lecteur que vous maîtrisez suffisamment le sujet en regard du contexte ;
  • donne une bonne vue d'ensemble du sujet traité sans « noyer le poisson » dans une foule de détails secondaires superflus ;
  • est écrit dans un style professionnel dans un français littéraire accessible et qui est agréable à lire ;
  • respecte l’intelligence et la curiosité du lecteur ;
  • est illustré par des exemples et des images (valent au moins 1000 mots) ;

Il est pénible de lire des « recettes de cuisine » (souvent simplistes) constituées de morceaux incohérents et raccordés tant bien que mal. Ce genre de contenu apporte n'apporte pas grand chose sauf un fort discrédit et sera difficilement toléré ici.

Vous devez expliquer au lecteur:

  • le contexte / portée du sujet (sans raconter votre vie) ;
  • ce qui est fait ;
  • comment le faire et… surtout… surtout… pourquoi vous le faites ;
  • quelles sont les alternatives éventuellement possibles (« entrebâiller la porte » est suffisant…. c'est même un excellent moyen de créer des opportunités pour d'autres articles) ;
  • éventuellement quelques aspects théoriques (comme le sel dans la soupe… ne pas en abuser) ;

Un bon article est comme le vin: il se bonifie avec le temps ! Si certains articles de la dompe cumulent des centaines d'heures de recherches, d'expérimentation et « pêche » aux détails sur Google, ils ont tous commencé par par une première ébauche et quelques phrases. Ne cherchez pas à tout écrire en seule fois, allez y une couche à la fois et faites confiance à la communauté pour vous aider enrichir le contenu, la dompe est un travail collaboratif.

Principe fondamental ! Nous préférons proposer un nombre relativement limité d'articles mais qui sont en revanche réputés avoir un « bon » voir « excellent » niveau technique. Ce n'est pas à votre article de s'en vanter explicitement, cette responsabilité incombe aux lecteurs qui vont lire et utiliser le contenu.

Article (style rédactionnel)

L'article écrit doit avoir un style pouvant être qualifié de professionnel.

  • Aucune de tournure de phrase à la première personne du singulier, utiliser le nous, vous ou une tournure impersonnelle
  • Allez à l'essentiel et ne racontez pas votre vie… le lecteur s'en fiche éperdument ;
  • Évitez autant que possible les fautes en particulier les fautes d'orthographe, de participes passés, etc ;
  • Bien qu'il soit vivement conseillé de minimiser l'usage des anglicismes, certains termes techniques tels que cluster, snapshot, tarball/tarballe ou gzipper sont à présent d'usage courant et peuvent être utilisés pour alléger les phrases ;
  • Évitez de traduire les acronymes notamment s'ils sont notoirement connus! « Logical Volume Manager (LVM) » est préférable à « Gestionnaire de Volumes Logiques (GVL) » (!)
  • Une erreur très courante dans les articles de wiki est d’annoncer explicitement le plan dans le paragraphe d'introduction de l'article: tous les articles de la dompe affichent une petite table des matières en haut de l'article remplit précisément cette fonction ;
  • Utilisation d'un tire comme titre Introduction ou Mise en contexte: a éviter, il vaut mieux placer votre paragraphe d'introduction directement dans l'en-tête de l'article juste avant le titre de votre première section (c'est le cas sur le présent article);
  • Éviter d'abuser des smileys (bonhomme-sourire), deux ou trois suffisent et encore limitez-vous aux expressions de base ':-) ' et ':-( '.
  • Ne ne vous prenez pas trop au sérieux… Une touche d'humour, un petit sarcasme bien placé voir un gros troll poilu (pas toujours bien subtilement caché d'ailleurs) trainant dans une phrase sont vos alliés ;-)
  • Sachez faire passer le message à demi-mots sans verser dans le simplisme ou l'irrespect du lecteur ;
  • Tournure de phrase (1ère personne):
Incorrect L'autre jour au bureau nous avons discuté de… et j'ai décidé de rédiger un article sur le sujet sur machintrucFS. Sur mon ordinateur équipé de BlahBlahLinux (…)
Correct La documentation de machintrucFS est succincte et le présent article se propose d'éclaircir quelques concepts de base. Les opérations sont réalisées sur BlahBlah Linux (…)
  • Tournure de phrase (usage du on):
Incorrect on va voir plus bas que …
Correct nous verrons plus loin que….
  • Manque d'objectivité/jugement de valeur:
Incorrect Nous avons vu dans cet article que ZFS est meilleur que ext3, notamment à cause de sa capacité à faire des snapshots. Ext3 est un système totalement pourri…
Correct ZFS dispose à la base de la possibilité de faire des snapshots et n'a pas, contrairement à ext3, de table d'inodes statique….
  • « Vache espagnole » (tend également à démonter votre « parfaite » maîtrise du sujet au lecteur…) :
Incorrect GCC va compiler votre code plus fort …
Correct L'utilisation des options d’optimisation de GCC va demander un peu plus de temps lors de la compilation de votre code du fait que le compilateur va devoir effectuer des analyses/optimisations plus approfondies….
  • Utilisation de termes locaux et de néologismes:
Incorrect Le système de courriel (terme spécifique français-canadien)
Incorrect Le système d'e-mail (anglicisme)
Correct Le système de courrier électronique
Incorrect La valeur sera randomisée par le programme… (deux pour le prix d'un!)
Correct Le programme fournira une valeur aléatoire…

Il existe deux types de boites de messages dans la dompe :

  • Les boites de message appuyant le fil de votre texte;
  • Les boites de messages « ambox » (voir Wikipédia) qualifiant éventuellement votre article;

Boites de messages informatives

Ce sont les classiques « Information », « Avertissement », etc. Quand utiliser quoi ? Par ordre d'importance:

  1. Critique
  2. Attention
  3. Information

Il est difficile d'établir des frontières absolues entre les trois niveaux, ces derniers étant à caractère qualitatif et dépendant fortement du contexte de l'article. Néanmoins:

  • Information: Une information facultative ou apportant une précision n'a pour ainsi dire aucune conséquence négative pour le lecteur (information)
  • Attention: Une recommandation à caractère facultatif ayant des conséquences mineures pour le lecteur mais qui n'entraîne pas de défaillance majeure comme un bris matériel des pertes de données ou autres dommages difficilement voire irréparables
  • Critique: veut bien dire ce que cela évoque… les conséquences pour le lecteur peuvent être catastrophiques : bris matériel, corruption de données (perte!), et plus généralement causant un dommage difficilement réparable voire totalement irréparable au système informatique du lecteur.

Une des difficultés est de savoir utiliser avec parcimonie les différentes boîtes de messages:

  • ne mettre que des boîtes de messages critiques finira par « lasser » le lecteur et aura un effet contraire à celui recherché: l'information importante sera noyée dans le reste du texte de l'article ;
  • user et abuser des boîtes de message finit par alourdir votre texte.

Il n'y a pas vraiment de règle absolue quand au nombre de boîtes de messages maximum et minimum à utiliser dans un article (fiez-vous à votre bon jugement). Un bon truc est de relire l'article à tête reposée: si vous avez l'impression de « sauter » les boîtes de message ou d'être perdu au milieu d'elles c'est probablement un signe qu'il y en a de trop…

Boites « ambox »

Ces boites viennent tout droit de Wikipédia et servent à qualifier le contenu d'un article en signalant par exemple:

  • Un manque de neutralité ;
  • Un manque au niveau de citation des sources ;
  • Un « coup de balais » à passer pour dépoussiérer contenu d'un article ;

Voir la page d'Accueil pour un bref descriptif de ce que nous souhaitons. En tout temps est banni et donc effacé de la dompe les articles :

  • Faisant référence à des activités illégales ou pouvant être interprétées comme telles ;
  • Faisant la promotion d'un produit ou d'un service commercial (même au profit d'un OSBL tiers) ;
  • Sans rapport avec les logiciels/technologies libres ;
  • Repris d'autres sites Web et qui violent les termes de propriété intellectuelle des articles originaux ;
  • Contenant des propos inadéquats (attaque personnelle, propos haineux, etc).

En toute circonstance: un article bourré de fautes est également un bon candidat à sa propre destruction…

Pour diverses raisons certains rédacteurs dupliquent les articles ce qui occasionne beaucoup de soucis entre autres de rendre l'information éparse et totalement désorganisée. Souvenez-vous de trois détails:

  1. un wiki est un travail collaboratif et que vous devez accepter que votre travail soit repris et enrichi, corrigé, etc ;
  2. l'ultime bénéficiaire est la communauté dans son ensemble pas vous à titre individuel ;
  3. il est toujours plus difficile de créer un article de rien que de modifier un article existant.

Morale de l'histoire: avant de créer un nouvel article, voyez si un de ceux qui existent ne peut pas être enrichi…

La dompe dispose d'un certains nombre de gabarits qui vont faciliter votre travail de rédacteur et vont permettre une présentation homogène dans l'ensemble des pages. La page Utilisation des gabarits détaille la manière de se servir de tous les gabarits de la dompe. Ces gabarit sont propres à LinuQ et ne sont pas des gabarits standards MediaWiki.

  • L'usage de technologies propriétaires comme Flash est BANNI ;
  • Autant que possible utiliser des formats vectoriels (SVG) ;
  • Utiliser le format PNG pour les images bitmap ;
  • Vos images doivent avoir une taille raisonnable ;
  • Pour les images qui ne sont pas de votre crû, assurez-vous que vous êtes en droit de les réutiliser… contacter l'auteur original est toujours une bonne idée. Idem pour ce qui est de placer une note sur les droits de reproduction dans les commentaires lorsque vous téléversez une image sur le wiki ;
  • Toutes les illustrations que vous créez et déposez dans le wiki doivent être compatibles avec la licence GNU/FDL (être librement partageables et réutilisables). Nous effacerons toute illustration restrictive (mention kamikaze: « © Machin, tout droit réservé »… pire : « © Machin, reproduction interdite » ) ;

Pour rendre le texte plus agréable à lire et surtout limiter la duplication d'informations, vous êtes largement encouragé à utiliser des références croisées dans les articles.


  • guide_de_redaction.txt
  • Dernière modification: 2018/01/26 00:03
  • par 54.172.63.225