Layout von technischer Dokumentation
Layout mit MS Word® o.ä.
Mit Schreibprogrammen wie MS Word® und DTP-Programmen wie Adobe InDesign® können Sie die Gestaltung von Informationsprodukten entweder direkt (= Direktformatierung) oder über Formatvorlagen steuern. Als Technischer Redakteur haben Sie direkten Zugriff auf alle Gestaltungsmöglichkeiten. Das stellt einerseits eine große Flexibilität dar, birgt andererseits aber mindestens folgende Risiken:
- Wenn Technische Redakteure "mal eben" ein Layout ändern können, ist das Risiko größer, dass Inkonsistenzen entstehen.
- Formatvorlagen können "kaputt" gehen. Die Inhalte sind dann manchmal nicht mehr vernünftig zu gestalten, Nummerierungen stimmen nicht mehr usw. Das kann z. B. beim Kopieren & Einfügen von Inhalten geschehen.
- Oft ist es mit Mehraufwand verbunden, Layouts gerade in sehr umfangreichen Informationsprodukten über alle Seiten hinweg absolut konsistent zu haben.
Außerdem sind Sie je nach Software an die relativ geringen Layout-Möglichkeiten gebunden.
Layout mit dem Redaktionssystem DoX CMS
Mit DoX CMS sind Sie vor diesen Fallstricken geschützt:
- Als Admin können Sie je Benutzergruppe festlegen, ob ein Bearbeiten der Layouts erlaubt ist.
- Sollte einer Ihrer Technischen Redakteure einmal eine Layoutänderung benötigen, ihm jedoch die nötige Berechtigung fehlen, muss er dies im Team abstimmen und von einem Berechtigten erledigen lassen. Das ist für den Moment zwar ein Umweg, doch dafür bleiben die Layouts konsistent.
- Auf die Layoutvorlagen von DoX CMS können Sie sich verlassen. Auch komplexe Layouts werden zuverlässig generiert.
Darüber hinaus können Sie mit DoX CMS auch bedingte Formatierungen erstellen. So können Inhalte beispielweise in Abhängigkeit von bestimmten Gültigkeiten oder Metadaten unterschiedlich formatiert werden.
Abbildungen
-
Abb. 1: Styles in DoX CMS dienen der Definition von Seiten -
Abb. 2: Themes in DoX CMS dienen der Definition von Formatierungen (Schriftgrößen, Farben, Einzüge uvm.). Themes werden in Styles referenziert. -
Abb. 3: Bei der Publikation eines Informationsproduktes wird ein Style ausgewählt (unten rechts im Bild).
Vorteile von DoX CMS bei der Gestaltung von Informationsprodukten
- Sie erstellen im Redaktionssystem DoX CMS ein oder mehrere Styles und Themes und wählen diese bei der Publikation ganz einfach aus.
- Auf das Layout können Sie sich verlassen. Sie haben direkt fertige PDF-Dokumente, Onlinehilfen usw. - ohne Nacharbeit.
- Die Layouts Ihrer Informationsprodukte werden automatisch konsistent.
- Sie als Technische Redakteurin oder Technischer Redakteur brauchen sich bei der Erstellung der Inhalte nicht (oder nur geringfügig, je nach Arbeitsweise) um die Gestaltung zu kümmern. Wichtig ist, dass Sie die Inhalte korrekt auszeichnen.
- Sie können DoX CMS so einrichten, dass Sie als Technischer Redakteur in Sonderfällen doch Einfluss auf das Layout einzelner Inhaltselemente haben.
- Sie können Formatierungen an beliebige Bedingungen knüpfen und so dynamisch machen. Beispiel: Unterschiedliche Schriftarten oder Farben je nach Kunde oder Produktreihe.
- Das Erstellen von Styles und Themes können Sie auf Wunsch von uns erledigen lassen. Sie brauchen sich dann nicht in dieses recht technische Thema einzuarbeiten.
Danke für Ihr Interesse an DoX CMS.
Was sind Ihre Bedürfnisse für Ihre technische Dokumentation?
Sehr gern überlegen wir in einem Gespräch mit Ihnen, ob und wie DoX CMS Sie bei der Erstellung von Gebrauchsanleitungen, Software-Dokumentation und anderen Informationsprodukten unterstützen kann.