Aussi ingénieux qu'un inventeur, programmeur ou rationalisateur puisse être, parfois ses créations ne peuvent tout simplement pas être utilisées aux fins prévues. La raison en est le manuel d'instructions mal rédigé ou son absence totale. Mais même des inventeurs ingénieux écrivent parfois de telles instructions que, à part des spécialistes étroits, personne ne peut lire ces papiers. Alors comment rédiger correctement un document aussi nécessaire ?
Il est nécessaire
- - une connaissance à cent pour cent de l'appareil ou du produit logiciel pour lequel le manuel est rédigé;
- - connaissances dans le domaine de la linguistique;
- - compétences en écriture.
Instructions
Étape 1
Un manuel d'utilisation ou, en d'autres termes, un manuel d'utilisation est un document conçu pour aider ses utilisateurs à utiliser un certain système. Pour compiler un manuel d'utilisation, vous devez connaître à cent pour cent le système décrit, mais le regarder à travers les yeux d'un étudiant ignorant. Supposons qu'un manuel d'utilisation soit écrit pour un utilitaire logiciel qui n'a pas encore d'analogues. Imaginez que c'est la première fois que vous utilisez ce programme. Par où commencez-vous ? Quelle est la première chose à savoir ? Organisez ces connaissances en catégories d'importance.
Étape 2
En divisant toutes les informations concernant votre création en groupes, vous avez établi un plan de rédaction d'un manuel d'utilisation. Commencez à décrire le travail de votre programme à partir de zéro, en laissant pour la fin les détails les plus difficiles, tels que la reprogrammation des fonctionnalités ou la gestion des erreurs critiques. A ce stade, vous devriez avoir le contenu du manuel d'utilisation prêt - l'une des parties requises de ce document.
Étape 3
Si le manuel que vous créez est destiné à être utilisé dans une grande entreprise, vous devez faire attention aux normes d'entreprise qui y sont adoptées. Par exemple, dans de nombreuses entreprises russes, les manuels d'utilisation ne sont pas acceptés sans support illustratif, en d'autres termes, des images qui expliquent ce qui est écrit. En plus du contenu, le manuel d'utilisation doit contenir d'autres parties obligatoires: - Une annotation, c'est-à-dire une explication des objectifs généraux du manuel et du produit décrit; - une introduction, qui décrit les documents liés au manuel d'utilisation et comment d'utiliser le manuel; - des sections expliquant l'utilisation du produit à différentes étapes de son utilisation, par exemple, les premiers pas, la réparation ou l'entretien; - une section de questions fréquemment posées et leurs réponses; - un glossaire ou un index des matières.
Étape 4
Habituellement, un rédacteur technique est impliqué dans la création d'un manuel d'utilisation - une personne qui possède toutes les connaissances nécessaires à la fois dans la langue et dans le produit décrit. En tant que rédacteur technique sans formation, il y a quelques règles à garder à l'esprit. Premièrement, vous ne devez pas abuser des termes spéciaux qui ne sont pas compréhensibles pour un utilisateur ordinaire. Deuxièmement, chaque terme utilisé doit être détaillé et expliqué. Troisièmement, vous devez écrire aussi clairement et concis que possible. Enfin, un rédacteur technique doit être capable de regarder son propre texte à travers les yeux d'un utilisateur ordinaire afin de voir les lacunes de son propre texte.
Étape 5
Il est bon de tester le texte fini du manuel d'utilisation en pratique en l'offrant à une personne qui n'a rien à voir avec le produit décrit. Par des efforts conjoints, il est possible d'éliminer toutes les lacunes et tous les écueils du document.
