Bonnes pratiques de documentation : le guide complet de la rédaction professionnelle

Maîtrisez l'art des bonnes pratiques de documentation : améliorez la conformité, fluidifiez vos processus et rehaussez la qualité de votre travail. Découvrez-les dès maintenant !
サインアップ
15分で読めます·公開日: 2024年2月27日火曜日
目次

Amazon produit plus de rédacteurs prolifiques que les écoles de commerce.

L'écriture chez Amazon est un art, et ce depuis 199x. Toutes les conversations professionnelles importantes chez Amazon passent par l'écrit. Ces documents adoptent l'un des 3 formats approuvés par l'entreprise : 2 Pager, 6 Pager, PRFAQ. Comme ils sont rédigés dans un style narratif, les 10 premières minutes des réunions chez Amazon sont consacrées à la lecture silencieuse du mémo. Et l'usage d'adjectifs ou de mots fourre-tout est strictement banni. Fastidieux ? Sans aucun doute.

Mais ça fonctionne pour l'entreprise, et pour l'employé qui rédige laborieusement au moins 2 pages sur sa nouvelle idée. Les employés qui adoptent cette culture de l'écrit obtiennent des promotions plus rapides et deviennent de meilleurs penseurs. Certains d'entre eux finissent même par rédiger des tribunes prolifiques dans de grandes publications économiques et deviennent des leaders d'opinion sur LinkedIn.

Enfin, et ce n'est pas le moins important, ils sont promus plus souvent. Les meilleurs communicants gravissent les échelons de l'entreprise plus vite car, à mesure que l'on monte dans la hiérarchie, le volume de communication dans lequel on s'engage augmente considérablement.

Alors, si vous visez une promotion, améliorez vos compétences en rédaction professionnelle. Commencez à écrire de meilleurs documents. Poursuivez votre lecture pour découvrir ce qu'est une bonne rédaction professionnelle, comment la pratiquer, et un outil d'IA gratuit en bonus qui vous aidera, à chaque fois.

Qu'est-ce qu'une bonne rédaction professionnelle ?

Une bonne rédaction professionnelle transmet des idées d'entreprise de la manière la plus simple possible. En général, la rédaction professionnelle est verbeuse, lourde et difficile à lire. Sans même parler de la comprendre.

‍Si l'on creuse un peu, une bonne rédaction professionnelle :

  • Est écrite dans un français simple et courant : personne n'a besoin d'ouvrir un dictionnaire des synonymes pour comprendre ce que vous essayez de dire.
  • Convainc votre équipe de la solution que vous proposez.
  • Répond à « Quel est le problème », « Comment le résoudre » et « Ce dont j'ai besoin de votre part pour que cela se concrétise ».

Plus important encore,

Une bonne rédaction professionnelle fait ressentir quelque chose aux gens.

Une bonne écriture déclenche un flux de dopamine dans le circuit de récompense de votre cerveau. Bill Birchard, le brillant coach en écriture de livres, a découvert qu'une bonne rédaction professionnelle a le pouvoir de nous motiver.

> Une excellente écriture libère des opioïdes qui activent les points chauds de la récompense. Tout comme un bon repas, un bain apaisant ou une étreinte enveloppante, une prose bien exécutée nous procure du plaisir, ce qui nous donne envie de continuer à lire.

- Bill Birchard

Un bon livre de développement personnel nous motive à apporter des changements concrets à notre quotidien. De même, un bon film sur l'amour nous motive à devenir de meilleurs partenaires. Et de la même manière, une rédaction professionnelle efficace nous amène à nous soucier du problème de l'entreprise et nous motive à nous impliquer dans sa résolution, en équipe.

Un rituel d'écriture étape par étape pour améliorer votre rédaction professionnelle de 80 %

Nous apprécions les directives d'écriture d'Amazon, mais elles sont un peu excessives. Leurs règles fonctionnent parce qu'elles sont adaptées à la taille colossale de l'entreprise et à l'importance de ses décisions.

Mais une petite entreprise n'a pas autant de contexte, d'informations sectorielles, ni le besoin de réussir du premier coup. Pour elle, la rédaction professionnelle doit aligner les parties prenantes sur la suite des opérations de la manière la plus brève possible. Avec juste assez de contexte.

Le rituel suivant repose sur de solides fondamentaux d'écriture. Il peut servir à rédiger des lettres commerciales, des rapports, jusqu'à des communiqués de presse.

1. Partez du principe que votre lecteur est pressé

9 fois sur 10, votre lecteur survolera votre document. Lors d'une journée de travail ordinaire, il jongle entre des appels, s'inquiète de ses tâches individuelles, aide ses collègues, etc. Il cherche toujours un résumé qui livre le maximum d'informations en un minimum de mots.

Faites donc une expérience de pensée. Que feriez-vous si vous deviez lire un document avant une réunion qui commence dans 5 minutes ?

Vous survoleriez les titres, liriez la section de synthèse, vérifieriez s'il vous mentionne ou crée une dépendance vous concernant.

Même si vous ne pouvez pas le vérifier auprès de vos collègues, ils parcourent probablement vos documents de la même façon. Alors avant d'écrire quoi que ce soit, partez toujours du principe que plus vous rendrez votre document simple, et court, plus il sera lu.

2. Sachez clairement pourquoi vous l'écrivez

Vous devriez pouvoir résumer en 1 phrase la raison pour laquelle vous rédigez un document professionnel. Vous devriez avoir une devise intérieure de ce type avant de commencer à assembler un document :

« Je veux faire comprendre qu'il existe un [problème/une opportunité] et que travailler dessus via [votre idée/initiative/processus] peut aider à améliorer [les indicateurs] de [pourcentage approximatif pour souligner l'ampleur] »

Soit vous avez trouvé une occasion de faire quelque chose de nouveau, soit d'améliorer une chose existante. Dans les deux cas, vous devez

  • Les amener à se soucier du problème
  • Les convaincre de la solution la plus efficace
  • Proposer un plan d'action qui anticipe les objections liées au budget, à la capacité ou aux ressources.

3. Maintenant, réfléchissez à voix haute

Si vous êtes un esprit critique avec peu de formation en écriture, vous allez adorer cette étape. Certaines personnes excellent à concevoir des idées mais peinent à les transmettre. Ces personnes ont du mal à rédiger de la documentation professionnelle car elles oscillent entre l'explication d'une idée et l'inquiétude de savoir dans quelle section ou quel format elle devrait figurer.

Si c'est votre cas, commencez toujours par ceci.

  1. Oubliez l'écriture, l'orthographe, la grammaire, etc. Fixez-vous pour objectif d'écrire un document incohérent mais riche en substance.
  2. Ouvrez un nouveau document et videz votre sac. Chaque nouveau point ou argument qui vous vient, transformez-le en un nouveau point de liste.
  3. Faites-le aussi longtemps que possible, au moins jusqu'à remplir une demi-page.
  4. Éloignez-vous pour une promenade ou faites autre chose. Revenez et relisez le document. Les points ont-ils un sens ? Barrez ceux qui n'en ont pas. Ajoutez quelques idées de plus si l'inspiration vous vient. Vous voyez l'idée.

Une fois cela terminé, vous en avez officiellement fini avec la partie réflexion d'une communication efficace. L'étape suivante consiste à emballer votre document dans un récit captivant, puis à le rendre facile à lire.

4. Développez vos pensées en une écriture simple et cohérente

Une fois vos pensées en place, restructurez-les en un récit et développez chaque point.

En faisant cela, veillez à ce que votre écriture soit simple. C'est essentiel. Tous les guides d'écriture vous conseilleront d'écrire de manière simple.

Mais que signifie vraiment une écriture simple ? En gros, cela signifie que vous utilisez des phrases courtes, des mots courants et des paragraphes courts. Il existe 3 règles précises que vous pouvez suivre pour rendre votre écriture plus « simple »

4.1 Maintenez un ratio de 80/20 entre voix active et voix passive.

Les établissements d'enseignement nous apprennent à utiliser le jargon et la voix passive pour faire paraître le texte profond. En réalité, la voix passive allonge les phrases. Et les rend plus difficiles à comprendre. Sur le plan cognitif, nous sommes prédisposés à comprendre la voix active bien mieux. C'est pourquoi vous devriez toujours essayer d'écrire à la voix active.

4.2 Privilégiez les phrases courtes.

Les phrases plus courtes sont plus faciles à comprendre. Comme celles-ci. Quand vous les utilisez en alternance avec des phrases moyennes, la magie opère. Cela s'appelle le rythme.

Les phrases courtes font environ 10 mots. Les phrases moyennes comptent 10 à 15 mots. Et les phrases longues dépassent les 20 mots.

Essayez toujours de rester autour de 15 mots ou moins. Vous pouvez raccourcir vos phrases les plus longues en supprimant les adverbes, les adjectifs, en remplaçant les mots difficiles, etc.

4.3 Bannissez les mots difficiles de votre vocabulaire.

Vous serez toujours tenté d'exhiber le dernier mot ou acronyme appris dans votre newsletter préférée. Mais il y a de fortes chances que vous puissiez presque toujours utiliser un choix de mot plus simple pour transmettre le même sens.

Voici un exemple.

Version complexe : « Notre produit tire parti d'une technologie de pointe pour optimiser le débit et l'évolutivité des cadres de traitement de données, améliorant ainsi de manière significative les efficacités opérationnelles. »

Version simplifiée : « Nous simplifions les opérations en utilisant les dernières technologies pour accélérer les cadres de traitement de données. »

Ces 3 règles à elles seules corrigeront la plupart de vos écrits. Et si vous voulez les corriger, utilisez un outil comme Hemingway. Il met en évidence les phrases longues et les mots difficiles pour que vous puissiez les corriger. De plus, il vous fournit une analyse de lisibilité de haut niveau de votre contenu.

Par exemple, voici l'analyse de lisibilité du contenu de l'article jusqu'au paragraphe ci-dessus :

Image importée depuis Webflow

Hemingway vous aide à analyser gratuitement la lisibilité de vos écrits

5. Relisez-le le lendemain

Laissez toujours passer 6 à 12 heures avant de réviser votre premier jet. Ce délai vous aide à examiner le document avec un regard neuf. C'est à ce moment-là que vous révisez et corrigez.

> Je finis probablement par jeter un quart de ce que j'écris dans le premier jet d'un chapitre de livre. Même si j'essaie d'être assez réfléchi pour déterminer ce que je veux dire avant d'écrire, il faut quand même voir comment les concepts se présentent sur la page pour décider s'ils méritent d'être conservés.

- Cal Newport

En écrivant, nous puisons dans la pensée convergente. Nous nous laissons emporter par notre chaîne de pensées incohérente et partons dans des digressions. Cela reste acceptable lorsqu'on écrit de la fiction, des essais ou des textes exploratoires sur des tendances émergentes. Mais les informations redondantes sont un péché en rédaction professionnelle. Elles font perdre du temps et envoient vos collègues dans les mêmes digressions inutiles, si vous ne les supprimez pas.

6. Facultatif - Ajoutez un appel à l'action (CTA)

Votre document devrait indiquer à chaque lecteur exactement ce que vous attendez de lui avec cette information. Cela peut prendre la forme de prochaines étapes ou de suggestions, mais c'est un élément crucial.

Si vous êtes une entreprise dynamique qui cherche à réduire les réunions, c'est indispensable. Mais si vous rédigez des documents comme point de départ d'une discussion interservices plus large, un CTA peut sembler un peu abrupt. À vous de juger.

Et 5 conseils avancés de rédaction professionnelle pour passer de bon à brillant.

Les conseils de la section précédente transformeront votre communication professionnelle. Mais si vous voulez rejoindre le top 1 % des rédacteurs professionnels au monde, faites ceci.

Conseil n°1 - Réduisez les affirmations générales et les mots faibles.

N'écrivez pas :

« Notre service client est excellent. »

Écrivez :

« 89 % des clients interrogés jugent notre service client "très satisfaisant", avec un score de satisfaction moyen de 4,8 sur 5 basé sur plus de 5 000 réponses. Cela nous classe n°1 en satisfaction client parmi nos 5 principaux concurrents. »

Au lieu de l'adjectif vague « excellent », cet exemple utilise des données et des pourcentages précis pour étayer l'affirmation sur la qualité du service client. Fournir le contexte des classements concurrentiels renforce aussi l'affirmation par des faits. Ce niveau de détail donne au lecteur des preuves tangibles plutôt qu'une affirmation générale et ambiguë.

Conseil n°2 - Anticipez les objections

N'écrivez pas :

« Notre nouvelle politique sera meilleure pour les employés. »

Écrivez :

« Certains pourraient penser qu'un horaire de début plus matinal est moins pratique. Cependant, les données montrent que le nouveau créneau de 9 h favorise un environnement de travail plus productif. Les employés peuvent profiter des heures matinales plus calmes, et les études font état d'une production accrue de 10 à 15 % grâce aux débuts plus précoces. »

Conseil n°3 - Donnez-lui des airs d'histoire

N'écrivez pas :

« Nous avons mis à jour nos offres, ce que les clients ont apprécié. »

Écrivez :

« Lorsque les groupes de discussion ont exprimé le désir de nouvelles fonctionnalités, notre équipe est passée à l'action. Les ingénieurs produit ont ajouté les options A et B, longtemps réclamées. Les marketeurs ont créé une campagne sociale au succès retentissant basée sur ces améliorations. En 2 mois, 83 % des utilisateurs avaient essayé les nouvelles fonctionnalités, et les abonnements ont augmenté de 20 %. »

Conseil n°4 - Allez au-delà des mots, ajoutez des visuels

N'écrivez pas seulement :

« Notre nouveau processus fait gagner du temps. »

Ajoutez aussi un schéma du processus en 10 étapes, en mettant en évidence l'endroit où 2 étapes redondantes ont été supprimées.

Conseil n°5 - Confiez la relecture de votre travail à quelqu'un.

Tous les écrivains professionnels ont un éditeur. La plupart des remerciements de livres commencent par des louanges à l'éditeur pour avoir supporté l'auteur et sculpté son écrit en une œuvre achevée.

Faites relire vos documents par un pair avant d'en envoyer un important. En général, ils repèrent des choses que vous ne pouvez tout simplement pas voir, aussi bon que vous deveniez. Idéalement, vous devriez avoir un respect immense pour cette personne afin de prendre ses retours au sérieux.

C'est pourquoi la plupart des excellents écrits professionnels prennent du temps. La lenteur est inhérente à la rigueur du processus. Même si vous avez déjà une idée géniale articulée dans votre tête, il vous faudra quand même du temps pour la peaufiner, la mettre en forme, corriger les fautes de frappe, et seulement après, vous pourrez la publier.

Alors, existe-t-il un moyen de produire d'excellents écrits professionnels en très peu de temps ?

Vous pouvez utiliser l'IA pour transformer vos notes brutes en documentation professionnelle, car c'est un excellent correcteur orthographique et un bon relecteur. Il y a 2 façons de procéder.

Méthode 1 - Utilisez le formateur de documents magique de Slite

Le formateur de documents gratuit de Slite transforme vos notes en un document cohérent, facile à lire et joliment mis en forme. Voici comment ça marche :

Étape 1 : Rendez-vous sur ce lien.

Image importée depuis Webflow

Étape 2 : Collez votre contenu et cliquez sur « Obtenir le document formaté »

Vous n'y croyez pas ?

Pour cet exemple, nous avons demandé à ChatGPT de créer un résumé du livre « Getting Things Done » et voici le résultat obtenu !

Image importée depuis Webflow

Le formateur de documents magique de Slite en action

Voici une brève liste de tout ce que le formateur de documents magique fait à votre contenu :

  1. Vous donne d'emblée accès à des modèles pour les documents de travail quotidiens
  2. Corrige tous types de fautes d'orthographe et de grammaire.
  3. Ajoute des sous-titres à votre contenu.
  4. Met en gras les phrases importantes pour souligner les points clés.
  5. Maintient un ton professionnel.
  6. Vous livre votre résultat gratuitement en quelques secondes. Traditionnellement, il faudrait au moins 20 à 30 minutes à la plupart des professionnels pour réaliser le genre d'édition que le formateur de documents magique effectue en un éclair.

Méthode 2 - Demandez manuellement à ChatGPT de développer votre contenu

La deuxième façon de procéder consiste à donner vos notes à ChatGPT et, une par une, à lui demander de :

  1. Développer les points
  2. Simplifier le vocabulaire et les phrases
  3. Les restructurer en un [type de document que vous préparez. Ex : un plan, une proposition, etc.]
  4. Reformater le contenu pour améliorer la lisibilité en ajoutant des sauts de paragraphe et des titres

‍Astuce de pro : Au lieu de donner toutes les instructions dans un seul message, donnez les consignes une à la fois. Les LLM peinent avec les processus en plusieurs étapes. Ils ont tendance à oublier des étapes ici et là en permanence. Une meilleure approche consiste à donner une instruction, à itérer jusqu'à ce que vous soyez satisfait, et seulement après, à passer à l'étape suivante.

Méthode 3 - Utilisez Slite pour rassembler des informations complètes avant d'écrire

Le plus grand gouffre temporel de la rédaction professionnelle n'est pas l'écriture elle-même : c'est de trouver les bonnes informations sur lesquelles écrire. Vos meilleures idées sont dispersées dans des conversations Slack, des tickets Linear, des discussions GitHub, des documents Google Drive et des tickets de support. Vous finissez par passer 30 à 40 % de votre temps de rédaction à fouiller dans plusieurs plateformes au lieu de construire votre récit.

Slite résout ce goulot d'étranglement de la recherche. Sa recherche par IA extrait des réponses de votre base de connaissances, et sur le plan Pro, Slite Agent effectue aussi des recherches dans tous vos outils connectés. Voici comment l'utiliser pour une meilleure rédaction professionnelle :

Étape 1 : Au lieu d'ouvrir plus de 15 onglets de navigateur, posez à Slite des questions en langage naturel comme « Quelles étaient les principales objections des clients à notre changement de tarif ? » ou « Quels indicateurs se sont améliorés après le nouveau processus d'intégration ? »

Étape 2 : Obtenez des réponses complètes avec citation des sources provenant de toutes les plateformes : discussions Slack, mises à jour de projet dans Linear, retours clients issus des outils de support et décisions techniques tirées de GitHub.

Étape 3 : Utilisez ces informations vérifiées comme fondation, puis appliquez les méthodes 1 ou 2 pour structurer et peaufiner votre écrit.

Cette approche transforme votre phase de recherche d'une chasse éparpillée en une collecte d'informations ciblée. Vous passez moins de temps à vous demander « Où ai-je vu cette discussion importante ? » et plus de temps à composer des récits professionnels convaincants avec un contexte complet.

Slite veille à ce que vous ne manquiez jamais une information cruciale parce qu'elle est enfouie dans le mauvais outil. Il démarre à 10 $/utilisateur/mois, et le plan Pro (20 $/utilisateur/mois) ajoute la recherche de Slite Agent dans tous vos outils connectés. Réservez une démo pour voir comment il accélère votre rédaction professionnelle.

Le mot de la fin - vous continuerez à progresser si vous vous exercez

Mark Twain a dit cette phrase célèbre : « Je n'ai pas eu le temps de t'écrire une lettre courte, alors je t'en ai écrit une longue. » Les écrivains vivent et respirent au rythme de cette citation. Bien écrire, c'est prendre une grande quantité d'informations, en faire une histoire, puis la condenser. C'est difficile.

‍Comme toute autre compétence exigeante, vous pouvez améliorer votre rédaction professionnelle si vous vous exercez. Mais contrairement à la plupart des autres compétences, il y a un effet cumulé. Vos réunions seront moins nombreuses. Vos collègues vous respecteront davantage. Vous aurez l'esprit plus critique. Davantage d'opportunités se présenteront à vous.

Mais tout commence par votre simple habitude d'écrire.

Ishaan Gupta
執筆者

Ishaan tracks the AI knowledge work shift for Slite and Super. He reads too much, argues with too many takes, and tries to find the words for things before they have words, e.g. knowledge drift, context graphs, workslop, and whatever the next term will be. When he's not writing, he's probably building AI agents to do it for him.

チームとエージェントが信頼できる、自己管理型ナレッジベース

デモを予約料金を見る