Wikis bringen Multimedia in die Dokumentation

Willkommen im HTML 5 Zeitalter. Es war nie einfacher Dokumentation mit Daten aus anderen Systemen zu verknüpfen und zu publizieren. Der Einsatz von Wikis für die Softwaredokumentation macht auch aus diesem Grund Sinn. Wer hat denn das letzte mal ein Handbuch für eine Software durchgeblättert? Hier also einige Tipps, wie man Dokumentation und Multimedia miteinander verknüpfen kann.

Bilder nutzen

Mit Bildern bleiben Informationen besser im Gedächtnis haften. Mehr noch: Bilder transportieren Informationen meist besser als nur Text. Man kann Daten kompakter und greifbarer in einem Diagramm unterbringen als ein schriftlicher Form. Zusätzlich wecken Bilder das Interesse der Leser.

Moderne Wikis geben den Editoren die Möglichkeit mit einfachen Mitteln ein Bild hinzuzufügen. Beispielsweise bietet das Enterprise Wiki Confluence eine Drag und Drop Funktion im Browser an, um beispielsweise ein Foto zum Text hinzuzufügen. Aber wo Wikis wirklich herausstechen, ist die Möglichkeit, die Doku mit dynamischen Daten aus anderen Seiten anzureichern.

Multimedialer Inhalt

Hier ein Überlbick, was alles mit modernen Wikis möglich ist

Video und Audio: Fügen Sie Multimediadateien zu Seiten hinzu oder betten Sie YouTube oder Vimeo Videos ein. Gerade für Anleitungen ist ein Video oft besser geeignet. Gleiches gilt für Screencasts. Aber: Natürlich ist diese Form der Dokumentation sehr zeit- und pflegeintensiv.
Bilder und Diagramme: Screenshots sollten in jeder Softwaredokumentation vorhanden sein. In Confluence ist es auch möglich Gliffy Diagramme direkt auf einer Seite anzuzeigen und zu editieren.
Präsentationen und andere Dokumente: Fügen Sie auch PDF-, Powerpoint-, SlideRocket oder Slideshare-Präsentationen zu ihrer Dokumentation hinzu, so dass Benutzer diese direkt auf der Dokuseite durchklicken können. Gleiches gilt für MS-Office Dokumente und GoogleDocs, die nicht erst vom Benutzer heruntergeladen werden müssen, sondern direkt auf der Seite betrachtet werden können.

Technische Redakteure sollten sich diese Funtionen zu nutze machen. Vielleicht hat Ihr Marketing Team gerade ein Anleitungsvideo produziert oder der Kollege aus der Technik hat einen Vortrag auf Slideshare veröffenlticht, der das System erklärt. Fügen Sie einfach diese Resourcen zur Dokumentation hinzu, ohne diese konvertieren zu müssen. Das sind tolle Resourcen für die Leser Ihrer Doku.

Echzeit-Daten

Ihre Seite kann Live-Informationen aus anderen Seiten enthalten. Wenn also Benutzer die Seite öffnen, sehen diese die neusten Informationen, die auf anderen Seiten publiziert worden sind:

Gadgets. iGoogle Gadgets bieten die Möglichkeit, beispielsweise eine Übersetzer-App, aktuelle Wetterinformationen, Landkarten und vieles mehr auf einfache Weise auf einer Wiki-Seite zu intgrieren.
Aufgabenverfolgung. Reichern Sie Ihre Release Notes mit erledigten Aufgaben aus Ihrer Aufgabenverfolgung an. Die Daten werden dynamisch aus dem Issue Tracker ausgelesen und in ihrer Releaseinformationsseite angezeigt.
und noch vieles mehr: Aktivitätsströme, Blogposts, Kalendar…

Twitter + Wiki = Tolle Kombination

Twitter ist für viele Menschen heutzutage die erste Wahl, um Informationen schnell zu verbreiten. Man liest und versendet Informationen im Netz, auf dem Smartphone, auf Facebook, via Email, RSS, spezielle Apps… An jedem Ort, zu jeder Zeit.

Wäre es nicht cool, wenn man technische Informationen über Twitter verschicken könnte? Noch besser: Wie wäre es wenn man Personen über Twitter an die Dokumentation heranführen kann? Atlassian hat mit beiden Sachen experimentiert.

Wir haben Kunden gebeten, über Tipps und Tricks für unsere Produkte zu twittern. Über ein speziellen HashTag teilen die Kunden Informationen mit uns und anderen Kunden. Diese Tweets werden dann auf unseren Doku-Seiten live veröffentlicht. Hier können Sie sich selbst davon überzeugen:

Interaktive und spielerische Dokumentation

Man glaubt es kaum, aber: Technische Doku kann von Spaß und Spiel profitieren. Diesen Gamifaction-Ansatz haben wir bei unserer Dragon Slayer Doku verfolgt. Dabei handelt es sich einfach um eine spielerische Anleitung, wie man Podukte installieren und konfigurieren kann. Die Installation und Konfiguration der gesamten Atlassian Produkte braucht ein wenig Zeit und kann auch mal ziemlich langweilig und tricky werden. Also haben wir Sir Charly von Atlassian, den furchtlose Drachentöter erfunden, der einen durch den Prozess leitet. Die Installation wurde dafür in verschieden Abschnitte unterteilt, an dessen jeweiligem Ende man über die Erfahrungen twittern soll.

“Fare ye well, brave souls and true. I’m starting the Atlassian Dragon Quest!”

Wir haben durchweg gute Erfahrungen mit der Einführung von Social Media – Fuktionalität in unserer Dokumentation mit Conflucence gemacht. Die Kunden schätzen die offene Kommunikation und lieben die Echtzeit-Funktionen.

Was für weitere Vorteile ein Wiki für die Softwaredokumentation im Team bietet, kann man hier nachlesen.