Dokumentationsmanagement

Dokumentation ist integraler Bestandteil eines jeden Projekts – oder sollte es sein, denn im Entwicklungsalltag gerät diese wichtige Aufgabe allzu leicht aus dem Blick. Ein häufiger Grund dafür sind Brüche in der Tool Chain und folglich in der Kommunikation: Autoren oder Redakteure sind oft nicht Teil des Entwicklerteams und nutzen in der Regel andere Werkzeuge, was den Austausch erschwert und die Zusammenarbeit behindert.

Dieser Kurs rückt den Bereich Dokumentation und Übersetzung näher an den Entwicklungsprozess. Mit ausgewählten Open-Source-Werkzeugen bauen die Teilnehmer eine Umgebung auf, die sämtliche Rollen und Stationen des Dokumentationsprozesses abbildet und zu einem effizienten System verbindet. Er ist damit aber auch ein idealer Einstieg für all jene, die Dokumentensammlungen unabhängig von z.B. Softwareprojekten erstellen und pflegen müssen und dafür eine ebenso verlässliche wie effiziente Infrastruktur suchen – Verlagsmitarbeiter, Redakteure, Übersetzer u.a.

Vom flachen Textformat (Markdown, AsciiDoc), der Verwaltung von Akteuren und deren Rollen (GitLab) über die verteilte, versionierte Textablage (Git) bis zur Übersetzung in beliebig viele Sprachen (OmegaT) zeigt der Kurs konkrete, praktische Lösungen. Aber: Die hier gewählte Software dient lediglich der Veranschaulichung von Konzepten und Technologien; mit den in diesem Kurs erworbenen Kenntnissen werden die Teilnehmer in der Lage sein, bei Bedarf analoge Lösungen auszuwählen und zu implementieren.

Der Kurs richtet sich an Autoren, Redakteure und Projektmanager ohne technische Vorkenntnisse – also all jene, die größere Textsammlungen kollaborativ erstellen, verwalten und ggf. übersetzen. Lediglich der Umgang mit einem Computersystem (im Idealfall Linux) und dessen Softwareverwaltung wird vorausgesetzt. Erfahrung in der Arbeit auf der Kommandozeile (Bash) ist von Vorteil.