ARA Quick-Start-Kit Software & IT

Die wesentlichen Anforderungen an die Technische Dokumentation im Bereich Software & IT sind einander oft sehr ähnlich. Um diese komplexen und doch immer wiederkehrenden Anforderungen schnell und einfach abdecken zu können, haben wir für Sie als Softwareunternehmen das ARA Quick-Start-Kit Software & IT entwickelt. Dabei können Sie auf eine Vielzahl von fertig definierten Vorlagen speziell für diesen Bereich zurückgreifen. Ein optimal abgestimmtes Toolset ermöglicht Ihnen einen schnellen Start in Ihr Dokumentationsprojekt.
Lesen Sie, was wir Ihnen anbieten können:


Die Anforderungen an die Dokumentation

Bei der Erstellung von Software-Dokumentation sollten die individuellen Bedürfnisse der speziellen Zielgruppe im Mittelpunkt stehen. Inhalt, Zugriffswege und Navigationsstrategien müssen an diese Bedürfnisse angepasst werden.

So sind z. B. heute die weitaus meisten Zielgruppen vertraut mit Software-Oberflächen. Detaillierte Anleitungen à la "Klicken Sie hier ..." oder "Doppelklick auf ..." sind daher in vielen Fällen überflüssig.

Notwendig ist aber, dem Anwender zu befähigen, die für seine Anforderungen richtige Funktion in der Software zu finden und sie im fachlichen Sinne korrekt anzuwenden. Dazu benötigt er eine Beschreibung der Funktionen aller Menüpunkte sowie Parameter und zur Orientierung den Menübaum. Systematiken der Screens müssen zur Orientierung dargestellt werden, eine Abbildung aller Screens kann aber meist entfallen.

Schritt-für-Schritt-Anleitungen werden für grundlegende, immer wiederkehrende Bedienschritte benötigt, ebenso für komplexe Schrittfolgen. Auf die grundlegenden Bedienschritte kann dann in den komplexen Anleitungen verwiesen werden.

Entscheidend für die Verständlichkeit ist eine klare Trennung der verschiedenen Informationsarten – also in einer Anleitung keine Funktionen erklären oder umgekehrt in die Funktionsbeschreibung keine Anleitungsschritte mischen. Dies steigert neben der Verständlichkeit auch die Auffindbarkeit der Informationen.

Elemente des ARA Quick-Start-Kits Software & IT

Ausgehend von ARAKonzept haben wir ein Paket für Softwareunternehmen geschnürt.
Es besteht aus folgenden Elementen:

  • Einer prinzipiellen modularen Inhaltsstruktur für Softwaredokumentation und Online-Hilfen
  • Einem fertig eingerichteten Toolset auf Basis eines kostengünstigen, einfachen Redaktionssystems
  • Fertig definierten Vorlagen, die einfach angepasst werden können, auch an das CI Ihres Unternehmens

Die modulare Inhaltsstruktur

Ein Element des Quick-Start-Kits Software & IT ist die prinzipiell modulare Inhaltsstruktur speziell für Bedienungsanleitungen und Online-Hilfen.

Die in einer MindMap vordefinierte Inhaltsstruktur wurde aus vielen Softwareprojekten heraus immer weiterentwickelt und hat jetzt einen optimalen, stabilen Stand, kann aber natürlich an Ihre individuellen Bedürfnisse angepasst werden.

Sie ist die Basis für die Planung des Projektes und das Werkzeug für die Recherchegespräche.

Das fertige Toolset

Gut aufeinander abgestimmte und flexibel anpassbare Werkzeuge sind die Voraussetzung für einen produktiven Erstellungs- und Übersetzungsprozess. Unser fertig eingerichtetes Toolset basiert auf dem kostengünstigen und einfachen Redaktionssystem Author-it der gleichnamigen Firma.

Author-it ist ein an den Bedürfnissen der Technischen Dokumentation ausgerichtetes Redaktionssystem. Es ermöglicht bei minimalen Einstiegskosten Modularisierung und Single Source / Cross Media Publishing.

In der Dokumentation fließen Informationen aus unterschiedlichen Bereichen des Unternehmens zusammen, müssen im Vorfeld gewichtet, sortiert und strukturiert werden. Optimal geeignet ist hierfür die Darstellung als MindMap.

Vollständig definierte Vorlagen

Damit das Toolset seine volle Leistungsfähigkeit entfaltet, müssen Vorlagen vorhanden sein, die direkt eingesetzt werden können.

  • Für Author-it haben wir verschiedene Gestaltungsmuster entwickelt und die typische Dokumentationsstruktur für den Bereich Software & IT hinterlegt.
  • Im MindManager wurde eine Mind Map entwickelt, mit der schnell alle notwendigen Informationen für die Dokumentation zusammengetragen werden können. Sie spielt im Kick-Off Workshop, einem festen Bestandteil von ARAKonzept, eine entscheidende Rolle.

Unsere Leistungen

Folgende Leistungen bieten wir an:

  • Einstiegsworkshop zur Definition der Inhalte Ihrer Softwaredokumentation / Online-Hilfe
    • Basis:
      vordefinierte Inhaltsstruktur für Softwaredokumentation / Online-Hilfe
    • Ergebnisse:
      Strukturentwurf der zu erstellenden Dokumentation;
      Detaillierte Mengen- und Aufwandsabschätzung
  • Gestaltungsmuster, die mit geringem Aufwand Ihren Anforderungen angepasst werden können
  • Konfigurierte Author-it Datenbank, in die Ihre spezifischen Inhalte sofort eingegeben werden können