Veuillez cliquer ici pour aider David McMurrey payer pour l'hébergement web :
Donnez n'importe quel petit montant que vous pouvez !
La rédaction technique en ligne restera gratuite.
Le plus grand obstacle que vous pourriez rencontrer en rédigeant une description est de vous rappeler ce que le terme signifie dans ce contexte. Nous utilisons tous le mot description librement pour désigner pratiquement toute discussion ou explication. Mais dans ce contexte, cela signifie la discussion détaillée des aspects physiques d'une chose. Cela signifie discuter de choses comme la couleur, la forme, la taille, le poids, la hauteur, la largeur, l'épaisseur, la texture, la densité, le contenu, les matériaux de construction, et ainsi de suite.
Par exemple, cette phrase n'est pas vraiment une description dans notre sens du mot :
Une disquette est un dispositif utilisé pour stocker des données électroniques.
Il explique la fonction ou l'objectif mais fournit peu ou pas de détails physiques. Cependant, cette phrase est très clairement une description :
La disquette informatique commune des années 1980 mesurait 3,5 pouces par 3,5 pouces et avait une épaisseur d'environ 1/8 de pouce.
Assurez-vous de consulter le exemples de descriptions disponible avec ce chapitre.
Infographie générée par NotebookLM de ce chapitre
Contexts pour la description
Comme mentionné précédemment, les descriptions sont un élément commun dans l'écriture technique—juste pas tout à fait de la même manière que les instructions. Les descriptions apparaissent plus souvent sous la forme d'une phrase ou deux ici, d'un paragraphe là, ou d'une section entière ailleurs. Certains types d'écriture technique comportent des descriptions :
- Rapports d'accidents nécessitant beaucoup de descriptions.
- Spécifications du produit—documents qui décrivent le design et les caractéristiques d'un nouveau produit ou d'un produit modifié—ont beaucoup de descriptions.
- Les instructions nécessitent souvent une description pour permettre aux lecteurs de visualiser ce qu'ils font et avec quoi ils travaillent.
Contenu et Organisation des Descriptions
Voici une revue des sections que vous trouverez souvent dans les descriptions. En lisant, consultez les exemples de descriptions.
Introduction. Planifiez soigneusement l'introduction de votre description. Assurez-vous qu'elle réalise toutes les choses suivantes (mais pas nécessairement dans cet ordre) qui s'appliquent à votre description particulière :
- Indiquez l'objet spécifique sur le point d'être décrit.
- Indiquez ce que le public a besoin en termes de connaissances et de contexte pour comprendre la description.
- Fournissez une description générale de l'objet.
- Inclure un aperçu du contenu de la description.
Contexte. Si la chose que vous décrivez n'est pas susceptible d'être familière à la plupart de vos lecteurs, envisagez d'ajouter un peu de contexte avant de vous plonger dans la description réelle. Si vous êtes sur le point de décrire un densimètre SGO/3 à des non-spécialistes, il vaut mieux d'abord discuter de ce qu'est cet objet, ce qu'il fait et dans quelle partie du monde il est utilisé.
Discussion des parties ou des caractéristiques. La partie principale de votre description est la discussion de chaque partie ou caractéristique. Vous devez diviser la chose que vous décrivez en parties, ou caractéristiques, ou les deux. Pièces sont faciles : par exemple, un crayon en bois a de la mine, un tonneau en bois, une gomme, et un clip en métal. Caractéristiques sont des aspects décrivables d'une chose mais ne sont pas des parties : par exemple, le crayon a un certain poids, une certaine longueur, une certaine largeur, et ainsi de suite. Si vous étiez un jeune magnat de l'immobilier et que vous deviez décrire un terrain vacant pour les dossiers de l'entreprise, vous le décririez probablement par ses caractéristiques : son emplacement, sa superficie, son terrain, sa végétation, son accès aux services publics, et ainsi de suite. (Regardez la description du grattoir en pierre primitive dans les exemples ; une partie est organisée par caractéristiques, et une partie par parties !)
Une fois que vous avez divisé la chose que vous décrivez en parties, caractéristiques, ou les deux, votre prochaine tâche est de décrire chacune d'elles. Pour les objets mécaniques, il est efficace de commencer par définir la partie, en expliquant sa fonction. Ensuite, vous décrivez la partie du général au spécifique, en utilisant toutes les sources de description qui sont appropriées.
Remarquez que dans la description, vous pouvez mélanger d'autres types d'écriture. Vous vous retrouverez à expliquer des fonctions, à définir des termes, à discuter un peu du processus en décrivant. Ce n'est pas un problème tant que le principal objectif et la majorité du contenu sont vraiment descriptifs.
Discussion de l'opération ou du processus associé. À un certain point dans une description, souvent à la fin, il est utile de résumer l'opération ou le processus associé à l'objet que vous décrivez. Par exemple, si vous venez de décrire un crayon mécanique, vous pourriez brièvement expliquer comment il s'utilise. Si vous venez de décrire un flocon de neige, vous pourriez discuter du processus par lequel il s'est formé.
Sources de Description
Lorsque vous rédigez une description, vous devez penser aux types de détails descriptifs que vous pouvez fournir. Parfois, les descriptions sont plutôt faibles à cet égard. Utilisez la liste suivante pour planifier votre description ou pour revoir une description que vous avez écrite. Pensez aux catégories de détails descriptifs que vous pourriez fournir, ou utilisez la liste suivante pour identifier des catégories que vous n'avez pas utilisées :
|
couleur hauteur largeur forme poids matériaux texture emplacement méthodes d'attachement odeur |
profondeur montant patron, design ingrédients âge sous-parties longueur finir température teneur en humidité |
Vue schématique des descriptions. N'oubliez pas que ceci n'est qu'un modèle typique ou courant pour les contenus et l'organisation—de nombreux autres sont possibles.
Préoccupations diverses
Dans les descriptions, vous vous retrouverez probablement à vous demander comment gérer les chiffres, les abréviations et les symboles :
Nombres. Rappelez-vous que l'écriture technique enfreint certaines des règles que vous avez travaillées si durement à apprendre dans vos anciens cours d'écriture. Dans le contexte de l'écriture technique, nous sommes souvent très attentifs aux chiffres et voulons qu'ils se démarquent. Cela signifie que vous devez utiliser des chiffres dans le texte courant lorsque le nombre indique un montant exact, mesuré ou mesurable ou lorsqu'il représente une valeur critique. Par exemple, dans ces phrases, il semble important que les chiffres soient exacts :
La tasse a un diamètre de 3 pouces.
Utilisez 4 punaises pour fixer l'affiche au mur.
Cependant, cela ne signifie pas utiliser des chiffres pour des valeurs indifférentes. Par exemple, dans cette phrase, il n'y a rien d'étonnant quant au nombre de sections que contient le rapport :
Le rapport contient quatre sections principales.
Voir la section sur nombres vs. mots pour plus de détails.
Anatomie d'un paragraphe descriptif. Typiquement, cela commence par une déclaration sur le but ou la fonction de la pièce, suivie des détails descriptifs. Les détails descriptifs s'appuient sur les "sources" de description— telles que la couleur, la forme, la largeur et la hauteur.
Abréviations. Dans l'écriture technique, nous nous attendons à voir des abréviations. Utilisez-les librement dans votre description. Rappelez-vous la règle sur la ponctuation des abréviations : ne les ponctuez que si elles forment un mot (par exemple, _IN_). N'oubliez pas non plus que les abréviations font pas aller à l'encontre du nombre avec lequel ils sont utilisés (par exemple, faire ce "ruban 8 mm" ou "ruban 8 mm" mais pas "tape 8mm").
Symboles. Le problème le plus courant avec les symboles dans les instructions et descriptions concerne les pouces et les pieds. Si vous rédigez des instructions pour le projet de rêve d'un menuisier où il y a des pieds et des pouces partout, utilisez les symboles " (pouces) et ' (pieds). Cependant, si vous ne citez les mesures en pouces et en pieds que quelques fois, utilisez le mot ou l'abréviation à la place.
Graphismes et Format dans les Descriptions
Dans la plupart des descriptions, vous aurez besoin d'au moins une illustration de la chose que vous décrivez, avec des étiquettes pointant vers les différentes parties. Voir la section sur graphismes pour en savoir plus sur la création de graphiques, leur formatage et leur incorporation dans vos descriptions.
Titres. Dans les descriptions, vous voudrez utiliser des titres et des sous-titres pour marquer la discussion des différentes parties ou caractéristiques. Rappelez-vous qu'idéalement, vous souhaitez décrire chaque partie dans un paragraphe ou une section séparée—et signaler cette discussion avec un titre. Si vous avez une section de contexte, utilisez également un titre pour celle-ci. Consultez la section sur titres pour les exigences spécifiques.
Listes. Les listes ne sont pas aussi importantes dans les descriptions que dans les instructions. Cependant, si vous énumérez des parties ou des sous-parties ou que vous listez des spécifications, ce sont de bonnes situations pour des listes. Consultez la section sur listes pour les exigences spécifiques.
Avis spéciaux. Dans les descriptions, il n'y a rien de tel que le rôle important des avis spéciaux comme dans les instructions. Après tout, si c'est vraiment une description, les lecteurs ne devraient pas essayer de suivre une procédure et ne devraient donc courir aucun risque d'endommager l'équipement, de gaspiller des fournitures, de réussir mal la procédure ou de se blesser eux-mêmes ou d'autres. Cependant, vous pouvez trouver le note avis spécial pour souligner des points importants ou des exceptions. Voir la section sur avis spéciaux pour une discussion complète sur l'utilisation appropriée de ces avis spéciaux ainsi que leur format et leur placement dans les instructions.
J'apprécierais vos réflexions, réactions, critiques concernant ce chapitre : réponse—David McMurrey
