Ce à quoi je pense quand j’édite un texte (2019)

Ce à quoi je pense quand j’édite un texte

• Transmettre le texte avec précision

  • Avant d’écrire, il faut décider ce que l’on veut dire.
  • Définir clairement l’objectif du texte en tenant compte du sujet, du lectorat visé, etc., puis le noter en haut du document.
  • Pendant l’écriture et l’édition, comparer le texte à cet objectif pour en préserver la cohérence.

• Répéter dans des limites raisonnables

  • Reconfirmer le sujet au début et à la fin du texte pour aider le lecteur à le comprendre.
  • Pour gagner en clarté, il peut être utile de répéter des noms plutôt que d’utiliser des verbes.

• Simplifier

  • Supprimer les mots inutiles et rendre les phrases concises.
  • Remplacer des formulations comme « vous » ou « vous pouvez » par des impératifs plus concis.
  • Couper les longues phrases en phrases plus courtes et utiliser les virgules à bon escient pour faciliter la compréhension.

• Éliminer la voix passive

  • La voix passive rend l’agent de l’action flou et diminue la clarté de la phrase.
  • Passer à la voix active rend les phrases plus claires et plus faciles à comprendre.

• Ne pas utiliser d’adverbes

  • Au lieu d’adverbes, utiliser des verbes plus précis ou ajouter des explications.
  • Les adverbes transmettent souvent mal le sens exact au lecteur et laissent une part d’ambiguïté.

• Ne pas supposer les connaissances

  • Fournir le contexte nécessaire pour les informations que le lecteur pourrait ne pas connaître.
  • Lors de la première utilisation d’un sigle, l’écrire en toutes lettres et ajouter une explication.

• Être conscient du ton

  • Le ton du texte doit rester cohérent, sans mélanger ton familier et ton formel.

• Éviter le jargon et les clichés

  • Utiliser des formulations précises pour faciliter la compréhension.
  • Le jargon peut être difficile à comprendre si le lecteur n’appartient pas à un groupe donné.

• Exploiter les espaces blancs

  • Fractionner les longs paragraphes et utiliser des sous-titres, des listes, des tableaux, etc., pour améliorer la lisibilité.
  • Mettre les éléments importants en gras afin que le lecteur ne manque pas les points clés.

Conclusion

• Les principes de base de l’édition consistent à transmettre clairement le sens et à supprimer les mots inutiles.
• En suivant ces principes, on peut développer son propre style et ses propres préférences.
• Le but de l’édition est de réfléchir à l’usage de la langue et de faire des choix adaptés à la transmission du message.

L’avis de GN⁺

• Maintenir l’objectif du texte et sa cohérence pendant le processus d’édition est un principe important pour toute forme d’écriture.
• L’usage de la voix passive est un style à éviter tout particulièrement dans la documentation technique, et le passage à la voix active contribue à renforcer la clarté.
• Éviter les adverbes et utiliser des formulations concrètes est efficace non seulement dans la documentation technique, mais dans toute écriture.
• Fournir un contexte pour les informations que le lecteur pourrait ne pas connaître est particulièrement important dans la documentation technique, car cela améliore la compréhension du lecteur et l’accessibilité du document.
• L’utilisation des espaces blancs et de la séparation visuelle est un élément important pour améliorer la lisibilité des contenus en ligne.

[GN⁺]

Avis Hacker News

• Résumé du premier commentaire :

  • L’auteur dit être honoré que son texte ait trouvé un écho auprès de tant de personnes.
  • Il est devenu ingénieur logiciel en suivant sa curiosité et, après avoir travaillé plusieurs années, regrette un rôle davantage centré sur l’écriture.
  • Il cherche un poste qui combine compétences techniques et capacités de communication, et peut être contacté via son site web et LinkedIn.

• Résumé du deuxième commentaire :

  • Dans la documentation technique, utiliser des sigles sans les introduire est gênant.
  • Dans la documentation d’un projet, ils se répètent et, quand l’équipe change, il peut ne plus y avoir personne qui en connaisse le sens.
  • Il arrive que la seule solution soit de traiter les sigles comme des noms propres et de continuer à les utiliser ainsi.

• Résumé du troisième commentaire :

  • En tant que relecteur de documentation technique, l’auteur a utilisé de nombreuses règles de rédaction.
  • Il propose en plus de ne pas appeler la même chose par des noms différents.
  • Lorsqu’il y a plusieurs auteurs, des variations de terminologie peuvent semer la confusion chez les lecteurs.

• Résumé du quatrième commentaire :

  • L’auteur n’est pas d’accord avec le conseil d’« éviter la voix passive ».
  • La voix passive est un outil qui peut changer la perspective portée sur une action.
  • Elle permet de choisir s’il faut mentionner ou non l’origine de l’action.

• Résumé du cinquième commentaire :

  • Il est difficile de décider pour qui l’on écrit.
  • Il faut prendre en compte des lecteurs techniques, des lecteurs généralistes et des lecteurs non techniques.
  • L’auteur est partagé entre la volonté de rendre son texte accessible à davantage de lecteurs et celle d’en réduire la longueur.

• Résumé du sixième commentaire :

  • L’auteur exprime sa passion pour l’amélioration de l’écriture.
  • Il donne des conseils sur l’importance des listes et sur la bonne manière de les utiliser.

• Résumé du septième commentaire :

  • Il est suggéré d’éviter l’usage du mot « just ».
  • « just » suggère quelque chose de simple, alors que ce n’est pas forcément le cas.

• Résumé du huitième commentaire :

  • L’importance des espaces est soulignée non seulement dans la documentation technique, mais aussi dans les blogs, les e-mails, etc.
  • Les longs paragraphes sont difficiles à lire et les gens perdent facilement leur attention.

• Résumé du neuvième commentaire :

  • Après avoir travaillé dans un MSP par le passé, l’auteur a pris conscience de l’importance de guides de production bien rédigés.
  • En s’appuyant sur son expérience dans la presse, il cherche des règles pouvant aider à la rédaction de documentation.

• Résumé du dixième commentaire :

  • Il est suggéré d’éviter l’usage du futur.
  • Dans la documentation, il vaut mieux écrire « si vous faites ainsi, cela fait ~ » plutôt que « si vous faites ainsi, cela fera ~ ».