Beratung zu Technischer Dokumentation, Softwaredokumentation, Onlinedokumentation

Mit meinem Hintergrund von über 25 Jahren Erfahrung im Konzipieren und Erstellen von Technischer Dokumentation im Allgemeinen und von Softwaredokumentation im Besonderen biete ich Ihnen folgende Beratungsleistungen:

Konzeption neuer Dokumentation

Als Dienstleister für Technische Dokumentation erstelle ich Konzepte für verständliche, benutzerfreundliche Handbücher, Onlinedokumentation und in eine Software-Oberfläche integrierte Hilfen.

Ihr Bedarf

Haben Sie ein neues Produkt oder eine neue Software entwickelt? Benötigen Sie dazu noch eine Benutzerdokumentation, wie Handbücher, Online-Hilfen (Onlinedokumentation, Help-Site) oder Screencasts?

Meine Dienstleistungen

Auf Basis einer eingehenden Zielgruppenanalyse erarbeite ich einen konkreten Realisierungsvorschlag für die Technische Dokumentation und User Assistance zu Ihrem Produkt – von den didaktischen Grundlagen bis hin zum detaillierten Strukturentwurf.

Optional übernehme ich nach Abschluss des Konzepts gerne auch die Erstellung der entwickelten Lösung oder unterstütze Sie dabei, diese selbst umzusetzen.

Benötigen Sie überhaupt ein Konzept?

Kann ein professioneller Technischer Redakteur nicht auch ohne vorgeschaltete Konzeptphase mit dem Schreiben beginnen und die Dokumentation spontan entwickeln?

Natürlich ist das möglich, aber es wird am Ende der teurere und längere Weg werden. Warum?

▪Im Laufe jedes Projekts sind viele Entscheidungen zu treffen. Diese Entscheidungen können entweder bereits im Rahmen eines vorgeschalteten Konzepts erfolgen oder aber erst unmittelbar beim Schreiben der Texte. Beides dauert gleich lange.
Bis hier ist durch ein vorgeschaltetes Konzept also noch kein Gewinn an Zeit und Kosten erkennbar – allerdings auch kein Verlust.

▪Viele Entscheidungen bedingen sich gegenseitig. Daher müssen später immer einige der zu Beginn getroffenen Entscheidungen wieder revidiert werden.
Solange Sie noch am Konzept arbeiten, geht die Rücknahme einer Entscheidung schnell und kostet nichts: Sie müssen lediglich Ihre Meinung ändern, das ist alles. Wenn jedoch schon mit dem Erstellen der Dokumentation begonnen wurde, kann es langwierig und teuer werden. Sie müssen alles bis zu diesem Zeitpunkt Erstellte wieder überarbeiten. Je mehr schon existiert, desto teurer wird es.

Beantworten Sie nun die Frage selbst, was am Ende der sicherere, kostengünstigere und schnellere Weg ist …

Fragen, die ein Dokumentationskonzept beantworten sollte

Ein solides Dokumentationskonzept muss nicht sehr umfangreich sein, sollte aber zumindest folgende Schlüsselfragen beantworten:

▪Anforderungen der Zielgruppe
Über welches Vorwissen verfügen Ihre Kunden bereits? Wie sind die Arbeitsabläufe? Was sind ihre primären Ziele und Aufgaben Ihrer Kunden?

▪Weitere zwingende Anforderungen
Welche fundamentalen Rahmenbedingungen sind zu berücksichtigen, wie z. B. Termine, Budget, Häufigkeit zukünftiger Überarbeitungen, Übersetzbarkeit. Muss sich die neue Dokumentation in ein bestimmtes Schema bereits existierender Dokumente einfügen? Im Falle von Software: Welches Betriebssystem und welche Programmiersprache werden verwendet, welche Browser sind auf den Computern der Benutzer verfügbar? Im Falle von Software auf mobilen Geräten oder Operator-Panels an Maschinen: Welche Bildschirmauflösung steht zur Verfügung? Gibt es eine Maus und eine vollwertige Tastatur oder einen berührungsempfindlichen Bildschirm (Touchscreen)?

▪Informationstypen
Welche Art von Informationen benötigen Ihre Kunden: allgemeine Grundlageninformationen, detaillierte Referenzinformationen, schrittweise Anleitungen? Muss auch allgemeines Domänenwissen über das Umfeld der Anwendung vermittelt werden oder reicht die reine Beschreibung der Produktbedienung?

▪Medien
Wird es ein gedrucktes Handbuch (PDF), eine kontextsensitive Online-Hilfe oder beides geben? Welche Informationen kommen ins Handbuch, welche in die Onlinedokumentation?

▪Dokumente
Welche Dokumente werden erstellt? Kommen alle Informationen in ein einziges Dokument oder werden verschiedene Handbücher für unterschiedliche Anwendungszwecke und Benutzergruppen vorgesehen?

▪Hilfe-Formate, kontextsensitive Hilfe-Aufrufe
Welches Hilfe-Format wird verwendet? Standard HTML oder ein spezielles Hilfe-Format? Können kontextsensitive Hilfe-Aufrufe vorgesehen werden? Wer weist die erforderlichen Hilfe-IDs zu: Programmierer oder Hilfe-Autoren?

▪Navigation
Welche Navigationselemente sollen in den Dokumenten und Hilfen angeboten werden? Wo sind Links / Querverweise sinnvoll, wo nicht?

▪Struktur, Gliederung
Wie sollen die Dokumente strukturiert werden? Welche Kapitel / Topics sind vorzusehen?

▪Erstellung, Produktion
Welche Erstellungswerkzeuge werden verwendet? Können diese Werkzeuge auch alle heute und in Zukunft benötigten Fremdsprachen handhaben?

Darüber hinaus kann das Konzept optional auch noch Beispiel-Layouts und einfache Prototypen umfassen.

Analyse und Optimierung bestehender Technischer Dokumentation

Als Dienstleister für Technische Dokumentation und Software-Dokumentation verbessere und optimiere ich Handbücher, Online-Hilfen und Screencasts (Software-Videos). Ich analysiere Ihre Dokumente sowohl aus Benutzersicht als auch im Hinblick auf den Erstellungsprozess. Das Ergebnis ist eine verständliche, benutzerfreundliche und kostengünstige Dokumentation.

Ihr Bedarf

Meine Dienstleistungen

Ich analysiere Ihre Dokumente sowohl aus Benutzersicht als auch im Hinblick auf den Erstellungsprozess und erarbeite Verbesserungsvorschläge. Die zentralen Schwachstellen lassen sich meist schnell erkennen, sodass der Aufwand in der Regel sehr überschaubar bleibt.

Als Ergebnis erhalten Sie entweder eine schriftliche Zusammenfassung der Analyse und der daraus abgeleiteten Verbesserungsvorschläge, oder ich präsentiere die Ergebnisse persönlich bei Ihnen im Unternehmen. Im Fall einer persönlichen Präsentation können wir unmittelbar eine vertiefende Diskussion anschließen und eine konkrete Umsetzungsstrategie ausarbeiten.

Beratung bei der Auswahl von Redaktionssystemen

Ich berate Sie neutral und unabhängig bei der Auswahl der richtigen Tools (Autorensysteme, Redaktionssysteme, Help-Authoring-Tools) für die Erstellung Technischer Dokumentation, insbes. Software-Dokumentation (Handbücher, Online-Hilfen). Gerne unterstütze ich Sie neben der Beratung auch tatkräftig beim Erstellen der notwendigen Formatvorlagen und beim Einrichten der Produktionsprozesse in den gewählten Werkzeugen.

Ihr Bedarf

Benötigen Sie ein geeignetes Autorensystem, um Softwaredokumentation (Handbücher, Online-Hilfen, Help-Site) selbst zu erstellen? Oder sind Sie mit Ihren derzeitigen Help-Authoring-Tools oder Onlinedokumentations-Tools nicht mehr voll zufrieden?

Strategische Entscheidungen an dieser Stelle haben weitreichende Auswirkungen:

▪auf die Qualität der Ergebnisse

▪auf die Effizienz bei Erstellung, Produktion und Übersetzung

▪auf die Prozesssicherheit in terminkritischen Situationen

Sollte sich Ihre Wahl im Nachhinein als unglücklich erweisen, wird es teuer: Es fallen erneut Lizenzkosten an, Sie benötigen abermals eine Einarbeitung aller beteiligten Mitarbeiter, Sie müssen noch einmal Formatvorlagen und Produktionsprozesse aufsetzen und Sie müssen die bereits erstellten Dokumente konvertieren.

Meine Dienstleistungen

Mit dem Hintergrund langjähriger Redaktionserfahrung analysiere ich systematisch Ihre spezifischen Anforderungen. Auf Grundlage dieser Anforderungen stelle ich Ihnen eine Vorauswahl der Werkzeuge vor, die diesen Anforderungen am besten gerecht werden. Zu jeder Lösung erkläre ich Ihnen die spezifischen Vorteile und Nachteile.

Somit bekommen Sie eine fundierte Entscheidungsgrundlage. Ich bin frei von bestimmten Vertriebsinteressen und berate Sie absolut neutral und herstellerunabhängig. Aus diesem Grund übernehme ich auch nicht die Beschaffung bestimmter Tools. Wenden Sie sich hierzu bitte direkt an den betreffenden Hersteller.

Gerne unterstütze ich Sie auch beim Erstellen der notwendigen Formatvorlagen und beim Einrichten der Produktionsprozesse in der gewählten Software.

Projektbegleitende Beratung

Als Experte für Technische Dokumentation biete ich Ihnen eine individuelle Beratung zu Ihren projektspezifischen Fragestellungen. Die Beratung kann entweder nur in Form eines einmaligen Workshops stattfinden oder kontinuierlich während Ihres gesamten Projekts.

Ihr Bedarf

Möchten Sie Technische Dokumentation oder Softwaredokumentation selbst erstellen und benötigen dabei kompetenten Rat? Oder möchten Sie einer bereits existierenden Technischen Dokumentation neue Impulse geben, sie modernisieren oder verständlicher machen?

Meine Dienstleistungen

In Form eines individuellen Workshops vermittle ich Ihnen gerne das erforderliche Know-how und unterstütze Sie kompetent bei der Lösungsfindung zu Ihren speziellen Fragen. Dabei profitieren Sie sowohl von meiner langjährigen Erfahrung im Bereich Technischer Dokumentation als auch von meiner unvorbelasteten Sicht auf Ihr Projekt als Außenstehender.

Je nach Ihren Anforderungen und Fragestellungen dauert ein solcher Workshop typischerweise ein bis zwei Tage.

Gerne begleite ich Sie auf Wunsch auch nach Abschluss des Workshops noch eine Zeit lang weiter und gebe Ihnen Feedback zur kontinuierlichen Optimierung Ihrer Arbeit.

Siehe auch meine weiteren Dienstleistungen.