Connaître le produit que vous écrivez au sujet :, Il est essentiel pour l'écrivain d'utiliser le produit pendant au moins plusieurs jours avant d'écrire un manuel pour cela. Utilisez le produit en aucune façon que vous pouvez imaginer. Rechercher des avantages et des mises en garde.
Utilisez le produit et tenir un journal. Pendant que vous utilisez le produit, garder un bloc-notes à portée de main et de prendre des notes sur votre expérience. Rédiger des notes sur les problèmes que vous aviez l'assemblage ou de l'installation ou de l'utiliser. Ils vous aideront à épargner le client d'éprouver les mêmes problèmes que vous aviez.
Créer une mise en page. La structure est très importante. Le manuel doit être un outil de référence. Cela signifie qu'il devra TABS imprimés sur les bords de chaque page de chaque section. Ces sections doivent être en ordre d'utilisation pour un propriétaire pour la première fois.
Onglets typiques seraient les suivants:
Ce qui est dans la boîte
Commencer
Connexions (ou l'installation)
Configuration (ou Configuration)
Utilisation de base (ou opération)
Utilisation avancée (ou opération)
Fonctions spéciales
Dépannage
Caractéristiques
- Liste des pièces
Ce qui est dans la boîte. Lorsque le client ouvre la boîte, ils ont besoin de savoir ce qui devrait dans la zone en cas quelque chose qui manque. Liste de toutes les pièces en forme de base complète. Exemple: le joueur, à distance, par câble, d'emploi, et les batteries. Les images de ces parties sont également d'une grande aide car certains utilisateurs peuvent être inexpérimenté et avoir besoin d'aide dans l'identification des pièces. Si ce produit doit être assemblé, montrer chaque ensemble de pièces avec des descriptions de taille. Par exemple: 3/4 pouces vis # 8, quantité. 12.
Commencer. Tous les appareils ont quelque chose qui doit être fait en premier. Expliquer au lecteur ce qui doit être fait avant de continuer avec le manuel. Cela pourrait inclure enlever le matériau d'emballage caché à l'intérieur de l'appareil, retirer une vis de transit ou d'installer une partie qui doit être installé avant de commencer, comme une cartouche d'encre, ou de retirer le film de protection en plastique clair sur écrans ou d'autres parties.
Connexions (ou l'installation). Utilisez des instructions étape par étape - marcher à travers le processus que vous prenez des notes et à nouveau lorsque vous écrivez le projet - montrant des images de la façon de se connecter ou d'installer le produit. Dans le cas des logiciels, montrer des captures d'écran de chaque étape de l'installation. Dans le cas de la connexion ou l'installation d'un dispositif, montrent des photos du produit d'action en cours d'installation. Les photos sont très important: Évitez d'utiliser des dessins, qui sont souvent inexacts et hors de proportion. Votre manuel sera mieux si vous utilisez des photos.
Configuration (ou Configuration). Dans cette section, utilisez des instructions étape par étape avec des images sur la façon de configurer ou installer votre produit. Cette situation est commune à des logiciels ou des périphériques qui sont contrôlées par un logiciel ou firmware. Ce serait également porter sur l'installation mécanique ou de réglage des fins de course, etc. Détail chaque étape avec des photos claires ou des captures d'écran.
Utilisation de base (ou opération). Dans cette section, la liste de toutes les opérations de base. Ce sont les opérations de base qui seraient utilisés quotidiennement. Si l'appareil utilise une télécommande, utilisez une barre latérale pour expliquer ce que les boutons sont utilisés pour reproduire cette action sur la télécommande (si applicable).
Utilisation avancée (ou opération). Dans cette section, la liste de toutes les opérations de base. Ce sont les opérations avancées qui seraient principalement utilisés par les utilisateurs avancés. Si l'appareil utilise une télécommande, utilisez une barre latérale pour expliquer ce que les boutons sont utilisés pour reproduire cette action sur la télécommande (si applicable).
Fonctions spéciales. Particularités sont ceux qui votre produit se démarque des autres.
Dans le détail de chaque section Feature avec un processus étape par étape sur la façon d'effectuer l'opération avec des captures d'écran ou des photos.
Dépannage. Cette section est un grand tableau qui répertorie l'utilisateur des problèmes communs pourraient rencontrer avec une cause et solution connue. Dans cette section, essayez d'éviter le ridicule comme aucun pouvoir = prise dans l'unité. Commencez avec des questions générales comme "Son, mais pas la vidéo", "Vidéo mais pas de son", "Démarre, mais lui-même éteint à nouveau". Votre produit est unique, afin de prendre un peu de temps avec ce domaine pour le rendre vraiment utile.
Spécifications. Dans ce domaine, la liste de spécifications électriques, les dimensions physiques, le poids, les spécifications de fidélité cas échéant. Aussi la liste des limitations telles que la gamme d'un sonomètre, la puissance maximale d'un amplificateur ou la vitesse maximale d'une perceuse ou une scie.
Liste Des Pièces. Dans ce domaine de fournir une vue éclatée de votre appareil si son pas de logiciel. La liste des pièces doit couvrir toutes les parties détaillées avec des numéros et des noms. Cette page devrait également inclure un numéro de téléphone, site internet et adresse e-mail pour obtenir des pièces de rechange en fonction de votre produit. Ne pas inscrire processus que ceux-ci sont sujets à changement.