Evolution in der Dokumentation

Beständig wachsen Bedarf und Notwendigkeit Produkte, Prozesse, Systeme, ja sogar die Ereigniswelten ganzer Unternehmen zu dokumentieren. Intellektuell gefertigte Beschreibungen und Darstellungen sowie elektronische als auch manuelle Aufzeichnungen müssen für einen vorgegebenen Zweck thematisch geordnet und bereitgestellt werden.

Dokumentation wird von Menschen für Menschen gemacht. Die Ersteller der Dokumentation tragen Beschreibungen und Aufzeichnungen zusammen, mit dem Ziel, den “Lesern“ der Dokumentation, zielsicher und schnell  Informationen zu einem speziellen Thema zu liefern.

Wofür braucht der “Leser“ diese Information? Er braucht Sie, um Verständnis für und über einen Sachverhalt zu verstehen.

Bei den Darstellungen in der Dokumentation handelt es sich um Behauptungen über Sachverhalte. Damit werden die beiden “Leser-Zielgruppen“ der Dokumentation klar. Eine Gruppe (z.B.  Prüfer)  möchte feststellen, ob die Behauptungen (Soll) mit der Wirklichkeit (Ist/War) aus Gegenwart /Vergangenheit übereinstimmen oder sie möchte nur Informationen über die vergangene Wirklichkeit erhalten und setzt die Dokumentation als zuverlässig voraus; bei der zweiten Gruppe will der Nutzer einer Sache schnell Informationen zur Handhabung dieser Sache gewinnen.

Der Ersteller der Dokumentation will und muss dem “Leser“ sowohl  einen Gesamtüberblick verschaffen als auch einen direkten Einstieg in ein spezielles Thema ermöglichen. Als probate Mittel zeigen sich hierbei das Inhaltsverzeichnis und die Präsentation des Themas in natürlicher Sprache, die sich gegenüber Knotennamen in Explorerartigen Bäumen für den “Leser“ als angenehmer und Orientierungssicherer bzw. „menschlicher“  erweist. Ein nach diesen Erfahrungen aufgebautes Werkzeug ist der Company Document Editor. Genial und einfach.

Ein interaktives Inhaltsverzeichnis, gefüttert mit der Struktur von Standards oder individuell gestaltbaren Vorlagen (Excel), jedes Thema mit einem Hilfe-Dokument oder Template, einem Owner (Person/Gruppe) und Status-Angabe versehen, erlaubt durch die Menüfreie Gestaltung einen sofortigen Einstieg in das aktive Erstellen und einordnen von beliebigen Dokumenten und Links mit Null Einarbeitungszeit. Jederzeit ist ein kompletter Export in barrierefreiem HTML möglich, der sich sowohl zur Archivierung als auch Verteilung an und Zugriff durch verschiedene Zielgruppen eignet.