So erstellen Sie ein professionelles technisches Dokument - Teil 2

Technisches Dokument erstellen

Sie haben einen neuen Mac und möchten das Internet für den Zugriff auf das Web einrichten. Sie befürchten, dass Sie die Schritte vergessen oder für andere hilfreich sein könnten. In diesem Beispiel werde ich ein einfaches, schrittweise technisches Dokument erstellen und als PDF-Dokument speichern.

1. Fügen Sie den Betreff und die Artikelbeschreibung hinzu

Schreiben Sie die Gegenstand und eine kurze Artikelbeschreibung. Es sollte kurz und klar sein und genau sagen, was Sie anzeigen möchten. In diesem Fall möchten Sie das Internet auf einem Mac einrichten. Das Gegenstand Zeile erscheint in der Seitenleiste der Klären Instrumententafel.

Klicken Datei> Speichern unter und wählen Sie den Ordner, in dem die Datei gespeichert werden soll. Standardmäßig wird der Betreff der ausgewählt Klären Dokument als Dateiname mit der Erweiterung als .klären und speichert es in der Dokumente klären Mappe.

Erstellen Sie die Betreff- und Artikelbeschreibung

2. Fügen Sie einen Schritttitel und einen Absatztext hinzu

Drücke den + Symbol, um einen neuen Schritt hinzuzufügen. Schreiben Sie die Schritt Titel und Absatztext in ihren jeweiligen Feldern. 

Wenn Sie einen Fehler machen, klicken Sie auf das Feld, um es zu bearbeiten. Wenn Sie eine hinzufügen Schritt Titel Der Schritttitel wird in der Seitenleiste von angezeigt Klären Instrumententafel.

Schritttitel und Absatztext erstellen. 1. Schritttitel 2. Textfeld für Absatz

3. Formatieren Sie den Absatztext

Klären bietet eine Reihe von Optionen zum Formatieren des Textes. Die Formatierungsleiste wird angezeigt, wenn Sie das Absatzfeld auswählen. Klicken Sie auf eines der Symbole, um das Format Ihres Textes zu ändern. Sie können wählen Fett gedruckt, Kursiv, Aufzählung, Verknüpfung, Hochgestellt und mehr. 

Wenn Sie die Return-Taste drücken, Klären erstellt einen neuen Absatz. Klären fügt Abstand zwischen den einzelnen Absätzen hinzu, wie Sie auf einer Website im Text sehen.

Verschiedene Absatzformatierungsoptionen in Clarify

Klären Außerdem können Sie Code als ganze Codeblöcke oder als einzelne Wörter innerhalb eines Satzes formatieren. Um ein oder zwei Wörter als Code zu markieren, wählen Sie das Wort aus und klicken Sie auf Als Code formatieren Schaltfläche aus der Formatierungssymbolleiste.

Wenn Sie das exportieren Klären Dokument als HTML, wird der Text eingeschlossen  Stichworte. Wählen Sie den gesamten Absatz aus und klicken Sie auf Als Code formatieren, um den Text in einen Codeblock umzuwandeln, dessen Ausgabe in eingeschlossen ist 

 Stichworte.

Code-Formatierungsoptionen in Clarify

4. Screenshots machen

Sie haben drei Möglichkeiten, Bilder aufzunehmen 

  1. Erfassung Schaltfläche in der Clarify-App
  2. Erfassung Schaltfläche aus der Menüleiste oder 
  3. Tastatürkürzel

Gehe zu Klären Sie> Voreinstellungen und in der Allgemeines Einstellungen konfigurieren die Hotkeys.

Screenshot vom Capture-Button machen

Wenn Sie die Taste drücken Erfassung Bildschirm-Capture-Tools werden auf dem Bildschirm angezeigt. Ziehen Sie über den Bereich, den Sie aufnehmen möchten, und drücken Sie die Rückkehr Schlüssel. Drücken Sie die Leertaste ein ganzes Fenster einfangen. Drücken Sie die Leertaste erneut, um zum Region-Aufnahmemodus zurückzukehren.

Drücken Sie R um durch die zuvor erfassten Regionen zu gelangen. Dies ist nützlich, wenn Sie immer wieder denselben Bereich des Bildschirms erfassen möchten. Drücken Sie C um den Cursor während der Aufnahme anzuzeigen oder auszublenden.

Screen Capture-Tool auf dem Bildschirm. Es enthält einige Tasten, um den Workflow für Screenshots wesentlich schneller zu machen

5. Grundlegende Aufgaben mit Bildern ausführen

Klären Bietet viele Optionen zum Bearbeiten von Bildern: Drehen, Zuschneiden, Verwenden der grundlegenden Anmerkungswerkzeuge, Ändern der Bildgröße und des Bildbereichs. 

Klicken Sie auf, um das Bild zu drehen Bearbeiten> Bild drehen.

Drehen Sie ein Bild in Clarify

Klicken Sie auf, um das Bild zuzuschneiden Bearbeiten> Bild beschneiden. Klicken und ziehen Sie über den Bereich, den Sie behalten möchten, und drücken Sie die Taste Rückkehr Schlüssel.

Beschneiden Sie ein Bild in Clarify

Sie können aus einer Reihe von Anmerkungswerkzeugen auswählen. Wählen Sie das Bild aus und klicken Sie in der Formatierungssymbolleiste auf den Typ des Anmerkungswerkzeugs, das Sie verwenden möchten: Linienwerkzeug, Quadratisches Werkzeug, Kreiswerkzeug, Sequenznummerierungstool (Sie können die Startsequenz anpassen), Textwerkzeug und Werkzeug verwischen.

Typ der Linienanmerkungstools in Clarify

Klären verfügt über drei Optionen zum Ändern der Bildgröße. Es hat vier Griffe an den Seiten des Bildeditors. Klicken Sie auf einen dieser Ziehpunkte und ziehen Sie ihn, um die Größe der Leinwand zu ändern. Mit diesen Leinwandgriffen können Sie kein Bild zuschneiden. 

Ziehen und halten Sie die Möglichkeit Taste, um alle Seiten der Leinwand gleich zu skalieren.

Ändern Sie die Größe der Leinwand eines Bildes durch Ziehpunkte

Verwenden Sie den Bildgrößenänderungsgriff in der rechten unteren Ecke. Klicken Sie auf diesen Griff und ziehen Sie ihn, um die Größe des Bildes zu ändern. Halten Sie die Taste gedrückt Möglichkeit Taste zum Ändern der Bildgröße in Schritten von 10%.

Ändern Sie die Größe des Bildes durch einen Griff in der rechten unteren Ecke

Klicken Sie für eine genaue Kontrolle der Bildgröße auf das Schrittbild und wählen Sie Bildgröße anpassen… . Wenn der Schritt mehrere Bilder enthält, müssen Sie ein bestimmtes Bild auswählen und die Größe über ein Kontextmenü ändern.

Bildgröße über ein Kontextmenü ändern 

6. Erstellen von Unterschritten oder Verschachtelungsschritten

Klären hat die Fähigkeit, Unterschritte zu erstellen. Ein Unterschritt ist unter dem übergeordneten Schritt eingerückt und kann eine Ebene tief sein. Wenn Sie das Dokument exportieren, wird eine Unterschrittkachel in einer kleinen Schriftgröße und Unterschrittnummerierung angezeigt (wenn Sie sie aktivieren). Erstellen Sie zunächst den üblichen Schritt wie zuvor beschrieben.

Wählen Sie den Schritt aus, den Sie einen Unterschritt machen möchten. Gehe zu Dokument> Schritt verschieben Menü und bewegen Sie den Schritt Recht es einzurücken Bewegen Sie den Unterschritt oben oder Nieder das technische Dokument nach Bedarf zu organisieren.

Teilschritte in Clarify erstellen

7. Automatische Nummerierung der Schritte

Wenn das technische Dokument mehrere Schritte umfasst, können Sie ihnen eine Nummer voranstellen. Klären wird die Schritte automatisch nummerieren, klicken Sie auf Dokumenteninspektor und prüfe Auto-Nummer-Schritte. Alle anderen Schritte werden automatisch mit Nummern versehen.

Automatische Nummerierung in Clarify

Um einen Schritt vom Abrufen eines Präfixes auszuschließen, klicken Sie auf die Schaltfläche Schrittinspektor und ticken Aus Auto-Nummer ausschließen. Diesem Schritt wird keine Nummer mehr vorangestellt.

Schließen Sie einen Schritt in Clarify aus

Es kann Situationen geben, in denen Sie die Schritte der obersten Ebene nicht automatisch nummerieren möchten, sondern nur die Unterschritte. Klicken Sie dazu auf die Schaltfläche Schrittinspektor und prüfe Teilschritte mit automatischer Nummerierung. Nur den Teilschritten werden Nummern vorangestellt.

Autonummer-Unterschritte in Klarstellen. Wenn diese Funktion nicht funktioniert, liegt wahrscheinlich ein Fehler vor

8. Durchführen von erweiterten Aufgaben mit Bildern

Klären enthält einige ausgeklügelte Funktionen zum Bearbeiten von Bildern. Obwohl diese Funktionen in anderen Bildbearbeitungsprogrammen verfügbar sind, sind diese Funktionen in enthalten Klären macht das Erstellen von technischen Dokumenten wesentlich schneller. Um einen Rahmen um Bilder hinzuzufügen, wählen Sie die Schritte aus, die Sie bearbeiten möchten.

Drücke den Schrittinspektor und innerhalb Bildeinstellungen Abschnitt ändern die Bildrand Sie möchten für die Bilder hinzufügen. Sie können wählen LinieBilderrahmen, und Abgerundete Ecken.

Bildrahmen in Clarify hinzufügen. Sie können zwischen Linie, Bilderrahmen und abgerundeten Ecken wählen

Klären kann die Bilder automatisch skalieren und verkleinern, wenn sie zu groß oder zu breit sind.

Drücke den Dokumenteninspektor und prüfe Bilder automatisch skalieren. Stellen Sie das Maximum ein Höhe, oder Breite des Bildes oder beides.

Skalieren Sie Bilder in Clarify automatisch, ohne dass ein Bildeditor erforderlich ist

Das Hinzufügen mehrerer Bilder in einem Schritt ist ebenfalls zeitaufwändig. Drücke den + Zeichen direkt neben dem Canvas-Griff. 

Machen Sie den Screenshot und Sie finden sie im Schritt.

Das Hinzufügen mehrerer Bilder zu einem Schritt ist einfach und ohne um Apps herumzuspielen

Wenn du konfiguriert hast Wiederholen Sie den letzten Screenshot Sie müssen sich nicht um Bildschirm-Capture-Tools kümmern. Das Bild wird direkt unter dem obersten Bild hinzugefügt und so weiter.

Mehrere Bilder zu einem Schritt hinzufügen. Wenn Sie mehrere Male einen Screenshot desselben Bereichs erstellen müssen, konfigurieren Sie den Hotkey "Repeat Last Screenshot"

Wenn Sie ein Bild für einen bestimmten Schritt ersetzen möchten, wählen Sie das Bild aus, das Sie ersetzen möchten, und klicken Sie dann auf Bild ersetzen Symbol in der oberen linken Ecke. 

Oder klicken Sie auf die Schaltfläche Ersetzen Symbol neben dem Canvas-Griff.

Ersetzen des Bilds in Clarify 1. Ersetzen Sie das Bildsymbol

9. Betten Sie ein gehostetes Video in einen Schritt ein

Ein technisches Dokument ist leicht zu finden, wenn Sie ein Video hinzufügen. Mit Klären Sie können Videos einbetten, die auf Videodiensten gehostet werden, wie z Youtube leicht in die Stufen. 

Wählen Sie den Schritt aus und klicken Sie auf Schrittinspektor und ändern Sie die Medientyp von Bild zu HTML.

Ändern Sie den Medientyp im Schritt-Inspektor von Bild zu HTML

Daraufhin sehen Sie eine Box zum Einfügen von HTML-Code. Gehe zu Youtube, und kopieren Sie den Einbettungscode des Videos. Klicken Vorschau um die Vorschau des HTML-Codes anzuzeigen.

Fügen Sie den Code zum Einbetten in die Box ein. Wählen Sie den Einbettungscode aus dem Youtube-Video

Einige Exportformate können den HTML-Code nicht für einen Schritt anzeigen. Klicke auf das Bild Registerkarte und fügen Sie ein Bild für diese Art von Exportformaten hinzu. 

Sie müssen beim Exportieren immer die Bilddarstellung verwenden Klären Dokument zu Wort (DOCX-Erweiterung).

Fügen Sie ein Bild hinzu, um HTML anzuzeigen 

10. Fügen Sie den Schritten in der HTML-Ausgabe einen Anker hinzu

Sie können Ankertags zu Schritten hinzufügen, die in der HTML-Ausgabe als id -Eigenschaft zugewiesen werden. Dies kann hilfreich sein, wenn Sie eine Verknüpfung zu bestimmten Schritten herstellen möchten Klären Dokument im Web. 

Wenn Sie beispielsweise den Ankernamen für einen Schritt auf setzen Spezialschritt und wenn dein Klären Dokument-URL lautet

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

dann können Sie durch Hinzufügen direkt auf den Schritt verweisen # Spezialschritt zur URL:

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

Um einem Schritt Ankertags hinzuzufügen, wählen Sie den zu bearbeitenden Schritt aus. Klicken Schrittinspektor und innerhalb Schritt Einstellungen Legen Sie den Ankernamen fest. 

Verwenden Sie beim Einrichten eines Ankernamens nur Buchstaben, Zahlen, Bindestriche oder Unterstriche.

Fügen Sie Anker-Tags zu Schritten in Dokument klar

Hinweis: Wenn Sie für einen Schritt keinen Anker setzen, dann Klären generiert automatisch Tags basierend auf der internen id welche Klären weist den Schritten zu, wenn Sie sie erstellen. Diese Ankertags bleiben bei jedem Export der Klären dokumentieren.

11. Exportieren und teilen Sie das Clarify-Dokument

Gehe zu Klären Sie> Voreinstellungen und klicken Sie auf Aktie. Drücke den + und wählen Sie das Freigabe-Konto für die Exportziele. Ein Freigabekonto kann nach Clarify-it.com exportiert werden, WordPress und Evernote. Sie können auch Ihre exportieren Klären Dokument als PDF, HTML und Word.

Für die Freigabe von Konten benötigen Sie ein Konto und eine Berechtigung. Wählen Sie für PDF oder HTML die Vorlage aus, die Sie jedes Mal verwenden möchten, oder passen Sie sie an.

Erstellen Sie Freigabekonten in Clarify

Sie können die Vorlage für PDF und HTML anpassen. E-Mail und Word. In der HTML-Vorlage können Sie aus einer Reihe von Vorlagen auswählen: Basic, Chrome, Corporate, Markdown, Technisch und sogar eine benutzerdefinierte HTML-Vorlage. 

Wählen Sie das Logo aus und legen Sie die Bildabmessungen für diese Vorlage fest. Drücke den Vorschau Schaltfläche, um die von Ihnen angepasste Vorlage anzuzeigen.

Passen Sie die HTML-Vorlage in Clarify an

Sie können die E-Mail-Vorlage auf dieselbe Weise anpassen. Da es PDF verwenden wird, können Sie die PDF-Vorlage anpassen und den E-Mail-Client auswählen: Apple Mail, Postbox, Outlook oder Airmail. Drücke den Vorschau Schaltfläche, um die von Ihnen angepasste Vorlage anzuzeigen.

E-Mail-Vorlage in Clarify. Wählen Sie den E-Mail-Client, den Sie bevorzugen

Fazit

Klären ist eine native App für Windows und Mac technische Dokumente erstellen. Mit dieser Funktion können Sie Vorlagen erstellen, sodass Sie sich auf das Erstellen eines technischen Dokuments konzentrieren können, ohne sich darum kümmern zu müssen, und mehrere App-Screen-Capture-, Textverarbeitungs- und Freigabewerkzeuge verwalten.

In diesem Lernprogramm wurde Ihnen Schritt für Schritt beschrieben, wie Sie ein technisches Dokument 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.