// du liest...

Open Source

Der gesamte Redaktionsprozess mit OpenSource

Wer kennt es nicht, plötzlich liegen Investitionen in benötigte Software für die Technische Redaktion nicht mehr drin. Was aber, wenn ich trotzdem etwas Besseres benötige, als Windows oder Wordpad bieten können? Dafür braucht und – gute Nachricht – gibt es qualitativ gute Tools, die mich unterstützen, Standards einhalten und von einer grossen Gemeinschaft gepflegt und weiterentwickelt werden. Ich werde anhand eines Arbeitsablaufes in der Technischen Dokumentation zeigen, wie man mit solchen Tools doch zu einem brauchbaren Resultat kommt.

Der Redaktionsprozess lässt sich in fünf Stufen aufteilen. Es handelt sich dabei um Planen, Entwickeln, Prüfen, Produzieren und Archivieren. Ich werden mich durch diese Stufen durchhangeln und zeigen wie man mit kostenlosen Tools seine Arbeit gut erledigen kann. Die folgenden Tools sind alle für das Windows Betriebssystem vorhanden und es gibt für jede vorgeschlagene Software unzählige Alternativen auf dem Internet. Die Schwierigkeit liegt aber darin, die guten von den schlechten Tools zu unterscheiden. Wobei man es nicht so schwarz/weiss anschauen darf, sondern eher von geeigneten und ungeeigneten Tools sprechen muss. Die hier vorgeschlagenen Programme kenne ich persönlich und kann diese deshalb auch mit gutem Gewissen weiterempfehlen.

Im Workshop werde ich einen gesamten Workflow vorführen und zeigen, wie die Tools am besten zusammenarbeiten. Standardisierte Datenformate und Regeln sind aber genau so wichtig.

Planen

Bevor wir im Prozess ganz vorne anfangen, muss ich mal bei den Standardwerkzeugen aufrüsten. Dazu gehören Virenscanner FreeAV, ich will ja dem Kunden keine Viren schicken, ein gutes Komprimierungsprogramm 7-zip, einen brauchbaren E-Mail-Client Thunderbird und einen mächtigen Texteditor Notepad++. Damit man die Termine im Griff hat, verwendet man am Besten eine Projektverwaltung, die auch mit Kundendateien im Format Microsoft Project zurecht kommt. Um das eigentliche Brainstorming zu strukturieren, verwende ich die Technik von Mindmaps mit FreeMind. Und zur Krönung möchte ich gerne für jeden Kunden einen Redaktionsleitfaden erstellen. Dies geschieht auf der Basis eines Wikis mit TiddlyWiki, welches mit einer Datei zurecht kommt und ohne Webserver oder Datenbank betrieben werden kann. Welche Plugins mit TiddlyWiki funktionieren, findet man hier: http://doc-x.org/nutzliche-plugins-tiddlywiki/2010/05/.

Hilfreich ist es auch eine virtuelle Maschine wie VMware Player zur Verfügung zu haben. So kann man kunden-/ auftragsspezifische Installationen ohne Probleme durchführen, aber auch einige der nachstehend genannten Tools sind als virtuelle Maschine verfügbar und können ohne Probleme auf Ihrem PC betrieben werden.

Entwickeln

Bei der Entwickeln, respektive Erstellen eines Dokumentes muss ich zuerst unzählige Medien erstellen. Für Screenshots verwende ich FastStone Capture und für Screencasts die Software CamStudio. Die Screencasts und sonstige Filme können dann mit Avidemux zusammengeschnitten werden.

Diagramme werden mit Dia erstellt, Bilder mit Gimp bearbeitet und Vektorgrafiken mit Inkscape gezeichnet.

Natürlich kann ich all diese Mediendateien im Dateisystem ablegen oder strukturiert mit ResourceSpace verwalten, diese dann im Intranet allen Kollegen zur Verfügung stellen und automatisch verschiedene Ausgangsformate erstellen lassen.

Für die eigentliche Dokumentenerstellung empfehle ich folgende Tools: OpenOffice, welches sehr an Word 2003 erinnert und auch ein eigenes Zeichnungstool hat. Erwähnenswert ist auch, dass man aus OpenOffice PDF exportieren kann. Wenn aber auch noch Online-Hilfen zum gedruckten Dokument erstellt werden müssen, empfiehlt sich dafür DaisyCMS. Hier darf ich auf meinen Workshop OTS8 hinweisen. Für Datenblätter, Kataloge, DVD-Hüllen oder Broschüren verwende ich Scribus.

Ach ja, und wenn ich die neue Software dokumentiere und trotzdem noch einige Fehler darin feststelle, dann erfasse ich diese im Bugtracker Mantis.

Prüfen

Der gesamte Prüfprozess der Dokumente geht über das PDF-Format. Alle Dokumente werden als PDF erstellt und dann korrigiert. Falls benötigt, ist Solid PDF Creator ein gutes Tools zum Erstellen von PDFs im Format PDF/A. Das Bereitstellen der Dateien erfolgt über Dropbox, wo man kostenlos bis zu 2GB hochladen kann. Das eigentliche Korrekturlesen wird dann im PDF XChange Viewer durchgeführt. Der XChange Viewer kann Notizen hinzufügen und Text markieren; also genug für die Korrekturlesung.

Produzieren

Beim Produzieren geht es entweder um das Drucken (Sorry, da kann ich nichts kostenloses liefern), das elektronische Publizieren oder die Übersetzung. Für die elektronische Publikation verwende ich entweder den Export von DaisyCMS als HTML oder ich wandle PDFs mit MegaZine3 in eBooks um.

Falls ich zu den Redakteuren gehöre, die nebst der Deutschen Originalanleitung auch noch die Übersetzung erstellen muss, dann verwende ich OmegaT dafür. Ein Übersetzungstool mit Translation Memory, Terminologieanzeige und Anbindung an Google Translate.

Archivieren

Irgendwann sind die Dokumente fertig und müssen revisionssicher abgelegt werden. Aus genau diesem Grund ist das einfache Ablegen auf dem Server oder das Brennen einer CD nicht die Lösung. Agorum ist ein enterprise-fähiges DMS, das sogar bestehende Dateisysteme indiziert und im Client darstellt.

Zum Workshop

Die Tools sind die eine Sache. Wie alles optimal zusammenwirkt eine Andere. Genau dies wird am Workshop gezeigt. Die vorgestellte kostenlose Software ist aus meiner persönlichen Sicht die Beste auf dem Markt. Natürlich kann ich nicht auf der ganzen Linie erwarten, dass die Leistung der kommerziellen Vorbilder erreicht wird. In den meisten Fällen sind die vorhandenen Funktionen aber viel mehr, als dass wir in der Technischen Dokumentation je benötigen werden.

Präsentation von der Tekom Jahrestagung

Für all diejenigen, die nicht an der Tagung teilnehmen könnten, hier noch die Präsentation mit den jeweiligen Links zu den vorgestellten Tools

Diskussion

4 Kommentare für “Der gesamte Redaktionsprozess mit OpenSource”

  1. “Diest ist mein Beitrag zum Tagungsband für die Tekom Jahrestagung vom 3.-5. November 2011″

    Hallo,
    ist wirklich das Jahr 2011 gemeint?

    Posted by ingmar | September 24, 2010, 07:53
  2. Danke sehr für die Übersicht. Winzige Anmerkung: Der Titel der Präsentation passt eigentlich nicht so ganz. Nicht alle Ihrer vorgestellten Anwendungen sind Open-Source-Software …

    Trotzdem danke noch mal.

    Posted by Frank U. | März 28, 2011, 15:29
  3. […] hier), muss man konstantieren, dass das hochgelobte Open-Source Dokumentationswiki (gelobt etwa bei http://www.doc-x.org ) unter Ubuntu einfach NICHT, aber auch GAR NICHT […]

    Posted by DaisyCMS – nix in Linux? « tecdoc0711 | November 15, 2011, 09:40

Einen Kommentar erstellen

 

November 2010
M D M D F S S
« Okt   Dez »
1234567
891011121314
15161718192021
22232425262728
2930  

Geplante Artikel