Sie suchen auf: {{ keyword }}

Wir unterstützen Unternehmen bei der Erstellung ihrer Dokumentation 

In einem Template, auch Vorlage, werden alle Entscheidungen zur grafischen Aufmachung erfasst. Für den Druck sind dies die Stile und das Seitenlayout. Für die Onlinenutzung ist dies die Musterseite (master page) und das Skin. Zudem kann in einem Template das Inhaltsverzeichnis festgelegt werden, und darin die festen oder häufigen Bestandteile der Dokumentation. Wenn auch Anforderungen aus Richtlinien berücksichtigt werden, ist dies eine gute Grundlage für all Ihre Dokumentation.

FORDERN SIE DIREKT EIN ANGEBOT AN

 


1

Stile

In einem Template werden unter anderem Stile festgelegt. Stile umfassen Schriftarten, Schriftgrößen usw. Eine Schriftart ist die grafische Gestaltung eines Zeichensatzes. Arial und Times sind beispielsweise häufig verwendete Schriftarten. Im Geschäftsverkehr sind die Schriftarten Teil der Corporate Identity, also des Erscheinungsbildes des Unternehmens. Es gibt Serifenschriften und serifenlose Schriftarten. Serifenschriften haben kleine Endstriche, umgangssprachlich auch Füßchen. Ist dies nicht der Fall, handelt es sich um serifenlose Schriftarten. Wenn die Schriftarten festgelegt wurden, können sie ins Template übernommen werden. Wenn sie noch nicht festgelegt wurden, wird eine Schriftart gewählt. Dabei werden einige Aspekte berücksichtigt:

  • Für Fließtext wird im allgemeinen eine ruhige Serifenschrift gewählt. Gelegentlich wird jedoch auch eine serifenlose Schrift gewählt.
  • Online-Schriftarten sind serifenlos, da sie besser lesbar sind.
  • Titel und Überschriften sind serifenlos.

Auch über die Schriftgrößen wird nachgedacht. Dabei muss eine lesbare Größe gewählt werden, was wiederum von der Zielgruppe der Anleitung abhängen kann. Die IEC/IEEE 82079-1:2019 schreibt die Verwendung von mindestens Schriftgröße 10 vor. Es bestehen auch produktspezifische Normen, die bei Warnungen in Anleitungen beispielsweise eine Schriftgröße von mindestens 4 mm Höhe vorschreiben.

Für jede Schriftart werden die Varianten festgelegt. Dies kann beispielsweise kursiv oder fett sein. Regeln werden definiert, wann welche Variante verwendet wird. Produktfunktionen können beispielsweise immer fett dargestellt werden. Etwa: Drücken Sie die Taste Start.

Eigenschaften der Regeln werden ebenfalls festgelegt. Zeilenabstand und Zeilenlänge werden definiert. Abschließend wird die Textausrichtung bestimmt (linksbündig oder Blocksatz).

Neben den Eigenschaften der Stile für Schrift und Zeile können auch Stile für Tabellen und Abbildungen festgelegt werden.


2

Seiteneinteilung

Das Format der Anleitung muss festgelegt werden. DIN A4 und A5 werden häufig für die Druckausgabe verwendet. Für große Abbildungen eignet sich DIN A4 besser. DIN A5 ist jedoch handlicher und schafft ein günstiges Verhältnis von Worten je Zeile. Anschließend wird die Seiteneinteilung bestimmt. Ein festes Schema ist dabei der Ausgangspunkt: Eine Einteilung, die bei jeder Seite gleich ist.

Bei den meisten Organisationen ist die Seiteneinteilung je Medium, ebenso wie die Stile, häufig schon festgelegt. Es wurden dann bereits Vorgaben gemacht, beispielsweise zur Größe einer Broschüre oder Anleitung, zur Größe der Abbildungen, zur Position des Logos, zum Aufbau usw.


3

Software für die Erstellung des Templates

Das Template wird mit Desktop-Publishing-Software (DTP) erstellt. Drei Hauptgruppen an Software gibt es für die Festlegung der grafischen Aufmachung und typografischer Eigenschaften.

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

Übliche Textbearbeitungsprogramme wie Microsoft Word bieten einige Möglichkeiten für die Gestaltung von Dokumenten. Ein Vorteil normaler Textverarbeitungsprogramme ist, dass nahezu jeder damit umgehen kann und dass die Aufmachung während des Schreibens des Contents gestaltet werden kann. Layout- und Satzprogramme bieten viele Möglichkeiten.

Auf dieser Seite sehen Sie, wie Sie eine Vorlage für Technische Dokumentation verwenden können, um Ihre eigene, rechtskonforme, benutzerfreundliche und ansprechende Betriebsanleitung zu erstellen.

Layout- und Satzprogramme wie Adobe InDesign eignen sich sehr für die Erstellung von Drucksachen hoher Qualität. Die Gestaltungsmöglichkeiten sind nahezu unbegrenzt. Zudem können diverse Dateiformate importiert werden, etwa XML, wodurch die (mehrsprachige) Erstellung größtenteils automatisiert werden kann.

Auch Content-Management-Software wie MadCap Flare bieten zunehmend Möglichkeiten, vergleichbar mit Layout- und Satzprogrammen, um die Gestaltung vorzunehmen. Vektordateien können verwendet werden, CSS-Stylesheets können erstellt werden und auch bei Schriftarten und abweichenden Seiteneinteilungen ist nahezu alles möglich.


4

Was können wir für Sie leisten?

Wir entwickeln für Sie die Vorlagen, die die Grundlage für all Ihre Dokumentation bilden. Wir definieren die Stile, Strukturen, Inhalte und Medien. Dabei werden rechtliche Anforderungen und wiederkehrender Content berücksichtigt. Die Templates können in nahezu allen Dateiformaten gespeichert werden. Je nach Prozess, der zu Ihnen passt, können Sie damit selbst arbeiten, können wir die Templates für die Entwicklung Ihrer Dokumentation verwenden oder arbeiten wir gemeinsam damit. Im Falle der Zusammenarbeit sind wir Ihre Rückendeckung, um Sie in stressigen Zeiten zu unterstützen. Wir beraten Sie diesbezüglich gerne.

FORDERN SIE DIREKT EIN ANGEBOT AN


Fordern Sie direkt ein Angebot an!

Fordern Sie ein Angebot an