Warum Schneider Dokumentation?

Kosten

Welcher Kosten- und Zeitaufwand ist mit der Erstellung technischer Dokumentation verbunden? Und lässt sich dieser Aufwand überhaupt genau abschätzen?

Verständliche, benutzerfreundliche technische Dokumentation garantiert zufriedene Kunden und minimiert Ihre Supportkosten. Unser Ziel ist es, das Gesamtoptimum zwischen diesen Vorteilen einerseits und den Kosten für die Doku-Erstellung andererseits zu erreichen. Gute Dokumentation ist teuer – schlechte Dokumentation zu haben ist noch teurer.

Stundenbasierte Kalkulation

Sicherlich würden Sie an dieser Stelle gerne konkrete Zahlen lesen. Aufgrund der Unterschiedlichkeit der Projekte ist eine allgemeingültige Aussage hierzu jedoch schwierig.
Unser Stundensatz richtet sich nach den spezifischen fachlichen Anforderungen. Gerne erstellen wir Ihnen ein individuelles Angebot.

 
Realistische Kostenschätzung

Basis unserer Angebote ist immer der realistisch zu erwartende Aufwand. Abgerechnet werden selbstverständlich nur die tatsächlich geleisteten Stunden.

Übrigens: Seien Sie misstrauisch bei Angeboten auf Basis von Seitenpreisen (einzige Ausnahmen: Übersetzungen und Lektorat). Es ist wesentlich benutzerfreundlicher, aber auch aufwendiger, dieselbe Information prägnant auf „nur“ einer Seite zu kondensieren als sie unreflektiert über mehrere Seiten auszubreiten. Seitenpreise führen unweigerlich zu Interessenkonflikten und bestrafen jede benutzerfreundliche Dokumentation.

 
Gezielte Nutzung knapper Budgets

Wenn Ihrem Projekt ein enger finanzieller Rahmen gesetzt ist, werden wir gemeinsam eine intelligente Lösung finden, dieses Budget mit maximaler Wirkung zu nutzen.

 

Berücksichtigen Sie folgendes bei Ihrer Entscheidung für einen Dokumentations-Dienstleister:

Bearbeitungsdauer

Wie lange dauert die Erstellung technischer Dokumentationen?

Nicht selten stehen neue Produkte bereits kurz vor Auslieferung, nur eine Betriebsanleitung fehlt 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 Bearbeitung

Die Bearbeitungsdauer für die Erstellung technischer Dokumentation ist direkt proportional zum Umfang der zu erstellenden Betriebsanleitung.

Zeit für Korrekturlauf

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

Vor- und Nachteile des Outsourcings

Nachfolgend haben wir zum einen die Bedenken der Kunden sowie die Vorteile eines Outsourcings im Bereich der technischen Dokumentation beleuchtet.

Vorteile

Häufig haben junge oder mittlere Unternehmen keine eigene Dokumentationsabteilung. Dokumentationsaufgaben werden von Entwicklung, Support, Produktmanagement oder Marketing übernommen. Meist fehlen hier jedoch die erforderliche Ausbildung und Erfahrung im Bereich Technischer Dokumentation. Auch ist das Schreiben von Betriebsanleitungen nicht immer eine der beliebtesten Aufgaben. Ein externer Dienstleister ist Spezialist auf diesem Gebiet. Er arbeitet hier meist ungleich effizienter und auf einem anderen Qualitätsniveau.

Bei Erscheinen eines neuen Produkts oder einer neuen Produktversion entstehen in fast jeder Dokumentationsabteilung Engpässe. In solchen Spitzenzeiten können Sie einen externen Dienstleister gezielt einsetzen, um die Durchlaufzeit Ihres Projekts zu verkürzen.

Nicht selten soll eine technische Dokumentation mal „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.

Niemand kann auf jedem Gebiet Experte sein. Bei außergewöhnlichen Aufgabenstellungen kann ein spezialisierter Dienstleister wesentlich effizienter arbeiten.

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.

Bedenken

„Outsourcing ist zu teuer“

Der eine oder andere Stundensatz erscheint auf den ersten Blick vielleicht hoch. Im Gegensatz zu internen Mitarbeitern bezahlen Sie bei einem externen Dienstleistungsunternehmen 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 externes Dienstleistungsunternehmen nur selten wesentlich teurer als ein interner Mitarbeiter. Dafür gewinnen Sie an Flexibilität in Zeiten ungleichmäßigen Arbeitsaufkommens.

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

Natürlich muss ein neu beauftragtes Dienstleistungsunternehmen 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 Anwendern 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.

„Wenn ich die Dokumentation an einen externen Dienstleister outsource, habe ich 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 technische Dokumentation durch interne Mitarbeiter erstellen lassen.

„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 Dienstleistungsunternehmens ist es, dass Sie sich stets die Rechte an allen Formatvorlagen und Texten sichern. Auch sollte der Produktionsprozess bei dem Dienstleistungsunternehmen 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.

Vor-Ort-Präsenz des Dienstleisters?

Wie weit sollte ein Dienstleister, der Ihre technische Dokumentation erstellt, maximal von Ihrem Standort entfernt sein? Muss er bei Ihnen vor Ort arbeiten, oder erstellt er Ihre technische Dokumentation besser in seinen eigenen Räumen?

Gezielte Termine vereinbaren

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 der Dienstleister mit Ihnen konkrete Termine zur Recherche 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 für Rückfragen lässt sich dadurch minimieren. Schließlich soll aus der geplanten Entlastung keine Belastung werden!

Spezialfall Software

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

Meilensteine eines Projekts

Wie ist der Ablauf eines typischen Dokumentationsprojekts? Welche Meilensteine sollten Sie in einem Projekt zur Erstellung technischer Dokumentation vorsehen?

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

Für ein Angebot benötigt ein 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.

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.

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 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 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 oder online via Teams 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.

Der 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 vom Dienstleister jedoch bitte nicht, Ihnen noch unfertige Teile auszuhändigen. Dies würde beiden Seiten nur zusätzliche Arbeit machen.

Der Dienstleister arbeitet die im Review beschlossenen Änderungen ein und liefert Ihnen die fertige Druckvorlage (PDF).

Sie erteilen schriftlich die formale und inhaltliche Freigabe. Damit ist das Projekt abgeschlossen.

Der Dienstleister sollte regelmäßig über den Projektfortschritt 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.

Angebote vergleichen

Worauf sollten Sie achten, wenn Sie die Angebote von Dienstleistern zur Erstellung technischer Dokumentation vergleichen und bewerten wollen?

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:

  • 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, so dass später einzelne Teile in anderen Dokumenten oder Medien wiederverwenden können?
  • Ist die Erstellung von Formatvorlagen im Angebot enthalten? Häufig müssen auch bereits vorhandene Formatvorlagen noch ergänzt oder angepasst werden.
  • Ist die Erstellung von Grafiken im Angebot enthalten?
  • Ist mindestens ein Korrekturlauf (Review) vorgesehen und ist der Aufwand für das Einarbeiten von Korrekturen und Änderungswünschen mit einkalkuliert?
  • 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 Wechsel verursacht Zusatzaufwand und birgt das Risiko schwankender Qualität.
  • 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?

Argumentationshilfe gegenüber Ihren Vorgesetzten

Sie möchten Ihre Vorgesetzten von der Sinnhaftigkeit einer externen Beratung, Schulung oder Erstellung technischer Dokumentation überzeugen? Hier finden Sie eine Argumentationshilfe und Kopiervorlage für Ihre Anträge.

Mögliche Einwände und Gegenargumente

„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, …“

„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?“

„Genau deswegen sind viele Bedienungsanleitungen so wie sie sind: unverständlich und unbrauchbar. Wollen wir das für unsere Produkte auch? Das Schreiben von verständlicher technischer Dokumentation ist alles andere als trivial und nicht mal so aus dem Ärmel zu schütteln. Dafür gibt es heute ganze Studiengänge.“

„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 einer Dokumentation gar nicht mehr erwähnen würden. Das sind genau die Dinge, über die unsere Kunden stolpern. Einem externen Redakteur wird das weniger leicht passieren.“

„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 fertigen Ergebnisse verfügen, sondern auch über alle Quelldaten. Dann besteht vom Risiko her faktisch kein Unterschied.“