Eine Formatvorlage (englisch Template) für ein Benutzerhandbuch oder für eine andere Technische Dokumentation von Grund auf selbst zu erstellen, kostet viel Zeit – meist mehr als gedacht:
Komplett vorkonfiguriert: indoition Formatvorlage für Technische Dokumentation
Der Einsatz einer vorkonfigurierten Formatvorlage für Technische Dokumentation spart Ihnen in Summe viele Stunden wertvoller Zeit und hilft Ihnen, strategische Fehler beim Anlegen der Formate von vornherein zu vermeiden.
Die indoition Formatvorlage für Technische Dokumentation ist eine solche vorkonfigurierte Formatvorlage zum Erstellen von Benutzerhandbüchern, Bedienungsanleitungen, IT-Dokumentationen und anderen Technischen Dokumentationen. Sie basiert auf über 30 Jahren Erfahrung in der Technischen Dokumentation und in der Entwicklung von Formatvorlagen.
Sie können die indoition Formatvorlage für Technische Dokumentation entweder sofort unverändert einsetzen, oder Sie können die bereits in der Formatvorlage definierten Formate und Einstellungen nach Belieben an Ihre unternehmensinternen Designvorgaben anpassen.
Die indoition Formatvorlage für Technische Dokumentation ist vollständig kompatibel mit Microsoft Word, OpenOffice und LibreOffice. In weiten Teilen funktioniert sie jedoch auch mit anderen Textverarbeitungsprogrammen und Autorensystemen, die Dateien der Formate .DOCX oder .ODT lesen können.
Sie können die indoition Formatvorlage für Technische Dokumentation hier für 19,90 € kaufen und herunterladen.
Beachten Sie Ihre Zielgruppe
Entwerfen Sie kein Design, wie es Designern gefallen würde. Entwerfen Sie ein Design, das zu den Bedürfnissen Ihrer Zielgruppe passt.
Beispiele für Anforderungen, die sich aus der Zielgruppe ergeben:
Beispiele für Anforderungen, die sich daraus ergeben, wo und wie die Zielgruppe Ihre Handbücher liest:
Halten Sie das Design einfach und übersichtlich
Weniger ist mehr. Halten Sie die Gestaltung der Formatvorlage für Ihre Bedienungsanleitungen so schlicht wie möglich. Lenken Sie die Leser nicht von den Inhalten ab. Erstellen Sie ein Design, das den Lesern dabei hilft, die im Handbuch gegebenen Informationen schnell zu finden und mit wenig Mühe aufzunehmen.
Vermeiden Sie überflüssige Vielfalt
Vermeiden Sie Redundanz
Lassen Sie alles weg, was keinen wirklichen Nutzen besitzt: Buchstaben, Symbole, Linien, sonstige Objekte.
Beispiele:
Tipp: Manchmal erfordern es die Designvorgaben eines Unternehmens, dass bestimmte Elemente zwangsweise auf jeder Seite erscheinen müssen, egal ob dies nun Sinn macht oder nicht. Falls Sie in einem solchen Fall keine Einflussmöglichkeiten auf eine Änderung dieser Vorgaben haben (Sie sollten es zumindest versuchen), halten Sie die betreffenden Elemente so unauffällig wie möglich: verkleinern Sie die Elemente, verzichten Sie auf Farben, machen Sie Text hellgrau statt schwarz, positionieren Sie die Elemente an einem möglichst wenig beachteten Ort, klar abgegrenzt vom wirklichen Inhalt.
Vermeiden Sie Überfrachtung
Überfrachten Sie die Seiten Ihrer Benutzerhandbücher und Bedienungsanleitungen nicht mit einem Zuviel an Informationen. Setzen Sie gezielt Weißraum ein, um die Aufmerksamkeit der Leser zu steuern, um zusammengehörige Dinge zu gruppieren und um an den richtigen Stellen für Lese- und Atempausen zu sorgen.
Sollte durch ein aufgeräumtes Layout Ihr Benutzerhandbuch ein wenig länger werden, ist das kein Problem. Wenn Sie nützliche Inhalte bieten, sind Leser auch dazu bereit, am Bildschirm zu scrollen oder eine Seite umzublättern. Sie sind jedoch nicht dazu bereit, Handbücher zu lesen, die sie überfordern.
Sehen Sie semantische, am Inhalt orientierte Formate vor
Verwenden Sie Formatnamen, die die Bedeutung eines Formats beschreiben und nicht dessen Aussehen. Benennen Sie ein Format zum Beispiel „Betonung“ und nicht „Fett-Rot“.
Semantische Formate haben wesentliche Vorteile:
Verwenden Sie eine durchdachte Namenskonvention
Um Ihre Handbuch-Formatvorlage möglichst anwendungsfreundlich für die Autoren zu machen, überlegen Sie sich ein effektives Benennungsschema für die Formatnamen:
Vermeiden Sie beim Schreiben amateurhafte Formatierungstechniken
Verzichten Sie auf:
Verwenden Sie ausschließlich die in Ihrer Formatvorlage definieren Formate!
Probleme mit leeren Absätzen
Verwenden Sie keine leeren Absätze, um den Abstand oberhalb oder unterhalb eines Absatzes zu vergrößern. Verwenden Sie stattdessen die dafür vorgesehenen Absatzeigenschaften.
Verwenden Sie leere Absätze außerdem nicht dazu, Seitenumbrüche zu erzeugen. Wenn Sie später einmal einzelne Zeilen zu Ihrem Benutzerhandbuch hinzufügen oder daraus löschen, rutscht sonst alles auf eine falsche Position. Verwenden Sie stattdessen immer manuelle Seitenumbrüche. Besser noch: Automatisieren Sie Seitenumbrüche nach Möglichkeit vollständig.
Alle Arten leerer Absätze führen zu Konflikten mit automatischen Seitenumbrüchen.
Probleme mit wiederholten Leerzeichen
Verwenden Sie keine Leerzeichen, um einen Text einzurücken. Definieren Sie stattdessen immer einen entsprechenden Einzug in den Absatzeigenschaften. Wenn Sie Leerzeichen zum Einrücken eines Absatzes verwenden, müssen Sie alle Folgezeilen manuell anpassen, sobald Sie etwas ändern.
In Online-Benutzerhandbüchern mit variabler Spaltenbreite funktionieren Einzüge mit Leerzeichen überhaupt nicht.
Die einzige Stelle, an der das Formatieren von Texten mit Leerzeichen in einem Benutzerhandbuch sinnvoll ist, sind Zitate von Programmcode. Wenn Sie über die Zwischenablage Programmcode in Ihr Handbuch einfügen, ist dieser typischerweise bereits mit Leerzeichen oder Tabulatoren eingerückt.
Probleme mit Tabulatoren
Vermeiden Sie das Verwenden der Tabulator-Taste. Tabulatoren können zu Problemen führen, wenn Sie ein Handbuch auch online verfügbar machen wollen, denn HTML kennt keine Tabulatoren. Tabulatorzeichen müssen dann in ein oder mehrere Leerzeichen oder in Einzüge umgewandelt werden, was nur selten sauber gelingt.
Anstelle von Tabulaturen verwenden Sie besser Absatzeinzüge oder eine Tabelle ohne Linien. Bedenken Sie: Selbst falls Sie heute noch keine Online-Version eines Benutzerhandbuchs bereitstellen möchten, sollten Sie sich diese Option für die Zukunft offenhalten.
Probleme mit lokaler Formatierung
Weisen Sie nicht manuell einzelnen Absätzen oder Zeichen Formateigenschaften zu. Verwenden Sie immer nur die in Ihrer Formatvorlage definierten Absatzformate und Zeichenformate. Wenn Sie ein Absatzformat für einen einzelnen Absatz manuell überschreiben, oder wenn Sie die Formatierung einzelner Zeichen manuell überschreiben, führt dies unweigerlich zu Problemen, wenn Sie später einmal das Design Ihres Benutzerhandbuchs ändern möchten. Dies mag Ihnen heute noch unwahrscheinlich erscheinen, passiert in der Praxis aber häufiger als gedacht.
Wenn Sie ausschließlich Formate der Formatvorlage verwendet haben und das Design ändern möchten, brauchen Sie lediglich in der Formatvorlage die Formatdefinitionen anzupassen und Ihr komplettes Handbuch erhält automatisch das neue Aussehen. Wenn Sie jedoch manuelle Formatierungen verwendet haben, müssen Sie diese alle einzeln von Hand anpassen. Bei mehreren Handbüchern, vielleicht sogar noch in mehreren Sprachen, kann das schnell viele Stunden zusätzlicher Arbeit bedeuten.