K15t Blog
7 Gründe, warum Sie Confluence in der technischen Dokumentation verwenden sollten
Michael Rieger

Michael Rieger am 20. Dezember 2017

Michael Rieger

Michael Rieger am 20. Dezember 2017

7 Gründe, warum Sie Confluence in der technischen Dokumentation verwenden sollten

Treffen sich technische Redakteure auf einer Konferenz, ist die erste Frage meist: „Welche Software verwendet ihr in der technischen Redaktion für die Produkthilfe-Seite?" Und die nächste Frage, die unmittelbar folgt, ist: "Und welches Redaktionstool würdet ihr lieber verwenden?"

Die meisten Redakteure erwarten eine Antwort wie „FrameMaker", „Flare" oder ein anderes klassisches Redaktionstool. Wenn Sie aber Thomas Walker, unserem technischem Redakteur bei K15t Software diese Frage stellen, wird er Sie mit seiner Antwort vermutlich verblüffen: „Wir setzen das Collaboration Tool Confluence ein und kombinieren es mit unseren aktuellsten Scroll Apps für die technische Dokumentation. Und um die zweite Frage zu beantworten: Am liebsten arbeite ich mit Confluence." Finden wir heraus, warum das so ist.

#1 Confluence kann unternehmensweit eingesetzt werden

Bei uns wird das Collaboration Tool Confluence in allen Abteilungen eingesetzt. Alle Mitarbeiter teilen ihre Informationen in internen Confluence-Bereichen (sogenannten Spaces), aufgeteilt nach Themen und Fachgebieten. Auch die Softwareentwickler nutzen Confluence. Hier schreiben sie ihre Spezifikationen und dokumentieren Entscheidungen zu Ideen und Entwürfen. Der nächste logische Schritt ist also, Confluence auch für die Erstellung und Verwaltung von technischen Dokumentationen zu verwenden, da bereits alle notwendigen Informationen in diesem Tool vorhanden sind.

Bei K15t Software gehört es zum Standard, dass jeder einen Confluence Account besitzt. Den Zugang erhalten neue Mitarbeiter direkt am ersten Tag, zusammen mit der E-Mail-Adresse und allen anderen notwendigen Zugangsberechtigungen. So können alle Teammitglieder von Anfang an Inhalte erstellen und verbessern. Und es funktioniert: Indem jeder mit dem gleichen System arbeitet, können Inhalte einfach geteilt, kommentiert und verbessert werden. Das gilt auch für die technische Dokumentation.

Doch damit nicht genug. Tom erklärt jedem gerne: „Wir verwalten außerdem unsere Webseite, unseren Blog und unser Mitarbeiterhandbuch in Confluence."

#2 Confluence arbeitet, wie Sie es erwarten

Die Bedienung von Confluence ist intuitiv und inspiriert Anwender buchstäblich zur Zusammenarbeit. Confluence hat eine sehr übersichtliche Oberfläche und einen Editor, der gängigen Desktop-Publishing-(DTP) oder Textverarbeitungsprogrammen wie Microsoft Word sehr ähnlich ist.

Anwender, die Confluence zum ersten Mal benutzen, benötigen nur eine kurze Einarbeitungszeit, um einsatzbereit zu sein – im Gegensatz zu vielen anderen klassischen Redaktionssystemen. Die meisten neuen Confluence-Nutzer legen einfach los, und es dauert nicht lange, bis sie Inhalte schreiben, kommentieren und wie Experten teilen können.

Für wiederkehrende Inhalte bietet Confluence Templates, um Inhalte schnell und einheitlich zu erstellen, beispielsweise für Besprechungsnotizen oder benutzerdefinierte Vorlagen für die Supportdokumentation. Das ist eine großartige Möglichkeit, in sich stimmige Seitenstrukturen und Inhalte beizubehalten. Trotzdem können Redakteure auch eigene Vorstellungen umsetzen, wenn ihnen das Template nicht genügt.

Das ist es, was Tom daran besonders gefällt: „Confluence erlaubt es mir auf der einen Seite, Inhalte einheitlich zu gestalten. Andererseits behalte ich die Freiheit, selber kreativ zu werden."

#3 Confluence motiviert Kollegen und Leser zum Mitmachen

Confluence-Seiten zu teilen ist einfach. Mit nur wenigen Klicks haben Sie Änderungen an der Dokumentation mit Kollegen geteilt. Bei K15t Software werden außerdem gerne und häufig Inline-Kommentare verwendet. So diskutieren wir Vorschläge oder vorhandene Inhalte direkt da, wo sie relevant sind. Wer an deren Entwicklung interessiert ist – egal aus welcher Abteilung – kann dieser Seite folgen und erhält eine kurze Notiz, sobald ein Kommentar hinzugefügt wurde.

Ist doch einmal eine ausführlichere Abstimmung notwendig, können sich alle Beteiligten einfach per Videochat-Erweiterung direkt auf einer Seite einwählen. 

Collaboration Tools wie Confluence schaffen es auf einfache und intuitive Weise jeden zum Mitmachen zu bewegen – anders als typische Redaktionssysteme, die einzig und allein auf die Bedürfnisse von Mitarbeitern in der technischen Dokumentation zugeschnitten sind. Ohne diesen Wiki-Ansatz wird der Inhalt vom technischen Redakteur in der Regel aus einem Content-Management-System (CMS) exportiert, um ihn dann den Kollegen aus anderen Fachbereichen zur Überarbeitung und Freigabe zuzusenden. Anmerkungen und Änderungsanforderungen müssen dann wieder importiert und nachgepflegt werden.

confluence-share-communication

#4 Confluence ist webbasiert

Um Confluence zu nutzen, brauchen Sie keine neue Software auf Ihrem Rechner zu installieren. Alles, was Sie brauchen, ist ein Webbrowser und ein persönliches Benutzerkonto. Inhalte werden zentral auf Ihrem firmeneigenen Confluence-Server verwaltet. Auf diese Weise hat jeder in Ihrem Unternehmen immer Zugriff auf die neueste Version, kann sie aktualisieren, teilen oder Inhalte hinzufügen – jederzeit an jedem Ort: am Arbeitsplatz, an einem andern Unternehmensstandort und sogar, wenn Sie geschäftlich unterwegs sind.

Tom ist ein großer Fan dieses webbasierten Ansatzes von Confluence: „Darüber hinaus brauche ich mich auch nicht mehr um die Aktualisierung meines Redaktionssystems zu kümmern. Unsere Administratoren kümmern sich zentral darum, dass wir immer mit der neuesten Version arbeiten."

#5 Confluence bietet Transparenz

Die Idee hinter einer Wiki-basierten Zusammenarbeit ist, dass jeder mitmacht und Zugang zum gesamten Wissen hat. Anwender können Seiten folgen und vergleichen, sich über aktuelles Wissen informieren und mitverfolgen, wie Inhalte sich weiterentwickeln. Die technische Dokumentation wächst so buchstäblich vor Ihren Augen (ab der Confluence Version 6 können außerdem mehrere Personen gleichzeitig eine Seite editieren).

Trotzdem müssen nicht alle Inhalte mit Kollegen geteilt werden. Daher können auch in Confluence Zugänge beschränkt werden. Dafür bietet das System ein spezifisches Rechte- und Rollenmanagement. So können Sie beispielsweise ganz einfach definieren, wer auf welcher Seite und in welchem Space lesen, editieren oder kommentieren darf.

Tom erklärt: „Bei K15t Software erhalten unsere Kunden eine Wiki-basierte Support-Dokumentation. Anwender haben natürlich nur Lesezugriff auf die öffentlichen Teile unseres Wikis. Wir motivieren aber alle Leser, Kommentare abzugeben, um wertvolles Feedback zu erhalten." Mit diesem Ansatz kann Kundenfeedback direkt verwendet werden, um die Qualität der technischen Dokumentation zu verbessern.

confluence-helpcenter-discussion

#6 Confluence kann individuell angepasst werden

Confluence ist kein typisches Content-Management-System (CMS). Es ist eine Plattform, die mit einer breiten Palette von Apps auf Ihre individuellen Bedürfnisse im Unternehmen im Allgemeinen und in der technischen Dokumentation im Besonderen angepasst werden kann. Die App Scroll Versions von K15t Software ermöglicht es beispielsweise verschiedene Versionen und Varianten einer technischen Dokumentation zu verwalten. So schlägt Confluence eine Brücke zwischen einem ausgereiften CMS und einem anwenderfreundlichem Wiki. Diskussionen an Inhalten führen Beteiligte persönlich und direkt im Dokument über Conversations Video Chat.

Mehrsprachige Inhalte können mit der Scroll Translations App verwaltet werden. Und wenn Sie Ihre technische Dokumentation dann auch noch gut gestaltet als PDF, Worddokument oder in anderen Formaten veröffentlichen wollen, verwenden Sie doch einfach eine der Scroll Exporters Apps. Oder Sie stellen Ihren Anwendern die Anwenderdokumentation in Form eines Help Centers mit Scroll Viewport zur Verfügung. All diese Apps installieren Sie mit wenigen Klicks und Sie können 30 Tage lang kostenlos testen.

Tom fügt hinzu: „Ich kann mir überhaupt nicht mehr vorstellen, wie wir ohne diese Scroll Apps arbeiten sollten. Die sparen mir viel Zeit, die ich besser darauf verwende, Inhalte zu schreiben, anstatt sie ständig hin- und herzukopieren und dann manuell zu verwalten."

#7 Confluence ist ideal für ein agiles Umfeld

Wie viele Softwarehersteller folgt K15t Software dem Modell der agilen Entwicklung. Zeitgleich zu den Produkten entwickeln sich technische Dokumentationen schrittweise innerhalb von Sprints und Releases. Releasezyklen werden allerdings immer kürzer und technische Redakteure müssen damit Schritt halten. Das ist allerdings nur möglich, wenn jeder im Team mit der gleichen Plattform arbeitet, um Informationen und regelmäßiges Feedback bereitzustellen.

Tom beschreibt seine Vorgehensweise bei der Veröffentlichung von technischen Dokumentationen: „Parallel zur Entwicklung arbeite ich an der anstehenden Version unserer Dokumentation. Sobald unsere Entwickler das Produkt freigegeben haben, veröffentliche ich mit Hilfe von Scroll Versions meine Inhalte mit wenigen Klicks."

Auch andere Unternehmen haben sich für einen solchen Ansatz entschieden und integrieren ihre Anwenderdokumentation in ihren agilen Entwicklungsprozess.

Fazit: Es gibt viele Anwendungsfälle

Confluence startete als Plattform für Zusammenarbeit und Wissensmanagement. Doch Anwender haben Confluence auch schon immer für andere Zwecke eingesetzt und so für viele weitere Anwendungsgebiete interessant gemacht. Mit jeder neuen App, die im Atlassian Marketplace angeboten wird, lassen sich weitere Anwendungsfälle abdecken und erweitern so die Einsatzmöglichkeiten von Confluence für die technische Dokumentation.

Aus diesen Gründen haben wir Enlite erschaffen – ein modernes Redaktionssystem, das auf Confluence basiert.

mehr erfahren






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