Designing templates and formatting documents

Ästhetik ist nicht das Einzige, was Sie beim Erstellen einer Formatvorlage anstreben sollten. In Technischer Dokumentation, wie Benutzerhandbüchern und Online-Hilfen, sind „Usability“, Lesbarkeit und Einfachheit mindestens ebenso wichtig. Das Design soll das Auge des Betrachters erfreuen, gleichzeitig muss es die Inhalte klar und übersichtlich kommunizieren. Absatzformate und Zeichenformate sollten beim Schreiben des Dokuments einfach zu handhaben sein. Der Layout-Prozess sollte so weit wie möglich automatisiert werden. Da Technische Dokumentation in der Regel häufig aktualisiert wird, ist ein automatisierter Layout-Prozess hier wesentlich wichtiger als in anderen Buchtypen. Wenn Sie z. B. einen neuen Absatz in ein Dokument einfügen, darf dies nicht dazu führen, dass Sie alle nachfolgenden Seitenwechsel von Hand neu optimieren müssen – ganz zu schweigen von Seitenzahlen, Querverweisen, dem Inhaltsverzeichnis und dem Index. Absatzformate und Zeichenformate zu definieren, die beim Erstellen und Pflegen eines Dokuments effizient anwendbar sind, erfordert viel Erfahrung als Technischer Redakteur. Die in diesem Buch gegebenen Empfehlungen sind die Essenz dieser Erfahrung. Alle Kapitel enthalten zahlreiche Beispiele, die Sie als Inspiration und Ausgangspunkt für Ihre eigenen Designs nutzen können. Diese Ausgabe des Buchs ist zweisprachig: Englisch + Deutsch. Alle global relevanten Themen werden in englischer Sprache behandelt. Themen und Hinweise, die speziell die deutsche Sprache und Dokumente für den deutschen Sprachraum betreffen, sind in deutscher Sprache beschrieben. Inhalt: Grundlagen zum Layout Satzspiegel festlegen Schriftarten und Abstände wählen Manuelle Formatierungen vermeiden Semantische Formate vorsehen Formate hierarchisch organisieren Empfohlene Bildschirm-Layouts Empfohlene Seiten-Layouts Empfohlene Tabellen-Designs Empfohlene Absatzformate Empfohlene Zeichenformate