Comment créer un document technique professionnel - partie 2

Création d'un document technique

Vous avez un nouveau Mac et souhaitez configurer Internet pour accéder au Web. Vous craignez d'oublier les étapes ou d'aider les autres. Dans cet exemple, je vais créer un document technique simple, étape par étape, et l'enregistrer en tant que document PDF..

1. Ajouter le sujet et la description de l'article

Écrire le Assujettir et un bref Description d'article. Il doit être bref, clair et indiquer précisément ce que vous souhaitez montrer, dans ce cas, vous souhaitez configurer Internet sur un Mac. le Assujettir la ligne apparaît sur la barre latérale de la Clarifier tableau de bord.

Cliquez sur Fichier> Enregistrer sous et sélectionnez le dossier dans lequel le fichier doit être enregistré. Par défaut, il sélectionne le sujet de la Clarifier document en tant que nom de fichier avec extension .clarifier et l'enregistre dans le Clarifier les documents dossier.

Créer un sujet et une description de l'article

2. Ajouter un titre d'étape et un texte de paragraphe

Clique le + symbole pour ajouter une nouvelle étape. Écrire le Titre de l'étape et le texte du paragraphe dans leurs cases respectives. 

Si vous faites une erreur, cochez la case pour la modifier. Quand vous ajoutez un Titre de l'étape vous verrez le titre de l'étape dans la barre latérale de la Clarifier tableau de bord.

Créez le titre de l'étape et le texte du paragraphe. 1. Titre de l'étape 2. Zone de texte Paragraphe

3. Formater le texte du paragraphe

Clarifier offre un certain nombre d'options pour formater le texte. La barre de formatage apparaît lorsque vous sélectionnez la zone de champ de paragraphe. Cliquez sur l'une des icônes pour changer le format de votre texte. Vous pouvez choisir parmi Audacieux, Italique, Liste de balle, Lien, En exposant et plus. 

Lorsque vous appuyez sur la touche de retour, Clarifier va créer un nouveau paragraphe. Clarifier ajoute un espacement entre chaque paragraphe comme vous le verrez dans le texte d'un site Web.

Diverses options de formatage de paragraphe dans Clarify

Clarifier vous permet également de formater le code sous forme de blocs de code entiers ou de mots individuels dans une phrase. Pour marquer un mot ou deux en tant que code, sélectionnez le mot et cliquez sur Format en code bouton de la barre d'outils de formatage.

Lorsque vous exportez le Clarifier document au format HTML, le texte sera placé entre  Mots clés. Sélectionnez le paragraphe entier et cliquez sur Format en code, convertir le texte en un bloc de code avec la sortie incluse dans 

 Mots clés.

Options de formatage du code dans Clarify

4. Prendre des screenshots

Vous avez trois options pour capturer des images 

  1. Capturer bouton dans l'application Clarify
  2. Capturer bouton de la barre de menu, ou 
  3. Raccourcis clavier

Aller à Clarifier> Préférences et dans le Général paramètres configurer les raccourcis clavier.

Prendre une capture d'écran à partir du bouton Capture

Lorsque vous appuyez sur le Capturer des outils de capture d’écran de bouton apparaîtront à l’écran Faites glisser la souris sur la zone que vous souhaitez capturer et appuyez sur la touche Revenir clé. appuyez sur la Barre d'espace capturer une fenêtre complète. appuyez sur la Barre d'espace encore une fois pour revenir en mode de capture de région.

presse R pour parcourir les régions précédentes que vous avez capturées. C'est utile lorsque vous souhaitez capturer la même zone de l'écran encore et encore. presse C afficher ou masquer le curseur lors de la capture d'écran.

Outil de capture d'écran à l'écran. Il comprend des clés pour rendre le flux de travail de capture d'écran beaucoup plus rapide

5. Effectuer des tâches de base avec des images

Clarifier fournit de nombreuses options pour manipuler les images: faire pivoter, rogner, utiliser les outils d'annotation de base, redimensionner les images et le canevas. 

Pour faire pivoter l'image, cliquez sur Édition> Faire pivoter l'image.

Faire pivoter une image dans Clarify

Pour recadrer l'image, cliquez sur Édition> Recadrer l'image. Cliquez et faites glisser la souris sur la zone que vous souhaitez conserver, puis appuyez sur la touche Revenir clé.

Recadrer une image dans Clarify

Vous pouvez choisir parmi plusieurs outils d'annotation. Sélectionnez l'image et cliquez sur le type d'outil d'annotation que vous souhaitez utiliser dans la barre d'outils de mise en forme: Outil de ligne, Outil carré, Outil de cercle, Outil de numérotation de séquence (vous pouvez personnaliser la séquence de départ), Outil texte et Outil de floutage.

Type d'outils d'annotation de ligne dans Clarify

Clarifier a trois options pour redimensionner les images. Il comporte quatre poignées sur les côtés de l'éditeur d'images. Cliquez et faites glisser l'une de ces poignées pour modifier la taille du canevas. Vous ne pouvez pas recadrer une image à l'aide de ces poignées de canevas. 

Faites glisser et maintenez le Option touche pour redimensionner tous les côtés de la toile.

Redimensionner la toile d'une image à l'aide de poignées

Utilisez la poignée de redimensionnement de l’image située dans le coin inférieur droit. Cliquez et faites glisser cette poignée pour redimensionner l'image. Appuyez et maintenez le Option touche pour redimensionner l'image par incréments de 10%.

Redimensionner l'image via une poignée située dans le coin inférieur droit

Pour un contrôle précis sur la taille de l’image, cliquez sur l’image de pas et sélectionnez Redimensionner l'image… . Si l'étape comporte plusieurs images, vous devez sélectionner une image en particulier, puis les redimensionner via un menu contextuel..

Redimensionner l'image via un menu contextuel 

6. Créer des sous-étapes ou des étapes d'imbrication

Clarifier a la capacité de créer des sous-étapes. Une sous-étape est mise en retrait sous l’étape parent et peut avoir une profondeur d’un niveau. Lorsque vous exportez le document, une mosaïque de sous-étape apparaît différemment dans une petite taille de police, avec une numérotation de sous-étape (si vous l'activez). Au début, créez l’étape habituelle comme décrit précédemment.

Sélectionnez l'étape pour laquelle vous souhaitez créer une sous-étape. Aller à Document> Déplacer une étape menu et déplacez le step droite l'indenter. Déplacer la sous-étape en haut ou vers le bas organiser le document technique, au besoin.

Création de sous-étapes dans Clarify

7. Numérotation automatique des étapes

Lorsque le document technique comporte plusieurs étapes, vous pouvez les préfixer d’un numéro. Clarifier numérotera automatiquement les étapes, cliquez sur Inspecteur de documents et vérifie Nombre automatique d'étapes. Toutes les autres étapes seront automatiquement précédées de chiffres.

Nombre automatique d'étapes dans Clarify

Pour exclure une étape de l’obtention d’un préfixe, cliquez sur le bouton Step Inspector et coche Exclure du numéro automatique. Cette étape ne sera plus précédée d'un numéro.

Exclure une étape dans Clarify

Il peut arriver que vous ne souhaitiez pas numéroter automatiquement les étapes les plus importantes, mais uniquement les sous-étapes. Pour ce faire, cliquez sur le bouton Step Inspector et vérifie Nombre automatique de sous-étapes. Seules les sous-étapes seront précédées de chiffres.

Nombre automatique de sous-étapes dans Clarify. Si cette fonctionnalité ne fonctionne pas, alors c'est probablement un bug

8. Exécution de tâches avancées avec des images

Clarifier comprend des fonctionnalités sophistiquées pour manipuler des images. Bien que ces fonctionnalités soient disponibles sur d’autres éditeurs d’images, celles-ci étant Clarifier accélère considérablement le processus de création de document technique. Pour ajouter une bordure autour des images, sélectionnez les étapes à modifier..

Clique le Step Inspector et à l'intérieur Paramètres d'image section changer le Bordure d'image vous voulez ajouter pour les images. Vous pouvez choisir parmi LigneCadre, et Coins arrondis.

Ajouter une bordure d'image dans Clarify. Vous pouvez choisir parmi Ligne, Cadre et Coins arrondis

Clarifier peut redimensionner automatiquement les images et les réduire si elles sont trop grandes ou trop grandes.

Clique le Inspecteur de documents et vérifie Images à échelle automatique. Définir le maximum la taille, ou largeur de l'image ou les deux.

Redimensionnez automatiquement les images dans Clarify sans avoir besoin d'un éditeur d'image

L'ajout de plusieurs images dans une étape prend également beaucoup de temps. Clique le + panneau situé juste à côté de la poignée en toile. 

Prenez la capture d'écran et vous la trouverez incluse dans l'étape.

L'ajout de plusieurs images à une étape est facile et sans manipuler les applications

Si vous avez configuré Répéter la dernière capture vous n'avez pas à vous soucier des outils de capture d'écran. L'image ajoute juste en dessous de l'image du haut, et ainsi de suite.

Ajout de plusieurs images à une seule étape. Si vous devez prendre une capture d'écran de la même zone à plusieurs reprises, configurez le raccourci clavier Répéter la dernière capture.

Si vous souhaitez remplacer une image pour une étape donnée, sélectionnez-la, puis cliquez sur le bouton Remplacer l'image icône dans le coin supérieur gauche. 

Ou cliquez sur le Remplacer icône située à côté de la poignée de la toile.

Remplacer l'image dans Clarify 1. Remplacer l'icône de l'image 2. Remplacer l'icône près de la poignée de la toile

9. Incorporer une vidéo hébergée dans une étape

Un document technique sera facile à suivre si vous incluez une vidéo. Avec Clarifier vous pouvez intégrer des vidéos hébergées sur des services vidéo tels que Youtube facilement dans les marches. 

Sélectionnez l'étape, cliquez sur le bouton Step Inspector et changer le Type de support de Image à HTML.

Changer le type de média dans l'inspecteur d'étape de image en HTML

Ce faisant, vous verrez une boîte pour insérer du code HTML. Aller à Youtube, et copiez le code intégré de la vidéo. Cliquez sur Aperçu voir l'aperçu du HTML.

Collez le code intégré dans la boîte. Choisissez le code d'intégration de la vidéo Youtube

Certains formats d'exportation ne peuvent pas afficher le code HTML pour une étape. Clique sur le Image onglet et ajouter une image, pour ces types de formats d'exportation. 

Vous devez toujours utiliser la représentation de l'image lors de l'exportation de vos fichiers. Clarifier document à Mot (Extension DOCX).

Ajouter une image pour voir le HTML 

10. Ajouter une ancre aux étapes de la sortie HTML

Vous pouvez ajouter des balises d'ancrage aux étapes qui attribueront la propriété id dans la sortie HTML. Cela peut être utile pour créer un lien direct vers des étapes spécifiques lorsque vous partagez un fichier. Clarifier document sur le web. 

Par exemple, si vous définissez le nom de l'ancre pour une étape sur étape spéciale et si votre Clarifier L'URL du document est

http://www.myblog.com/my-article.html

alors vous pouvez lier directement à l'étape en ajoutant # special-step à l'URL:

http://www.myblog.com/my-article.html#special-step

Pour ajouter des balises d'ancrage à une étape, sélectionnez l'étape que vous souhaitez modifier. Cliquez sur Step Inspector et à l'intérieur Paramètres de l'étape définir le nom de l'ancre. 

Lorsque vous définissez un nom d'ancre, utilisez uniquement des lettres, des chiffres, des traits d'union ou des traits de soulignement..

Ajouter des balises d'ancrage aux étapes dans Clarify Document

Remarque: Si vous ne définissez pas d'ancrage pour une étape, alors Clarifier générera automatiquement des tags basés sur un identifiant interne qui Clarifier assigne des étapes lorsque vous les créez. Les balises d'ancrage restent les mêmes chaque fois que vous exportez le fichier. Clarifier document.

11. Exporter et partager le document Clarify

Aller à Clarifier> Préférences et cliquez Partager. Clique le + bouton et choisissez le compte de partage pour les cibles d'exportation. Un compte de partage peut exporter vers Clarify-it.com, WordPress et Evernote. Vous pouvez également exporter votre Clarifier document en format PDF, HTML et Word.

Pour partager des comptes, vous devez avoir un compte et une autorisation. Pour PDF, HTML, sélectionnez ou personnalisez le modèle que vous souhaitez utiliser à chaque fois.

Créer des comptes de partage dans Clarify

Vous pouvez personnaliser le modèle pour PDF, HTML. Email et Word. Dans un modèle HTML, vous pouvez choisir parmi plusieurs modèles: Basic, Chrome, Corporate, Markdown, Technique et même un modèle HTML personnalisé. 

Sélectionnez le logo et définissez les dimensions de l'image pour ce modèle. Clique le Aperçu bouton pour voir le modèle que vous avez personnalisé.

Personnaliser le modèle HTML dans Clarify

Vous pouvez également personnaliser le modèle de courrier électronique de la même manière. Puisqu'il utilisera PDF, vous pouvez personnaliser le modèle PDF et sélectionner le client de messagerie: Apple Mail, Postbox, Outlook ou Airmail. Clique le Aperçu bouton pour voir le modèle que vous avez personnalisé.

Modèle de courrier électronique dans Clarify. Choisissez le client de messagerie que vous préférez

Conclusion

Clarifier est une application native pour les fenêtres et Mac créer des documents techniques. Il vous permet de créer des modèles afin que vous puissiez vous concentrer sur la création d'un document technique sans complications et la gestion de plusieurs outils de capture d'écran, d'applications de traitement de texte et de partage.

Dans ce tutoriel, je vous ai montré la procédure pas à pas pour créer un document technique. L'application comprend un essai de 14 jours et est disponible pour 29,99 $. Voir les détails de tarification pour plus d'informations.