Manuels

Un manuel, tel que nous le définissons ici, est une combinaison des éléments suivants :

• concept information
• instruction information
• informations de référence

tout axé sur un sujet spécifique adapté aux besoins d'un public spécifique. Si vous suivez un cours de rédaction technique avec ce livre, votre projet de manuel doit inclure d'une manière ou d'une autre chacun de ces trois éléments. De plus, ces éléments devraient être un "ajustement" naturel et logique pour votre projet de manuel.

Assurez-vous de consulter le exemples.

Infographie générée par NotebookLM de ce chapitre

Principes de base du manuel

Concepts. L'information conceptuelle explique comment les choses fonctionnent, comment les choses sont assemblées. Pour des instructions plus complexes, vous devez connaître certains concepts, théories, antécédents, principes pour exécuter les instructions. Considérez l'exemple de la fonction logicielle qui vous permet de modifier ou de créer votre propre couleur. Utiliser quelque chose comme Photoshop, Illustrator, CorelDraw ou Paint Shop Pro pour cela—les véritables boutons et curseurs—est facile. Mais comprendre comment la teinte, l'intensité, la luminosité, la saturation, la densité, le contraste, le RGB—c'est difficile. Vous devez connaître la théorie des couleurs informatiques pour créer la couleur dont vous avez besoin.

Considérez un autre exemple : des commandes simples de système de fichiers Linux —ls, cd, cp, mv, pwd. Pour utiliser ces commandes, vous devez comprendre ce que sont les fichiers et les répertoires, et probablement ce qu'est un système d'exploitation ainsi que les jokers. Vous ne pouvez vraiment pas comprendre comment utiliser ces commandes —suivre les instructions en les utilisant —à moins de comprendre ces concepts de base.

Instructions. Si vous comprenez les concepts fondamentaux, alors vous pouvez suivre intelligemment les procédures étape par étape. Les instructions sont ces choses familières sous forme de liste numérotée qui vous guident soigneusement à travers une procédure. Les instructions sont partout, sur les emballages de produits, dans les guides d'utilisation qui accompagnent les appareils et les ordinateurs.

Référence. La dernière catégorie d'informations concerne les informations de consultation, ou les informations de référence rapide. Si vous avez suivi l'exemple du système de fichiers ci-dessus, vous avez dû étudier et apprendre les concepts de fichiers, de répertoires, et d'opérateurs génériques d'abord. Ensuite, vous avez pu suivre et comprendre les instructions sur le changement de répertoires, la copie, la suppression ou le déplacement de fichiers. Après un certain temps, cependant, vous n'avez plus besoin des instructions, mais de temps en temps, vous avez des exigences particulières non couvertes dans la section d'instructions ou vous ne vous rappelez plus certaines procédures qui y étaient décrites. C'est maintenant le moment où vous avez besoin d'informations de référence de base : vous allez simplement dans cette section et vous y jetez un coup d'œil rapidement.

Et donc, après un certain temps, vous n'avez plus besoin ni de la section des concepts ni de la section des instructions : vous vous êtes tellement habitué à ces procédures que vous les connaissez par cœur. Mais de temps en temps, vous oubliez un petit détail ou vous avez une tâche spéciale que vous n'avez jamais faite auparavant —c'est là que vous allez à la section de référence. Vous pourriez probablement déchirer les sections des concepts et des instructions et les jeter. Tout ce dont vous aurez besoin, c'est de la section de référence.

Format et Style du Manuel

Dans un cours de rédaction technique utilisant ce livre, il se peut que l'on vous demande d'utiliser les directives spécifiques pour l'utilisation des titres, des listes, des avis, des graphiques, des tableaux, de la documentation et des introductions :

Prototype de manuel. Depuis le lien ci-dessous, vous pouvez obtenir une version d'exemple du manuel. Il comprend toutes les pages requises dans un bon format. Ce document Word contient des styles de paragraphe et de caractère qui faciliteront votre travail et ajouteront des compétences professionnelles à votre répertoire.

Prototype de manuel

Prototype de contenu. Le prototype de la table des matières est particulièrement utile : il vous donne les styles Word pour produire une table des matières d'aspect professionnel. Il est difficile d'obtenir les alignements à gauche et à droite ainsi que les points de leader correctement :

Prototype de table des matières

Exemples de manuel

Voici quelques liens vers des exemples de manuels. Soyez conscient qu'il y a des problèmes dans les exemples, problèmes que j'ai pour la plupart commentés. Certains d'entre eux sont des manuels borderline. Ce qui fait un manuel pour moi, c'est la présence de discussion conceptuelle, d'instructions et d'informations de référence.

Assurez-vous de vérifier le exemples.

Invites d'IA pour les manuels

Les listes de contrôle, qui généralement ne sont pas lues, peuvent être utilisées comme source pour des invites d'IA avec quelques modifications. Copiez ce qui suit, collez-le dans un système d'IA tel que Google Gemini, et voyez ce que vous avez peut-être manqué.

Remarque : Toutes les références au contenu, au format, au style des techdocs ou à ses composants peuvent être trouvées dans le manuel de rédaction technique en ligne.

bientôt disponible !

J'apprécierais vos réflexions, réactions, critiques concernant ce chapitre : votre réponse—David McMurrey.