Freie Profis auf dem Mac – Open Source in der Technischen Dokumentation

1. Dezember 2011
von Mirko
Allgemein, Grafik, Redaktion

 

Logo Open Source

Open Source

Besonders kleine Entwickler- oder Redaktionsteams haben oft nicht das Geld für die großen kommerziellen Werkzeuge, die zur Erstellung von Handbüchern und Onlinehilfen benötigt werden. Hinzu kommt, dass gerade für Apple-Computer unter Mac OS X viele dieser Software gar nicht zur Verfügung steht. Da ist Software aus dem Open-Source-Umfeld, die oft plattformunabhängig zur Verfügung steht, meist die einzige Möglichkeit.

Spezialisierte Software für die Technische Dokumentation unter Mac OS X ist auch im Open-Source-Bereich nicht weit verbreitet. Für die wichtigsten Schritte finden sich aber brauchbare Lösungen, die auch ihre Tauglichkeit in der Praxis schon unter Beweis gestellt haben. Die Hauptschritte im Prozess der Technischen Dokumentation stellen dabei folgende 5 Schritte dar:

  • Planung und Recherche
  • Erstellung und Bearbeitung
  • Prüfung
  • Publikation
  • Verwaltung und Archivierung

Apple stellt verschiedene Werkzeuge, die den gesamten Redaktionsprozess begleiten, bereits von Haus aus zur Verfügung. Zumindest beim Webbrowser und auch beim E-Mail-Client stehen mit Firefox und Thunderbird aber mächtige Alternativen bereit. Den Virenschutz, gerade bei betriebssystemübergreifenden Projekten übernimmt dabei ClamXav.

Logo Firefox

Firefox

Logo Thunderbird

Thunderbird

Logo ClamXav

ClamXav

Planung und Recherche

Zu Beginn eines Projekts stehen Planung und Recherche. Um die einzelnen Meilensteine genau zu planen, den zeitlichen Ablauf festzulegen und den Überblick über den Projektfortschritt zu behalten, helfen die MS Project-Alternativen OpenProj und GanttProject. Zur Strukturierung der späteren Dokumentation aber auch zur Organisation des gesammelten Wissens ist FreeMind das Pendant zum weitverbreiteten MindManager, den es in der aktuellen Version auch für Mac OS X gibt. Für die Erstellung von Styleguides und die Pflege der Projektdokumentation bieten sich verschiedene Wikis an, wie DokuWiki oder TiddlyWiki, welches sogar ohne das bereits durch OS X zur Verfügung gestellte MAMP einsetzbar ist.

Logo OpenProj

OpenProj

Logo GanttProject

GanttProject

Logo FreeMind

FreeMind

Logo DokuWiki

DokuWiki

Logo TiddlyWiki

TiddlyWiki

Erstellung und Bearbeitung

Steht das Projekt und sind die benötigten Daten zusammengetragen, geht es an die Erstellung. Dabei müssen sowohl Texte als auch Bilder und Grafiken bearbeitet oder neu erstellt werden. Für das Schreiben der Texte ist der große MS Office-Konkurrent OpenOffice bzw. LibreOffice eines der geeignetsten Werkzeuge. Als Webeditor bietet sich hier powered by Mozilla BlueGriffon an. Soll es aber ein vollwertiges CMS sein, so lohnt ein Blick auf Daisy CMS. Vektorgrafiken ala Adobe Illustrator werden mit Inkscape erstellt und Adobe Photoshop kann größtenteils durch Gimp ersetzt werden. Für professionell gelayoutete Publikationen lässt sich auf Scribus zurückgreifen, welches in etwa mit Adobe Indesign vergleichbar ist.

Werbung

Übersetzungen der OpenOffice und HTML-Dateien sind dann eine Aufgabe des Translation-Memory-Tools OmegaT, welches besonders bei sich wiederholenden Übersetzungen seine Vorteile ausspielen kann.

Logo LibreOffice

LibreOffice

Logo BlueGriffon

BLueGriffon

Logo Daisy CMS

Daisy CMS

Logo Inkscape

Inkscape

Logo Gimp

Gimp

Logo Scribus

Scribus

Logo OmegaT

OmegaT

Prüfung

Ist die Dokumentation erstellt, folgt das Lektorat aus fachlicher und redaktioneller Sicht. So wäre es zur Prüfung z. B. möglich, die fertige Publikation als PDF per FTP-Tool Cyberduck für externe Teammitglieder auf einen beliebigen Webspace zu laden und mit Hilfe von Skim das PDF mit Kommentaren und Anmerkungen zu versehen.

Logo Cyberduck

Cyberduck

Logo Skim

Skim

Publikation

Soll die spätere Dokumentation nicht nur als PDF oder HTML veröffentlicht werden, so lassen sich mit Sigil die immer mehr an Bedeutung gewinnenden ePubs bearbeiten und erstellen. Das bereits genannte Daisy CMS hilft schließlich bei der Publikation verschiedener Onlineformate.

Logo Sigil

Sigil

Logo Daisy

Daisy

Verwaltung und Archivierung

Nicht erst am Ende des Redaktionsprozesses hilft svnX bei der Versionierung der einzelnen Dokumente, Grafiken und Publikationsstände. Fertige ePubs lassen sich z. B. komfortabel mit calibre verwalten.

Logo svnX

svnX

Logo calibre

calibre

Ist es auch per Open Source nicht möglich eine passende, unter Mac OS X laufende Software, zu finden, hilft vielleicht die Virtualisierungssoftware Virtualbox weiter, die den Einsatz von Windows-Software unter Mac OS X erlaubt.

Logo VirtualBox

VirtualBox

Die Aufzählung der einzelnen Werkzeuge zeigt, dass für die meisten Bedürfnisse in der Technischen Dokumentation auch unter Mac OS X Werkzeuge zur Verfügung stehen, um zum gewünschten Ergebnis zu kommen. Wichtig ist es, die einzelnen Tools und Formate auf seine eigenen Ansprüche anzupassen und den gesamten Workflow gut zu planen und aufeinander abzustimmen. So ist es auch mit einem kleinen Budget möglich professionell Technische Dokumentation unter Mac OS X zu erstellen und je nach persönlichem Interesse sogar auf die Entwicklung der Werkzeuge Einfluss zu nehmen bzw. diese zu unterstützen.

Buchempfehlungen

©  Foto „Open Source“ – http://opensource.org

Hinterlassen Sie einen Kommentar.

Werbung


Danke

Wenn Ihnen ein Artikel gefallen oder sogar geholfen hat, Zeit und Kosten zu sparen, dann sagen Sie Danke mit einer kleinen Spende.