Formatvorlage für Benutzerhandbücher und andere Technische Dokumentationen

Fertige Formatvorlage für Benutzerhandbücher und andere Technische Dokumentationen

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:

Viele Stunden vergehen oft bereits nur damit, herauszufinden, wie sich in Microsoft Word, OpenOffice, LibreOffice oder einer anderen Textverarbeitung bestimmte Dinge einstellen lassen. Noch mehr Zeit vergeht damit, die Einstellungen dann im Einzelnen auch vorzunehmen.
Es dauert dann nochmals viele Stunden, den Handbüchern bis in alle Details ein professionelles Aussehen zu verleihen. Einstellen – testen – verbessern – nochmals testen – nochmals verbessern …
Ein schickes Aussehen alleine reicht jedoch noch nicht: Benutzer müssen sich in den mit der Formatvorlage erstellten Handbüchern auch gut zurechtfinden: Bereits der erste Blick in das Dokument sollte ausreichend visuelle Orientierung bieten. Die Texte müssen in jeder Situation klar lesbar sein – auch unter widrigen Bedingungen und unter Zeitdruck.
Nicht zuletzt sollten auch Sie als Autor oder Autorin effizient mit Ihrer Formatvorlage arbeiten können. Auch Ihnen selbst hilft ein übersichtliches Layout beim Schreiben ungemein. Außerdem sparen Sie eine Menge Zeit, wenn die Formatvorlage das Automatisierungspotenzial Ihres Redaktionsprogramms voll ausschöpft – z. B. durch vorausschauende Einstellungen zum automatischen Seitenumbruch.

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 29,90 € kaufen und herunterladen.

Aufgeräumtes, klares Design erleichtert die Konzentration auf die Inhalte

Die Gestaltung der Formatvorlage für Benutzerhandbücher und andere Technische Dokumentationen ist bewusst schlicht gehalten. Leser eines Handbuchs möchten schnelle Antworten auf ihre Fragen, keinen störenden Schnickschnack.

Die Formatvorlage verwendet ausschließlich solche gestalterischen Elemente, die auch einen klaren praktischen Nutzen haben, und z. B. das Auge des Lesers an die richtigen Stellen führen.

Gestaltung unterstützt punktuelles Lesen und Querlesen

Sehen Sie den Tatsachen ins Auge: Nur in den seltensten Fällen werden Leser ein Benutzerhandbuch oder eine andere Technische Dokumentation vollständig von vorne bis hinten durchlesen.

Daher unterstützt die Gestaltung der Formatvorlage die Leser von vornherein beim schnellen Überfliegen und Querlesen eines Dokuments, um die benötigten Informationen gezielt zu finden. Ihre Kunden werden das zu schätzen wissen!

Aussehen der Formate erleichtert die Orientierung im Text

So ziemlich das Schlimmste, was Lesern eines Benutzerhandbuchs passieren kann, ist es, die Orientierung zu verlieren. Sie finden dann die benötigten Informationen nicht und fühlen sich verloren und alleingelassen. Da kann das Handbuch noch so gut geschrieben sein: Werden die enthaltenen Informationen nicht gefunden, sind sie wertlos!

Die Formatvorlage wurde so gestaltet, dass Leser die Struktur eines Dokuments stets auf einen Blick erfassen können: nicht nur im Inhaltsverzeichnis, sondern auch mitten im Text.

Ausgewogener Anteil an Weißraum

Leerer Platz auf einer Seite ist nicht notwendigerweise verschenkter Platz. Der richtige Anteil an sogenanntem „Weißraum“, platziert an den richtigen Stellen eines Handbuchs, kann das Augenmerk der Leser gezielt auf die relevanten Stellen lenken. Auch kann Weißraum dabei helfen, zusammengehörige Dinge visuell zu gruppieren.

Die Formatvorlage setzt Weißraum gezielt und mit Bedacht ein.

Richtig gewählte Fonts und Font-Größen

Sie haben kein Problem damit, einen in einer schmucken aber kleinen Schrift geschriebenen Text zu lesen? Schön für Sie! Viele Menschen tun sich damit allerdings schwer.

Die Formatvorlage für Benutzerhandbücher und andere Technische Dokumentationen verwendet klare Standardschriften, die deutlich und groß genug sind, sodass der Text mühelos lesbar ist. Gleichzeitig bleiben die Schriften klein genug, um dennoch genug Informationen auf einer Seite unterzubringen.

Optimale Zeilenlängen für gute Lesbarkeit

Stehen zu viele Buchstaben in einer Zeile eines Handbuchs, findet das menschliche Auge beim Zeilenwechsel nur schwer den Beginn der nächsten Zeile, ohne dabei zu verrutschen. Das ermüdet auf Dauer beim Lesen und behindert die Konzentration auf den Inhalt.

Die Formatvorlage verwendet eine ausgewogene Zeilenlänge, die das Lesen nicht unnötig erschwert.

Semantische Formate

Die Formatvorlage verwendet sogenannte semantische Formate. Dies bedeutet, dass die Formate nicht entsprechend ihres Aussehens benannt sind, sondern entsprechend des für ein Format vorgesehenen Verwendungszwecks: der Semantik.

Beispiel: Ein Format, mit dem Sie den Namen einer Schaltfläche auszeichnen, heißt nicht „Arial10ptBold“, sondern „Schaltfläche“. Wenn Sie z. B. eines Tages das Format in einem Benutzerhandbuch von „Arial 10 Punkt Fett“ ändern möchten in „Verdana 12 Punkt Blau Kursiv“, können Sie dies tun, ohne ein neues Format anlegen und überall neu zuweisen zu müssen. Sie aktualisieren lediglich das Aussehen des bestehenden Formats.

Durchdachte Namenskonventionen

Alle in der Formatvorlage für Benutzerhandbücher und andere Technische Dokumentationen definierten Absatzformate und Zeichenformate sind entsprechend eines durchdachten einheitlichen Schemas benannt. Insbesondere sind die Formate so benannt, dass verwandte Formate immer zusammenstehend aufgelistet werden, wenn Sie in Ihrem Textverarbeitungsprogramm ein Format aus dem Formatekatalog auswählen.

Den am häufigsten benötigten Formaten sind in der Formatvorlage Tastenkürzel zugewiesen. Die Tastenkürzel verwenden charakteristische Buchstaben aus den jeweiligen Formatnamen, sodass Sie sich die Tastenkürzel leicht merken können.

Automatisierte Zeilenumbrüche und Seitenumbrüche

Die Formatvorlage verwendet alle verfügbaren Layout-Automatismen. So können Sie sich vollständig auf das inhaltliche Schreiben Ihrer Benutzerhandbücher oder anderer Technischer Dokumentationen konzentrieren und brauchen sich nicht darum zu kümmern, manuell irgendwelche Zeilenumbrüche und Seitenumbrüche zu setzen.

Jedes Format besitzt die optimalen Einstellungen zur Steuerung, ob ein Seitenumbruch den Absatz unterbrechen darf, ob ein bestimmter Absatz immer oben auf einer neuen Seite stehen soll, ob ein bestimmter Absatz immer zusammen mit einem anderen Absatz auf derselben Seite stehen soll usw.

Für internationalen Vertrieb druckbar sowohl auf A4-Papier als auch auf Letter-Papier

Mit der Formatvorlage formatierte Benutzerhandbücher und andere Technische Dokumentationen lassen sich sowohl auf Papier im A4-Format ausdrucken als auch auf Papier im Letter-Format. Wenn Sie also beispielsweise Ihre Bedienungsanleitungen in elektronischer Form ausliefern (z. B. als PDF-Datei), brauchen Sie daher für verschiedene internationale Märkte nicht unterschiedliche Versionen Ihrer Dokumente vorzusehen.

Falls Sie eine von A4 oder Letter abweichende Papiergröße benötigen, können Sie die Formatvorlage jederzeit entsprechend anpassen.

Alle Einstellungen bei Bedarf individuell anpassbar

Die Formatvorlage enthält alle Elemente, die typischerweise in einer Technischen Dokumentation vorkommen. Sie können die Formatvorlage somit unmittelbar einsetzen.

Optional können Sie die Formatvorlage jederzeit anpassen, um Ihren Handbüchern ein unverkennbares Aussehen zu geben oder um das Design an die Corporate Identity Ihres Unternehmens anzupassen. Das Anpassen der bereits existierenden Formate erfordert im Normalfall nur Grundkenntnisse in Ihrem Redaktionsprogramm (z. B. Microsoft Word).

Einmalig 29,90 € statt viele Stunden mühevolle Kleinarbeit

Die Formatvorlage für Benutzerhandbücher andere Technische Dokumentationen kostet einmalig 29,90 Euro. Vergleichen Sie diese Kosten selbst mit der Zeit, die Sie benötigen würden, um eine vergleichbare Formatvorlage für Benutzerhandbücher von Grund auf selbst zu entwickeln …

Sie können mit der Lizenz beliebig viele Dokumente erstellen.

Lizenz und Download

Verwenden Sie die indoition Formatvorlage für Technische Dokumentation, statt viele Stunden mit dem Anlegen einer eigenen Formatvorlage zu verbringen. Um ein individuelles Design zu erzielen, lassen sich bei Bedarf alle Formate mit wenig Aufwand anpassen.

Sie können die indoition Formatvorlage für Technische Dokumentation hier für 29,90 € kaufen und herunterladen.

Tipps zum Erstellen eigener Formatvorlagen für Benutzerhandbücher

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.

Wer sind Ihre Leser?
Wo und unter welchen Bedingungen werden Ihre Leser Ihre Handbücher lesen?

Beispiele für Anforderungen, die sich aus der Zielgruppe ergeben:

Ältere Menschen benötigen eine größere Schriftgröße und mehr Abstand zwischen den Zeilen als jüngere Zielgruppen.
Techniker bevorzugen im Allgemeinen ein schlichteres Design als Endverbraucher.
Leser mit eher geringem Bildungsniveau benötigen eine klarere Führung als Hochschulabsolventen.

Beispiele für Anforderungen, die sich daraus ergeben, wo und wie die Zielgruppe Ihre Handbücher liest:

Leser in einer lauten Produktionshalle brauchen eine größere Schriftgröße und mehr Zeilenabstand als Leser in einem ruhigen Büro.
Leser in einem fahrenden Auto, Bus, Zug, Flugzeug oder Schiff brauchen eine größere Schriftgröße und mehr Zeilenabstand als Leser in einer erschütterungsfreien Umgebung.
Leser in direktem Sonnenlicht brauchen glanz- und spiegelfreie Seiten.
Leser in Räumen mit schlechter Beleuchtung brauchen einen starken Kontrast zwischen Papier und Text sowie zwischen verschiedenen Farbtönen.
Leser, die ein gedrucktes Handbuch mit sich führen müssen, brauchen möglicherweise ein Dokument in einem kleineren Seitenformat, das in ihre Tasche passt oder in ein speziell dafür vorgesehenes Fach am Produkt. Zum Beispiel sollte das Bordbuch eines Autos ins Handschuhfach passen.
Leser eines elektronischen Benutzerhandbuchs auf einem Mobilgerät brauchen ein platzsparendes Layout auf kleinem Raum.

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

Verwenden Sie nur einige wenige Farben. Verwenden Sie unterschiedliche Farben nur dann, wenn diese einen bestimmten Zweck erfüllen. Reservieren Sie optisch hervorstechende Farben für besonders wichtige Dinge.
Verwenden Sie nur wenige verschiedene Schriftarten und Schriftgrößen. Setzen Sie eine abweichende Schriftart oder Schriftgröße nur dann ein, wenn Sie damit einen klaren Zweck verfolgen. Reservieren Sie große und fette Schrift ausschließlich für besonders wichtige Informationen sowie für Überschriften.
Versuchen Sie, mit möglichst wenigen Formaten auszukommen.
Verwenden Sie dieselben Formate einheitlich im gesamten Handbuch.
Verwenden Sie dieselben Formate auch in allen anderen Dokumenten zum Produkt: Montageanleitungen, Installationsanleitungen, Bedienungsanleitungen, Benutzerhandbücher, Referenzhandbücher, Betriebshandbücher, Wartungsanleitungen usw.
Verwenden Sie beim Anordnen von Objekten immer dieselben Positionen. Richten Sie alle Objekte an einem einheitlichen Gestaltungsraster aus.

Vermeiden Sie Redundanz

Lassen Sie alles weg, was keinen wirklichen Nutzen besitzt: Buchstaben, Symbole, Linien, sonstige Objekte.

Objekte, die wichtige oder hilfreiche Informationen vermitteln, sind nicht überflüssig.
Objekte, die den Lesern dabei helfen, Informationen zu finden und zu verarbeiten, sind nicht überflüssig.
Objekte, die nur dazu da sind, leeren Platz zu füllen, sind überflüssig!

Beispiele:

Verzichten Sie auf Hintergrundbilder.
Verzichten Sie darauf, Ihr Logo auf jede Seite zu setzen. Es genügt auf der Titelseite.
Wiederholen Sie nicht auf jeder Seite den Namen des Autors.
Wiederholen Sie nicht auf jeder Seite den Hinweis zum Copyright.
Wiederholen Sie nicht auf jeder Seite Versionsnummer und Datum.
Wiederholen Sie nicht auf jeder Seite den Dokumenttitel.
Ein laufender Kolumnentitel mit der Überschrift des jeweils aktuellen Kapitels kann Lesern jedoch die Orientierung im Handbuch erleichtern und stellt damit einen wirklichen Mehrwert da.

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:

Der Formatname zeigt Ihnen, wann Sie das Format sinnvollerweise einsetzen.
Sie können das Erscheinungsbild des Formats jederzeit ohne negative Seiteneffekte ändern. Beispiel: Stellen Sie sich vor, Sie haben ein spezielles Format angelegt, das Sie immer dann verwenden, wenn der Name eines Bedienelements im Text vorkommt. Wenn Sie das Format zum Beispiel „Element“ genannt haben, können Sie später die Schrifteinstellungen jederzeit einfach ändern. Wenn Sie die Schriftart von Arial auf Verdana ändern möchten oder die Schriftgröße von 10pt auf 12pt, ist das kein Problem. Was wäre aber, wenn Sie Ihr Format “Arial-10pt-Fett” genannt hätten? Das würde jetzt nicht mehr viel Sinn ergeben …
Semantische Formate sind eine der Grundvoraussetzungen für strukturiertes Schreiben in XML und DITA. Wenn Sie semantische Formate verwenden, sind Ihre Bedienungsanleitungen automatisch darauf vorbereitet, falls Sie eines Tages einmal zu einer strukturierten Texterfassung und -verarbeitung übergehen möchten.

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:

Wählen Sie Namen, die Sie sich leicht merken können.
Wählen Sie die Namen so, dass verwandte Formate im Formatekatalog Ihres Autorenwerkzeugs zusammenstehend aufgelistet werden. Sie können dies erreichen, indem Sie die Namen verwandter Formate mit demselben Präfix beginnen.
Wählen Sie für Tastenkürzel solche Tasten, die Sie sich leicht merken können. Verwenden Sie dasselbe Schema einheitlich für alle Absatzformate und ein anderes Schema einheitlich für alle Zeichenformate. Zum Beispiel könnten Sie für alle Absatzformate verwenden Alt+Umschalttaste+Buchstabe und für alle Zeichenformate Strg+Umschalttaste+Buchstabe.

Vermeiden Sie beim Schreiben amateurhafte Formatierungstechniken

Verzichten Sie auf:

leere Absätze
wiederholte Leerzeichen
Tabulatoren
alle Arten individueller lokaler Formatierung

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.

Möchten Sie viel Zeit sparen und mit einer fertig vorkonfigurierten Formatvorlage starten?

Nutzen Sie die indoition Formatvorlage für Technische Dokumentation.