Je continue la lecture du livre Communication Patterns de Jacqui Read. Aujourd’hui le chapitre 7 qui commence la seconde partie dédiée à la communication multimodale. Il traite de la communication écrite et particulièrement technique.

Idée principale

Jacqui Read partage des techniques pour avoir une écriture qui permet de faire passer son message. L’écriture technique n’est pas de l’écriture créative. Il y a un public cible, et l’objectif n’est pas de divertir, mais d’informer. Pour y parvenir on doit travailler sur son langage, le vocabulaire et la compréhension de nos phrases. Mais aussi sur la structure de notre texte.

Pattern : Un langage simple

Pour des documents techniques, il faut garder un langage simple. Cela rend le texte plus facile à lire, notamment pour les personnes neuro-divergentes, et les personnes dont ce n’est pas la première langue.

La “malédiction de la connaissance” peut faire que l’on ne se rend pas compte de la difficulté de ce que l’on partage. Donc il faut toujours penser à son audience et à son niveau de connaissance.

The more of an expert you become on a subject, the harder it is to remember what it is like to be inexperienced, making communication with nonexperts more difficult.

La syntaxe

La clarté est le plus important. Utiliser des verbes qui sont précis et pas avec un sens vague / trop large. Eviter les phrases avec “il y a”. Utiliser des phrases courtes. On retire tout ce qui est superflu. C’est à la fois plus facile à lire, mais aussi à maintenir.

Soigner particulièrement la première phrase de chaque paragraphe. Elle doit précisément l’introduire.

Your audience may scan your content and choose which parts to read based on the first sentence.

Un paragraphe doit avoir une seule raison d’être à son niveau d’abstraction. Et n’avoir que 3 à 5 phrases.

On utilise un vocabulaire cohérent, avec un mot pour désigner un concept, sans varier. Si on utilise des acronymes, on les définit dès leur premier usage.

Structurer son écriture

Ces conseils sont applicables à tout type de document : documentation, email, etc.

En écriture technique, l’écriture pyramidale (Minto pyramind principle de Barbara Minto) est très appropriée.

On commence par le plus important, le message, ou les takeaways.

The easiest order for a reader is to receive the major, more abstract ideas before he is required to take in the minor supporting ones. — Barbara Minto

Et on descend au fur et à mesure dans le niveau de détail. Chaque élément proposé est donc préalablement introduit avant d’être détaillé. Ainsi, en mettant le plus important dès le début, certains publics peuvent ne pas avoir besoin de lire l’ensemble du texte, si les détails ne leur sont pas importants.

Il peut être important aussi de définir : le périmètre du document, et aussi ce qu’il n’inclut pas, l’audience, les prérequis.

Mon feedback

Un chapitre très clair, qui donne des conseils applicables rapidement pour améliorer la qualité de ses écrits techniques. Et sûrement avoir une base suffisante pour faire passer son message.
La communication écrite est une compétence très utile à développer, plus on travaille avec du monde, plus elle est indispensable. Personnellement je produis pas mal de documents, encore plus depuis ma lecture du livre Learning Systems Thinking, de Diana Montalion. Partager des propositions, des décisions, c’est donner le contexte pour le futur qui permettra à d’autres personnes de comprendre ce qui a amené à prendre une décision. C’est aussi exposer à tous ses raisons, et donc monter son niveau d’exigence car nos raisons doivent être irréprochables. Et c’est aussi s’ouvrir à d’autres perspectives en partageant un document que d’autres pourront lire et critiquer.