Comment écrire un Disposition Manuel d'instruction

Un manuel d'instruction peut être simple comme un livre de recettes ou aussi complexe que d'un manuel de montage d'un avion de ligne. Dans les deux cas, la conception du manuel pourra vous aider ou vous gêner lorsque vous essayez de l'utiliser. Un "disposition" peut signifier un ou l'autre de deux choses: l'ordre dans lequel l'information est présentée, ou la façon dont les informations apparaissent sur la page ou sur l'écran et les relations entre les éléments graphiques sur la page ou de l'écran. Définir la portée du manuel d'instruction et de déterminer les éléments graphiques et de texte que vous allez utiliser avant de créer l'autre type de mise en page.

Choses que vous devez

  • Page conception de logiciels / de traitement de texte
  • Décrivant logiciels (facultatif)

Instructions

  1. Créer un plan pour votre manuel d'instruction Liste toutes les tâches et sous-tâches dans l'ordre vous décider. Microsoft Word contient une caractéristique décrivant qui permettra d'automatiser le processus pour vous.




  2. Inclure l'espace dans votre format pour toutes les différentes parties de manuels d'instruction, y compris des sections comme la table des matières, un index, des diagrammes de pièces montrant comment les assembler, les instructions d'utilisation et d'autres articles pertinents à votre contenu technique. Pas toutes les sections seront nécessaires pour tous les manuels, donc en fonction de ce que votre manuel d'instruction est destiné, additionner ou soustraire ces partir du contour. Faire le contour aussi détaillée que possible afin que le manuel sera plus facile d'écrire dans sa forme finale.

  3. Décidez de ce que le format manuel sera. Si il est une collection de tâches autonomes, comme un livre de cuisine, vous avez plus d'options de présentation que si le manuel est un ensemble de sous-tâches séquentielles qui conduisent à un résultat global, comme un manuel vous montrant comment démonter un moteur.




    Si vous avez besoin de reproduire les informations en plusieurs formats (tels que les pages imprimées, les écrans d'ordinateur et les écrans de téléphone portable), vous pouvez utiliser une "single sourcing" framework comme XML et DITA. Ces outils vous permettent de séparer les informations du format afin que l'information peut être "réorientés" plus facilement. Si vous décidez de "seule source" votre information, planifier le plus tôt dans le processus que possible. Vous pourrez produire des blocs d'information ("sujets") et de multiples formats de livraison, nécessitant de multiples configurations graphiques.

  4. Créer une mise en page dans un programme de conception de page tels que FrameMaker (pour les projets de texte-lourd dont le format ne change pas beaucoup d'une page à) ou InDesign (pour les projets graphiques-lourds, ou des manuels où la conception visuelle de base varie d'une page à) .

Conseils & Avertissements

  • En règle générale, un rapport d'un tiers l'espace blanc au texte des deux tiers et graphiques est agréable à l'œil et plus facile à lire que d'une page coincée avec le texte.
  • Ne pas utiliser plus de deux polices de caractères par page.
  • Aligner des éléments tels que des boîtes de textes, photographies, graphiques et autres éléments graphiques uns avec les autres et les marges du texte sur la page.
» » » » Comment écrire un Disposition Manuel d'instruction