Dokumentationsablauf
     
  Dokumentationsablauf


Einzelne Teilaufgaben können jederzeit pragmatisch, flexibel und unbürokratisch abgewickelt werden. Mittlere bis größere Dokumentationsprojekte und Online-Hilfe-Projekte verlaufen typischerweise in folgenden Phasen:

Projektanfrage
Sie erfragen, ob der Dokumentations-Dienstleister Ihr Anliegen bearbeiten könnte: thematisch, technisch, im erforderlichen Zeitraum.
Für ein Angebot benötigt der Dokumentations-Dienstleister in der Regel weitere Informationen, die entweder bei einem persönlichen Kennenlernen vor Ort geklärt werden können, oder aber z.B. durch eine Spezifikation oder die Testversion einer Software.

Angebot
Der Dokumentations-Dienstleister erstellt Ihnen ein Angebot – entweder als Festpreisangebot oder (häufiger) auf Basis einer Aufwandsschätzung. Falls von Ihrer Seite noch kein genaues Dokumentations-Konzept mit Gliederungsentwurf besteht, ist zu diesem Zeitpunkt nur eine grobe Aufwandsschätzung möglich. Erst wenn das Dokumentations-Konzept beschlossen ist, lässt sich der Aufwand für die Redaktion seriös kalkulieren.

Auftrag
Sie erteilen den Auftrag für die Konzeptionsphase oder – falls bereits eine Konzeption vorliegt – für das Gesamtprojekt. Wichtig ist, dass Sie dem Dokumentations-Dienstleister einen oder mehrere fachlich qualifizierte Ansprechpartner benennen, die Rückfragen zum Produkt (zur Software) und zu dessen (deren) Zielgruppe beantworten können.

Grobkonzept
Der Dokumentations-Dienstleister erarbeitet ein didaktisches Grobkonzept. Bevor viel Zeit (= Geld) in die Detailarbeit eines Feinkonzepts investiert wird, sollten Sie bereits dieses Grobkonzept
mit ihm abstimmen.

Feinkonzept
Nach Abstimmung des Grobkonzepts erarbeitet der Dokumentations-Dienstleister ein Feinkonzept mit detailliertem Gliederungsentwurf. Falls erforderlich können parallel dazu bereits die Formatvorlagen und Autorenwerkzeuge für den Erstellungsprozess vorbereitet werden.

Abstimmung Feinkonzept
Die Abstimmung des Feinkonzepts 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 alle Redakteure, die das Konzept später umsetzen sollen.

Redaktion
Ihr Dokumentations-Dienstleister beginnt mit der Detailrecherche und Redaktion und legt Ihnen am Ende die fertigen Ergebnisse zur Korrektur vor (häufig als "Review" bezeichnet).
Nach Möglichkeit sollten Sie das Projekt so planen, dass fertige Dokumentationsteile sofort Korrektur gelesen werden. Potenzielle Folgefehler lassen sich so vermeiden. Verlangen Sie von Ihrem Dokumentations-Dienstleister jedoch bitte nicht, Ihnen noch unfertige Teile auszuhändigen. Sie erweisen damit weder ihm noch sich selbst einen Gefallen, ärgern sich über Dinge, die ohnehin noch behoben würden, machen sich doppelte Arbeit und gefährden letztendlich die vertrauensvolle Zusammenarbeit.

Review
In Ihrem Hause werden alle Texte, die Sie von Ihrem externen Dokumentations-Dienstleister erhalten, nochmals Korrektur gelesen. Dabei ist es sinnvoll, die Korrektur an Experten zu delegieren, die sich mit einzelnen Themen fachlich besonders gut auskennen. Eine empfehlenswerte Aufteilung ist z.B.: 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 und achtet dabei
auf die didaktischen und formalen Aspekte.

Lieferung und Freigabe
Der Dokumentations-Dienstleister arbeitet die im Review beschlossenen Punkte 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.

Projektstatus
Im Laufe des Projekts sollte Sie Ihr Dokumentations-Dienstleister regelmäßig über den Projektforschritt informieren. Bewährt haben sich z.B. wöchentliche Statusreports aus denen Sie alle vereinbarten Änderungen und Terminverschiebungen ersehen können. So gehen Sie sicher, dass der veranschlagte finanzielle Rahmen eingehalten wird und erkennen potenzielle Engpässe und Terminverzögerungen bereits im Vorfeld.