Die Basis für jede Dokumentation


Manualise entwickelt Ihre Templates

In einer Vorlage, einem sogenannten Template, wird die grafische Gestaltung festgelegt und kann so für unterschiedliche Inhalte immer wieder verwendet werden. Für die Druckausgabe beinhaltet dies z. B. Schriftarten, Absatzformate und das gemäß CI gestaltete Seitenlayout, für Online-Inhalte die Master Page (Musterseite) und das Skin. In einem Template kann auch das Inhaltsverzeichnis festgeschrieben werden, um eine Struktur mit grundlegenden Bestandteilen vorzugeben, die in jeder oder in vielen Dokumentationen enthalten sind. Wenn dann noch die Anforderungen der betreffenden Richtlinien berücksichtigt werden, ist bereits eine gute Grundlage für Ihre Dokumentation geschaffen.

FORDERN SIE DIREKT EIN ANGEBOT AN >

Stile

Das Template legt unter anderem Stile fest. Stil ist ein Oberbegriff für grafische Gestaltungsmerkmale von Schriften – Schriftarten (Fonts), Schriftgrößen etc. Bekannte Schriftarten sind z. B. Arial oder Times New Roman. Schriftarten zählen zur CI (Corporate Identity) eines Unternehmens. Bei den Schriftarten unterscheidet man Serifenschriften und Schriftarten ohne Serifen. Serifen sind kleine Endstriche quer zur Richtung des Buchstabenstrichs, die bei serifenlosen Schriften nicht vorhanden sind. Bei der Erstellung eines Templates werden die Schriftarten der CI übernommen oder entsprechend geeignete gewählt. Dabei sind einige Aspekte zu berücksichtigen:

  • Für gedruckte Texte wird meist eine Serifenschrift gewählt, da die Serifen die Buchstaben optisch verbinden und für eine „fließende“, lesefreundliche Optik sorgen.
  • Serifenlose Schriftarten dagegen werden oft für Online-Publikationen gewählt, da sie sich auf dem Bildschirm deutlicher darstellen lassen und so weniger ermüdend wirken.
  • Titel und Überschriften sollten immer serifenlos sein.

Auch die Größe der Schrift ist zu bedenken. Die Schrift muss mühelos lesbar sein, was nicht notwendigerweise bei jeder Zielgruppe dieselbe Größe bedeutet. Die EN IEC 82079-1 schreibt die Verwendung von mindestens Schriftgröße 10 vor. Manche der produktspezifischen Normen schreiben bei Warnungen in Anleitungen beispielsweise eine Schriftgröße von mindestens 4 mm Höhe vor.

Für jede Schriftart werden auch Varianten festgelegt, z. B. kursiv oder fett. Es werden Regeln definiert, wann welche Variante zu verwenden ist. Produktfunktionen kann man beispielsweise immer fett darstellen, wie z.B.: Drücken Sie die Taste Start.

Ebenfalls definiert werden Eigenschaften der Regeln, Zeilenabstand und Zeilenlänge, und die Absatzausrichtung (linksbündig oder Blocksatz).

Solche Formate können nicht nur für Schriften und Absätze festgelegt werden, sondern auch für Tabellen und Abbildungen.

shopify
Beispiel: Illustration in festgelegtem Stil.
H1.2_Manualise_Toon_assembly_exploded_view
Beispiel einer Illustration mit typischem Stil

Welche Eigenschaften lassen sich in einem Template festlegen?

  • Seitengröße

  • Seitenränder

  • Einteilung

  • Schriftstile

  • Tabellenstile

  • Illustrationsstile

  • Webskin

  • Inhaltsverzeichnis

  • Corporate-Design-Elemente

  • Rechtliche Vorgaben

Seiteneinteilung

Das Format der Anleitung ist ebenfalls zu definieren. DINA4 und A5 nutzt man oft für die Druckausgabe. Für große Abbildungen ist zwar DIN A4 besser, A5 ist jedoch handlicher und lesefreundlicher, was das Verhältnis von Wörtern pro Zeile angeht. Anschließend wird die Aufteilung der einzelnen Seiten festgelegt. Die Grundlage hierfür: Die Aufteilung soll möglichst auf jeder Seite gleich sein.

Oft ist die Seitenaufteilung für jedes Medium schon festgelegt, ebenso wie die Stile. Es bestehen dann bereits Vorgaben z. B. zur Größe der Broschüre oder Anleitung, zur Größe der Abbildungen, zur Positionierung von Bildern und Logos, zu Absatzformaten oder zur allgemeinen Struktur.

Eneco_instructie_brochures_A5-01

Software zur Erstellung von Templates

Zur Erstellung von Templates wird Desktop-Publishing-Software (DTP) verwendet. Man unterscheidet zwischen drei Programmtypen für die Festlegung des grafischen Designs und typografischer Eigenschaften.

  • Textverarbeitungsprogramme
  • Layout- und Satzprogramme
  • Content-Management-Software

Die herkömmlichen, bekannten Textbearbeitungsprogramme wie Microsoft Word bieten schon einige Möglichkeiten für die Gestaltung von Dokumenten. Diese Programme haben den Vorteil, dass sie weit verbreitet und leicht zu bedienen sind, und dass die Gestaltung während des Schreibens festgelegt oder angepasst werden kann. Die Möglichkeiten von speziellen Layout- und Satzprogrammen sind erheblich umfangreicher.

Die Gestaltungsmöglichkeiten solcher Programme, z. B. Adobe InDesign oder FrameMaker, sind nahezu unbegrenzt – sie eignen sich besonders gut für die Erstellung von Druckerzeugnissen hoher Qualität. Zudem erlauben sie den Import diverser Dateiformate, etwa XML, wodurch die Erstellung selbst mehrsprachiger Dokumente sich größtenteils automatisieren lässt.

Ähnlich wie Layout- und Satzprogramme, auch Content-Management-Software wie „MacCap Flare“ bieten immer mehr Möglichkeiten der Gestaltung. Damit könnenCSS-Stylesheets erstellt werden, und auch bei Schriftarten und abweichenden Seiteneinteilungen sind die Möglichkeiten nahezu grenzenlos.

Referenzen

Möchten Sie Templates als solide Grundlage für Ihre Dokumentation entwickeln lassen? Wir entwickeln Templates nach Ihren Wünschen und Vorgaben. Zu unseren Kunden zählen:

„Manualise hat für uns die Templates für den Quick Start Guide, die ausführliche Anleitung und die Online-Anleitung entwickelt, die als Grundlage für all unsere Dokumentation dienen.“

- Jan Voorbergen , AKAI Benelux -


Möchten Sie mehr über die Entwicklung von Templates für Ihre Dokumentation erfahren?

Fordern Sie hier ein Angebot an >

Haben Sie Fragen zu unseren Leistungen?

Rufen Sie uns an: + 49 3222 10320-01 Ruf mich an >