Das Vorgehensmodell

Wir müssen das Rad nicht immer wieder neu erfinden! Zwar hat jede Redaktion branchen- und produktspezifische Anforderungen. Aber es gibt ein einfaches und klares Vorgehensmodell, um Ihre Dokumentation aufzuräumen und zu systematisieren.

Auf dieser Seite erfahren Sie, wie ARAKonzept in Ihrem Unternehmen angewendet werden kann und das typische Vorgehen bei der Einführung.

Ablauf, Ziel und Ergebnis

Das Ziel des Vorgehensmodells ist eine produktspezifische Umgebung für Ihre Dokumentation. Diese soll den Qualitätskriterien von ARAKonzept folgen. Außerdem soll die Umgebung möglichst schnell und pragmatisch entwickelt und dokumentiert werden.

Dabei entstehen eine Musterdokumentation, die den Qualitätskriterien entspricht, ein eingerichtetes Tool inkl. Template und gegebenenfalls ein Redaktionsleitfaden.

Das Vorgehensmodell besteht aus den folgenden Schritten:

  • Kick-Off-Workshop
  • Musterdokumentation erstellen
  • Redaktionstool anpassen
  • Redaktionsleitfadens erstellen

Kick-Off-Workshop

Das Projekt startet mit einem Kick-Off Workshop. Dort definieren wir mit allen beteiligten Personen den Rahmen des Projektes.

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 (Termine, Budget, CI/CD-Vorgaben, Tool-Vorgaben, Sprachen etc.)

Musterdokumentation erstellen

In der Praxis hat es sich bewährt, zunächst eine Musterdokumentation entsprechend der Qualitätskriterien zu erstellen.

  • Diese ist so funktional, dass die Anwender mit dem Produkt sehr schnell arbeiten können.
  • Sie ist außerdem so systematisch modularisiert, dass die Dokumente in ein Redaktionssystem übernommen werden können.
  • Und sie ist schließlich so standardisiert und kurz, dass die Kosten für Erstellung und Übersetzung minimal sind.

Die Musterdokumentation enthält mindestens ein Muster aller Topic-Klassen und bildet alle Verlinkungsregeln ab. Wir erstellen die Musterdokumentation zunächst in einem flexiblen System ohne vordefinierte Struktur. Erst wenn sicher ist, dass die Musterdokumentation auch für weitere Produkte trägt, übertragen wir die Strukturen in ihr System.

Die Erstellung der Musterdokumentation ist außerdem eine wertvolle Basis für den Redaktionsleitfaden und die Schulung der Redakteure, da das Lernen am Beispiel meist leichter ist als das theoretische Lernen.

Redaktionstool anpassen

Wenn man vom hierarchischem Schreiben auf Topics wechselt, muss man in der Regel die Toolumgebung anpassen. Konkret heißt das, dass sich Templates und/oder Strukturen ändern, um die nicht-hierarchischen Informationseinheiten abzubilden (Frage-Antwort-Muster und Topics).

Sobald die Musterdokumentation fertig ist, kann man die definierten Mustertopics der Topic-Klassen als Vorlagen ins Template integrieren.

Redaktionsleitfaden erstellen

Je nach Anwendungszweck fällt der Redaktionsleitfaden unterschiedlich detailliert aus. Wir empfehlen dabei nicht in allen Fällen die Erstellung eines vollständigen Redaktionsleitfadens, wie er sich z. B. aus dem Funktionsdesign ergibt.

  • Kleine redaktionelle Gruppen: Eine Musterdokumentation und ein Template mit integrierten Inhaltsvorlagen gemäß den definierten Mustertopics reichen aus.
  • Größere redaktionelle Gruppen: Eine systematische Dokumentation der Definitionen – angelehnt an das Klassenkonzept – ergänzt die Musterdokumentation und das Template.
  • Einführung eines komplexen Redaktionssystems: Hier sollten alle Details vollständig und ausführlich dokumentiert werden. Daraus kann eine semantische DTD bzw. ein Schema etnwickelt werden – angelehnt an das Funktionsdesign.

Für die unterschiedlichen Detaillierungsgrade bietet ARAKonzept Muster an, die die Umsetzung erleichtern.