Dokumentation ist kompliziert! Wirklich?

13. Juli 2021

Finde heraus, wie Du Deine Dokumentation schnell und einfach erstellst und in Deinem System integrierst.

Sicherlich kennst Du Folgendes: Du erstellst eine Dokumentation, speicherst sie in einem Format (z.B. Word oder PowerPoint) und exportierst sie als eine PDF. Die Dateien legst Du in einem Verzeichnis ab und/oder verschickst sie an Deine Kollegen und Kolleginnen.

Nach einer Anpassung der Dokumentation entsteht eine neue Version, die Du vielleicht an einen anderen Kreis verschickst. So entstehen viele Versionen der Dokumentation, die bei Dir und Deinen Kollegen im E-Mail-Postfach oder Verzeichnissen liegen. Wenn Du die Dokumentation suchst, findest Du sie nicht an der Stelle, wo Du sie vermutest, oder findest viele Versionen, die nicht mehr aktuell sind. In der Dokumentation enthaltene Links sind wahrscheinlich nicht mehr aktuell.

Bei Textor & Team verwenden wir DokuWiki. Wir schreiben unsere Dokumentation in einem Web-Browser. Wir können von jedem Gerät die Dokumentation erstellen und mit Tabellen und Diagrammen anreichern. Die Dokumentation liegt zentral auf dem Server und jede/r Kollege/Kollegin kann sie lesen, editieren und in wenigen Sekunden durchsuchen.

Wenn wir eine Information benötigen, z.B. zum Austausch mit dem Kunden, exportieren wir sie einfach als PDF-Dokument. Aufgrund des einfachen Aufrufs über den Browser setzen wir es auch sehr intensiv bei unseren Kunden als Plattform für Anleitungen ein. Einer unserer Kunden benötigt z.B. für die Mitarbeiter eine Verfahrensanleitung, die sekundenschnell aufzurufen ist (ein Browser ist definitiv auf jedem Smartphone oder Tablet vorhanden).

Eine weitere Erleichterung ist es, Informationen automatisiert abzulegen und diese mit verschiedenen Versionen zu versehen und auch Links aus der Dokumentation an der richtigen Stelle zu verwenden. Passwörter empfehlen wir in einem „PasswortSafe“ abzulegen.

Das Ganze lässt sich natürlich auch für einzelne Benutzer individuell anpassen oder einschränken.

Auch hier wieder ein OpenSource Produkt, das sich einfach installieren und ohne größeren Aufwand nutzen lässt. Aber auch eine individuelle Erweiterung an eigene Anforderungen ist selbstverständlich möglich.

Für unsere Yazi-Map (die Basis dafür bildet wie in unserem 1. Blog erwähnt Zabbix) nutzen wir die Dokumentation noch als Erweiterung des Monitorings. Dazu stellen wir morgen noch einen separaten Blog zur Verfügung.

Eure
Textor & Team IT Service GmbH

Kontaktiere uns gerne für weitere Informationen.

Hier gehts zum Kontakt →