Egal, ob Sie eine Gebrauchsanleitung schreiben, eine Risikobeurteilung vornehmen oder einen Maschinenumbau dokumentieren: In der Technischen Redaktion gibt es eine Vielzahl von Programmen, die Ihnen Ihr Vorhaben erleichtern. Die Praxis zeigt aber oftmals: So speziell muss es gar nicht sein – Microsoft Word ist für die Technische Dokumentation bestens geeignet. Das Geheimnis des Erfolgs liegt nur darin, richtig damit umzugehen!
Warum Microsoft Word für die Technische Dokumentation?
Bei der Technischen Dokumentation geht es nicht nur um die Erfassung von Informationen. Ihr Ziel ist es, brauchbar zu sein. Und ein großer Teil davon besteht darin, sie strukturell logisch und leicht navigierbar zu machen. Bevor Sie sich überhaupt mit der Erstellung von Inhalten befassen, sollten Sie also darüber nachdenken, wie Sie diese Inhalte präsentieren wollen.
Mehr als 60 Prozent aller Technischen Dokumente werden mit MS Word erstellt.
MS Word ist ein Programm, das nahezu jeder kennt und beherrscht, das einfach ist und viele Möglichkeiten für eine gute Technische Dokumentation bietet. Bevor Sie sich allerdings motiviert in die Arbeit stürzen: Nehmen Sie einen tiefen Atemzug, sammeln Sie sich, sortieren Sie Ihre Ideen und lesen Sie unsere 7 goldenen Regeln für MS Word in der Technischen Dokumentation. Los geht’s!
MS Word: Technische Dokumentation mit System
1. Richten Sie Ihre Arbeitsumgebung ein
Bevor Sie starten, sollten Sie es sich bequem einrichten – nicht nur auf Ihrem Stuhl, sondern auch in Word. Für die Technische Dokumentation sollten Sie gleich zu Beginn einige Anpassungen an Ihrer Arbeitsumgebung festlegen, um Routinen zu entwickeln und strukturiert vorgehen zu können.
Lernen Sie die gängigsten Shortcuts (Tastenkombinationen) für wiederkehrende Befehle auswendig, zum Beispiel Speichern oder Formatvorlagen löschen. Sie können auch eigene Kurzbefehle festlegen, sinnvoll sind Kombinationen mit der ALT-Taste. So müssen Sie sich nicht jedes Mal umständlich durchs Menü klicken und sparen reichlich Zeit.
Aktivieren Sie Textbegrenzungen im Dokument, um zu sehen, wo sich der Seitenspiegel befindet, also wo Sie schreiben können. Das Auge arbeitet am Bildschirm ohnehin auf Hochtouren, da kann ein wenig visuelle Hilfe nicht schaden!
Auch Absatzmarken helfen bei der Orientierung im Dokument. Oft verzweifeln Word-User an Phänomenen wie ungewollten Seitenumbrüchen. Absatzmarken zeigen deutlich, wo sich Leerzeichen, Umbrüche und Absätze befinden und machen damit auch die kleinsten Fehler im Dokument deutlich.
Formatvorlagen helfen, Struktur ins Dokument zu bringen (siehe Punkt 2). Damit Sie sie jederzeit greifbar haben, sollten Sie sich am rechten Bildschirmrand platzieren. Dort werden sie übersichtlich als Liste dargestellt und ermöglichen einen schnellen Zugriff. Nutzen Sie die Formatvorlagen für Überschriften, die Ihnen Word zur Verfügung stellt. In Kombination mit dem Navigationsbereich können Sie ganz einfach im Dokument von Kapitel zu Kapitel springen. Außerdem lassen sich die einzelnen Abschnitte so problemlos per Drag-and-drop im Navigationsbereich verschieben.
2. Erstellen Sie Formatvorlagen
Wir haben es gerade schon angedeutet: Formatvorlagen in Word sind für die Technische Dokumentation eine feine Sache. Denn sie ermöglichen es, das Dokument sauber zu strukturieren. So können Sie etwa mit einem Mausklick im gesamten Dokument die Schriftart anpassen, ohne dass die sonstige Formatierung verloren geht.
Nutzen Sie niemals die Vorlage Standard direkt im Text. Sie dient als „Mutter“ der Formatvorlagen, die lediglich die Standardschriftart und -farbe festlegt. Erstellen Sie separate Formatvorlagen für die verschiedenen Inhaltselemente, etwa für den normalen Fließtext. Dort können Sie nach Lust und Laune mit Abständen zwischen den Absätzen experimentieren, ohne das gesamte Layout zu zerschießen.
Arbeiten Sie hierarchisch und benennen Sie die Formatvorlagen nachvollziehbar. Ein Beispiel: Erstellen Sie Warnhinweise in der Dokumentation, die immer im gleichen Format angezeigt werden, dann gehen Sie am besten auch hier nach der SAFE-Methode vor. Benennen Sie die Formatvorlagen jeweils nach der Textart und machen Sie deutlich, wofür Sie diese verwenden.
Aufbau Warnhinweis (WH):
- WH1 Signalwort (basierend auf Standard)
- WH2 Art der Gefahr (basierend auf WH1)
- WH3 Folgen der Gefahr (basierend auf WH1)
- WH4 Entkommen (basierend auf WH1)
Haben Sie alle Formatierungen einmal in der Vorlage festgelegt, können Sie immer wieder darauf zurückgreifen, erleichtern sich die Arbeit und sorgen für die Einheitlichkeit im Dokument.
Denn – und das ist beim Thema Formatvorlagen eine der wichtigsten Regeln: Formatieren Sie niemals direkt im Dokument!
3. Legen Sie das Layout fest
Bevor Sie das Layout festlegen, sollte Sie sich die Frage stellen: Möchte ich mein Dokument drucken oder als PDF ausgeben? Denn je nach Verwendung entscheidet sich, wie Sie den Seitenspiegel des Dokuments anlegen.
Beginnen Sie jedes neue Kapitel der Übersichtlichkeit halber auf einer ungeraden Seite und arbeiten Sie mit „lebenden Kolumnentiteln“. Dabei handelt es sich um eine Seiten- oder Kapitelzahl mit beigefügtem Text, der auf den nachfolgenden Seiten seinen Inhalt ändern kann. Der große Vorteil darin? Er schenkt dem Leser schnelle Orientierung, wenn er ein bestimmtes Thema sucht.
Möchten Sie komplizierte Strukturen im Word Ihrer Technischen Dokumentation unterbringen, dann arbeiten Sie am besten mit Tabellen, in denen Sie etwa Warnhinweise oder Grafiken übersichtlich einbinden können.
4. Automatisieren Sie Ihr Inhaltsverzeichnis
Möglicherweise haben Sie diese nervenaufreibende Erfahrung bereits gemacht: Eigentlich sind Sie fertig mit Ihrer Dokumentation – das Word-Dokument steht. Doch dann müssen Sie noch eine winzige Kleinigkeit anpassen. Fatal! Denn plötzlich verschieben sich alle Seitenzahlen und die Nummerierung im Inhaltsverzeichnis ist wieder im Eimer. Das geht viel besser – und zwar mithilfe automatisierter Seitenzahlen und einer eigenen Formatvorlage für Überschriften. So weiß Word automatisch, wenn sich etwas ändert und passt es direkt an.
Für Überschriften gilt zudem: Gehen Sie maximal bis Überschrift 3, sonst wird der Inhalt zu kleinteilig. Und nutzen Sie immer erst dann untergeordnete Überschriften, wenn mindestens zwei gleichrangige Überschriften folgen.
5. Aktivieren Sie die Abschnittsfunktion
Abschnitte ermöglichen verschiedene Layouts, Fußzeilen und andere Elemente im Word der Technischen Dokumentation. Darüber können Sie einstellen, ob Sie Ihr Dokument im Hoch- oder Querformat anlegen möchten, einen Abschnitt auf der gleichen Seite, auf der nächsten Seite, auf der nächsten geraden oder ungeraden Seite beginnen möchten. Das spart nicht nur eine Menge Zeit, in der Sie immer und immer wieder durch das Dokument klicken und alle Abschnitte händisch prüfen müssten. Es hat auch den großen Vorteil, dass Sie nichts übersehen.
6. Fügen Sie Grafiken sauber ein
Über Grafiken und die Technische Illustration lassen sich eigene Abhandlungen schreiben. Für Word gilt: Stellen Sie Grafiken sinnvoll in den Textfluss ein. Um ein strukturiertes Layout zu gewährleisten, sollten sie nicht einfach vor den Text gesetzt werden. Denn stellen Sie sich nur vor, was passiert, wenn Sie noch eine kleine Änderung am Text vornehmen – genau, Ihr gesamtes Layout könnte sich verschieben.
Besser ist es, wenn Sie Tabellen für die Grafiken anlegen. Diese Felder haben den Vorteil, dass sie eindeutig festlegen, wo Grafik und Text stehen. Außerdem können sie nicht vom Text verschoben werden.
Für Rastergrafiken eignen sich in Word-Dokumenten das gif- oder png-Format und für Vektorgrafiken das emf-Format. Im Gegensatz zum alten wmf-Format kann das emf-Format auch Bézierkurven darstellen. Mit svg-Grafiken kann Word dagegen nicht ordentlich umgehen.
7. Benutzen Sie Schnellbausteine
Sie arbeiten mit häufig wiederkehrenden Modulen, zum Beispiel Tabellen für eine Grafik mit Beschreibung der Positionsnummern? Dann legen wir Ihnen AutoText ans Herz. Solche Schnellbausteine beschleunigen in Word die Technische Dokumentation um ein Vielfaches.
An alles gedacht – und was sagt der Anwender?
Haben Sie alle Punkte beachtet, dann macht Word die Technische Dokumentation zum Kinderspiel. Doch Sie ahnen es sicher: Auch das ist nur die halbe Miete. Denn die Technische Dokumentation kann noch so strukturiert sein – ob der Anwender die Inhalte auch versteht und richtig anwenden kann, steht wieder auf einem anderen Blatt. Eine User Journey hilft einzuschätzen, ob die Anwender tatsächlich mit der Technischen Dokumentation zurechtkommen und wo möglicherweise Verbesserungen oder Ergänzungen nötig sind.
Wir unterstützen Sie in MS Word
Manchmal erreicht man als Word-Anwender einen Punkt, an dem es einfach nicht weitergeht – wir kennen das zu gut. Das Layout macht nicht das, was es soll oder die schiere Menge an Bildern und Texten lähmt das Dokument und macht den Umgang damit unerträglich. Aber keine Sorge – in 99,9 % der Fälle haben wir dazu eine Lösung parat! Ganz egal, ob Sie Vorgänge in MS Word automatisieren wollen oder einfach nur schlankere Dokumente möchten.
Mit unseren Schulungen und IT-Dienstleistungen helfen wir weiter.
Erzählen Sie uns von Ihren Herausforderungen!
Bildquellen: Pixabay
