Share
Ein technisches Dokument ist das Ergebnis der Erstellung effektiver technischer Benutzerinformationen. Es erklärt entweder wie etwas funktioniert oder wie man es benutzt. Es kann für Menschen in unterschiedlichen Rollen andere Dinge bedeuten. Möglicherweise benötigen Sie eine solche Dokumentation, um neue Mitarbeiter zu integrieren, neue Funktionen zu erläutern oder als Referenz für Personen, die sich nicht mit Technik auskennen.
Das Schreiben eines technischen Dokuments erfordert eine Reihe von Tools - eine Screenshot-App, einen Bildeditor, ein Textverarbeitungsprogramm zum Schreiben von Anweisungen und Tools zum Freigeben des Dokuments.
Obwohl dies das beste Protokoll zum Erstellen eines technischen Dokuments ist, scheint es nicht richtig zu sein, wenn Sie Zeit haben oder regelmäßig aktualisiert werden müssen.
In diesem zweiteiligen Tutorial zeige ich Ihnen, wie man es benutzt Klären einfache und professionelle technische Dokumente erstellen.
Klären gibt Ihnen einige Optionen, um das technische Dokument entsprechend Ihren Anforderungen einzustellen. Gehe zu Klären Sie> Voreinstellungen.
Sie sehen drei Einstellungen: Allgemeines, Aktie, und PDF-Vorlagen. In jeder Voreinstellung können Sie mehrere Parameter konfigurieren.
Wählen Sie die allgemeinen Einstellungen in den Voreinstellungen zum KlärenKonfigurieren Sie die Hotkeys für die Aufnahme von Screenshots. Um den Hotkey zu ändern, klicken Sie auf Löschen und geben Sie den neuen Hotkey ein. Wenn Sie es vorziehen, Ihre technischen Dokumente mit einer großen Leinwand zu erstellen, schalten Sie um Textgröße des Dokumenteditors von klein zu groß.
Klären können Sie die Bildeinstellungen nach Ihren Wünschen anpassen. Wählen Sie das Exportformat als PNG oder JPEG (gut, besser, am besten). Sie können ALT-Tags für die Bilder automatisch generieren oder die Breite und Höhe gemäß der Style-Anleitung automatisch skalieren.
Wählen Sie die Freigabeeinstellungen in den Voreinstellungen für das Klären. Klicken Sie auf die Schaltfläche +, um ein Konto hinzuzufügenClarify bietet verschiedene Möglichkeiten, die erstellten Dokumente gemeinsam zu nutzen. Sie können nach clarify-it.com exportieren, damit andere Dokumente anzeigen können. Sie können das Dokument als benutzerdefiniert exportieren WordPress Blog oder .com Blog oder speichern Sie sie als PDF, HTML oder Wort dokumentieren.
Klären Im Lieferumfang sind vier grundlegende Vorlagen enthalten: Standard, Schwarzweiß, Chrome und Corporate.
Wenn Sie bestimmte Anforderungen haben, können Sie Ihre eigene PDF-Vorlage erstellen. Drücke den + Schaltfläche, um eine neue benutzerdefinierte Vorlage zu erstellen.
Allgemeine Einstellungen einer PDF-Vorlage anpassen. Klicken Sie auf die Schaltfläche +, um eine benutzerdefinierte Vorlage hinzuzufügenIn dem Allgemeines Auf dieser Registerkarte können Sie Seitengröße und -ränder, Bildausrichtung, Einstellungen für den Inhalt und vieles mehr anpassen. Beim Generieren eines PDF-Dokuments, Klären fügt Seitenumbrüche an bestimmten Orten hinzu. Obwohl Klären versucht, Schrittinhalt zusammen zu halten, können Sie sie konfigurieren.
Drücke den Inhaltsfluss Menü, um die Einstellungen für den Seitenumbruch zu konfigurieren. Wählen Ein Schritt pro Seite nach jedem Schritt einen Seitenumbruch hinzufügen.
Wählen Passen Sie so viel Inhalt wie möglich pro Seite an So viel Inhalt wie möglich auf die Seite setzen. Verwenden Sie CSS zur weiteren Kontrolle der Seitenumbrüche.
Im Headerfeld können Sie eine hinzufügen Logo und passen Sie einige weitere Variablen an. Sie können Variablen wie hinzufügen
Accentsconagua
[[Dokumenttitel]] - Der Name des Dokuments[[Dateiname]] - Der Name der PDF-Datei[[Datum]] - Das Datum in dem Format, das Ihr System verwendet[[MM / TT / JJJJ]] - Monat, Tag und JahrIm Fußzeilenfeld können Sie Seitennummern und Fußzeilentext hinzufügen. Sie können Variablen wie hinzufügen
[[Seitennummer]] - Die Seitennummer[[Seitenzahl]] - Die Gesamtzahl der Seiten
Passen Sie Schriftarten und Farben der PDF-Vorlage anIn dem Schriftarten und Farben Auf dieser Registerkarte können Sie die Standardschriftart, die Schriftgröße und -farbe für Kopf- und Fußzeile, Artikelbeschreibung, Schritttitel und Teilschritttitel festlegen. Wenn Sie keine Schriftart für ein bestimmtes Objekt festlegen, wird das verwendet Standardschriftart.
CSS einer PDF-Vorlage anpassen. Wenn Sie sich mit CSS auskennen, können Sie viele Variablen hinzufügen Das Benutzerdefinierte CSS Auf dieser Registerkarte können Sie Anpassungen an Elementen vornehmen, die in der Benutzeroberfläche nicht verfügbar sind. PDF-Vorlagen in der Klären arbeitet nach dem Prinzip von HTML und CSS. Wenn Sie über beides Bescheid wissen, können Sie der PDF-Vorlage viele Variablen hinzufügen. Zum Beispiel
.Schrittcontainer (Seitenumbruch: immer)
Dieses CSS weist den PDF-Generator an, nach einem Schritt immer einen Seitenumbruch hinzuzufügen. Sie können Ihrem PDF-Dokument auch einen bestimmten Schriftstil hinzufügen, indem Sie dem Dokument bestimmte CSS-Klassen hinzufügen.
.Schritttitel (Schriftstil: kursiv;Schriftgewicht: leichter;)
Einige der Klassen, die Sie verwenden können, sind Artikelbeschreibung, Schritttitel, Schrittcontainer, Unterschritt, und Schrittanweisungen. Bei jedem Schritt können Sie klicken Vorschau um die endgültige Ausgabe der PDF-Vorlage anzuzeigen.
Klären ist eine native App für Windows und Mac, um technische Dokumente zu erstellen. Mit dieser Funktion können Sie Vorlagen erstellen, sodass Sie sich auf das Erstellen eines technischen Dokuments konzentrieren können, ohne sich umständlich zu kümmern, und mehrere Apps verwalten - Bildschirmaufzeichnungstool, Textverarbeitung und Freigabewerkzeuge.
In diesem Lernprogramm habe ich Ihnen gezeigt, wie Sie die Clarify-App konfigurieren, um die maximalen Vorteile zu nutzen, und wie Sie Vorlagen einrichten.
Im nächsten Tutorial werde ich Schritt für Schritt vorgehen, um ein technisches Dokument zu erstellen. Die App beinhaltet eine 14-tägige Testversion und ist für 29,99 US-Dollar erhältlich. Weitere Informationen finden Sie in den Preisangaben.
