Wissen >> Styleguide

Styleguide

Inhalt eines Styleguides

In einem Styleguide (deutsch: Gestaltungsrichtlinie) ist festgelegt, wie die einzelnen Elemente der Technische Dokumentation zu gestalten sind. Es können z. B. Regeln für folgende Aspekte festgelegt werden:

Sprachliches:

  • einheitliche Bezeichnungen
  • Sprachstile
  • Formulierungen

Seitenformatierung:

  • Layout
  • Design
  • Verwendung von Farben
  • Schriftarten
  • Schriftgrad
  • Zeilenabstand

Vorgaben für Gestaltungselemente:

  • Tabellen
  • Abbildungen
  • Formeln

Zweck

Die Richtlinien in einem Styleguide dienen dazu, dass alle zusammengehörigen Dokumente ein einheitliches Erscheinungsbild und einen einheitlichen Aufbau haben. Der Vorteil ist ein höherer Wiedererkennungswert der verschiedenen Bestandteile der Technische Dokumentation, auch im Sinne einer unternehmensweiten Corporate Identity. Außerdem sollen die Produkte so als zusammengehörig wahrgenommen und ggf. auch mit der entsprechenden Marke assoziiert werden.

Neben diesen wirtschaftlichen Aspekten hat die einheitliche Gestaltung von Dokumenten speziell für die Technische Dokumentation den Vorteil, dass der Benutzer sich besser in Dokumenten zum beschriebenen Produkt orientieren kann. Wenn der Leser eines Handbuchs häufiger mit Produkten desselben Unternehmens zu tun hat und die zugehörige Dokumentation einheitlich gestaltet ist, sucht er bei einem neuen Produkt im besten Fall nicht lange nach der gewünschten Information, weil er bereits mit dem Aufbau der Dokumentation vertraut ist.

Styleguide = Redaktionsleitfaden?

Zwischen Styleguide und Redaktionsleitfaden gibt es inhaltliche Schnittmengen, sie sind jedoch nicht identisch. Im Gegensatz zum Redaktionsleitfaden enthält ein Styleguide ausschließlich Vorgaben zur graphischen Gestaltung von Dokumenten und keine Informationen zu Zielgruppe, projektbezogenen Prozessen etc. Daher kann der Styleguide Bestandteil des Redaktionsleitfaden sein oder als separates Dokument vorliegen.