K15t Blog
Wiki-basierte Dokumentation: 7+1 Mythos unter der Lupe
Martin Häberle

Martin Häberle am 23. März 2017

Martin Häberle

Martin Häberle am 23. März 2017

Wiki-basierte Dokumentation: 7+1 Mythos unter der Lupe

 

Immer mehr Organisationen wie die NASA, Nintendo, BMW, Lufthansa und Red Bull organisieren technische Inhalte in Wikis und setzen dabei auf Atlassian Confluence als Dokumentationsplattform. Dennoch gibt es einige Missverständnisse über Wikis in der Technischen Redaktion, die wir heute einmal näher betrachten wollen.  Mythos enthüllt

Technische Redakteure haben oft die Qual der Wahl, welches Redaktionswerkzeug sie nutzen sollen. Angefangen bei den dokumentzentrierten Klassikern wie Microsoft Word, dann Help Authoring Tools, textbasierte Werkzeuge und schließlich teure XML-Redaktionssysteme oder kollaborative Plattformen. Kein Wunder, dass es dazu im Web genauso viele Debatten wie Missverständnisse gibt. 

In einem englischsprachigen E-Book werden beispielsweise sieben K.-o.-Kriterien zusammengetragen, die Wikis als Werkzeuge zum Erstellen von Produktdokumentation als untauglich einstufen.

Doch diese Bedenken sind oft sehr pauschal. Werden wir also konkret und befassen uns hier mit Atlassian Confluence – teilweise in Kombination mit relevanten Add-ons. Und bei näherer Betrachtung lösen sich dann die oft recht alten Vorurteile gegen Wikis in Luft auf. Deshalb bezeichnen wir die folgenden Gründe als das, was sie wirklich sind: Mythen

Mythos 1: Wikis sind kompliziert zu bedienen 

Wer einmal einen Beitrag auf Wikipedia verfassen wollte, musste zunächst dessen Wiki-Syntax aus eckigen und geschweiften Klammern erlernen – tatsächlich ziemlich abschreckend! Wer aber nun glaubt, das träfe auf alle Wiki-basierten Plattformen zu, liegt falsch: Atlassian Confluence bietet einen komfortablen grafischen Editor und eine intuitiv nutzbare Oberfläche, die Drag and Drop sowie Tastenkürzel für Power-User unterstützt. 

„Wiki“ steht im Hawaiianischen übrigens für „schnell“. Wirklich gerecht wird diesem Begriff aber erst Confluence.

Mythos 2: Wikis haben keine Struktur 

confluence uebersicht diskussion erstellenDass ein Wiki nur eine flache Ansammlung von unstrukturierten Seiten ist, mag vor zehn Jahren einmal richtig gewesen sein. Als modernes Enterprise-Wiki integriert Confluence alle Werkzeuge für den Unternehmenseinsatz, um effektiv die Qualität und die Struktur von Inhalten sicherzustellen – beispielsweise durch die hierarchische Organisation von Seiten in Bereichen, die Gruppierung über Stichwörter oder die Nutzung von Vorlagen und Add-ons zur strukturierten Datenerfassung und Workflow-Steuerung.

Mythos 3: In einem Wiki darf jeder alles

Stimmt! In einem Wiki zu arbeiten bedeutet zunächst einmal die Freiheit, eigenes Wissen beizutragen und Inhalte zu verbessern. Doch selbstverständlich lassen sich in Confluence, wenn nötig, Beschränkungen feingranular definieren – etwa die Seitenbearbeitung auf bestimmte Benutzergruppen einzuschränken oder ganze Bereiche zu schützen. Diese Flexibilität macht Confluence zur Plattform der Wahl für junge Start-ups bis hin zum globalen Konzern.

Mythos 4: Wikis haben keine vernünftige Suchfunktion 

confluence suchfunktion

Bei manchen einfachen Wiki-Plattformen mag es nicht immer einfach gewesen sein, den gesuchten Inhalt auf Anhieb zu finden. Doch das trifft sicherlich nicht auf Confluence und dessen mächtige Suchfunktion zu. Denn die funktioniert und zwar nicht nur für Seiten, sondern auch für Blogposts, Anhänge und Kommentare. Und falls sich der gewünschte Inhalt dennoch hartnäckig verstecken sollte, lässt sich die Trefferliste weiter filtern – etwa nach Datum, Typ, Autor oder Bereich.

Mythos 5: Wikis bieten keine Integrationsmöglichkeiten 

Als Enterprise-Wiki wird Confluence meist innerhalb von Unternehmen genutzt. Externe LDAP-Benutzerverzeichnisse, perfekte JIRA-Integration und die mobile Nutzung via App sind daher selbstverständlich. Für Confluence steht darüber hinaus mit dem Atlassian Marketplace ein komplettes Ökosystem an Integrationsmöglichkeiten zur Verfügung. Hier gibt es nicht nur Add-ons für nahezu jeden Anwendungsfall, sondern auch Integrationsmöglichkeiten für viele Drittsysteme, einschließlich Salesforce. Sorry, aber dieser Mythos ist einfach nur ein Märchen. 

Mythos 6: Wikis sind unflexibel bei der Publikation 

Eine wichtige Anforderung an Produktdokumentation ist, dass sie in verschiedenen Formaten bereitgestellt werden soll – etwa als PDF. Von Anfang an bietet Confluence daher eine Exportfunktion für PDF und HTML, um für alle Fälle auch eine Offline-Variante der Inhalte zu ermöglichen. 

Experten-Tipp

Weil wir wissen, dass Technische Redakteure höchste Ansprüche an die eingesetzten Programme stellen, gibt es mit den Scroll Exportern für Confluence eine Reihe von Add-ons zum professionellen Single-Source Publishing. Unterstützt werden hierbei die Formate HTML, Word, PDF, EPUB, DocBook, EclipseHelp und sogar das gute alte CHM für kontextsensitive Hilfen. Alle Ausgabeformate lassen sich übrigens über Vorlagen an Gestaltungsvorgaben anpassen.

Mythos 7: Wikis bieten keine Versionskontrolle 

Wenn sich im Laufe der Zeit die beschriebenen Produkte ändern, lassen sich nur mit einer effektiven Versionskontrolle Änderungen komfortabel verwalten und unnötiger Mehrfachaufwand vermeiden. Eine Kernfunktion von Wikis ist zwar eine konsequente, nachvollziehbare Änderungshistorie zu jeder Seite, doch eine Gesamtdokumentation zu versionieren zählt nicht dazu.

Experten-Tipp

Gut, dass es deshalb Scroll Versions für Confluence gibt. Denn mit diesem Add-on erhalten Technische Redakteure ein einfach nutzbares Werkzeug zum Versions- und Variantenmanagement sowie zum agilen Publizieren. Um einen ersten Eindruck zu bekommen, wie Scroll Versions funktioniert, empfehlen wir dieses Video mit einem Scroll Versions Crash-Kurs 

Bonus-Mythos: Wiki-Inhalte sind redundant, veraltet und trivial 

Noch immer nicht genug von diesen Mythen? Hier noch ein weiterer Mythos, der die Inhalte in Wikis betrifft. Diese seien zumeist doppelt und dreifach vorhanden, selten aktuell und wenig aussagekräftig. Tatsächlich ermöglicht Confluence allen Beteiligten Inhalte aktuell und relevant zu halten – nicht nur Technischen Redakteuren. Denn je mehr Menschen auf Inhalte schauen und einfach beitragen können, umso besser, aktueller und nützlicher werden diese. Dabei helfen Funktionen wie Kommentare und Diskussionen, Inhalte schnell zu teilen, auf Seitenhistorien zuzugreifen und Änderungen, falls nötig, wieder zurückzusetzen. 

Wenn alle Beteiligten mitmachen, werden mit Confluence die Dokumentationsinhalte lebendig –  durch einen kontinuierlichen Strom von Feedback und Verbesserungen.

Augen auf bei pauschaler Wiki-Kritik

Es überrascht uns immer wieder, wie viele alte Mythen noch verbreitet werden – über wilde Content-Dschungel und unbedienbare Informationsilos ohne Eignung zum professionellen Content Management. Denn längst treffen sie nicht mehr zu – spätestens seit Atlassian Confluence wurde die Wiki-basierte Zusammenarbeit von Technische Redakteuren, Fachabteilungen und allen anderen für immer verändert. 

In einer agilen, sich ständig wandelnden Arbeitswelt mit dynamisch zusammengestellten Teams und kurzen Produktzyklen eignet sich der Wiki-basierte Ansatz mit Confluence und den Scroll Add-ons also nicht nur für die Technische Dokumentation, sondern ist bei vielem mehr die ideale Lösung.

Wir enthüllen gerne weitere Mythen.

SPRECHEN SIE UNS AN

Damit unsere Homepage gut funktioniert, wir unseren Service verbessern können und Ihnen die Nutzung erleichtern, werden Cookies gesetzt (u.a. Google Analytics). Informationen hierzu unter: unserer Datenschutzerklärung.
Ok