L’art de la révision — comment les développeurs rédigent des documents techniques

• Révision : action de corriger et d’affiner un texte en y réfléchissant à plusieurs reprises lors de sa rédaction. Ou ce travail lui-même

• Pourquoi la révision est nécessaire

• Conseils de révision

→ Rendre son propre texte plus étranger : le lire à voix haute, le relire plus tard, l’imprimer sur papier pour le relire

→ Revue par les pairs

→ Utiliser une checklist

→ Conseils pour retravailler les phrases afin d’améliorer la lisibilité

① Réorganiser et corriger en phrases courtes

② Supprimer les formulations inutiles

③ Transformer le texte en un écrit logique

[budlebee]

Ça me fait penser aux principes d’écriture de Stephen King. Comme il s’agit de romans, il y a sans doute des différences avec la rédaction technique, mais pour noter ce qui me vient à l’esprit :

• utiliser des phrases courtes et simples.

• après avoir écrit un premier jet, je le mets dans un tiroir, puis je le ressors six mois plus tard pour le relire.

• la version révisée retire 10 % au premier jet.

• lire le texte à voix haute permet de repérer les passages maladroits.

• j’écris en définissant précisément le public visé. Dans mon cas, c’est ma femme.

[xguru]

En ce moment, les équipes de technical writing de Kakao Enterprise publient beaucoup de très bons articles. Je recommande de s’abonner à leur blog !