|
Meilensteine eines typischen Dokumentationsprojekts
|
|
Einzelne Teilaufgaben können jederzeit pragmatisch, flexibel und unbürokratisch abgewickelt werden. Mittlere bis größere Dokumentationsprojekte orientieren sich typischerweise an folgenden Meilensteinen:
Sie erfragen, ob der Dokumentations-Dienstleister Ihr Projekt thematisch, technisch und im erforderlichen Zeitraum bearbeiten könnte.
Für ein Angebot benötigt der Dienstleister in der Regel Detailinformationen, die er am besten in einem kurzen telefonischen oder persönlichen Gespräch mit Ihnen klärt. Sehr hilfreich ist es zur Vorbereitung, wenn Sie schon vorab einige Informationen zu Ihrem Produkt zur Verfügung stellen können (z.B. Spezifikationen, Verkaufsunterlagen, Testversionen o.ä.). Soll eine bereits bestehende Dokumentation ergänzt oder überarbeitet werden, benötigt der Dienstleister auch Einblick in diese Dokumente.
|
Dienstleister erstellen Ihre Angebote meist auf Basis einer vorläufigen Aufwandsschätzung. Bei umfangreichen Projekten gibt es fast immer mehrere Lösungsalternativen. Welche davon die empfehlenswerteste ist, zeichnet sich oft erst im Rahmen einer eingehenden Zielgruppenanalyse ab.
Erst wenn Sie sich für eine bestimmte Lösungsalternative entschieden haben, lässt sich der Aufwand für die Redaktion und Umsetzung seriös im Detail kalkulieren. Viele Angebote sind daher zweigeteilt und unterscheiden zwischen Konzeptionsphase und Redaktionsphase.
|
Sie sollten überlegen, Ihren Auftrag zunächst ausschließlich für die Konzeptionsphase zu erteilen. Auf diese Weise halten Sie sich die Möglichkeit offen, nach Abschluss des Konzepts den Anbieter noch wechseln zu können, sollten Sie mit dessen Arbeit wider Erwarten nicht voll zufrieden sein. Auch können Sie auf Basis einer verabschiedeten Konzeption ein wesentlich detaillierteres und zuverlässigeres Angebot für die Redaktionsphase erwarten, was Ihre weitere Planungssicherheit deutlich erhöht.
In beiden Fällen sollten Sie dem Dokumentations-Dienstleister einen oder mehrere fachlich qualifizierte Ansprechpartner in Ihrem Hause benennen, die während des Projekts Rückfragen zur Zielgruppe und zum Produkt beantworten können.
|
Handelt es sich bei Ihrem Projekt um die Erstellung einer neuen Dokumentation, erarbeitet der Dokumentations-Dienstleister im ersten Schritt zunächst ein Konzept für diese Dokumentation (siehe auch Abschnitt "Benötigen Sie überhaupt ein Konzept?" unter Konzeption neuer Dokumentation).
Die Abstimmung des Konzepts sollte nach Möglichkeit im Rahmen einer persönlichen Präsentation vor Ort geschehen. Wichtig ist, dass dabei auch Ihre fachlichen Ansprechpartner eingebunden werden, ebenso wie das Produktmanagement und gegebenenfalls alle weiteren Redakteure, die das Konzept später umsetzen sollen.
|
Ihr Dokumentations-Dienstleister erstellt nun die Inhalte und legt Ihnen am Ende die fertigen Ergebnisse zur Überprüfung vor (häufig als "Review" bezeichnet).
Nach Möglichkeit sollten Sie das Projekt so planen, dass einzelne bereits fertige Dokumentationsteile sofort Korrektur gelesen werden. Dies verkürzt zum einen die Durchlaufzeit des Projekts, zum anderen lassen sich potenzielle systematische Wiederholungsfehler frühzeitig erkennen und beheben. Verlangen Sie von Ihrem Dokumentations-Dienstleister jedoch bitte nicht, Ihnen noch unfertige Teile auszuhändigen. Dies würde beiden Seiten nur zusätzliche Arbeit machen.
Es hat sich bewährt, das Review aufzuteilen:
| ▪ | Jeweils ein Entwickler überprüft fachlich das Kapitel zu den Funktionen, für die er auch technisch verantwortlich zeichnet. |
| ▪ | Der Produktmanager oder ein Mitarbeiter der Dokumentationsabteilung liest nochmals alle Kapitel quer und achtet dabei auf allgemeine und formale Aspekte. |
|
Der Dokumentations-Dienstleister arbeitet die im Review beschlossenen Änderungen ein und liefert Ihnen die fertige Online-Hilfe bzw. die fertige Druckvorlage.
Sie erteilen schriftlich die formale und inhaltliche Freigabe. Damit ist das Projekt abgeschlossen.
|
Regelmäßige Statusberichte
Ihr Dokumentations-Dienstleister sollte Sie regelmäßig über den Projektforschritt informieren. Bewährt haben sich z.B. wöchentliche Statusreports, aus denen alle vereinbarten Änderungen und Termine hervorgehen. Auf diese Weise haben Sie immer die volle Kontrolle über den zeitlichen und finanziellen Rahmen und können bei Bedarf frühzeitig gegensteuern.
Siehe auch
Lieferzeiten
|
|
|
|
|
 |
Software-Dokumentation
seit 1989
|
 |
Handbücher und Online-Hilfen kostengünstig aus gemeinsamer Textquelle
seit 1995 |
 |
Zahlreiche Fachvorträge und Publikationen, u.a. zu den Themen:
Informationsdesign,
Benutzerführung und Navigation,
Embedded User Assistance,
Single Source Publishing,
Autorenwerkzeuge
Prozessoptimierung in der Technischen Dokumentation
|
 |
| Goldene Diskette des Computermagazins CHIP |
 |
| Mitglied im deutschen Fachverband für Technische Kommunikation und Informationsentwicklung |
 |
Intro zeigen:  |
 |
|