Exemple de guide utilisateur

Grande documentation utilisateur final se compose de titres qui sont spécifiques, et souvent sous la forme d`effectuer une tâche. Avec une URL unique, vous pouvez répondre dans chatter, e-mail, dans les communautés, etc. Cela rend non seulement plus facile pour vos utilisateurs finaux de trouver ce qu`ils recherchent, mais il vous aide à écrire de meilleurs articles. Il est utile de cliquer avec le bouton droit de la souris (ou de Ctrl + clic pour une seule touche) sur un lien de page sur lequel vous aimeriez travailler et de l`ouvrir dans un nouvel onglet. La vidéo agit comme un enseignant pour expliquer un processus global et de fournir une formation initiale. Dans la fenêtre contextuelle “Insérer/modifier l`image”, cliquez sur l`onglet “apparence”. C`est une excellente façon de faire la documentation de l`utilisateur final. D`autres types de modules utiliseront cette option pour appliquer un titre au module sur la page Web en direct. Conseils lors de la sélection d`image: il peut être un peu délicat de sélectionner votre image dans l`éditeur de contenu Toolbox pour modifier ses paramètres. La majorité de la documentation de l`utilisateur final doit avoir des captures d`écran, et ces captures d`écran doivent inclure une sorte d`annotation.

Si vous pouvez supprimer les obstacles que vos utilisateurs finaux doivent sauter par-dessus afin de trouver des réponses, ils référencent votre documentation. La rubrique 3 sera votre style d`en-tête principal après le titre de la page à la fois dans les colonnes gauche et droite. Si votre documentation n`est pas consultable, alors il ne va pas être utilisé très souvent. Il est appelé le module téléchargeable liste de documents. Ce n`est pas le cas pour les modules de texte libre, il suffit de cliquer sur “soumettre” pour ajouter votre titre descriptif. Sélectionnez votre image et cliquez sur l`icône “Insérer/modifier l`image”. Dans la page du module texte libre, il y a un deuxième onglet à côté de l`onglet Éditeur de contenu appelé «paramètres. Pour créer un manuel d`utilisation, commencez par expliquer comment configurer le produit, ainsi qu`une liste de ses fonctions les plus courantes.

La rubrique 1 (H1) est reserverd pour l`en-tête de page en haut de chaque page Web. Il ne doit jamais être “cliquez ici”, “ici”, ou l`URL elle-même. Ensuite, Organisez vos informations dans des sections, telles que options, conseils de dépannage et Foire aux questions. Les images n`ont pas de marges par défaut. Les instructions étape par étape sont excellentes pour le rappel rapide. Mais après la formation initiale, les utilisateurs finaux n`ont pas besoin de regarder la vidéo entière à nouveau-ils ont juste besoin d`un rappel rapide de ce qu`il faut faire. Comme votre page a de plus en plus de modules de texte, il sera plus facile d`obtenir le module que vous voulez si elle a un titre descriptif court. À la fin de tout cela, ce qui est l`utilisateur final censé voir? Au lieu d`aller droit à l`information dont ils ont besoin, les utilisateurs finaux devront passer au crible toutes les autres choses pour trouver une réponse. Sinon, les utilisateurs finaux gaspillent du temps à chercher ce que vous venez de référencer. L`objectif de la documentation de votre utilisateur final est de réduire le nombre d`heures que vous passez à expliquer les workflows et de réduire le nombre d`heures que les utilisateurs finaux consacrent à la recherche de réponses. Au bas de la page de modification est la zone de contenu de PAGE où vous pouvez éditer des modules de texte libre. HubSpot fait un excellent travail d`écriture des titres utiles, puis la démonstration du flux de travail en utilisant des images, du texte et des annotations.