Das Vorgehensmodell

Das Rad muss nicht immer wieder neu erfunden werden! Auch wenn jede Redaktion branchen- und produktspezifischen Anforderungen begegnen muss, so gibt es doch ein einfaches und klares Vorgehensmodell, mit dem wir Ihre Dokumentation aufräumen und systematisieren.

Hier können Sie erfahren, wie ARAKonzept in Ihrem Unternehmen angewendet werden kann und wie wir bei einer Einführung typischerweise vorgehen:


Ablauf, Ziel und Ergebnis

Ziel des Vorgehensmodells ist es, eine produktspezifische Dokumentationsumgebung, die den Qualitätskriterien von ARAKonzept folgt, möglichst schnell und pragmatisch zu entwickeln und zu dokumentieren.

Das Ergebnis dieses Vorgehens ist eine Musterdokumentation, die den Qualitätskriterien entspricht, ein eingerichtetes Tool inkl. einem Template und gegebenenfalls ein Redaktionsleitfaden.

Das Vorgehensmodell besteht aus den folgenden Schritten:

  • Kick-Off Workshop
  • Erstellung der Musterdokumentation
  • Toolumsetzung
  • Erstellung des Redaktionsleitfadens

Kick-Off-Workshop

Um die Transparenz des Projektes zu gewährleisten, startet das Projekt mit einem Kick-Off Workshop, in dem ...

  • der Rahmen des Projektes definiert wird, sodass ein Projektüberblick sofort gegeben ist
  • alle beteiligten Personen integriert werden

 

Alle Themen des Kick-Off Workshops sind in einer MindMap vorstrukturiert und
umfassen die folgenden Punkte:

  • Überblick über das zu dokumentierende Produkt verschaffen
  • Zielgruppenbeschreibung erstellen
  • Zweckbeschreibung erstellen
  • Inhaltlichen Rahmen definieren
  • Frageninventur
  • Aufgaben- und Kenntnisinventur
  • Makrostruktur entwerfen
  • Informationen clustern (gespiegelt an typischen Musterstrukturen oder ggf. mit statistischen Methoden)
  • Rahmenbedingungen des Projektes festlegen wie beispielsweise a) Termine, b) Budget, c) CI/CD-Vorgaben, d) Tool-Vorgaben und e) Sprachen

Erstellung der Musterdokumentation

Ein praxisorientierter Ansatz zur Entwicklung einer produktspezifischen Dokumentationsumgebung ist die Erstellung einer Musterdokumentation, die den Qualitätskriterien entspricht und sich also folgendermaßen charakterisieren lässt: so funktional, dass die Anwender mit dem Produkt sehr schnell arbeiten können so systematisch modularisiert, dass die Dokumente in ein Redaktionssystem übernommen werden können so standardisiert und textlich reduziert, dass minimale Erstellungs- und Übersetzungskosten erzielt werden.

 

Die Musterdokumentation muss mindestens ein Muster aller Topic-Klassen enthalten und alle Verlinkungsregeln abbilden. Auch wenn die Einführung eines XML-Redaktionssystem geplant ist, benutzen wir zur Erstellung der Musterdokumentation ein beliebiges flexibles System (z. B. ein Help Authoring Tool), in dem Strukturen frei ohne Vordefinitionen aufgebaut werden können. Erst wenn sicher ist, dass die Musterdokumentation auch für weitere Produkte trägt, werden die Strukturen in das eigentlich gewählte System übertragen. Die Erstellung der Musterdokumentation ist eine sehr wertvolle Basis für den Redaktionsleitfaden und die Schulung der Redakteure, da das Lernen am Beispiel meist leichter fällt als das theoretische Lernen.

Toolumsetzung

Der Wechsel von hierarchischem Schreiben zu Topic-orientiertem Schreiben bedingt immer eine Änderung in der Toolumgebung, konkret am Template und/oder den Strukturvorgaben, da die nicht hierarchischen Informationseinheiten abgebildet werden müssen: die Frage/Antwortmuster und die Topics. Sobald die Musterdokumentation fertig ist, können die definierten Mustertopics der Topic-Klassen als verallgemeinerte Vorlagen ins Template integriert werden. Wenn das Ziel des Projektes die Einführung eines Redaktionssystems ist, bieten sich für die Erstellung der Musterdokumentation Help Authoring Tools an.

Erstellung des Redaktionsleitfadens

Wir empfehlen nicht in allen Fällen die Erstellung eines vollständigen Redaktionsleitfadens, wie er sich z. B. aus dem Funktionsdesign ergibt. Der Detaillierungsgrad des Redaktionsleitfadens hängt in ARAKonzept von dem Anwendungszweck ab: Kleine redaktionelle Gruppen: Musterdokumentation und Template mit integrierten Inhaltsvorlagen gemäß den definierten Mustertopics reicht aus Größere redaktionelle Gruppen: systematische tabellenorientierte Dokumentation den Definitionen – an Klassenkonzept angelehnt – ergänzt Musterdokumentation und Template Einführung eines XML-Redaktionssystems: vollständige ausführliche Dokumentation aller Details, sodass daraus eine semantische DTD abgeleitet werden kann – an Funktionsdesign angelehnt Für die unterschiedlichen Detaillierungsgrade bietet ARAKonzept Muster, die die Umsetzung erleichtern.