Software für Bedienungsanleitungen

Bedienungsanleitungen gehören zu den klassischen Publikationen von produzierenden Unternehmen. Gerade für sehr kleine Unternehmen bietet sich dafür die Open Source Software Typemill an. Typemill ist kostenfrei, schlank, Autoren-freundlich und kann Inhalte gleichzeitig als Webseite und als PDF-Publikation ausgeben. Dabei können beliebig viele Bedienungsanleitungen für unterschiedliche Produkte aus einer Instanz erzeugt werden. Auch mehrsprachige Bedienungsanleitungen mit einem Daumenregister sind mit Typemill möglich. Beispiele dafür finden Sie auf unserer Demo-Installation.

Was ist Typemill?

Typemill ist ein schlankes und modernes Open Source CMS, das sich auf informationslastige Inhalte wie Dokumentationen, Manuals, Handbücher, Bedienungsanleitungen und ähnliche Publikationen spezialisiert hat. Typemill gehört zu den Flat File Systemen und speichert alle Inhalte als Markdown-Dateien ab. Damit bleiben die Inhalte transportabel und unabhängig.

Animated gif demonstrates the visual editor

Typemill hat sich außerdem zum Ziel gesetzt, eine erstklassige Author-Experience zu bieten. Gerade Dokumentationen, Bedienungsanleitungen und Handbücher gehören in Unternehmen zu den lästigen Pflichten, sodass ein autorenfreundliches System die Motivation und damit oft auch die Qualität eines Publikationsprojekts deutlich erhöht. Aus diesem Grund setzen inzwischen zahlreiche Unternehmen und Organisationen auf Typemill, um beispielsweise IT-Dokumentationen, kleine Wikis, Knowlegde Bases oder Handbücher und Anleitungen zu erstellen.

PDF-Publikationen mit Typemill

Typemill kann mit Hilfe eines eBook-Plugins erweitert werden, sodass sich aus einer Webseite beliebig viele PDF-Publikationen erstellen lassen. Das Plugin bietet zahlreiche Einstellungsmöglichkeiten an, sodass jedes eBook individualisiert werden kann.

Vorschau eBook Plugin Typemill

Im Unternehmensumfeld werden so gut wie immer eigene Layouts notwendig, die dem Corporate Design des Unternehmens entspricht. Typemill bietet die Möglichkeit, für eBooks ähnlich wie für Webseiten eigene Themes und Layouts zu erstellen. In die Layouts können auch Features wie ein Daumenregister oder Druckmarken und ähnliches integriert werden.

Typische Gliederung einer Bedienungsanleitung

Üblicherweise bietet ein Unternehmen ein Sortiment mit mehreren Produkten an. Wenn alle Bedienungsanleitungen über Typemill erstellt werden sollen, dann kann man die Produkte jeweils als Haupt-Ordner anlegen und die verschiedenen Sprachen jeweils als Unterseite:

- Produkt A  
  - english  
  - deutsch  
  - français   
  - italiano
- Produkt B  
  - english  
  - deutsch  
  - français   
  - italiano

Mit einer solchen Gliederung können recht einfach mehrsprachige Bedienungsanleitungen für unterschiedliche Produkte als eBook generiert werden.

Übersetzungsprozess

Bei mehrsprachigen Bedienungsanleitungen gibt es in der Regel eine Hauptsprache, die als Übersetzungs-Grundlage dient. Daher würde man immer erst die Hauptsprache bearbeiten und nach dessen Fertigstellung die Übersetzer informieren.

Da Typemill ein Flat-File-System ist, müssen die Übersetzer nicht zwangsläufig einen Zugriff auf das System erhalten. Genausogut können die Übersetzer den Text als Markdown-Datei erhalten mit der Bitte, die übersetzte Version als Markdown-Datei zurückzusenden. Die Datei kann dann in den Content-Folder von Typemill einsortiert und über die Autorenoberfläche weiterbearbeitet werden.

Versionierung

Wird die Bedienungsanleitung überarbeitet, dann wird zunächst erneut die Hauptsprache bearbeitet und anschließend übersetzt. Dafür gibt es verschiedene Ansätze:

Auch wenn eine Archivierung von Inhalten notwendig sein sollte, können entsprechende Plugins auf Anfrage entwickelt werden. Sprechen Sie uns einfach an, um ein unverbindliches Angebot zu erhalten.