Beratung zu Technischer Dokumentation, Softwaredokumentation und Onlinedokumentation
Als Experte und freiberuflicher, selbstständiger Dienstleister für Technische Dokumentation mit Schwerpunkt Softwaredokumentation und Onlinedokumentation biete ich Ihnen folgende Beratungsdienstleistungen:
Konzeption neuer Technischer Dokumentation
Ich erstelle für Sie Konzepte für verständliche, benutzerfreundliche Handbücher, Onlinedokumentation und in die Software-Oberfläche integrierte Hilfen.
Ihr Bedarf
Haben Sie ein neues Produkt entwickelt? Benötigen Sie dazu noch eine Benutzerdokumentation, wie Handbücher, Online-Hilfen (Onlinedokumentation) oder Screencasts (Software-Videos)?
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 Technischen Dokumentation oder unterstütze Sie dabei, diese selbst umzusetzen.
Benötigen Sie überhaupt ein Konzept?
Kann ein professioneller Technischer Redakteur nicht auch ohne vorgeschaltete Konzeptphase direkt mit dem Schreiben beginnen und die Dokumentation spontan entwickeln?
Natürlich ist das möglich, aber es wird am Ende länger dauern und damit teurer werden.
- Im Laufe jedes Dokumentationsprojekts 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. 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 braucht nicht sehr umfangreich zu sein, sollte aber mindestens folgende Schlüsselfragen beantworten:
- Anforderungen der Zielgruppe
Über welches Vorwissen verfügen Ihre Kunden bereits? Wie sind die Arbeitsabläufe? Was sind die 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 eine reine Hilfe zur 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 (WebHelp) 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 Anforderungen abdecken?
Darüber hinaus kann das Konzept optional auch noch ein Beispiel-Layout und einen einfachen Prototypen umfassen.
Analyse und Optimierung bestehender Technischer Dokumentation
Als freiberuflicher, selbstständiger Dienstleister für Technische Dokumentation und Softwaredokumentation 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 und erarbeite konkrete Verbesserungsvorschläge.
Ihr Bedarf
Haben Sie bereits Technische Dokumentation (Handbücher, Online-Hilfen, Screencasts) für Ihre Produkte erstellt, sind damit aber nicht ganz zufrieden? Oder sind Sie unsicher, ob die gegenwärtige gedruckte Dokumentation oder Onlinedokumentation allen Anforderungen gerecht wird? Gibt es vielleicht sogar bereits erste Klagen von Kunden oder häufen sich Support-Anfragen zu bestimmten Themen?
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 ü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 festlegen.
Projektbegleitende Beratung
Als Experte für Technische Dokumentation biete ich Ihnen eine individuelle Beratung zu Ihren projektspezifischen Fragestellungen. Die Beratung kann entweder einmalig in Form eines Workshops stattfinden oder kontinuierlich während Ihres gesamten Projekts.
Ihr Bedarf
Erstellen Sie selbst Technische Dokumentation oder Softwaredokumentation 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 von außen.
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 Dokumente.