Vérifiez le contenu
L'un des moyens les plus importants de réviser un brouillon est de vérifier le contenu—comme c'est évident ! Toutes les bonnes transitions, la bonne organisation et la structure de phrase claire du monde ne peuvent pas aider un document technique qui n'a pas le bon contenu. Le contenu d'un document technique peut être "erroné" de plusieurs manières :
- Cela peut être complètement absent : par exemple, imaginez que quelqu'un ait écrit un rapport sur "les communautés virtuelles" mais n'a jamais pris la peine de définir ce que ce terme signifie. Cela serait difficile dès le début de ce rapport.
- C'est là mais pas assez : prenons le même exemple—imaginez que l'auteur n'ait fait que quelques déclarations vagues sur les communautés virtuelles. Ce qui était nécessaire, c'était au moins un paragraphe sur le sujet, sinon une section complète de 3 ou 4 pages.
- C'est là, mais au mauvais niveau pour le public : Il est également possible de présenter des informations à un niveau inapproprié en termes de connaissances, de parcours ou de besoins des lecteurs. Imaginez que l'auteur ait inclus une section de 3 pages sur la mise en cache des données, mais rédigée pour un expert "développeur de produits" alors que le rapport était réellement destiné à des non-spécialistes.
Si vous pouvez sentir comment l'information est insuffisante dans un brouillon de rapport, vous devriez être bien parti pour savoir ce qu'il faut faire spécifiquement pour réviser. Un outil de brainstorming utile est de penser en termes de types de contenu.
Utilisez les questions fournies dans contenu du document pour examiner votre brouillon afin d'ajouter ou de modifier des types d'information.
Vérifiez la structure de vos contenus.
Il y a deux façons d'envisager l'organisation de l'information dans un document :
- une, couverte dans la section suivante, implique de regarder la séquence des morceaux d'information, en vérifiant s'ils sont dans le bon ordre.
- Un autre concerne les niveaux d'information. Vous pouvez examiner les phrases ou les paragraphes dans un brouillon et voir que certaines phrases approfondissent la discussion sur le sujet plus que d'autres. D'autres phrases jouent le rôle de cadre sur lequel ces phrases de niveau plus profond dépendent. En regardant la structure de cette manière, vous ne vérifiez pas seulement son organisation mais vous obtenez également de nombreuses bonnes idées sur la façon d'améliorer le contenu du texte.
Une explication beaucoup plus détaillée est fournie à coordination et subordination dans des paragraphes.
Vérifier l'organisation
Si vous avez le bon contenu dans un rapport, au moins vous avez toutes les "bonnes choses" disponibles pour les lecteurs. Cependant, cela peut encore ne pas être correctement organisé—comme lorsque vous venez de déménager et que tout est en désordre ou encore dans des cartons. Vous avez besoin de deux compétences essentielles pour revoir l'organisation d'un brouillon :
- Identifier le sujet de morceaux d'information à divers niveaux. Pour évaluer l'organisation d'une série de paragraphes, vous commencez par penser à un mot ou une phrase pour identifier le sujet de chaque paragraphe—en d'autres termes, comprendre chacun d'eux. Ensuite, vous vous éloignez de ces mots ou phrases, en considérant s'ils sont dans le bon ordre. Cependant, ce n'est qu'un niveau. Vous pouvez également examiner dans un paragraphe individuel pour son organisation. Dans ce cas, vous identifiez le sujet de chaque phrase et considérez le séquencement de ces phrases.
- Choisissez la meilleure séquence pour les morceaux d'information. Une fois que vous connaissez le sujet de chacun des morceaux d'information (quel que soit le niveau que vous explorez), vous pouvez alors décider s'ils sont dans le bon ordre. Cette décision implique de connaître les schémas de séquençage courants ; voici quelques exemples :
- Général → spécifique : Une façon courante d'organiser est de disposer des blocs de contenu du général au spécifique. Par exemple, définir tout Les collecteurs solaires constituent une discussion plus générale que celle des différents types de collecteurs solaires. Et décrire le fonctionnement d'un type spécifique de collecteur solaire est encore moins général. Ce schéma est illustré ici :
Révision avec le schéma organisationnel général-à-spécifique. Il est plus naturel de commencer par définir ce que font tous les collecteurs solaires, puis de passer à leurs différents types. - Simple, basique → complexe : Une autre façon d'organiser les unités d'une discussion est de commencer par les éléments simples, basiques, fondamentaux et ensuite de passer aux plus complexes et techniques.
- Objet au repos → objet en mouvement : Un autre schéma d'organisation consiste d'abord à décrire l'objet (comme dans une photographie), puis à discuter de son fonctionnement ou de son processus (comme dans une vidéo). Cette approche pourrait bien fonctionner pour une discussion sur un système d'injection de carburant.
- Mouvement spatial : — Si vous décrivez les détails physiques de quelque chose, vous voudrez peut-être utiliser un certain schéma de mouvement physique, par exemple, de haut en bas, de gauche à droite, ou de l'extérieur vers l'intérieur.
- Mouvement temporel : — Un des motifs les plus courants est basé sur le mouvement à travers le temps ; organisez la discussion des événements en relation avec la séquence temporelle.
- Concept → application du concept, exemplesUn schéma organisationnel courant consiste à discuter d'un concept en termes généraux, puis à discuter d'une application de celui-ci. Par exemple, un autre chapitre de ce livre aborde d'abord les propositions sur un plan conceptuel, puis discute d'exemples de propositions.
- Données → conclusions : Un autre moyen d'organiser l'information est de présenter des données (observations, données expérimentales, résultats d'enquêtes), puis de passer aux conclusions qui peuvent être tirées de ces données. (Et ce schéma est parfois inversé : présenter la conclusion d'abord, puis les données qui la soutiennent.)
- Problème, question → solution, réponse : Vous pouvez également organiser l'information en discutant d'abord d'un problème ou en posant une question, puis en passant à la solution ou à la réponse.
- Version simplifiée → version détaillée : Une manière utile d'expliquer des questions techniques à des non-spécialistes est de commencer par discuter d'une version simplifiée de la chose, établir une compréhension solide de celle-ci, puis revenir en arrière et tout expliquer à nouveau mais cette fois en ajoutant des détails techniques de manière dense et approfondie !
- Le plus important → le moins important : Une méthode d'organisation plus "rhétorique" est de commencer par les informations les plus importantes, les plus accrocheuses, les plus dramatiques, puis de passer à des informations progressivement moins marquantes. (Et ce schéma peut être inversé : vous pouvez parvenir à un climax, plutôt que de commencer par lui.)
- Le plus convaincant → le moins convaincant : — De même, vous pouvez commencer par l'argument le plus convaincant pour votre position — afin d'attirer l'attention de tout le monde — puis passer à des arguments de moins en moins convaincants. (Ce schéma peut également être inversé : vous pouvez accumuler vos arguments les plus convaincants.)
- Général → spécifique : Une façon courante d'organiser est de disposer des blocs de contenu du général au spécifique. Par exemple, définir tout Les collecteurs solaires constituent une discussion plus générale que celle des différents types de collecteurs solaires. Et décrire le fonctionnement d'un type spécifique de collecteur solaire est encore moins général. Ce schéma est illustré ici :
Ce ne sont que quelques possibilités. Lorsque l'objectif est informatif, vous organisez l'information de manière à ce que les lecteurs comprennent les bases avant de passer aux choses compliquées et techniques. Lorsque l'objectif est persuasif, vous disposez les éléments pour maximiser l'effet persuasif sur les lecteurs, par exemple, en plaçant les arguments les plus forts en premier.
Et de toute façon, vous évitez de mélanger ces approches—par exemple, jeter des données, puis énoncer quelques conclusions, puis faire cela de manière aléatoire. Gardez les pommes séparées des oranges !
Renforcez les phrases principales et les aperçus.
L'une des meilleures choses que vous pouvez faire est de revenir sur un brouillon et de vérifier si vous pouvez insérer des phrases de sujet et des aperçus à des points clés. Lorsque nous écrivons, nous ne sommes généralement pas sûrs exactement de la direction qu'un paragraphe ou une section prend en termes de contenu et de logique. Une fois qu'elle a "atteint ce stade," il est souvent nécessaire de revenir au début et d'ajouter une sorte d'aperçu ou de modifier ce qui est déjà là pour rendre l'aperçu plus clair. Les lecteurs ont besoin de savoir où ils vont dans un rapport, ce qui arrive ensuite, et d'ailleurs où ils viennent juste d'être.
Avoir un aperçu dans un rapport est comme avoir une carte quand on est dans une nouvelle ville. Les phrases de sujet et les aperçus offrent une perspective sur ce qui est où : le sujet, les sous-sujets, le but de la discussion à venir, sa relation avec la section précédente et avec le document dans son ensemble. (Maintenant, une partie de cela implique des transitions, qui est le prochain élément à examiner.)
Pour un traitement détaillé de ce sujet, voir phrases thématiques et aperçus.
Renforcer la cohérence, les transitions
Vous pouvez avoir les bonnes informations dans un rapport et les organiser correctement, mais quelque chose d'important peut quand même mal tourner. Les lecteurs peuvent manquer le "flux" des idées, avoir du mal à sentir comment les morceaux d'information sont liés ou connectés les uns aux autres. Ce dont les lecteurs ont besoin, c'est d'une guidance continue—que vous, en tant qu'écrivain, fournissez. Et ce que vous utilisez pour fournir cette guidance s'appelle des transitions—divers dispositifs qui aident les lecteurs à travers un document. Il y a (ou devrait certainement y avoir) une logique qui relie chaque phrase dans un document et qui dicte une certaine séquence à ces phrases.
Voir le chapitre sur cohérence et transitions pour une discussion détaillée et des exemples.
Vérifiez la longueur des paragraphes.
Une dernière façon de revoir votre brouillon au niveau de la structure est de vérifier comment vous avez défini les sauts de paragraphe. Les paragraphes sont des créatures étranges—certains chercheurs en écriture croient qu'ils n'existent pas et ne sont que des points de rupture arbitraires que les auteurs insèrent quand et où bon leur semble. Désolé—dans l'écriture technique, le paragraphe est un acteur clé dans la bataille pour la clarté et la compréhension. Bien que ce ne soit pas toujours possible, les paragraphes devraient apparaître là où il y a un changement de sujet ou de sous-sujet ou un changement dans la façon dont un sujet est discuté.
Sur une page pleine de texte en interligne simple, recherchez au moins une à quatre coupures de paragraphe—il n'y a rien de magique dans cette moyenne, alors ne la considérez pas comme une loi. Jetez juste un second regard à ces longs paragraphes et vérifiez la possibilité de coupures de paragraphe.
J'apprécierais vos pensées, réactions, critiques concernant ce chapitre : votre réponse—David McMurrey.
