Was ist ARAKonzept?

ARAKonzept ist eine von uns entwickelte Methode zur Standardisierung und Strukturierung Technischer Dokumentation. Mit ARAKonzept können Sie Herausforderungen rund um das Thema der Technischen Dokumentation angehen und erfolgreich umsetzen.

Warum ARAKonzept?

Alle kennen schlechte Dokumente, die ihren Zweck nicht erfüllen. Solche Dokumente verschwenden Geld, egal ob sie kurz oder lang sind. Viele oft komplexe Theorien und Lehrbücher versuchen das Wissen zu vermitteln, wie es besser geht – leider ohne allzu großen Erfolg. Wir möchten diese Situation ändern.

Wir haben die Methode ARAKonzept entwickelt, um den typischen Herausforderungen der Technischen Dokumentation zu begegnen und auf einfache Weise gut verständliche Dokumente zu erstellen.

ARAKonzept fasst die wesentlichen Aspekte für verständliche Dokumente einfach zusammen. Sie ist sozusagen die Anleitung zur Anleitung.

Definition

ARAKonzept ist eine Methode, um Technische Dokumentation systematisch zu erstellen. Sie befasst sich mit Inhalt, Struktur und Gestaltung der Dokumente sowie dem Vorgehen von der Informationsrecherche bis zur Übersetzung. Wesentliches Merkmal ist das musterorientierte Arbeiten, das in Anlehnung an eine Methode aus der Software-Entwicklung („Design Patterns“) entwickelt wurde.

Ziel der Methode

ARAKonzept verfolgt zwei Ziele:

  • Sie lernen, funktionale Dokumente zu erstellen und zu übersetzen, die den Anforderungen Ihrer Nutzer und Branchen gerecht werden.
  • Außerdem werden die Dokumente systematisch modularisiert. Erst dann können Sie sie sinnvoll in Redaktionssystemen verwenden.

Theoretischer Hintergrund

Die Regeln für Inhalt, Struktur und Gestaltung der Dokumente basieren auf Erkenntnissen der Kognitionspsychologie und auf Zielgruppen- und Zweckorientierung. Diese systematische Vorgehensweise haben wir aus den Erfahrungen zahlreicher Projekte entwickelt.

Grundlegende Merkmale

Die grundlegenden Merkmale von ARAKonzept sind:

  • Systematisch und einheitlich.
  • Erweiterbare Muster für Inhalt, Struktur und Gestaltung von Dokumenten.
  • Es gibt ein Vorgehensmodell.
  • Dokumente sind funktional: Jeder Text einen genau definierten Zweck.
  • Einfache Übersetzungen durch standardisierte und schlanke Texte.
  • Leicht zu erlernen.

Im Ergebnis erstellen Sie funktionale und übersetzungsgerechte Dokumente. Das bedeutet:

Die Dokumente werden funktional, weil jeder Text einen genau definierten Zweck – eine Funktion – hat. Der Zweck besteht darin, genau eine Anwenderfrage zu beantworten, die inhaltlich zu einem Thema gehört. Ein Thema enstpricht einem Topic. Daher sind die Topics in funktionale Einheiten gegliedert, sogenannte Frage-Antwort-Muster.

Übersetzungsgerecht sind die Dokumente, wenn sie durch eindeutige und klare Sprache leicht zu übersetzen sind. Und wenn sie nur so viel Text enthalten, wie für Zielgruppe und Zweck nötig sind.

Bestandteile

Die Bestandteile der Methode sind:

  • Es gibt ein Set von Qualitätskriterien für funktionale Dokumente.
  • Dazu gibt es ein pragmatisches Vorgehensmodell in 4 Schritten, um eine produktspezifische Dokumentationsumgebung zu entwickeln und zu dokumentieren.
  • Und schließlich sind vorkonfigurierte Pakete aus Tools und Templates für die Erstellung, Übersetzung und Strukturierung verfügbar.

Nutzen

Welchen Nutzen bringt Ihnen nun ARAKonzept?

  • Durch die Orientierung an vorhandenen Mustern können Sie pragmatisch und schnell eine systematische Dokumentationsumgebung aufbauen.
  • Die Dokumente sind systematisch modularisiert und damit optimal für ein Redaktionssystem vorbereitet.
  • Die Dokumente sind funktional. Sie erklären das Produkt aus der Anwendersicht und erlauben 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 niedrigeren Kosten für Erstellung und Übersetzung.
  • Die generelle Systematik lässt eine Dokumentationsumgebung entstehen, in der auch Nicht-Redakteure funktionale Technische Dokumentation mit geringem Aufwand erstellen können.