Mehrere Quelldokumentationen sinnvoll in Zieldokumentation überführen

 Dokumentation, Tutorials  Kommentare deaktiviert für Mehrere Quelldokumentationen sinnvoll in Zieldokumentation überführen
Jan 132017
 

Eine häufige Ausgangssituation:

Dokumentation

  • aus zwei oder mehr Quellen
  • mit unterschiedlichen Strukturen
  • mit unterschiedlichen Inhalten
  • mit unterschiedlicher Tiefe an Inhalt

soll vereinheitlicht werden zu einer Zieldokumentation (meist in einem neuen Dokusystem), die alle aktuellen Inhalte abbilden soll.

Typischer Fehler, der an dieser Stelle  gemacht wird: „Wenn wir schon dran sind, vereinheitlichen wir jetzt alle Dokumente auf denselben neuen Stil!“

Meine Erfahrung: Dieser Ansatz führt dazu, dass alle vorhandene Dokumentation als „veraltet“ wahrgenommen und ein riesiger Arbeitsberg generiert wird, bei dem nach 20% dem Projekt die Puste ausgeht, weil das nächste dringende Projekt kommt.

Ein sinnvoller Ablauf (praxiserprobt für interne IT-Dokumentation; es war keine Rechtssicherheit notwendig):

1. Was genau liegt an Dokumenten vor? Dies erzeugt  eine lange und sehr wichtige Masterliste, z.B. in Excel. Hier gehören alle Infos rein:

  • Quellinfo: Laufende Nummer, Link in Dokusystem/Ordersystem/Sharepoint etc., Titel, Ansprechpartner, Größe des Dokument, Quellformat (bei mehreren vorhandenen Formaten), Qualitätsstatus (aktuell, nicht aktuell etc.).
  • Zielinfo: Status „Soll überführt werden“ (sonst Archivieren!), Status „Ist überführt“, Link im Zielsystem, ggf. neuer Titel, ggf. neues Format

Die Vollständigkeit der Liste ist entscheidend für jegliche Aussage über Aufwände und Fortschritt! Ohne eine klare Definition des Ausgangszustandes sind alle Aussagen zur Zielerreichung nur eine Schätzung/Hoffnung!

2. Den optimalen Zielzustand formulieren. Dies beinhaltet

  • das Format der Doku (alles von Copy&Paste bis stundenlanger Umarbeitung), ggf. von Hilfskräften durchführbar.
  • gewünschte Informationen und Tiefe der Informationen – dies führt potentiell zu sehr viel Arbeit bei den Sachexperten!

3. Mit einigen der ausgewählten Dokumente verschiedener Quellformate ein „Rapid Prototyping“ betreiben, d.h. einen Testlauf mit Zeitnahme (!), wie lange eine Umarbeitung in den 100% gewünschten Zustand dauert.

4. Dies mit einem Faktor von 2-3 auf die Dokumentation hochrechnen, die umgezogen werden soll.

5. Abgleichen mit dem gewünschten Endtermin des Projekts (z.B. Abschalttermin von Altsystemen) und den eingeplanten Personen und ihrer realistischen(!) Arbeitsstunden im Projekt.

An diesem Punkt stellt man meist fest, dass das Projekt so nicht machbar ist. Dokumentation umarbeitet kostet viel Zeit, diese wird immer unterschätzt.

6. Den machbaren Zielzustand definieren. Dies erfordert Abstriche an der Wunschliste, die in Punkt 2 formuliert wurde. Oft ist der Punkt „vollständige Dokumentation“ kritisch. Hier besser ein unvollständiges aktuelles Dokument umziehen und später ergänzen, als sich in der Datensammlung aufzuhalten (außer, es ist rechtlich kritische Dokumentation). Auch der Umbau der Formate sollte auf den kleinsten wirklich notwendigen Aufwand gekürzt werden.

7. Eine ausführliche Arbeitsanweisung für den Umzug der Dokumente erstellen, damit alle Schritte ausformuliert und festgehalten sind. Bei Quellformaten mit klaren Strukturen können hier oft Schritte automatisiert werden, z.B. mit VBA-Makros in Word.

8. Mit der Verarbeitung der Quelldokumente beginnen und – wichtig! – Soll-Prozess mit Ist-Prozess abgleichen! Wie lange dauert die Umarbeitung wirklich? Ist der Fortschritt wie geplant?
Erfahrungsgemäß muss eine Automatisierung immer wieder für Fälle erweitert werden, die im ursprünglichen Testset nicht erfasst waren.

Auch  ein Dokumentenumzug unterliegt der 80-20 Regel: 80% der Dokumente machen wenig Aufwand, 20% viel. Dokumente, die Probleme erzeugen, beiseite legen und in der Excel-Masterliste vermerken, damit sie mit etwas mehr Ruhe nachbearbeitet werden können. Etwas für regnerische Freitagnachmittage oder lange Zugfahrten.

Archivieren oder Löschen?

  • Nur wirklich obsolete oder doppelt vorhandene Dokumente sollten gelöscht werden.
  • Archivierte Dokumente sollten noch mindestens 2 Jahre im Zugriff sein. Erfahrungsgemäß muss immer wieder darauf zugegriffen werden, z.B. weil beim Umzug Inhalte verloren gingen oder sich Dokumente nachträglich als doch wichtig herausstellen. Für optimale Durchsuchbarkeit ist ein Ablegen von Word-oder PDF-Snapshots der Quelldateien in einem ganz normalen Ordnersystem hilfreich. Für datenbankbasierte Dokusysteme sollte zwei Jahre ein read-only Zugriff möglich sein. Motto: „Dateien fressen kein Brot. Archivieren ist billiger als neu Schreiben“.

Abschließender Tipp

Hier am Ende möchte ich nochmals betonen, dass ein genauer Überblick über die Dokumentation zum Startpunkt des Umzugs lebenswichtig ist. Dieser Überblick sollte an einer einzigen Stelle vorhanden sein (nicht verteilt über mehrere Systeme), und idealerweise von 1-2 Personen gepflegt sowie von allen Personen im Projekt gelesen werden können.

Mit einer Excel-Masterliste bin ich damals perfekt gefahren. Es wird gerne über Excel gelästert, dabei hat es viele Vorteile:

  • in jeder Firma vorhanden (jedenfalls in jeder, in der ich in 17 Jahren unterwegs war)
  • fast jeder kann die Kernfunktionen schon bedienen oder schnell geschult werden
  • sehr gute und schnelle Filtermöglichkeiten
  • sehr gut mit VBA automatisierbar
  • jederzeit schnell ein Backup in ein ZIP schreibbar

Soweit zum Thema Dateiumzug. Die ebenfalls große Frage „Und wie wird das dann alles zukünftig aktualisiert?“ behandle ich in einem zukünftigen Blogbeitrag.

Share
© 2012 Doku-Hotline Suffusion theme by Sayontan Sinha