ORR2013 - Bewertungsphase
OpenRheinRuhr 2013
Ein Pott voll Software
Speakers | |
---|---|
Georg Schütz |
Schedule | |
---|---|
Day | 10.11.2013 - 2013-11-10 |
Room | Vortragsraum 2 |
Start time | 13:30 |
Duration | 01:00 |
Info | |
ID | 178 |
Event type | Lecture |
Track | Freies Wissen |
Language used for presentation | German |
(Technische) Dokumentation schick und sicher mit zpub
Publizieren leicht gemacht...
Dokumentationen für technische Produkte, Anwendungen oder Studien-, Bachelor- oder Masterarbeiten sollten einfach, stabil und sicher erzeugt werden können. Dazu gibt es viele Werkzeuge. In diesem Vortrag möchte ich zpub vorstellen, praktische Beispiele zeigen und so den Nutzen einer cleveren Kombination Freier Software demonstrieren.
Mit dem etwas sperrigen Begriff „Technische Dokumentationen“ meine ich zum Beispiel Anwenderdokumentation also Handbücher für Software, Maschinen oder Anlagen. Aber auch Studienarbeiten für Seminare, Bachelor-, Master- oder Doktorarbeiten. Sicher, es gibt schon etliche Werkzeuge. Sieht man sich diese näher an, dann stellt man fest, dass wir es entweder mit „What you mean is what you get“ oder „What you see is what you get“ handelt. Bis hierher geht es also um Werkzeuge zur Texterstellung und Formatierung. Und nur darum. Wenn wir unsere Dokumentation mit diesen Werkzeugen schreiben, müssen wir uns zusätzlich um geeignete Verfahren für Datensicherung und gegebenenfalls für eine Versionierung kümmern. Wer schon einmal eine Seminararbeit praktisch zweimal geschrieben hat, weil kurz vor der Vollendung die Textverarbeitung einen irreparablen Absturz produzierte, der weiß wovon die Rede ist... Es findet sich aber nicht in jedem Unternehmen oder Projekt oder bei jedem Studenten gleich welcher Fachrichtung das Know-How, um all das richtig zu installieren und zu pflegen. Und was macht man, wenn man mit mehreren Menschen an der gleichen Dokumentation arbeiten möchte? Und wie realisiert man denn Ausgaben in verschiedenen Formaten, z.B. pdf oder html oder epub für mobile Geräte? Bei vielen Anwendungen in der Technik wäre es doch schön, wenn die Dokumentation oder das Handbuch auch direkt am Gerät in aktueller, elektronischer Form verfügbar wäre und nicht nur als Papier in einem Ordner. Wäre es nicht clever, ein für die Dokumentation gemachtes rundum-komplett-Werkzeug auch für Anfänger oder Nicht-Programmierer zu haben? Wäre es nicht schön, wenn man sich auf seine spezielle Aufgabe, seine Studienarbeit, sein Handbuch oder was-auch-immer-Dokumentation konzentrieren könnte, ohne die Infrastruktur aus Versionsverwaltung, Dokumenterzeugung, Vorlagen, Layout usw. immer wieder neu einrichten zu müssen? Wäre es nicht nett, wenn man die Bearbeitung einfach mit einem WYSIWYG-ähnlichen Editor machen könnte? Genau dafür gibt es zpub