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
tous axés sur un sujet spécifique pour répondre aux besoins d'un public particulier. Si vous suivez un cours de rédaction technique en utilisant 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.
Infographie générée par NotebookLM de ce chapitre
Notions 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, contextes, 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, Illustration, CorelDraw ou Paint Shop Pro pour faire cela—les boutons et curseurs— est facile. Mais comprendre comment la teinte, l'intensité, la luminosité, la saturation, la densité, le contraste, le RVB— c'est difficile. Vous devez connaître la théorie des couleurs de l'ordinateur pour créer la couleur dont vous avez besoin.
Considérez un autre exemple : des commandes simples du 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 des instructions les utilisant—à moins que vous ne compreniez 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 en 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'information concerne les informations de recherche, ou les informations de référence rapide. Si vous avez suivi l'exemple de système de fichiers ci-dessus, vous avez dû étudier et apprendre les concepts de fichiers, de répertoire, de caractères génériques d'abord. Ensuite, vous pouviez suivre et comprendre les instructions sur le changement de répertoires, la copie, la suppression ou le déplacement de fichiers. Cependant, après un certain temps, vous n'avez plus besoin des instructions, mais de temps en temps, vous avez des besoins spécifiques non couverts dans la section d'instructions ou vous ne vous souvenez plus de certaines procédures qui y étaient décrites. C'est à ce moment que vous avez besoin d'informations de référence basiques : vous allez simplement à cette section et vous les consultez 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 à ce moment-là que vous allez à la section de référence. Vous pourriez probablement détacher les sections de concepts et d'instructions et les jeter. Tout ce dont vous aurez jamais 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, vous pourriez être amené à suivre 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. À partir du lien ci-dessous, vous pouvez obtenir une version d'essai du manuel. Elle comprend toutes les pages requises dans un bon format. Inclus dans ce document Word, des styles de paragraphe et de caractère qui faciliteront votre travail et ajouteront des compétences professionnelles à votre répertoire.
Prototype de contenu. Le prototype de la table des matières est particulièrement utile : il vous fournit les styles Word pour produire une table des matières au look professionnel. Il est difficile d'obtenir correctement les alignements à gauche et à droite ainsi que les points de suite :
Prototype de table des matières
Invites AI pour les manuels
Les listes de contrôle, qui restent généralement sans être 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 Gemini de Google, et voyez ce que vous avez peut-être manqué.
Remarque : Toutes les références au contenu, au format, au style des techdocs ou de ses composants peuvent être trouvées dans le manuel de rédaction technique en ligne.
arrive bientôt !
J'apprécierais vos pensées, réactions, critiques concernant ce chapitre : votre réponse—David McMurrey.
