Formatvorlage für Technische Dokumentation
Mit der Formatvorlage für Technische Dokumentation (Formate Word, OpenOffice/LibreOffice) erstellen Sie professionell gestaltete Benutzerhandbücher, Betriebsanleitungen, Bedienungsanleitungen und andere Formen Technischer Dokumentation.
▪Sie sparen viele Stunden Zeit, selbst eine geeignete Formatvorlage (Template) von Grund auf neu erstellen zu müssen.
▪Sie nutzen eine Vorlage, die nicht nur professionell aussieht und den Lesern die Inhalte übersichtlich vermittelt – die Formatvorlage ist auch so angelegt, dass Sie als Autor oder Autorin effizient und angenehm damit arbeiten können.
▪Bei Bedarf lassen sich die Titelseite und alle Formate mit wenig Aufwand individuell an Ihre firmeneigene Gestaltung anpassen. Dies ist jedoch optional. Sie können auch einfach nur die Vorlage öffnen und sofort loslegen!
Funktionen der Formatvorlage im Einzelnen
Anders als diverse im Internet zu findende kostenlose Formatvorlagen für Benutzerhandbücher hält die indoition Formatvorlage für Technische Dokumentation auch professionellen Ansprüchen Stand.
▪In einer guten Technischen Dokumentation ist es mit einem ansprechenden Aussehen allein nicht getan. Mindestens ebenso wichtig wie die Schönheit ist in einem Benutzerhandbuch oder einer Bedienungsanleitung ist eine optimale Lesbarkeit. Die Inhalte sind meist komplex genug, da muss wenigstens das Lesen einfach sein und darf die Benutzer nicht zusätzlich anstrengen.
▪Eine Technische Dokumentation enthält in den meisten Fällen ziemlich viel Text. Entsprechend wichtig ist es, dass Absatzformate und Zeichenformate auch für die Autoren einfach anzuwenden sind und die Seitenumbrüche und andere Formatierungsarbeiten weitgehend automatisiert funktionieren. Oder möchten Sie jeden Absatz einzeln von Hand ausrichten? (Und das nach jedem Update und in jeder Sprache noch einmal …)
Wesentliche Merkmale der Formatvorlage
▪Langjährig bewährt
▪Klares, modernes Design
▪Übersichtlich und gut lesbar
▪Vermeidet strategische Fehler beim Anlegen der Formate
▪Enthält alle in der Praxis benötigten Zeichenformate, Absatzformate, Tabellenformate
▪Voreinstellungen für Abbildungen
▪Titelseite
▪Impressum
▪Inhaltsverzeichnis
▪Alphabetisches Stichwortverzeichnis
▪Automatische Kapitelnummerierung
▪Rechte und linke Seiten
▪Kopfzeile mit lebendem Kolumnentitel
▪automatische Seitenzahlen
▪Optimal eingestellte und aufeinander abgestimmte Seitenränder
▪Optimal eingestellte und aufeinander abgestimmte Schriftgrößen
▪Einstellungen sorgen für automatisch für bestmögliche Zeilenumbrüche und Seitenumbrüche
▪Bewährtes, systematisches Benennungsschema für Formatnamen und Tastenkürzel
▪Funktioniert mit allen Sprachversionen von Microsoft Word, OpenOffice und LibreOffice; Sie müssen keine Formatnamen und Feldfunktionen anpassen
▪Funktioniert mit allen vom verwendeten Textverarbeitungsprogramm unterstützten Fremdsprachen
▪Sowohl auf A4-Papier als auch auf Papier im Letter-Format (USA) druckbar
▪Seitenformat bei Bedarf frei änderbar
▪Design und alle Einstellungen bei Bedarf ebenfalls frei änderbar
Beispielseiten
Die folgenden Abbildungen zeigen Ausschnitte aus dem mit der Vorlage mitgelieferten Beispieltext.
Klicken Sie auf ein Bild, um es zu vergrößern.
Titelseite:
Inhaltsverzeichnis:
Überschriften:
Abbildungen und Tabellen:
Textelemente:
Alphabetisches Stichwortverzeichnis (Index):
Online-Konvertierung (Beispiele)
Übrigens: Auf Basis der Formatvorlage für Technische Dokumentation erstellte Dokumente lassen sich effizient auch in die meisten Programme zur Erstellung von Online-Hilfen (Help-Authoring-Tools) importieren und anschließend in eine Onlinedokumentation konvertieren. Die folgende Onlinedokumentation wurde z. B. mit dem Programm „HelpNDoc“ aus der Formatvorlage für Technische Dokumentation generiert:
Die in den folgenden Bildern gezeigte Onlinedokumentation wurde mit dem Programm „Help+Manual“ basierend auf der Formatvorlage für Technische Dokumentation generiert. Der gesamte Konvertierungsprozess dauerte weniger als 10 Minuten.
Systemvoraussetzungen
Der Lieferumfang der Formatvorlage für Technische Dokumentation umfasst 3 Varianten:
▪eine Formatvorlage für Microsoft Word Desktop, verwendbar mit allen Desktop-Versionen von Microsoft-Word, die das Format *.DOCX unterstützen
▪eine Formatvorlage für Microsoft 365 Web (wegen des eingeschränkten Funktionsumfangs dieser Word-Version verwendet diese Variante der Formatvorlage eine vereinfachte Titelseite, einige vereinfachte Absatz- und Zeichenformate und enthält kein alphabetisches Stichwortverzeichnis)
▪eine Formatvorlage für OpenOffice und LibreOffice, verwendbar mit allen Programmversionen, die das Format *ODT unterstützen
Wesentliche Funktionen der Formatvorlage sind auch in anderen Textverarbeitungsprogrammen und Redaktionssystemen nutzbar, die Dateien der Formate *DOCX oder *.ODT importieren können. Allerdings sind in der Praxis nicht alle dieser Programme vollständig mit Microsoft Word oder LibreOffice kompatibel. Die in der Formatvorlage enthaltenen Absatzformate und Zeichenformate werden fast immer korrekt übernommen, möglicherweise müssen Sie jedoch z. B. das Inhaltsverzeichnis oder das Stichwortverzeichnis mit den Bordmitteln des jeweiligen Programms neu anlegen.
Lizenz und Download
Der Preis für eine zeitlich unbefristete Lizenz der Formatvorlage beträgt einmalig € 29,90 plus Mehrwertsteuer (länderabhängig).
Verkauf durch digistore24.com.
Mit einer Lizenz dürfen beliebig viele Dokumente erstellt werden. Jeder Autor benötigt eine eigene Lizenz. Die genauen Lizenzbedingungen finden Sie hier.
Wichtiger Hinweis: Die in der Formatvorlage enthaltenen Beispieltexte (Sprache Englisch) sind lediglich Platzhalter. Beachten Sie zum Umgang mit den in der Formatvorlage enthaltenen Formaten die Dokumentation des Textverarbeitungsprogramms oder Redaktionssystems, mit dem Sie die Formatvorlage nutzen (z. B. Dokumentation zu Microsoft Word). Die Lizenz für die Nutzung der Formatvorlage umfasst keinen Support für die korrekte Verwendung Ihres Textverarbeitungsprogramms oder Redaktionssystems.
Siehe auch meine weiteren Arbeitshilfen zur Technischen Dokumentation.