Un document technique est le résultat de la création d’une information technique utilisateur efficace. Cela explique soit comment quelque chose fonctionne ou comment l'utiliser. Cela peut signifier différentes choses pour des personnes jouant des rôles différents. Vous aurez peut-être besoin de cette documentation pour intégrer de nouvelles recrues, expliquer de nouvelles fonctionnalités ou servir de référence aux personnes non familiarisées avec la technologie..
La rédaction d'un document technique nécessite plusieurs outils: une application de capture d'écran, un éditeur d'images, un traitement de texte permettant d'écrire des instructions et des outils de partage du document..
Bien que ce soit le meilleur protocole pour créer un document technique, cela ne semble pas correct si vous manquez de temps ou si vous devez le mettre à jour périodiquement..
Dans ce tutoriel en deux parties, je vais vous montrer comment utiliser Clarifier créer des documents techniques simples et professionnels.
Clarifier vous donne peu d'options pour définir le document technique selon vos besoins. Aller à Clarifier> Préférences.
Vous verrez trois préférences: Général, Partager, et Modèles PDF. Chaque préférence vous permet de configurer plusieurs paramètres.
Choisissez les paramètres généraux dans les préférences ClarifyConfigurez les touches de raccourci pour prendre des captures d'écran. Pour changer le raccourci clavier, cliquez sur Retirer et tapez le nouveau raccourci clavier. Si vous préférez une grande toile pour écrire vos documents techniques, basculez Taille du texte de l'éditeur de document de petit à grand.
Clarifier vous permet de personnaliser les paramètres de l'image, comme vous le souhaitez. Sélectionnez le format d'exportation comme PNG ou JPEG (bon, meilleur, meilleur). Vous pouvez générer automatiquement des balises ALT pour les images ou les redimensionner automatiquement, en largeur et en hauteur, conformément au guide de style..
Choisissez les paramètres de partage dans les préférences Clarify. Cliquez sur le bouton + pour ajouter un compteClarify propose différentes manières de partager les documents créés. Vous pouvez exporter vers clarif-it.com pour que les autres puissent voir les documents. Vous pouvez exporter le document au format personnalisé WordPress blog ou blog .com ou enregistrez-les au format PDF, HTML ou Mot document.
Clarifier livré avec quatre modèles de base: Basic, Black and White, Chrome et Corporate.
Si vous avez des besoins spécifiques, vous pouvez créer votre propre modèle PDF. Clique le + bouton pour créer un nouveau modèle personnalisé.
Personnaliser les paramètres généraux d'un modèle PDF. Cliquez sur le bouton + pour ajouter un modèle personnalisédans le Général onglet, personnalisez la taille et les marges de la page, l’alignement des images, les paramètres de flux de contenu, etc. Lors de la génération d'un document PDF, Clarifier ajoute des sauts de page à certains endroits. Bien que Clarifier essaie de garder le contenu de l'étape ensemble, vous pouvez les configurer.
Clique le Flux de contenu menu pour configurer les paramètres de saut de page. Choisir Une étape par page ajouter un saut de page après chaque étape.
Choisir Ajuster le contenu autant que possible par page mettre autant de contenu sur la page que possible. Utiliser CSS pour mieux contrôler les sauts de page.
Dans le champ d'en-tête, vous pouvez ajouter un Logo et personnaliser un peu plus de variables. Vous pouvez ajouter des variables comme
Accentsconagua
Share[[Titre du document]] - Le nom du document[[Nom de fichier]] - Le nom du fichier PDF[[Rendez-vous amoureux]] - La date au format utilisé par votre système[[MM / JJ / AAAA]] - Mois, jour et annéeDans le champ de bas de page, vous pouvez ajouter des numéros de page et du texte de bas de page. Vous pouvez ajouter des variables comme
[[Numéro de page]] - Le numéro de page[[Nombre de pages]] - Le nombre total de pages
Personnaliser les polices et les couleurs du modèle PDFdans le Polices et couleurs onglet, définissez la police, la taille et la couleur par défaut de l'en-tête et du pied de page, la description de l'article, le titre de l'étape et le titre de la sous-étape. Si vous ne définissez pas de police pour un objet particulier, il utilisera le Police par défaut.
Personnaliser le CSS d'un modèle PDF. Avoir une connaissance de CSS vous permet d'ajouter de nombreuses variables le CSS personnalisé L'onglet vous permet de modifier les éléments qui ne sont pas disponibles dans l'interface utilisateur. Modèles PDF dans le Clarifier fonctionne sur le principe de HTML et CSS. Si vous connaissez les deux, vous pouvez ajouter de nombreuses variables au modèle PDF. Par exemple
.step-container (page-break-after: toujours)
Ce code CSS indique au générateur de PDF de toujours ajouter un saut de page après une étape. Vous pouvez également ajouter un style de police spécifique à votre document PDF en ajoutant des classes CSS spécifiques dans le document..
.step-title (style de police: italique;poids de police: plus léger;)
Certaines des classes que vous pouvez utiliser sont description d'article, titre de l'étape, conteneur étape, sous-étape, et instructions étape par étape. À chaque étape, vous pouvez cliquer Aperçu pour voir le résultat final du modèle PDF.
Clarifier est une application native pour Windows et Mac permettant de 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 applications - outil de capture d'écran, traitement de texte et outils de partage..
Dans ce tutoriel, je vous ai montré comment configurer l'application Clarify pour tirer le maximum d'avantages et comment configurer des modèles..
Dans le prochain tutoriel, je vais vous expliquer pas à pas la procédure à suivre 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.
