alle : IT-Dokumentation

Startalle IT-Dokumentation

Document IT

Dieses Seminar steht nur als Inhouse-Veranstaltung zur Verfügung.

Struktur, Homogenität, Konsistenz, Klarheit und Präzision gehören zu einer Dokumentation, die Fragen beantwortet statt neue aufzuwerfen. Der Nutzer soll sich auf die Inhalte konzentrieren können und schnellstmöglich die Lösungen finden, um seine Arbeit fortzusetzen. Mit dem Booklet haben wir die perfekte Bedienungsanleitung für Software entwickelt. Das Seminar liefert alle Informationen und das Wissen, das erforderlich ist, um dieses Format mit eigenen Ressourcen umsetzen zu können.

Dummy-Test bestanden

Eine Software-Dokumentation leistet ihren maximalen Nutzen, wenn jemand nur mithilfe dieses Booklets die dokumentierten Prozesse bedienen kann, ohne vorher geschult worden zu sein. Ich nenne das den Dummy-Test. Ich bitte jeden Kunden, diesen Dummy-Test mit der  erstellten Anwender-Dokumentation durchzuführen. Und so wird Praktikanten, Auszubildenden oder Kollegen, die noch nie Berührung mit dem IT-System hatten, das Booklet in die Hand gedrückt. Damit sollen Sie die dokumentierten Prozesse am IT-System durchführen. Und sie schaffen es, jedes Mal.

Damit hat die erstellte IT-Dokumentation den Test bestanden und leistet das Maximale, das eine gute Dokumentation leisten kann. Natürlich müssen die Anwender noch verstehen, was sie da tun, müssen wissen, welche Informationen sie einzugeben haben und welche Bedeutung die Daten haben. Das ist Prozess- und firmeninternes Know-how, das die Mitarbeiter in der Regel bereits besitzen.

Die Perfekte Bedienungsanleitung für Software bildet auf jeden Fall die Basis für einen sicheren Umstieg.

 

7 x 24 Online verfügbar: das WebBook

Da die MindManager-Software nicht nur ein Tool zum „Malen von Mindmaps“ ist, war die unternehmensweite Nutzung verbunden mit dem MUSS für eine anwendergerechte Dokumentation, die auch zum selbständigen Lernen genutzt werden kann. Für uns war klar, dass hier eine Online-Dokumentation, also ein WebBook, zum Einsatz kommen muss.

pwag_webbook_beispiel_02

Informieren und Lernen

Das MindManager WebBook wurde ausgestattet mit einem Trainingspfad, der neuen Anwendern die Einarbeitung im Selbstlernstudium ermöglicht. Dazu wurden Filmanleitungen einfach nur in einer zum Lernen geeigneten Reihenfolge zusammen gestellt – also wieder verwendet. Für die erfahrenen Anwender stehen die Informationen in einer prozessorientierten Reihenfolge zur Verfügung. Damit bietet das MindManager WebBook allen Anwendern den richtigen Einstieg.

pwag_webbook_beispiel_03

Auf die Struktur kommt es an

Die Wiederverwendung von Inhalten für unterschiedliche Zwecke setzt eine intelligente und gut analysierte Informationsstruktur voraus. Unsere Zielsetzung lautet: Einmal dokumentiert – vielfach genutzt. Zur Analyse der zu dokumentierenden Inhalte und Entwicklung der Struktur nutzen wir MindMaps. Da wir IT-gestützt arbeiten setzen wir MindManager ein.

 

pwag_webbook_beispiel_04

Was für ein Typ sind Sie?

Eher der textorientierte? Oder lernen Sie lieber mit Bildern und sind der grafische Typ? Das MindManager WebBook bietet jedem Typ den richtigen Weg. Basierend auf einer Datenbasis stehen die Arbeits- und Klickanleitungen in drei verschiedenen Varianten zur Verfügung. Der von der PW entwickelte Weg ermöglicht dies ohne Mehraufwand.

 

pwag_webbook_beispiel_05

Die Module FAQ und Praxis

Antworten auf Ihre Fragen bietet das Zusatzmodul FAQ und Praxis, das im MindManager WebBook implementiert wurde. Der Anwender kann hier seine Fragen einstellen. Diese werden kategorisiert, also einem Thema zugeordnet und dann beantwortet. Die häufigsten Fragen – Frequently Asked Questions – werden in einer Übersicht FAQ angezeigt. Alle anderen Fragen können über eine abgestufte Suche nach Themen und Unterthemen angezeigt werden. Die Integration in das WebBook ermöglicht den direkten Verweis auf die relevante Arbeitsanweisung, weitere Informationen oder auf die entsprechende Lerneinheit.

pwag_webbook_beispiel_06

Die Modul Handbuch

Das Modul Handbuch zum Nachschlagen ist eine themenorientierte Zusammenstellung von vorhandenen Informationen. So ist diese notwendige Dokumentation einfach und schnell erstellt. Es handelt sich bei dem Handbuch um eine Zusatzfunktion, die innerhalb des WebBooks zur Verfügung steht.

 

Software

Flex Wiki und Adobe Captivate

 

Auf einen Blick …

… erkennen, was zu tun ist. Innerhalb der detaillierten Klickanleitungen verwenden wir diese Symbole zur visuellen Orientierung. Sie liefern bereits einen großen Teil der erforderlichen Informationen.

Der Anwender kann sich  entscheiden, ob er  auch noch den Text dazu lesen möchte, je nach individuellem Bedarf aufgrund persönlicher Vorkenntnisse und Erfahrungen.

Es gibt gute Gründe

Sie kennen Sie alle, die Probleme die auftauchen, weil die Anwender nicht wissen oder nicht verstehen, wie sie die Software richtig und optimal nutzen. Die Folge davon sind: Prozessfehler, korrupte und fehlerhafte Daten, Auswertungen ohne Aussagekraft weil Sie Äpfel mit Birnen vergleichen, um nur Einige zu nennen.

Das spricht für Die perfekte Bedienungsanleitung für Software:

  • Schafft Vertrauen bei den Anwender. Ein Verkaufsprospekt für Ihre Software.
  • Weniger Rückfragen und Support-Anfragen von den Anwendern.
  • Die Anwender arbeiten nach einheitlichen Standards.
  • Die Datenqualität steigt.
  • Die Aussagekraft Ihrer Auswertungen ist zuverlässig.
  • Der Trainingsaufwand kann reduziert werden.
  • Die Software-Dokumentation wird als Trainingsunterlage genutzt.
  • Unser Vorgehen sorgt für reduzierten Pflegeaufwand der Dokumentation. 

Was das wieder kostet …

… wenn Sie keine anwenderfreundliche und prozess-orientierte Dokumentation haben, lässt sich vermutlich nicht ganz genau vorhersagen. Aber alleine die Tatsache, dass Sie durch die konsequente, präzise und vollständige Dokumentation den Trainingsaufwand und Einarbeitungsaufwand für die Anwender reduzieren können, reicht meist aus, um eine positive Bilanz ziehen zu können.

Beispielrechnung 1

Anzahl Anwender 240
Anwendungskomplexität Mittel Geschätzter Trainingsaufwand 2 Tage pro Person (ohne Dokumentations-Lösung).
Reduzierung des Trainingsaufwandes je Anwender durch das Bereitstellen und Nutzen der Software-Dokumentation 3 Stunden
Ergibt bei einem kalkulierten Stundensatz je Mitarbeiter in Höhe von 65 Euro eine Gesamtersparnis in Höhe von 46.800 Euro

 

Beispielrechnung 2

Anzahl Anwender 135
Anwendungskomplexität Hoch Geschätzter Trainingsaufwand 3 Tage pro Person (ohne Dokumentations-Lösung).
Reduzierung des Trainingsaufwandes je Anwender durch das Bereitstellen und Nutzen der Software-Dokumentation 7 Stunden
Ergibt bei einem kalkulierten Stundensatz je Mitarbeiter in Höhe von 65 Euro eine Gesamtersparnis in Höhe von 61.425 Euro

 

 

Von Äpfeln und Birnen

Begriffe sollten eindeutig geklärt werden. Sonst spricht einer von Registern, der Zweite spricht von Reitern und der Dritte sagt Karteikarte. Alle Drei meinen das Gleiche und nutzen doch andere Begriffe. Innerhalb der Software-Dokumentation ist es wichtig, dass ein Begriff einmalig definiert und dann konsequent genutzt wird.

Von Äpfeln und BirnenDies erfolgt zu Beginn und wird für jeden Kunden individuell definiert. Dabei werden die folgenden Quellen berücksichtigt:

– allgemeiner Sprachgebrauch
– unternehmensspezifischer Sprachgebrauch
– Fachbegriffe
– Normen und Verordnungen
– Festlegung auf eine Sprache
– vorhandene Dokumentation
– Abgrenzung zu anderen IT-Systemen schaffen/vermeiden