Was ist ARAKonzept?
Warum ARAKonzept?
Schlechte Dokumente, die ihren Zweck nicht erfüllen, kennt jeder. Egal, ob kurz oder lang, solche Dokumente sind Geldverschwendung. Viele oft komplexe Theorien und Lehrbücher versuchen, das Wissen zu vermitteln, wie es besser geht – ohne allzu viel Erfolg. Diese Situation zu ändern ist unser Ziel. ARAKonzept fasst die wesentlichen Aspekte auf einfach nachzuvollziehende Weise zusammen – die Anleitung zur Anleitung. Erfahren Sie mehr über ARAKonzept:
Definition
ARAKonzept ist eine Methode zur systematischen Erstellung von Technischer Dokumentation. Die Methode befasst sich mit Inhalt, Struktur und Gestaltung der Dokumente und mit dem Vorgehen von der Informationsrecherche bis zur Übersetzung.
Wesentliches Merkmal ist das musterorientierte Arbeiten, das in Anlehnung an eine Methode aus dem Webdesign – das muster- (pattern-) orientierte Design – entwickelt wurde.
Ziel
Ziel der Methode ist es, mit möglichst geringem Aufwand funktionale Dokumente erstellen und übersetzen zu können, die den Anforderungen des Nutzers und ggf. den rechtlichen Anforderungen in der Branche entsprechen. Da eine Minimierung des Aufwands häufig mit den Einführung eines Redaktionssystems verbunden ist, ist es das sekundäre Ziel der Methode, die Dokumente systematisch zu modularisieren und damit systemfähig zu machen.
Theoretische Grundlagen
Die Regeln für Inhalt, Struktur und Gestaltung der Dokumente basieren auf kognitionspsychologischen Ergebnissen und strikter Zielgruppen- und Zweckorientierung. Die systematische Vorgehensweise wurde aus den Erfahrungen zahlreicher Projekten entwickelt.
Grundlegende Merkmale
Grundlegende Merkmale der Methode sind
- die generelle Systematik und Einheitlichkeit
- die Verfügbarkeit von erweiterbaren Mustern für Inhalt, Struktur, Gestaltung von Dokumenten und für Vorgehensweisen
- die Funktionalität der Dokumente
- die einfache Übersetzbarkeit der Dokumente durch standardisierte und minimierte Texte
- die einfache Erlernbarkeit der Methode
Das produktive Ergebnis der Methode sind funktionale und übersetzungsgerechte Dokumente.
Funktionalität der Dokumente bedeutet, dass jeder Text einen genau definierten Zweck - eine Funktion - hat. Dieser Zweck besteht in der Beantwortung einer bestimmten Anwenderfrage, die inhaltlich zu einem Thema - einem Topic - gehört. Daher sind die Topics in funktionale Einheiten gegliedert, die Frage-Antwort-Muster.
Übersetzungsgerecht ist ein Dokument dann, wenn es durch eindeutige und klare Sprache leicht übersetzt werden kann und nur so viel Text enthält wie für Zielgruppe und Zweck nötig.
Bestandteile
Die Bestandteile der Methode sind:
- ein Set von Qualitätskriterien für funktionale Dokumente
- ein pragmatisches Vorgehensmodell in 4 Schritten, um mit ARAKonzept eine produktspezifische Dokumentationsumgebung zu entwickeln und zu dokumentieren
- vorkonfigurierte Toolsets für Erstellung, Übersetzung und Strukturierung
- die ARA Quick-Start-Kits: branchenspezifische Systematiken für Dokumente, Vorgehensmodelle und Toolsets
Nutzen
Der Nutzen der Methode lässt sich wie folgt zusammenfassen:
- Durch die Orientierung an vorhandenen Mustern kann die systematische Dokumentationsumgebung pragmatisch und schnell aufgebaut werden.
- Die Dokumente sind systematisch modularisiert und damit optimal für ein Redaktionssystem vorbereitet.
- Die Dokumente sind funktional: Sie erklären das Produkt aus der Sicht des Anwenders und erlauben ihm den Einstieg mit jeder beliebigen Frage. Funktionale Dokumente müssen daher nicht komplett gelesen werden.
- Reduzierter Textumfang, standardisierte Texte und ein sehr systematischer Erstellungsprozess führen zu minimalen Erstellungs- und Übersetzungskosten.
- Die generelle Systematik führt zu einer Dokumentationsumgebung, in der auch Nicht-Redakteure funktionale technische Dokumentation mit minimalem Aufwand erstellen können.
