Rédaction technique - Technical writing

La rédaction technique est la rédaction ou la rédaction de communications techniques utilisées dans les domaines techniques et professionnels, tels que le matériel informatique et les logiciels , l' ingénierie , la chimie , l' aéronautique , la robotique , la finance , la médecine , l'électronique grand public , la biotechnologie et la foresterie . La rédaction technique englobe le plus grand sous-domaine de la communication technique.

La Society for Technical Communication définit la communication technique comme toute forme de communication qui présente une ou plusieurs des caractéristiques suivantes : « (1) communiquer sur des sujets techniques ou spécialisés, tels que des applications informatiques, des procédures médicales ou des réglementations environnementales ; (2) communiquer en utilisant la technologie, telle que des pages Web, des fichiers d'aide ou des sites de médias sociaux ; ou (3) en fournissant des instructions sur la façon de faire quelque chose, quelle que soit la technicité de la tâche".

Aperçu

La rédaction technique est effectuée par un rédacteur technique (ou auteur technique) et est le processus de rédaction et de partage d'informations techniques dans un cadre professionnel. La tâche principale d'un rédacteur technique est de communiquer des informations techniques à une autre personne ou partie de la manière la plus claire et la plus efficace possible. Les informations que les rédacteurs techniques communiquent étant souvent complexes, de solides compétences en rédaction et en communication sont essentielles. Les rédacteurs techniques transmettent non seulement des informations par le biais de textes, mais ils doivent également maîtriser les ordinateurs. Les rédacteurs techniques utilisent un large éventail de programmes pour créer et éditer des illustrations , des programmes de création de diagrammes pour créer des aides visuelles et des processeurs de documents pour concevoir, créer et formater des documents.

Alors que la rédaction technique est généralement associée à l'aide en ligne et aux manuels d'utilisation , le terme documentation technique peut couvrir un plus large éventail de genres et de technologies. Communiqués de presse , notes de service , rapports , propositions commerciales , fiches techniques , descriptions et spécifications de produits , livres blancs , curriculum vitae et demandes d'emploi ne sont que quelques exemples de rédaction pouvant être considérés comme de la documentation technique. Certains types de documentation technique ne sont généralement pas traités par les rédacteurs techniques. Par exemple, un communiqué de presse est généralement rédigé par un rédacteur en relations publiques, bien qu'un rédacteur technique puisse avoir son mot à dire sur toute information technique incluse dans le communiqué de presse.

Histoire

Alors que l'écriture technique n'est reconnue comme une profession que depuis la Seconde Guerre mondiale , ses racines remontent à l'Antiquité classique . Les critiques citent les œuvres d'écrivains comme Aristote comme les premières formes d'écriture technique. L' ouvrage de Geoffrey Chaucer , Treatise on the Astrolabe, est un des premiers exemples de document technique . Les premiers exemples d'écriture technique remontent à la période du vieil anglais.

Avec l'invention de l' imprimerie mécanique , le début de la Renaissance et l'avènement de l' âge de la raison , la documentation des découvertes est devenue une nécessité. Des inventeurs et des scientifiques comme Isaac Newton et Léonard de Vinci ont préparé des documents relatant leurs inventions et leurs découvertes. Bien qu'ils n'aient jamais été appelés documents techniques au cours de leur période de publication, ces documents ont joué un rôle crucial dans le développement des formes modernes de communication et d'écriture techniques.

Le domaine de la communication technique s'est développé pendant la révolution industrielle . Il y avait un besoin croissant de fournir aux gens des instructions pour utiliser les machines de plus en plus complexes qui étaient inventées. Cependant, contrairement au passé, où les compétences se transmettaient par les traditions orales, personne en dehors des inventeurs ne savait comment utiliser ces nouveaux appareils. L'écriture est ainsi devenue le moyen le plus rapide et le plus efficace de diffuser l'information, et des écrivains capables de documenter ces dispositifs étaient recherchés.

Au cours du 20e siècle, le besoin de rédaction technique a explosé et la profession est devenue officiellement reconnue. Les événements de la Première et de la Seconde Guerre mondiale ont conduit à des progrès dans la médecine, le matériel militaire, la technologie informatique et les technologies aérospatiales. Cette croissance rapide, associée à l'urgence de la guerre, a créé un besoin immédiat de documentation bien conçue pour soutenir l'utilisation de ces technologies. La rédaction technique était très demandée à cette époque, et « rédacteur technique » est devenu un titre de poste officiel pendant la Seconde Guerre mondiale .

Après la Seconde Guerre mondiale , les progrès technologiques ont conduit à une augmentation des biens de consommation et du niveau de vie. Pendant le boom d'après-guerre, les services publics comme les bibliothèques et les universités, ainsi que les systèmes de transport comme les bus et les autoroutes, ont connu une croissance substantielle. Le besoin pour les écrivains de faire la chronique de ces processus s'est accru. C'est également au cours de cette période que les grandes entreprises et les universités ont commencé à utiliser des ordinateurs. Notamment, en 1949, Joseph D. Chapline a rédigé le premier document technique de calcul, un manuel d'instructions pour l' ordinateur BINAC .

L'invention du transistor en 1947 a permis de produire des ordinateurs à moindre coût et à la portée des particuliers et des petites entreprises. Au fur et à mesure que le marché de ces « ordinateurs personnels » se développait, le besoin d'écrivains capables d'expliquer et de fournir une documentation utilisateur pour ces appareils s'est accru. La profession de rédacteur technique a connu une nouvelle expansion au cours des années 1970 et 1980, alors que l'électronique grand public s'installait dans les foyers de plus en plus de personnes.

Ces dernières années, l'importance des ordinateurs dans la société a conduit à de nombreuses avancées dans le domaine des communications numériques, entraînant des changements dans les outils utilisés par les rédacteurs techniques. L'hypertexte , les traitements de texte , les programmes d'édition graphique et les logiciels de mise en page ont rendu la création de documents techniques plus rapide et plus facile, et les rédacteurs techniques d'aujourd'hui doivent maîtriser ces programmes.

Technique

Une bonne rédaction technique est concise, ciblée, facile à comprendre, exempte d'erreurs et axée sur le public. Les rédacteurs techniques s'efforcent de rendre leurs documents aussi clairs que possible, en évitant les phrases trop techniques et les choix stylistiques comme la voix passive et les nominalisations. Étant donné que les documents techniques sont utilisés dans des situations réelles, il doit toujours être explicitement clair quel est le sujet d'un document technique et comment utiliser les informations présentées. Ce serait désastreux si, par exemple, les instructions d'un rédacteur technique sur la façon d'utiliser un appareil à rayons X de grande puissance étaient difficiles à déchiffrer.

L'écriture technique exige qu'un écrivain examine en profondeur son public. Un rédacteur technique doit être conscient des connaissances existantes de son auditoire sur le matériel dont il discute, car la base de connaissances de l'auditoire de l'écrivain détermine le contenu et l'orientation d'un document. Par exemple, un rapport d'évaluation discutant des conclusions d'une étude scientifique qui est écrit à un groupe de scientifiques hautement qualifiés sera construit très différemment d'un rapport destiné au grand public. Les rédacteurs techniques n'ont pas besoin d'être eux-mêmes des experts en la matière (PME). Ils collaborent souvent avec des PME pour accomplir des tâches qui nécessitent plus de connaissances sur un sujet qu'ils n'en possèdent.

La rédaction technique doit être précise. Un rédacteur technique, après avoir analysé son public, sait ce dont il a besoin pour communiquer et doit ensuite transmettre le message de manière précise et éthique. Des répercussions physiques, environnementales ou financières pourraient survenir si un écrivain ne le fait pas correctement. Connaître le public est essentiel à la précision, car le langage sera adapté en fonction de ce qu'il comprend déjà sur le sujet traité. Par exemple, des instructions sur la façon d'assembler correctement et en toute sécurité une étagère sont incluses avec l'achat. Ces instructions sont conçues de manière à ce que tout le monde puisse les suivre, y compris des détails précis sur l'emplacement de chaque attache. Si ces instructions étaient inexactes, la bibliothèque pourrait être instable et échouer.

La conception et la mise en page des documents sont également des éléments essentiels de la rédaction technique. Les rédacteurs techniques passent beaucoup de temps à s'assurer que leurs documents sont lisibles, car un document mal conçu nuit à la compréhension du lecteur. La conception de documents techniques met l'accent sur l'utilisation appropriée des choix de conception de documents tels que les puces, la taille de la police et le texte en gras. Les images, les diagrammes et les vidéos sont également couramment utilisés par les rédacteurs techniques, car ces supports peuvent souvent transmettre des informations complexes, telles que les revenus annuels d'une entreprise ou les caractéristiques de conception d'un produit, beaucoup plus efficacement que le texte.

Les documents techniques

La rédaction technique couvre de nombreux genres et styles d'écriture, en fonction de l'information et du public. Les documents techniques ne sont pas uniquement produits par des rédacteurs techniques. Presque tous ceux qui travaillent dans un cadre professionnel produisent des documents techniques d'une certaine variété. Voici quelques exemples de documentation technique :

  • Les instructions et les procédures sont des documents qui aident les développeurs ou les utilisateurs finaux à utiliser ou à configurer un appareil ou un programme. Des exemples de documents d'instructions comprennent des manuels d'utilisation et des guides de dépannage pour les programmes informatiques, le matériel informatique, les produits ménagers, les équipements médicaux, les produits mécaniques et les automobiles.
  • Propositions . La plupart des projets commencent par une proposition - un document qui décrit l'objectif d'un projet, les tâches qui seront effectuées dans le projet, les méthodes utilisées pour mener à bien le projet et enfin, le coût du projet. Les propositions couvrent un large éventail de sujets. Par exemple, un rédacteur technique peut rédiger une proposition décrivant le coût d'installation d'un nouveau système informatique, un professionnel du marketing peut rédiger une proposition avec les offres de produits et un enseignant peut rédiger une proposition décrivant comment un nouveau cours de biologie sera structuré.
  • Les e - mails , les lettres et les notes de service sont parmi les documents les plus fréquemment écrits dans une entreprise. Les lettres et les e-mails peuvent être construits avec une variété d'objectifs - certains visent généralement à simplement communiquer des informations tandis que d'autres sont conçus pour persuader le destinataire d'accomplir une certaine tâche. Alors que les lettres sont généralement écrites à des personnes extérieures à une entreprise, les mémorandums (mémos) sont des documents écrits à d'autres employés au sein de l'entreprise.
  • Communiqués de presse . Lorsqu'une entreprise souhaite révéler publiquement un nouveau produit ou service, elle demandera à un écrivain de rédiger un communiqué de presse . Il s'agit d'un document qui décrit les fonctions et la valeur du produit pour le public.
  • Les spécifications sont des contours de conception qui décrivent la structure, les pièces, l'emballage et la livraison d'un objet ou d'un processus de manière suffisamment détaillée pour qu'une autre partie puisse le reconstruire. Par exemple, un rédacteur technique peut schématiser et rédiger les spécifications d'un smartphone ou d'un vélo afin qu'un fabricant puisse produire l'objet.
  • Les descriptions sont des explications plus courtes des procédures et des processus qui aident les lecteurs à comprendre comment quelque chose fonctionne. Par exemple, un rédacteur technique peut rédiger un document qui montre les effets des gaz à effet de serre ou démontre le fonctionnement du système de freinage d'un vélo.
  • Les curriculum vitae et les demandes d'emploi sont un autre exemple de documents techniques. Ce sont des documents qui sont utilisés dans un cadre professionnel pour informer les lecteurs des références de l'auteur.
  • Les rapports techniques sont rédigés pour fournir aux lecteurs des informations, des instructions et des analyses pour les tâches. Les rapports se présentent sous plusieurs formes. Par exemple, un rédacteur technique peut évaluer un bâtiment à vendre et produire un rapport de voyage qui met en évidence ses conclusions et indique s'il pense que le bâtiment devrait être acheté. Un autre écrivain qui travaille pour une entreprise à but non lucratif peut publier un rapport d'évaluation qui montre les conclusions des recherches de l'entreprise sur la pollution de l'air.
  • Une étude de cas est un rapport publié sur une personne, un groupe ou une situation qui a été étudié au fil du temps ; aussi  : une situation de la vie réelle qui peut être regardée ou étudiée pour apprendre quelque chose. Par exemple, la situation difficile d'une personne sur son lieu de travail et la façon dont elle l'a résolue est une étude de cas.
  • Les livres blancs sont des documents écrits pour des experts dans un domaine et décrivent généralement une solution à un défi ou un problème technologique ou commercial. Des exemples de livres blancs incluent un article qui détaille comment faire en sorte qu'une entreprise se démarque sur le marché ou un article expliquant comment empêcher les cyberattaques contre les entreprises.
  • Sites Web . L'avènement de l'hypertexte a changé la façon dont les documents sont lus, organisés et consultés. Les rédacteurs techniques d'aujourd'hui sont souvent responsables de la création de pages sur des sites Web tels que des pages "À propos de nous" ou des pages de produits. On s'attend souvent à ce qu'ils maîtrisent les outils de développement Web.
  • Les fiches techniques sont les documents qui résument les caractéristiques, les spécifications clés, les caractéristiques techniques, les circuits d'application et quelques autres informations importantes sur le produit, la machine, l'équipement, le logiciel, l'application ou le système en bref.
  • Les guides API sont écrits pour la communauté des développeurs et sont utilisés pour expliquer les interfaces de programmation d'applications .
  • Les systèmes d'aide sont des centres d'aide en ligne qui fournissent aux utilisateurs des informations techniques sur les produits et services. Ils fournissent du contenu sous forme de pages Web qui sont affichées dans un navigateur. Le contenu peut être créé dans un logiciel de centre d'aide, tel que Zendesk , ou dans des outils de création d'aide ou des systèmes de gestion de contenu de composants qui peuvent créer un centre d'aide en tant que sortie HTML.

Outils

Les outils suivants sont utilisés par les rédacteurs techniques pour rédiger et présenter des documents :

  • Outils de publication assistée par ordinateur ou traitement de texte . Les rédacteurs techniques utilisent des traitements de texte tels que Scrivener, Microsoft Word , Apple Pages et LibreOffice Writer pour créer, éditer, concevoir et imprimer des documents. Étant donné que la rédaction technique concerne autant la mise en page que le langage écrit, des outils de publication assistée par ordinateur améliorés tels qu'Adobe InDesign et LyX sont également utilisés. Ces programmes fonctionnent de manière similaire aux traitements de texte, mais offrent aux utilisateurs plus d'options et de fonctionnalités pour la conception du document et automatisent une grande partie du formatage.
  • Outils de création d'aide . Ceux-ci sont utilisés par les rédacteurs techniques pour créer les systèmes d'aide qui sont fournis avec les produits logiciels, fournis via des navigateurs Web ou fournis sous forme de fichiers que les utilisateurs peuvent afficher sur leurs ordinateurs. Lors de la rédaction de procédures pédagogiques pour décrire des programmes mécaniques, électriques ou logiciels, les rédacteurs techniques utilisent ces outils pour les aider à simplifier les processus d'assemblage, d'exploitation ou d'installation.
  • Systèmes de gestion de contenu de composants . Ceux-ci sont également utilisés par les rédacteurs techniques pour créer des systèmes d'aide et des documents. Les systèmes de gestion de contenu par composants (CCMS) permettent aux rédacteurs de créer des sorties similaires à celles des outils de création d'aide, mais ils fournissent également des fonctionnalités de gestion de contenu telles que la gestion des versions et des flux de travail intégrés.
  • Logiciel de retouche d'images . Souvent, les images et autres éléments visuels peuvent mieux communiquer des informations que des paragraphes de texte. Dans ces cas, des logiciels de retouche d'images comme Adobe Photoshop et GIMP sont utilisés par les rédacteurs techniques pour créer et modifier les aspects visuels de documents tels que des photos, des icônes et des diagrammes.
  • Logiciels collaboratifs. Parce que la rédaction technique implique souvent une communication entre plusieurs personnes qui travaillent pour différentes entreprises, cela peut être une affaire de collaboration. Les rédacteurs techniques utilisent des systèmes Wiki et des espaces de travail de documents partagés pour travailler avec d'autres rédacteurs et parties afin de construire des documents techniques.
  • Outils de développement Web . Les travaux de rédacteur technique ne se limitent plus à la simple production de documents. Ils produisent parfois également du contenu pour les sites Web d'entreprise et d'autres sites professionnels d'une entreprise. On peut donc s'attendre à ce que les rédacteurs techniques maîtrisent les outils de développement Web comme Adobe Dreamweaver .
  • Editeurs de texte . Des programmes tels que Microsoft Notepad , TextEdit ou Wordstar permettent aux rédacteurs techniques d' éditer du texte brut . Les éditeurs de texte peuvent être utilisés pour modifier le contenu tel que les fichiers de configuration , les fichiers de documentation et le code source du langage de programmation . Les éditeurs de texte sont largement utilisés par les rédacteurs techniques travaillant avec du contenu en ligne.
  • Logiciel graphique. Pour communiquer des informations statistiques telles que le nombre de visites dans un restaurant ou le montant d'argent qu'une université dépense pour ses programmes sportifs, les rédacteurs techniques utilisent des graphiques et des organigrammes. Alors que des programmes comme Microsoft Excel et Word peuvent créer des graphiques et des tableaux de base, les rédacteurs techniques doivent parfois produire des graphiques plus complexes et détaillés qui nécessitent des fonctions non disponibles dans ces programmes et peuvent avoir besoin de se tourner vers des outils graphiques et de création de diagrammes (par exemple, Microsoft Visio ).
  • Outils de capture d'écran. Les rédacteurs techniques utilisent fréquemment des outils de capture d'écran comme Camtasia et Snagit . Lors de la création d'instructions pour un logiciel informatique, il peut être plus facile pour un rédacteur technique d'enregistrer simplement une courte vidéo de son bureau pendant qu'il accomplit une tâche que d'écrire une longue série d'instructions décrivant comment la tâche doit être effectuée. Les outils de capture d'écran sont également utilisés pour prendre des captures d'écran des programmes et logiciels exécutés sur les ordinateurs des utilisateurs, puis pour créer des diagrammes d'accompagnement.

Liste des associations

Les références

Liens externes