Étape 1 Acquérir des Connaissances Générales sur le Modèle de Manuel d’Utilisation
Avant d’utiliser réellement le Modèle de Manuel d’Utilisation et les autres outils que j’ai développés pour Philip, je voulais m’assurer que nous avons le même point de départ. Je lui ai fourni quelques informations générales sur les instructions d’utilisation et quelques bons exemples de manuels d’utilisation existants.
J’ai listé ces informations ci-dessous.,
Quelle est la définition d’un manuel d’utilisation?
Un manuel d’utilisation est un document de communication technique destiné à aider les personnes à utiliser un produit. Un bon manuel d’utilisation aide les utilisateurs à utiliser un produit de manière sûre, saine et efficace.,
d’Autres noms, ou d’autres formes d’un manuel de l’utilisateur, peut être:
- guide de l’Utilisateur
- la documentation Technique
- manuel
- manuel Opérationnel
- manuel de Formation
- Guide de Démarrage Rapide
- manuel d’Installation
- manuel de Maintenance
- manuel du Logiciel
En plus de l’objectif principal d’un manuel de l’utilisateur (pour aider un utilisateur), les objectifs secondaires pourrait être de créer une meilleure expérience utilisateur et satisfaire aux exigences juridiques.
Un manuel d’utilisation se compose d’informations visuelles textuelles (illustrations, captures d’écran, tableaux, etc., pour aider l’utilisateur à remplir des tâches spécifiques.
L’utilisateur joue le rôle central lors de l’élaboration d’un manuel d’utilisation. Un manuel d’utilisation bien rédigé ne fournit que les informations pertinentes pour l’utilisateur prévu du produit.
Le manuel d’utilisation doit contenir à la fois des informations procédurales (instructions étape par étape) et des informations conceptuelles (informations dont l’utilisateur a besoin pour comprendre les informations procédurales).
Un bon manuel d’utilisation est concis et utilise un langage sans jargon. Un bon manuel d’utilisation devrait répondre COMMENT et QUELLES questions., Ils doivent contenir des informations sur ce qui se passe si une tâche n’est pas effectuée correctement.
Dans certains cas, un produit est destiné à être utilisé par différents types d’utilisateurs. Les types d’utilisateurs typiques sont l’utilisateur final, l’installateur, l’ingénieur de maintenance et l’opérateur. Chaque type d’utilisateur a besoin d’une approche différente en termes de langage à utiliser, de ton de voix et d’informations conceptuelles fournies.
Quelles informations devraient figurer dans un manuel d’utilisation?
Différents types de produits nécessitent un manuel d’utilisation. Un produit peut être un système, outil, un appareil, un instrument, un logiciel ou une application.,arnings
à l’Aide d’un manuel de l’utilisateur modèle
Le principal outil que j’ai développé afin d’aider Philip rédiger son manuel de l’utilisateur est un Manuel de l’Utilisateur Modèle., Le modèle contient toutes les informations et plus de la liste ci-dessus. Il est conforme aux exigences de son produit.
Le modèle de manuel d’utilisation peut être utilisé pour créer votre manuel pour votre système, outil, appareil, instrument, ou pour créer un manuel d’installation, un manuel de logiciel, un manuel d’exploitation, un manuel de maintenance ou un manuel de formation.
Basé sur le premier modèle pour Philippe, nous avons élaboré des modèles pour les groupes de produits suivants:
- Dispositifs Médicaux
- Jouets
- Machines
- Électronique
Ce que formats un manuel de l’utilisateur ont?,
Les manuels d’utilisation peuvent être fournis en format papier ou sous forme de document électronique (PDF ou mis en ligne ou sur l’appareil en HTML). Le modèle de manuel d’utilisation est un document MS Word qui peut être imprimé ou mis en ligne.
Les manuels d’utilisation peuvent être créés à l’aide de divers outils. Chaque outil a ses propres avantages et inconvénients., contenu possible
Solution tout-en-un
Publications Omni-platform
Contient des modèles de/td>
Exemples de manuel d’utilisation
Lors de la rédaction d’un manuel d’utilisation à l’aide du modèle de manuel d’utilisation, il peut être pratique d’avoir de bons exemples., Grâce aux liens suivants, vous pouvez télécharger un exemple de manuel d’utilisation pour la documentation:
- Instructions d’installation IKEA
- Manuel d’utilisation Jura
Étape 2 Identifiez le ou les Utilisateurs de votre Modèle de Manuel d’utilisation
Ok, alors maintenant Philip a quelques connaissances de base sur les manuels d’utilisation. Plongeons dans les détails et les actions.
Lorsque vous voulez écrire un manuel qui aide votre utilisateur à résoudre des problèmes, vous devez d’abord définir qui est votre utilisateur. Cela peut être fait en créant un profil utilisateur, également nommé persona.,
Avec un personnage, vous faire quelques hypothèses raisonnables sur les caractéristiques de votre utilisateur. Ce n’est pas seulement utile pour créer vos instructions d’utilisation, mais c’est un élément essentiel au début du développement de tout produit! En tant qu’ingénieur en design industriel formé, c’est ainsi que nous avons commencé toutes nos missions de design.
Lors de la vérification du site Web ISOVOX, je n’ai même pas trouvé de description claire de leurs utilisateurs prévus. C’est pourquoi j’ai demandé à Philippe de définir ses utilisateurs et de répondre à des questions comme:
- Qui est l’utilisateur de votre produit?,
- Le produit est-il utilisé professionnellement ou principalement en privé?
- Quelles autres expériences techniques ont-ils? Ce que décrit à l’utilisateur?
j’ai créé un modèle qui contient les questions. J’ai demandé à Philip de remplir le modèle.
Vous pouvez utiliser le modèle vous-même pour déterminer qui est votre utilisateur. Veuillez noter que le deuxième onglet contient également les réponses de Philip, vous avez donc un exemple de la façon dont la feuille pourrait être utilisée.
Action: Utilisez le modèle pour décrire vos utilisateurs.
Je suis un GRAND fan de la visualisation des choses., Donc, si vous voulez aller plus loin dans la définition de votre utilisateur, je vous suggère de visualiser votre utilisateur sous la forme d’un personnage. Lors de la création d’un personnage, vous donnez à votre utilisateur un nom, un âge, etc., il devient donc une personne réelle qui représente votre utilisateur.
je l’ai fait pour Philip., Voici le résultat:
Action: Créer une visualisation de votre utilisateur
Si vous voulez en savoir plus sur la définition de votre audience et la création de personas:
Étape 3 Création de rubriques pour les problèmes de votre Utilisateur
Commencez par identifier les problèmes que votre(vos) utilisateur (s) peut (peuvent) rencontrer pendant le cycle de vie du produit et qu’il / elle souhaite résoudre. Les problèmes typiques peuvent comprendre: l’installation du produit, l’utilisation du produit, en utilisant le produit en toute sécurité, la maintenance du produit et de l’élimination du produit.,
Si le problème est trop complexe, vous pouvez le décomposer en morceaux.
J’ai demandé à Philip d’identifier les problèmes et les solutions que son utilisateur pourrait rencontrer pendant le cycle de vie du produit. Pour ce faire, j’ai créé un autre modèle pour Philip. Dans la colonne de gauche de l’onglet Cycle de vie, les étapes du cycle de vie d’un produit sont mentionnées. Ceux-ci sont dérivés de la norme internationale pour les instructions d’utilisation, la CEI/IEEE 82079. Nos modèles de manuel d’utilisation sont conformes à cette norme.
Dans l’onglet Cycle de vie, vous voyez comment Philip a ajusté le cycle de vie à son propre produit.,
Action: Utilisez ce modèle et les instructions du premier onglet pour identifier les problèmes que votre utilisateur pourrait avoir pendant le cycle de vie de votre produit et présenter leurs solutions.,
Si vous voulez en savoir plus sur la définition des problèmes de votre utilisateur et la création de sujets:
- Création basée sur les sujets
- Minimalisme
- Cartographie de l’information
- Chunking
Étape 4 Définir la structure du Modèle a maintenant identifié les problèmes qu’un utilisateur pourrait avoir avec son produit au cours de son cycle de vie et il a maintenant pensé à la solution pour résoudre le problème. En d’autres termes: Philip a défini les sujets de son manuel d’utilisation., Chaque sujet ne peut porter que sur un sujet spécifique, a un but identifiable et doit être capable de se tenir seul.
Un sujet doit donner la réponse à une seule question d’un utilisateur. Un utilisateur veut résoudre un problème à la fois. Lorsqu’un utilisateur a résolu le problème, il / elle ira résoudre le problème suivant.
Un sujet deviendra une section dans le manuel de l’utilisateur. Il peut être un chapitre ou un sous-paragraphe. Dès qu’un utilisateur cherche une réponse à son problème, il utilisera la table des matières pour savoir comment accéder à cette réponse.,
J’ai demandé à Philip de structurer les sujets et de définir leur place dans le manuel d’utilisation, en attribuant un certain sujet à un chapitre ou un (sous-)paragraphe spécifique. Le résultat peut être vu sur l’onglet ToC.
Action: Pour définir la structure de votre manuel d’utilisation:
- Copiez le contenu de l’onglet Cycle de vie vers l’onglet ToC.
- Dans l’onglet ToC, remplacez le nom du produit par votre propre nom de produit.
- Ajouter une colonne à gauche. Nommez-le « Section ».
- Le cas échéant, organisez vos sections de manière logique.
- Déterminez quels sujets deviendront des chapitres en ajoutant des numéros de chapitre., Commencer la numérotation PRÉPARATION PRODUIT À UTILISER avec le numéro 4. Nous ajouterons d’autres chapitres à l’étape suivante.
- Déterminez quels sujets deviendront des paragraphes en ajoutant les numéros de section.
- Déterminez quels sujets deviendront des sous-paragraphes en ajoutant les numéros de sous-section.
Vous avez maintenant créé la Table des Matières (ToC). La table des matières est le contour de votre manuel d’utilisation. Plus tard, nous ajouterons d’autres sujets/sections, comme l’Introduction, les informations de sécurité, etc., alors ne vous inquiétez pas d’ajouter cela maintenant.,
Étape 5 Créer des en-têtes significatifs
Chaque sujet du manuel d’utilisation a son propre en-tête. Les titres sont les (sous-)titres qui précèdent le texte réel. Ils apparaissent dans la table des matières, de sorte que l’utilisateur peut naviguer les informations nécessaires.
Alors, Philip vient de créer les (sous-)titres de ses sujets.
Parce que les entrées ToC jouent un rôle si important pour aider votre utilisateur à trouver son chemin, et pour l’aider à sauter ce qui n’est PAS important, ils ont besoin d’un peu plus d’attention.
Fondamentalement, vous devriez essayer de travailler avec trois niveaux d’en-têtes: les en – têtes de premier, deuxième et troisième niveaux.,
L’en-tête de premier niveau décrit le contenu du chapitre ou de la section (par exemple, L’INSTALLATION DU PRODUIT). Les titres de deuxième niveau devraient utiliser le style de formulation « comment quoi » (par exemple, Comment assembler le Produit et Comment faire l’installation électrique). Un titre de troisième niveau utilise des phrases nominales (par exemple, le contenu de l’emballage et les outils à utiliser).
J’ai demandé à Philip de rediriger ses en-têtes et de prendre connaissance des directives générales suivantes:
- Utilisez la structure indiquée ci-dessus pour les en-têtes de premier, deuxième et troisième niveaux.,
- assurez-vous que les titres sont explicites. Le titre Faire des crêpes est beaucoup plus orienté vers l’utilisateur que d’utiliser le MagicCook5000.
- Assurez-vous que l’en-tête couvre le sujet complet. Si la section couvre l’entretien et la réparation d’un produit, dans la rubrique Entretien serait incomplète.
- Si possible, essayez d’omettre des articles au début des en-têtes
Action: Écrivez de nouveaux en-têtes pour vos entrées de table des matières.
La table des matières de Philips avec des titres significatifs se trouve dans l’onglet Tables des matières w. Titres significatifs. ,
Étape 6 Déterminer le contenu juridique
En fonction du marché où votre produit est mis ou mis en service, et en fonction du groupe de produits auquel votre produit appartient, une législation spécifique s’applique à votre produit.
En général, la législation exige que votre produit soit » sûr » et donne donc des exigences générales de sécurité auxquelles votre produit devrait répondre.
Ces exigences incluent également des exigences sur le contenu de votre manuel d’utilisation et des instructions de sécurité.,
Afin de vendre votre produit sur un marché spécifique, vous devez vous assurer que votre manuel d’utilisation est conforme à ces exigences.
Ces deux articles ci-dessous vous expliqueront comment vous pouvez savoir exactement quelle législation s’applique à votre produit pour le marché européen et américain et quelles sont les exigences de votre manuel d’utilisation. Conseil de pro: lorsqu’une déclaration de conformité est déjà disponible, vous pouvez y trouver les directives applicables.,
- Comment Créer des Manuels conformes pour l’UE
- Comment Créer des Manuels conformes pour les États-Unis
Philip n’a pas eu besoin de procéder à ces étapes, car le modèle qu’il a utilisé contenait déjà le contenu juridique requis par les directives pertinentes.
Pour son produit, cela signifie que les informations suivantes sont requises pour le manuel d’utilisation de son produit:
EU (directives de marquage CE pertinentes: LVD, EMC, RoHS, DEEE, REACH):
- Le manuel d’utilisation doit être traduit dans la ou les langues du pays où le produit est vendu.,
- Le manuel de l’utilisateur doit décrire l’utilisation prévue du produit.
- Le manuel d’utilisation doit décrire l’utilisation imprévue raisonnablement prévue du produit.
- Le cas échéant, la non-conformité dans les zones résidentielles doit être mentionnée.
- Le type, le numéro de lot ou de série ou tout autre élément permettant l’identification du produit doit être mentionné sur le produit. Si le produit est trop petit, cela peut être placé dans le manuel d’utilisation.
- Le nom, le nom commercial ou la marque déposée et l’adresse postale doivent être mentionnés sur le produit., Si le produit est trop petit, cela peut être placé dans le manuel d’utilisation.
- Une analyse des risques devrait être effectuée pour déterminer les risques résiduels liés à l’utilisation du produit. Des informations de sécurité doivent être fournies afin d’informer l’utilisateur des mesures à prendre.
- informations DEEE doivent être inclus
- des Informations sur les déchets d’emballages doivent être inclus.
Outre cette législation, il existe également une norme internationale pour les manuels d’utilisation, la norme IEC/IEEE 82079-1:2019. Cette norme a été harmonisée dans l’UE., Le respect des normes harmonisées donne présomption de conformité avec la législation correspondante!
Le modèle de manuel d’utilisation est conforme à cette norme.
J’ai également créé une liste de contrôle IEC 82079 qui peut être utilisée pour vérifier que votre manuel d’utilisation est conforme à cette norme.
Afin de créer un manuel d’utilisation conforme à l’échelle internationale, vous devez toujours vous assurer que votre manuel répond aux exigences de l’UE, des États-Unis et du 80279.,
Action: Pour déterminer les exigences légales de votre manuel d’utilisation:
- Suivez les étapes 1 à 2 des articles de conformité de l’UE et / ou les étapes 1 à 6 des articles de conformité des États-Unis pour déterminer le cadre juridique de vos instructions.
- Étudiez la liste de contrôle IEC 82079 pour vous assurer que votre manuel est conforme à la norme 82079.
Dans cette vidéo, j’explique comment vous pouvez créer un manuel conforme à la norme 82079:
AU MAGASIN
Étape 7 Téléchargez et préparez le Modèle de Manuel d’utilisation
Maintenant, Philip peut commencer la création réelle de son manuel d’utilisation.,
je lui ai demandé d’ajuster la table des matières du modèle selon sa propre table des matières. Sans supprimer et éléments obligatoires bien sûr…
vous souvenez-vous de l’étape 4 qui j’ai demandé de commencer la numérotation des sections du chapitre 4? Une fois que vous avez téléchargé vous-même le document du modèle de manuel d’utilisation, vous verrez que quelques chapitres standard ont été ajoutés, ainsi que quelques annexes.,
Action: Pour ajuster le modèle de manuel d’utilisation:
Si vous voulez travailler avec le modèle gratuit:
- Téléchargez le modèle de manuel d’utilisation gratuit Word 2013 ou 2007
- Modifiez les en-têtes de section en fonction de votre propre ToC. Avis! Ne pas ajuster la table des matières. La table des matières peut être mise à jour automatiquement une fois que vous avez ajusté les en-têtes de section.
- Ajouter le contenu obligatoire tel que déterminé à l’étape 6 de votre manuel.
- Le cas échéant, modifier les sections 1-3 et les annexes selon vos propres besoins.,
Ou utilisez l’un de nos modèles payants qui contiennent tout le contenu obligatoire, comme Philip l’a fait:
- Medical Devices EU
- Medical Devices US
- Machinery EU
- Machinery US
- Electronics EU
- Toys EU
Étape 8 Créez le Contenu de votre Modèle de Manuel d’utilisation
Écrivez l’utilisation prévue
Le but de votre produit, ou mieux: l’utilisation prévue, est au cœur d’un manuel d’utilisation et constitue la base pour assurer l’utilisation sûre et saine du produit.,
La façon dont l’utilisation prévue est décrite détermine également votre responsabilité et affecte le contenu ultérieur du manuel d’utilisation.
La plupart des lois vous obligent à inclure une description de l’utilisation prévue dans les instructions d’utilisation.
La norme internationale pour les instructions d’utilisation, la CEI 82079-1, fournit la définition suivante pour l’utilisation prévue:
Une gamme exhaustive de fonctions ou d’applications prévues définies et conçues par le fournisseur du produit
En décrivant l’utilisation prévue, vous déterminez l’enveloppe sûre du produit., Et une fois que vous avez déterminé l’utilisation prévue, vous pouvez vous concentrer sur la fourniture uniquement des instructions de sécurité et d’utilisation sur la façon d’utiliser le produit dans l’enveloppe donnée.
En plus de l’utilisation prévue, de nombreuses autres normes, directives et réglementations vous obligent également à inclure une description de l’utilisation abusive raisonnablement prévisible.
Par exemple, le mauvais usage raisonnablement prévisible d’un détergent agressif pourrait être l’utilisation de l’informatique dans un environnement de transformation des aliments.
Accorder trop peu d’attention à la description de l’utilisation abusive raisonnablement prévisible aura une incidence sur la responsabilité d’une entreprise.,
Les lois / règlements sur la responsabilité des produits tiennent un fabricant responsable d’un produit défectueux. Si la défectuosité d’un produit doit être déterminée, toutes les circonstances seront prises en compte. Qui comprend l’utilisation raisonnablement prévisible du produit.
La description de l’utilisation prévue détermine quelles instructions sont données dans le reste du manuel. Par exemple, si un système de refroidissement n’est utilisé que pour refroidir certains médicaments, seules ces procédures doivent être décrites.,
Lorsque l’on peut raisonnablement prévoir que le système de refroidissement peut être utilisé comme système pour refroidir les organes, cela devrait être décrit dans les instructions. Ce faisant, vous, en tant que fabricant, limiterez votre responsabilité et vous pourrez vous concentrer uniquement sur la description de l’utilisation du système pour refroidir les médicaments.
Action: écrivez l’utilisation prévue et la mauvaise utilisation raisonnablement prévisible de votre produit.
la Figure 1. Utilisation abusive raisonnablement prévisible?,
Écrire les mises en garde de sécurité basé sur l’analyse des risques
Même si l’utilisation prévue est maintenant clairement définie, cela ne signifie pas que l’utilisation d’un produit est complètement sans risque.
Pour identifier les dangers qui viennent avec l’utilisation d’un produit, vous pouvez effectuer une analyse des risques. Une analyse des risques peut également être obligatoire pour certains groupes de produits, tels que les équipements basse tension, les jouets, les machines et les équipements destinés à être utilisés dans des atmosphères explosives.
Des normes, comme la norme ISO 12100, ont été élaborées sur la façon de mener une analyse des risques., L’ISO 12100 donne également une méthode pour prendre des mesures d’atténuation: la méthode en trois étapes. Selon cette méthode, il existe la hiérarchie suivante des mesures de réduction des risques:
- Mesures de conception intrinsèquement sûres
- Mesures de sauvegarde et mesures de protection complémentaires
- Informations d’utilisation
Cela signifie que le guide de l’utilisateur doit avertir de tout risque résiduel lié à l’utilisation du produit. Ceci est fait avec des avertissements de sécurité.,
ACHETER MAINTENANT
Un bon avertissement de sécurité décrit la nature d’une situation dangereuse, les conséquences de ne pas éviter les situations dangereuses et les méthode(s) pour l’éviter.
Pour indiquer le degré de danger que l’utilisateur peut rencontrer, les mots de signalisation « Danger”, « Avertissement” et « Attention” doivent être utilisés.
Consultez les messages de sécurité suivants:
ATTENTION! Les pièces en rotation. Risque de blessures graves. Gardez les mains claires. Verrouillage / étiquetage avant l’entretien.
Ensuite, vous voulez avertir l’utilisateur lorsqu’une situation dangereuse peut être rencontrée. La NORME ANSI Z535.,6 standard décrit les emplacements suivants dans le manuel d’utilisation où cela pourrait être:
- Regroupés dans un chapitre séparé.
- Dans la première partie de la section:
- Incorporé dans une procédure:
1. Ce faire.
2. Le faire. AVERTISSEMENT! Il s’agit de messages de sécurité intégrés. Général de texte texte texte général.
3. Ce faire.,
- Dans la Préface, toutes les directives supplémentaires peuvent être placées, telles que Lire toutes les instructions avant utilisation ou Conserver ces instructions pour référence ultérieure peuvent être placées dans l’introduction d’un manuel d’utilisation.
Dans l’UE, selon le type de produit, il peut être autorisé à fournir uniquement les informations de sécurité sous forme imprimée et le reste des informations en ligne.
Afin d’aider Philip à créer et à placer un message de sécurité, j’ai créé un autre modèle.
Action: effectuez une analyse des risques et rédigez vos messages de sécurité à l’aide de ce modèle.,
Créer un tout autre contenu
Maintenant, j’ai demandé à Philippe de créer tous les autres contenus, tels que les procédures, spécifications techniques et les informations légales.
J’ai donné les conseils suivants:
- Exclure le matériel inutile pour éviter la surcharge d’informations (par exemple, la promotion des ventes, la répétition étendue, etc.).
- Assurez-vous que les termes sont familiers à l’utilisateur, les caractéristiques techniques et les termes sont bien expliqués et utilisent les termes de manière cohérente.
- Décrivez toutes les conditions préalables qui doivent être remplies avant le début des instructions., Cela peut également décrire des outils spéciaux ou de l’espace pour l’entretien et la réparation.
- Fournir des informations conceptuelles lorsque des informations sont nécessaires pour une compréhension et une exécution adéquates des tâches.
- Toujours écrire en fonction du sujet.
- Utilisez une police de caractères en gras pour tous les éléments du produit.
- Utilisez un guide de style pour vous aider à écrire et à formater la documentation de manière plus claire.
- Indiquez quand vous souhaitez ajouter une image pour une meilleure compréhension plus tard.
- assurez-vous que les mots et les phrases ne sont pas trop compliqués ou trop sophistiqué.,
- Utilisez des phrases simples / standardisées et courtes: une phrase-une commande.
- Ne mettez pas trop d’informations dans une phrase.
- Utilisez la voix active directe et les commandes assertives.
- Utilisez des mots comme les noms et les verbes de manière cohérente pour éviter toute ambiguïté.
- Pour rédiger de meilleures instructions, utilisez les Principes du Minimalisme dans la Communication Technique et l’Anglais Technique Simplifié.
Action: créez tout autre contenu pour votre manuel d’utilisation.
Encore une fois, pour la plupart des groupes de produits, il existe des modèles payants qui pourraient faciliter le travail., Ces modèles contiennent tous les textes juridiques, les informations d’élimination obligatoires, les déclarations de droit d’auteur et sont conformes à la norme CEI 82079 sur les instructions d’utilisation.
Placez les avertissements de sécurité dans la bonne position
Lors de l’utilisation du modèle pour l’élaboration des messages de sécurité, j’ai demandé à Philip d’indiquer si un message de sécurité est une directive supplémentaire ou doit être placé sous forme de message de sécurité groupé, en section ou intégré.
Maintenant que tout le texte a été créé, les messages de sécurité peuvent être placés au bon endroit.,
Action: placez tous les messages de sécurité au bon endroit dans le manuel d’utilisation.
Étape 9 Ajouter la navigation à votre modèle de manuel d’utilisation
Un manuel d’utilisation devrait aider les gens en fournissant des informations sur la façon d’utiliser un produit. Trouver la bonne information qui résout le problème de l’utilisateur devrait prendre le moins de temps possible.
L’élaboration de titres significatifs est l’un des outils qui aident les utilisateurs à trouver des informations., Cependant, il existe plusieurs autres outils pour aider l’utilisateur à trouver les informations qu’il souhaite, tels que:
- Table des matières
- Numérotation des pages
- Index
J’ai demandé à Philip de mettre à jour la table des matières et d’ajouter la numérotation des pages et un index.
Action: Ajoutez ou mettez à jour votre table des matières, votre numérotation des pages et votre index.
Étape 10 Faites réviser votre manuel d’utilisation
Philip a maintenant créé la version préliminaire de son manuel d’utilisation, en utilisant le modèle de manuel d’utilisation. Nous appelons cette version la conception de contenu textuel.,
Comme Philip a un partenaire commercial et un développeur avec une connaissance technique approfondie des produits, j’ai demandé à Philip de les laisser examiner le travail jusqu’à présent.
Son partenaire commercial et le développeur ont tous deux fourni des commentaires. Philip a utilisé ces commentaires pour optimiser le manuel d’utilisation.
Action: Envoyer la version préliminaire du manuel d’utilisation à toute personne au sein de votre équipe qui pourrait être en mesure de fournir des commentaires. Demandez-leur de combiner tous les commentaires en un seul document avant de vous les renvoyer. Cela stimule la discussion des membres de votre équipe et évite les désaccords à un stade ultérieur.,
Etape 11 Créer les Images
Une fois le mode d’emploi revu et optimisé, les textes sont plus ou moins précis. Cela signifie que toutes les images peuvent maintenant être créées et ajoutées au contenu.
La raison d’attendre que les textes soient prêts est que la création ou l’édition d’images peut prendre du temps. Comme les images doivent prendre en charge, remplacer ou augmenter le texte, vous devez attendre de les créer jusqu’à ce que les textes soient définitifs.
Les images dans les manuels d’utilisation peuvent inclure des illustrations, des photos, des captures d’écran, des tableaux, des diagrammes et des schémas.,
Il existe de nombreux outils qui peuvent vous aider à créer vos images, tels que:
- Snagit ou Adobe Photoshop pour l’édition de captures d’écran ou de photos
- Solidworks Composer ou Google Sketchup pour la création de dessins au trait
- Lucidchart ou Microsoft Visio pour les diagrammes et ne pas utiliser les photos comme une alternative bon marché pour les illustrations. Souvent, les photos ne sont pas aussi informatives car elles contiennent trop d’informations. En outre, les photos peuvent rendre un manuel d’utilisation désordonné.,
Pour cette raison, Philip a utilisé Google Sketchup pour créer ses illustrations.
Action: Créez les images pour votre manuel d’utilisation.
Si vous voulez en savoir plus sur la création d’images:
- Utilisation de texte, d’images ou de vidéos
- Création de manuels IKEA-ish
Étape 12 Vérification finale du Modèle de Manuel d’utilisation
Avant de commencer à le rendre joli et à traduire le contenu, est terminé.
pour ce faire, j’ai demandé à Philippe pour utiliser une liste de contrôle.,
Action: l assurez-vous que votre manuel d’utilisation est conforme à toutes les exigences pertinentes de la CEI 82079-1:2012 en utilisant cette liste de contrôle.
Étape 13 Concevoir votre modèle de manuel d’utilisation
Un manuel bien conçu contribue à améliorer la marque et l’expérience utilisateur.
Vous pouvez ajuster le Modèle de Manuel d’utilisation dans MS Word en ajoutant un logo d’entreprise et en ajustant la police, les couleurs, etc., mais cela peut avoir des limites.
Lorsque vous savez travailler avec Adobe Indesign, ou que vous êtes prêt à apprendre à travailler avec, cela vous offrira des possibilités de conception beaucoup plus grandes.,
j’ai créé ce modèle dans Indesign et demandé à Philippe pour l’adapter à son identité de marque.
Action: Ajustez le modèle de manuel d’utilisation pour l’adapter à votre identité de marque, ou téléchargez le modèle de manuel d’utilisation InDesign et ajustez-le.
Step 14 DTP Works
DTP signifie Publication assistée par ordinateur et Wikipedia le décrit comme « la création de documents en utilisant des compétences de mise en page sur un ordinateur personnel principalement pour l’impression ».
Philip a maintenant à la fois le contenu de son manuel d’utilisation (fichier Word) et le modèle de manuel d’utilisation (fichier InDesign)., Le contenu doit être placé dans le modèle InDesign. Cela s’appelle l’Édition de Bureau.
Action: placez le contenu de votre fichier Word dans le modèle Indesign. Si vous avez décidé de ne pas utiliser le modèle InDesign mais que vous êtes resté dans le fichier Word, vous pouvez ignorer cette étape.
Étape 15 Traduire et publier vos manuels d’utilisation
Selon le marché sur lequel vous allez vendre votre produit, vous devrez peut-être traduire le manuel d’utilisation.
Quelques conseils:
- recherchez un traducteur ayant vécu une expérience similaire., Il peut s’agir d’un traducteur expérimenté dans la traduction de contenu technique, avec des produits similaires ou avec la traduction de manuels d’utilisation.
- Si vous avez besoin de traduire en plusieurs langues, travailler avec une agence de traduction peut vous faire gagner beaucoup de temps.
- Demandez au traducteur ou à l’agence leurs procédures de qualité et qui va réviser le texte après la traduction.
- Comme vous connaissez le mieux votre produit et qui est votre public, il pourrait être judicieux de fournir au traducteur ou à l’agence un glossaire ou une liste avec la terminologie que vous souhaitez utiliser.,
- Recherchez un traducteur qui peut travailler directement dans votre fichier Word ou InDesign ou trouvez une agence qui peut également effectuer les travaux de PAO. Alternativement, vous pouvez le faire vous-même, bien sûr.
Comme Philip vendra son produit aux États-Unis et dans l’UE, il a décidé de travailler avec une agence.
Action: Trouvez un traducteur ou une agence qui correspond à vos besoins et faites traduire votre manuel d’utilisation.
En général, un manuel d’utilisation doit être disponible dans un format facilement accessible à l’utilisateur. Qui peut être imprimé ou utilisé en ligne ou sur l’appareil.,
Comme un utilisateur veut des informations au moment où il en a besoin et ne pense donc pas dans les canaux, la meilleure approche serait de fournir les instructions omni-platform.
Dans l’Union européenne, pour certains groupes de produits, il est toujours limité de fournir le manuel d’utilisation imprimé avec le produit.
Cependant, à partir d’avril 2016, les instructions de nombreux groupes de produits peuvent être livrées dans un format différent plutôt que sous forme imprimée. Il y a cependant une exception.Les informations de sécurité doivent toujours être livrées sous forme papier avec le produit., En outre, à la demande d’un consommateur, un manuel d’utilisation sur papier devrait être mis à la disposition du consommateur.
Philip a décidé de ce qui suit:
- Il fournit un manuel complet imprimé avec le produit, y compris les instructions de sécurité.
- Il a créé un guide de démarrage rapide distinct à fournir avec le produit ainsi.
- Il a mis en ligne une version pdf du manuel complet.
- Il créera une section d’aide en ligne sur son site Web avec la version HTML du manuel d’utilisation. Ici, il peut également ajouter des vidéos., Et en optimisant la version HTML pour les moteurs de recherche, il permet à son utilisateur de trouver plus facilement des informations pour son utilisateur
Conclusion
C’est tout ce qu’il y a à faire. C’est ainsi que Philip a créé un manuel d’utilisation conforme avec l’aide du modèle de Manuels d’utilisation et des autres outils disponibles que j’ai fournis.
La meilleure partie de tout cela est que vous pouvez obtenir les mêmes résultats que Philip en suivant ce processus étape par étape sur la façon de créer un manuel d’utilisation.