Erstellung von Stylesheets und Formatvorlagen für Technische Dokumentation

Technische Dokumentation, wie Benutzerhandbücher oder Online-Hilfen (Onlinedokumentation), sollte aus mehreren Gründen professionell gestaltet sein:

• Sie ist eine Visitenkarte Ihres Unternehmens. Damit trägt sie wesentlich zu einem guten Gesamtbild bei.
• Eine ansprechend gestaltete Technische Dokumentation motiviert zum Lesen – zumindest ein bisschen.
• Besonders wichtig ist jedoch: Eine gut gestaltete Technische Dokumentation erleichtert das Lesen. Sie macht es einfach, Informationen im Text zu finden, bietet den Lesern Orientierung und lenkt das Auge auf das Wesentliche.

Übrigens: Für die Autoren ist eine gut gestaltete Formatvorlage gleichermaßen hilfreich!

Ich entwerfe und erstelle Stylesheets und Formatvorlagen (Englisch „Templates“) für Handbücher, Online-Hilfen und andere Formen Technischer Dokumentation. Dabei achte ich darauf, dass die Stylesheets und Formatvorlagen nicht nur schick aussehen, sondern auch effizient zu benutzen sind und die Informationen in gut lesbarer Form präsentieren.

Ihr Bedarf

Benötigen Sie ein professionell gestaltetes Stylesheet oder eine Formatvorlage für Ihre Technische Dokumentation oder Softwaredokumentation?

Legen Sie dabei Wert auf eine gute Usability und User Experience für Ihre Kunden, aber auch für die Autoren der Technischen Dokumentation?

Meine Dienstleistungen

Ich erstelle für Sie individuelle Formatvorlagen und Stylesheets, die mehr leisten als nur gut auszusehen und die dargestellten Informationen benutzerfreundlich und übersichtlich zu präsentieren.

Eine gute Formatvorlage ist auch für die Autoren einer Dokumentation benutzerfreundlich und effizient in der Anwendung und kann damit erheblich Zeit und damit Geld sparen. Die Einsparung multipliziert sich mit jedem neuen Dokument und mit jeder Überarbeitung eines Dokuments, das auf der Formatvorlage basiert.

Während Sie das visuelle Design einer Formatvorlage auch von einem Grafiker erstellen lassen können, erfordert die Definition der einzelnen Absatzformate und Zeichenformate im Detail viel redaktionelle Praxiserfahrung und Weitblick für die Anforderungen in einer Technischen Dokumentation.

Wie sollte eine Formatvorlage für Technische Dokumentation gestaltet sein?

• Beschränkung auf das Wesentliche: Sowohl für den Leser als auch für den Autor ist ein ruhiges und einheitliches Schriftbild wichtig, um sich voll auf die Inhalte konzentrieren zu können. Hier gilt die Regel: Weniger ist mehr. Eine überschaubare Anzahl gut durchdachter Formate ist wesentlich effizienter als eine Sammlung dutzender Spezialformate für jeden erdenklichen Sonderfall.
• Semantische Formate: Alle Formate werden grundsätzlich nicht entsprechend ihrem optischen Erscheinungsbild benannt, sondern entsprechend der Bedeutung dessen, was sie auszeichnen (sogenannte semantische Formate). Ein Format heißt also zum Beispiel nicht „ArialFett10Punkt“, sondern „Hervorhebung“ oder „Menüpunkt“.
  Dies zwingt den Autor zu einem durchdachten und einheitlichen Aufbau der Dokumentation und ist außerdem die Grundlage für jede strukturierte Dokumentationserstellung, z. B. mit XML DITA. Auch wenn Sie heute Ihre Dokumente noch nicht nach einer solchen Methode strukturieren, schaffen Sie durch semantische Formate bereits die Grundlage.
  Für die Änderungsfreundlichkeit Ihrer Dokumentation sind semantische Formate ebenfalls unerlässlich.
• Einfache Änderbarkeit: Alle Formate sind hierarchisch organisiert. Abgeleitete Formate erben gemeinsame Eigenschaften von übergeordneten Formaten. So können Sie z. B. nachträglich die Schriftart für alle Formate eines Dokuments zentral mit nur einem Befehl ändern, indem Sie einfach die Formateigenschaft des obersten Wurzelelements anpassen.
• Leichte Zuweisung: Alle Formate sind so benannt, dass zusammengehörige Formate (z. B. alle Listenformate) im Formatkatalog Ihres Redaktionssystems direkt untereinander stehen.
• Einprägsame Tastenkürzel: Häufig benötigte Formate können effizient über Tastenkürzel zugewiesen werden. Ein durchdachtes System stellt dabei sicher, dass Sie sich diese Tastenkürzel auch merken können.
• Automatisierte Formatierung: Durch eine geschickte Definition bestimmter Formateigenschaften lässt sich viel manueller Formatierungsaufwand vermeiden. Beispielsweise lässt sich hervorragend steuern, an welchen Stellen automatisch ein Seitenumbruch erfolgt, und wo nicht.