Outsourcing Technischer Dokumentation

Wenn Sie vor der Überlegung stehen, die Erstellung Ihrer Technischen Dokumentation ganz oder teilweise auszulagern, helfen Ihnen möglicherweise folgende Informationen bei der Entscheidungsfindung.

Vor- und Nachteile des Outsourcings Technischer Dokumentation

Welches sind die Vorteile und Nachteile des Outsourcen Technischer Dokumentation? Was sind die Vorteile und was sind die Nachteile, wenn Handbücher oder Online-Hilfen außer Haus durch einen externen Dienstleister erstellt werden? Ist es möglich und sinnvoll, Technische Dokumentation außer Haus erstellen zu lassen?

Vorteile Nachteile Outsourcing Technischer Dokumentation

Bedenken Nr.1: Kosten

„Outsourcing Technischer Dokumentation ist zu teuer.“

Der eine oder andere Stundensatz erscheint auf den ersten Blick vielleicht hoch. Im Gegensatz zu internen Mitarbeitern bezahlen Sie bei einem Dokumentations-Dienstleister jedoch ausschließlich produktive Arbeitszeiten und tragen keine zusätzlichen Lohnnebenkosten, Krankheitstage, Urlaub, Weiterbildung usw. Auch sparen Sie die Kosten für einen Arbeitsplatz, einschließlich spezieller Software.

In Summe ist daher ein externer Dokumentations-Dienstleister nur selten wesentlich teurer als ein interner Mitarbeiter. Dafür gewinnen Sie an Flexibilität in Zeiten ungleichmäßigen Arbeitsaufkommens.

Bedenken Nr.2: Fachliche Kompetenz

„Ein Außenstehender kann unsere Produkte niemals so gut in allen Einzelheiten verstehen wie wir selbst.“

Natürlich muss ein neu beauftragter Dokumentations-Dienstleister zu Beginn viel über Ihr Produkt und über Ihre Kunden lernen. Dies kostet zwar eine gewisse Zeit, bringt aber einen ganz entscheidenden Vorteil: Niemand kann eine Technische Dokumentation benutzerfreundlicher gestalten als jemand, der selbst denselben Lernprozess durchläuft wie die Benutzer. Für Ihre internen Mitarbeiter sind viele Dinge bereits selbstverständlich, die Benutzern noch längst nicht klar sind. Schreiben interne Mitarbeiter die Dokumentation, kommen die entsprechenden Themen dort oft zu kurz. Die Dokumentation ist dann, insbesondere für Anfänger, nur schwer verständlich.

Bedenken Nr. 3: Zeitaufwand

„Wenn wir die Technische Dokumentation an einen externen Dienstleister outsource, haben wir viel Aufwand für Projektmanagement und Betreuung.“

Selbstverständlich müssen Managementzeiten in die Kosten-Nutzen-Bilanz mit eingehen. Kein Dokumentationsprojekt kommt ganz ohne Planung, Interviews und Korrekturzyklen aus. Bedenken Sie aber auch, dass unter dem Strich die meisten dieser Arbeiten genauso anfallen, wenn Sie Ihre Handbücher oder Online-Hilfen durch interne Mitarbeiter erstellen lassen.

Bedenken Nr.4: Abhängigkeit

„Durch das Outsourcing begeben wir uns in Abhängigkeit. Was ist, wenn der Dokumentations-Dienstleister ausfällt oder zu teuer wird?“

Zugegeben: Ein gewisses Ausfallrisiko lässt sich nie ganz ausschließen. Aber besteht dasselbe Risiko nicht genauso bei internen Mitarbeitern? Auch interne Mitarbeiter können erkranken oder kündigen.

Wichtig bei der Auswahl Ihres Dokumentations-Dienstleisters ist es, dass Sie sich stets die Rechte an allen Formatvorlagen, Texten und Quellcodes (speziell bei Online-Hilfen, Onlinedokumentationen) sichern. Auch sollte der Produktionsprozess beim Dokumentations-Dienstleister so ausgelegt sein, dass Sie diesen Prozess jederzeit selbst im eigenen Haus abbilden können. Konkret: Es wird frei verkäufliche Standardsoftware eingesetzt. Alle Dokumentationsprozesse sind selbst ausreichend dokumentiert. Falls individuelle Zusatztools und Skripte programmiert wurden, sind diese ebenfalls ausreichend dokumentiert und stehen Ihnen mit den erforderlichen Nutzungsrechten zur Verfügung.

Vorteile

Wie Sie sehen konnten, sind die meisten Bedenken zwar nicht unbegründet, bei umsichtiger Auswahl Ihres Dienstleisters überwiegen aber oft die Vorteile.

  • Qualität
    Häufig haben junge oder mittlere Unternehmen keine eigene Dokumentationsabteilung. Dokumentationsaufgaben werden von Entwicklung, Support, Produktmanagement oder Marketing übernommen. Meist fehlt hier jedoch die erforderliche Ausbildung und Erfahrung im Bereich Technischer Dokumentation. Auch ist das Schreiben von Handbüchern und Hilfetexten nicht immer eine der beliebtesten Aufgaben. Ein externer Dokumentations-Dienstleister ist Spezialist auf diesem Gebiet. Er arbeitet hier meist ungleich effizienter und auf einem anderen Qualitätsniveau.
  • Flexibilität
    Bei Erscheinen eines neuen Produkts oder einer neuen Produktversion entstehen in fast jeder Dokumentationsableilung Engpässe. In solchen Spitzenzeiten können Sie einen externen Dokumentations-Dienstleister gezielt einsetzen, um die Durchlaufzeit Ihres Projekts zu verkürzen.
  • Entlastung
    Nicht selten soll eine Technische Dokumentation oder Online-Hilfe mal eben „nebenbei“ von Mitarbeitern aus Entwicklung, Produktmanagement oder Marketing erstellt werden. Dies bindet wertvolle Ressourcen. Durch die Fremdvergabe der Dokumentation verschaffen Sie sich wieder Zeit für Ihre Kernaufgaben.
  • Spezielles Know-how
    Niemand kann auf jedem Gebiet Experte sein. Bei außergewöhnlichen Aufgabenstellungen kann ein spezialisierter Dienstleister wesentlich effizienter arbeiten.
  • Neue Ideen, neutraler Blick
    Je länger man sich selbst mit einer Sache beschäftigt, desto schwieriger wird es, diese Sache nochmals unvoreingenommen zu reflektieren und neue Ideen zur weiteren Verbesserung zu entwickeln. Für einen Außenstehenden ist dies wesentlich einfacher.

Muss Ihr Dokumentationsdienstleister vor Ort arbeiten?

Wie weit sollte ein Dienstleister, der Ihre Technische Dokumentation erstellt, maximal von Ihrem Standort entfernt sein? Ist es sinnvoll, Software-Dokumentation wie Handbücher, Online-Hilfen oder Screencasts von einem Dienstleister erstellen zu lassen, der nicht vor Ort ansässig ist?

Dienstleister Technische Dokumentation vor Ort

Sollte Ihr Dokumentations-Dienstleisterer seinen Firmensitz in Ihrer Nähe haben? Muss er bei Ihnen vor Ort arbeiten, oder erstellt er Ihre Technische Dokumentation besser in seinen eigenen Räumen?

Gezielte Termine

Jede Präsenz vor Ort erleichtert zwar die Recherche, dafür müssen Sie aber auch einen geeigneten Arbeitsplatz bereithalten. Erschwerend kommt hinzu, dass Prototypen neuer Produkte häufig nur in sehr begrenzter Anzahl vorhanden sind und daher nur kurzzeitig für Demos und Tests zur Verfügung stehen.

Aus diesen Gründen ist es meistens am effizientesten, wenn Ihr Dokumentations-Dienstleister mit Ihnen konkrete Termine zur Recherche bei Ihnen vor Ort vereinbart, die Inhalte dann jedoch in seinem eigenen Büro ausarbeitet. Zur Vorbereitung der Treffen sollte der Dienstleister (soweit vorhanden) auch Pflichtenhefte, Spezifikationen und sonstiges schriftliches Material für seine Recherche nutzen. Der Zeitaufwand Ihrer Mitarbeiter für Rückfragen lässt sich dadurch minimieren. Schließlich soll aus der geplanten Ent-lastung keine Be-lastung werden!

Spezialfall Software

Wenn es sich bei Ihrem Produkt um reine Software handelt, kann Ihr Dokumentations-Dienstleister häufig anhand einer Testversion oder über einen Online-Zugang komplett im eigenen Büro recherchieren. Termine bei Ihnen vor Ort können sich dann auf Interviews Ihrer Produktexperten beschränken. Viele Rückfragen lassen sich aber auch telefonisch oder per E-Mail klären, oder über Skype und vergleichbare Dienste.

Empfehlung

Generell lässt sich zusammenfassen:

  • Je intensiver direkt am Produkt recherchiert werden muss, desto größer sollte die Präsenz des Dokumentations-Dienstleisters vor Ort sein. Fast immer reichen dafür jedoch einige konkrete, gut vorbereitete Einzeltermine aus.
  • Im Software-Bereich (Softwaredokumentation) ist es erfahrungsgemäß kein Problem, wenn der Firmensitz des Kunden und der des Dokumentations-Dienstleisters mehrere hundert Kilometer auseinanderliegen.

Meilensteine eines typischen Dokumentationsprojekts

Wie ist der Ablauf eines typischen Dokumentationsprojekts? Welche Meilensteine sollten Sie in einem Projekt zur Erstellung Technischer Dokumentation, insbesondere Software-Dokumentation vorsehen? Welche Aufgaben und Schritte gibt es auf dem Weg zur Erstellung eines Handbuchs, einer Online-Hilfe oder eines Screencasts?

Meilensteine Projekt Technische Dokumentation

Einzelne Teilaufgaben können jederzeit pragmatisch, flexibel und unbürokratisch abgewickelt werden. Mittlere bis größere Dokumentationsprojekte orientieren sich typischerweise an folgenden Meilensteinen:

Projektanfrage

Für ein Angebot benötigt ein Dokumentations-Dienstleister in der Regel einige Informationen, die Sie am besten in einem kurzen telefonischen Gespräch mit ihm klären. Sehr hilfreich ist es zur Vorbereitung, wenn Sie schon vorab einige Fakten 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.

Angebot

Dienstleister erstellen Ihre Angebote meist auf Basis einer vorläufigen Aufwandsschätzung. Bei umfangreichen Projekten gibt es fast immer mehrere Lösungsalternativen. Welche Alternative 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 beziffern. Viele Angebote sind daher zweigeteilt und unterscheiden zwischen Konzeptionsphase und Redaktionsphase.

Auftrag

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.

Konzeption

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.

Die Abstimmung des Konzepts sollte nach Möglichkeit im Rahmen einer persönlichen Präsentation vor Ort erfolgen. Wichtig ist, dass dabei auch Ihre fachlichen Ansprechpartner eingebunden werden, ebenso das Produktmanagement und gegebenenfalls alle weiteren Redakteure, die das Konzept später umsetzen sollen.

Redaktion und Review

Ihr Dokumentations-Dienstleister erstellt 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 möglichst frühzeitig 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 deren Umsetzung er auch technisch verantwortlich ist.
  • Der Produktmanager oder ein Mitarbeiter der Dokumentationsabteilung liest nochmals alle Kapitel quer und achtet dabei auf allgemeine und formale Aspekte.

Freigabe und Lieferung

Der Dokumentations-Dienstleister arbeitet die im Review beschlossenen Änderungen ein und liefert Ihnen die fertige Druckvorlage (PDF) oder Online-Hilfe.

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.

Bearbeitungsdauer für die Erstellung einer Technischen Dokumentation

Wie lange dauert die Erstellung Technischer Dokumentation, insbesondere von Software-Dokumentation (Handbücher, Online-Hilfen, Screencasts)?

Bearbeitungsdauer der Erstellung Technischer Dokumentation

Nicht selten stehen neue Produkte bereits kurz vor Auslieferung, nur ein Benutzerhandbuch oder eine Online-Hilfe fehlen noch. Erschrecken Sie nicht, wenn Sie die nachfolgenden Zahlen lesen. Wenn Sie unter Termindruck stehen, können wir im ersten Schritt auch eine Übergangslösung fertigstellen und diese dann später schrittweise ausbauen.

Zeit für die Bearbeitung

Die Bearbeitungsdauer für die Erstellung Technischer Dokumentation ist direkt proportional zum Umfang der zu erstellenden Handbücher und Online-Hilfen. Wie bei der Abschätzung der Kosten können Sie auch hier mit folgender Faustformel rechnen:

  • ca. 1 Stunde pro Seite für das Überarbeiten bereits bestehender Dokumente
  • ca. 2 Stunden pro Seite für das Schreiben neuer Dokumente

Zeit für den Korrekturlauf

Am Ende der Redaktionsphase steht in der Regel ein Korrekturlauf (Review), in dessen Rahmen Sie die Texte auf inhaltliche Richtigkeit prüfen und Änderungswünsche einbringen können. Die Zeit für dieses Review und für das Einarbeiten möglicher Korrekturen kommt zur reinen Bearbeitungszeit hinzu.

Angebote vergleichen

Worauf sollten Sie achten, wenn Sie die Angebote von Dienstleistern zur Erstellung Technischer Dokumentation, insbesondere Software-Dokumentation vergleichen und bewerten wollen (z. B. für Handbücher, Online-Hilfen, Screencasts)?

Angebote zur Erstellung Technischer Dokumentation vergleichen

Das vordergründig billigste Angebot ist nicht immer auch das preiswerteste Angebot mit dem besten Kosten-Nutzen-Verhältnis. Folgende Punkte sollten Sie beim Vergleich unterschiedlicher Angebote für die Erstellung technischer Dokumentation nicht vernachlässigen:

Ist die Lösung ganzheitlich?

  • Berücksichtigt das Angebot auch eine vorausgehende Konzeption des Dokuments? Ein „intuitives“ Schreiben erscheint im ersten Schritt vielleicht schneller, ist am Ende aber immer langsamer und teurer.
  • Sind die Themen Übersetzbarkeit und Dokumentationspflege (spätere Aktualisierungen bei Produkt-Updates) berücksichtigt?
  • Werden die Dokumente modular strukturiert, sodass Sie später einzelne Teile in anderen Dokumenten oder Medien wiederverwenden können?

Welche Zusatzarbeiten sind inbegriffen?

  • Ist die Erstellung von Formatvorlagen im Angebot enthalten? Häufig müssen auch bereits vorhandene Formatvorlagen noch ergänzt oder angepasst werden. Ist dies berücksichtigt?
  • Ist die Erstellung von Grafiken und Bildschirmabbildungen (Screenshots) im Angebot enthalten oder müssen Sie diese selbst zuliefern?
  • Ist die Erstellung eines Stichwortverzeichnisses (Index) im Angebot enthalten?
  • Ist mindestens ein Korrekturlauf (Review) vorgesehen und ist der Aufwand für das Einarbeiten von Korrekturen und Änderungswünschen mit einkalkuliert?

Wer bearbeitet Ihre Dokumente?

  • Klären Sie rechtzeitig, wer Ihre Dokumente bearbeiten wird und über welche Qualifikation und Erfahrung diese Person verfügt. Klären Sie auch, ob Ihnen derselbe Bearbeiter gegebenenfalls auch für zukünftige Aktualisierungen der Dokumentation zur Verfügung stehen wird. Jeder spätere Bearbeiterwechsel verursacht Zusatzaufwand und birgt das Risiko schwankender Qualität.
  • Ist der Bearbeiter ein Volontär oder Praktikant, verlangen Sie einen deutlichen Preisabschlag.

Wie einfach können Sie bei Bedarf den Dienstleister wechseln?

  • Bekommen Sie mit der Lieferung nur die fertigen Ergebnisse (z. B. PDF-Dateien) oder auch alle Quelldaten (z. B. Microsoft-Word-Dateien) und Formatvorlagen, einschließlich der entsprechenden Nutzungsrechte? Dies ist ein entscheidender Punkt, falls Sie später den Dienstleister wechseln oder die Dokumentation selbst weiterpflegen möchten.
  • Welche Erstellungswerkzeuge werden eingesetzt? Sind diese Programme frei auf dem Markt erhältlich oder binden Sie sich durch die Wahl untrennbar an Ihren Dienstleister? Wenn Sie Handbücher und Online-Hilfen aus einer gemeinsamen Textquelle generieren möchten (Single-Source-Publishing), achten Sie darauf, dass Sie auch alle eventuell individuell erstellten oder angepassten Konverter erhalten, einschließlich der entsprechenden Nutzungsrechte.

Argumentationshilfe gegenüber Ihren Vorgesetzten

Sie möchten Ihren Chef von der Sinnhaftigkeit einer externen Beratung, Schulung oder Erstellung Technischer Dokumentation überzeugen? Hier finden Sie eine Argumentationshilfe.

Argumente für externe Beratung / Schulung / Dienstleistungen:

  • Know-how: Durch eine externe Beratung profitieren wir von speziellem Know-how, ohne selbst in eine entsprechende Weiterbildung oder Recherche investieren zu müssen. Einmal aufgesetzte Strukturen und Prozesse können wir auch nach Abschluss der Dienstleistung selbst weiternutzen. Eine gezielte Schulung kann uns mit minimalem Aufwand punktuell genau dort voranbringen, wo wir noch zusätzliche Kompetenzen brauchen.
  • Kosten: Durch die Wahl der optimalen Tools und Prozesse steigern wir nicht nur die Qualität der Ergebnisse, sondern erstellen und pflegen die Dokumentation zukünftig billiger. Verglichen mit den Kosten, die typischerweise in die Erstellung und vor allem auch in die regelmäßige Aktualisierung einer Dokumentation fließen, sind die Kosten für eine fundierte Tool-Auswahl schnell amortisiert.
  • Kapazitäten: Extern geleistete Arbeit verschafft uns intern entsprechend mehr Kapazitäten. Wir können uns auf unsere Kernaufgaben konzentrieren und gewinnen auf diese Weise Flexibilität. Letztendlich bringen wir dadurch unsere Produkte schneller auf den Markt und können rascher auf sich wandelnde Anforderungen reagieren. Die Tatsache, die anstehenden Aufgaben zeitlich ausreichend gut bewältigen zu können, steigert unsere Mitarbeiterzufriedenheit und schafft mehr Raum für Kreativität und Weitblick.
  • Perspektivenwechsel: Ein externer Berater hat einen unbelasteten und damit objektiven Blick auf die Dinge. Wir selbst sehen bestimmte Lösungen unter Umständen gar nicht mehr oder schließen sie aus historischen, inzwischen eigentlich längst hinfälligen Gründen von vornherein aus.

Mögliche Einwände und Gegenargumente:

  • „Ein externer Dienstleister ist viel zu teuer.“
    Gegenargument: „Das stimmt fast immer nur auf den ersten Blick. Wenn wir die kompletten Lohn- und Arbeitsplatzkosten eines vergleichbar qualifizierten internen Mitarbeiters berücksichtigen, sind die Kosten durchaus vergleichbar. Vergessen Sie nicht Lohnnebenkosten, Urlaub, Krankheit, Weiterbildung, Büromiete, Computer, Software, Versicherungen, Steuern, …“
  • „Die Kosten für das Projekt sind viel zu hoch. Kein Kunde zahlt einen Cent mehr, nur weil er eine bessere Dokumentation bekommt.“
    Gegenfrage: „Können wir es uns leisten, die Investition in eine bessere Dokumentation nicht zu tätigen? Wie viele Kunden verlieren wir durch eine unzureichende Dokumentation? Wie viele Kunden gewinnen wir erst gar nicht, wenn wir keine gute Dokumentation liefern? Welche Support-Kosten entstehen uns aufgrund einer unzureichenden Dokumentation?“
  • „Dann suchen wir uns lieber einen Praktikanten oder eine günstige Hilfskraft. Schreiben kann schließlich jeder. Oder die Entwicklung schreibt nebenbei die Dokumentation!“
    Gegenargument: „Genau deswegen sind viele Bedienungsanleitungen so wie sie sind: unverständlich und unbrauchbar. Wollen wir das für unsere Produkte auch? Das Schreiben verständlicher Technischer Dokumentation ist alles andere als trivial und nicht mal „so eben“ aus dem Ärmel zu schütteln. Dafür gibt es heute ganze Studiengänge.“
  • „Unsere Produkte sind so komplex, die kann nur ein interner Mitarbeiter richtig verstehen.“
    Gegenfrage: „Und wie ist das mit unseren Kunden? Erwarten wir von denen nicht auch, dass sie unsere Produkte verstehen? Ist es nicht vielleicht sogar gerade besser, die Dokumentation wird von einer Person erstellt, die denselben Lernprozess durchlaufen muss wie der Kunde? Für uns ist vieles mit der Zeit schon so selbstverständlich geworden, dass wir in der Dokumentation gar nicht mehr erwähnen würden. Das sind genau die Dinge, mit denen unsere Kunden dann Probleme bekommen. Einem externen Redakteur wird das weniger leicht passieren.“
  • „Ich möchte nicht, dass wir uns in eine Abhängigkeit begeben. Wir müssen jederzeit selbst handlungsfähig bleiben.“
    Gegenargument: „Stimmt. Allerdings können auch interne Mitarbeiter das Unternehmen schneller als gedacht verlassen. Dann gleichen sich die Probleme. Egal wer unsere Dokumentation erstellt: Wichtig ist, dass wir mit gängigen Tools und Formaten arbeiten, und dass wir jederzeit nicht nur über die Ergebnisse verfügen, sondern auch über alle Quelldaten. Dann besteht vom Risiko her faktisch kein Unterschied.“