Für verschiedenste Bereiche werden Technische Dokumentationen benötigt. Die Technische Dokumentation umfasst alle Dokumente und Informationen, die zu einem bestimmten Produkt wie beispielsweise eine Software oder eine Maschine, Anlage oder ein Gerät gehören. Die Dokumentation gliedert sich in der Regel in eine Interne Technische Dokumentation und eine Externe Technische Dokumentation. Für den Bereich des Softwareproduktes werden beispielsweise für den internen Gebrauch u.a. das Software Projekt und die Schnittstellen dokumentiert. Für den externen Bereich wird in den allermeisten Fällen für ein Softwareprodukt eine Benutzerdokumentation benötigt, die oft auch für das Marketing eingesetzt wird. Die Handbücher (meist PDFs) werden häufig durch Software-Videos bzw. Tutorials ergänzt. Für die Erstellung solcher Handbücher und Technischer Dokumentationen finden Sie hier IT-Dienstleister.
Die Technische Dokumentation eines Produktes wie einer Software, eines Geräts oder einer Maschine bzw. Anlage umfasst sämtliche Informationen, Dokumente und Daten zu diesem Produkt. Die Technische Dokumentation unterteilt sich in interne und externe Dokumentation. Die interne Dokumentation beinhaltet in der Regel die produktrelevanten Informationen und Dokumente von der Planung über die Entwicklung bis hin zur Markteinführung des Produkts. Hierzu gehören bei Geräten und Maschinen beispielsweise unter anderem Versuchs- und Prüfberichte, Risikobeurteilungen oder auch Nachweise für die Qualitätssicherung. Beispiele für interne Softwarebeschreibungen sind u.a. die Projektdokumentation (Pflichtenheft, Backlogs, Use-Cases, etc.), die Systemdokumentation (Code-Kommentare, Architekturdokumentation, UI- und Software-Design), die Schnittstellendokumentation sowie Test- und Prozessdokumentation. Interne Dokumentationen können Grundlage bzw. Bestandteil der externen Dokumentation sein.
Anwendungsgebiete der externen Dokumentation können insbesondere für Softwareprodukte beispielsweise Installationshandbücher, Datenblätter zur Software, Tutorials, Software-Handbücher oder auch Online-Hilfen sein.
Die Anforderungen an die Softwaredokumentation sind im Wesentlichen ähnlich wie die Anforderungen an andere Produktdokumentationen. Die Dokumentation sollte vollständig, aktuell und inhaltlich korrekt sein. Sie sollte in der Lage sein, den Nutzer der Software zur korrekten Anwendung zu befähigen. Des Weiteren sollte die Dokumentation gemeinsam mit der Software ausgeliefert werden und eine dem Benutzer angepasste Sprache verwenden. Vorteilhaft sind außerdem eine Suchfunktion innerhalb der Dokumentation und durchdachte Navigationskonzepte, sodass der Nutzer möglichst schnell bei Fragen in der Dokumentation Lösungen finden kann. Bei der Erstellung Softwaredokumentation sollten relevante Normen und Standards berücksichtigt werden.
Im Bereich der Technischen Dokumentation gibt es für die unterschiedlichen Produktbereiche verschiedene Standards und Normen. Für die Softwaredokumentation sind dies beispielsweise:
Nicht in jedem Unternehmen gibt es ausreichend Kapazitäten zur Erstellung von Technischen Dokumentationen. Für die Technische Dokumentation bzw. für Handbücher müssen Texte erstellt und in den meisten Fällen auch Detail-Illustrationen erarbeitet werden. Verständliche Texte zu schreiben, ist oft schwerer als Software zu programmieren. Ein professioneller technischer Redakteur ist Spezialist auf seinem Gebiet und arbeitet daher in der Regel effizient und auf hohem Niveau.
Durch eine professionelle Softwaredokumentation wird nicht nur die Wartbarkeit der Software verbessert, sondern auch der Einstieg in die Bedienung (für den Nutzer) und die Weiterentwicklung (für neue Entwickler) erleichtert. Eine klare und gut strukturierte Dokumentation erleichtert die Zusammenarbeit zwischen den Entwicklern und ist zudem eine gute Hilfe für den Support.
Technische Redakteure sind geübt darin, Dokumentationen aus der Sicht der Kunden zu schreiben. Auf diese Weise wird eine Softwaredokumentation mit einem hohen Nutzwert erstellt. Eine gut verfasste Dokumentation, die neue Erkenntnisse in der Text Usability und User-Assistance berücksichtigt, sorgt bei den Kunden bzw. Nutzern dafür, dass diese besser mit der Software zurechtkommen und weniger Anfragen beim Support stellen.
Viele Dienstleister im Bereich der Technischen Dokumentation setzen auf Konzepte, die auf Textersparnis ausgerichtet sind. Sie verwenden in der Regel Textbausteine für häufig wiederkehrende Beschreibungen. Von Vorteil ist es auch, dass die Redakteure meist eine Sprache verwenden, die auf eine einfache Übersetzung optimiert ist.
Ein weiterer Vorteil einer Dokumentation durch einen Dienstleister liegt darin, dass dieser in der Regel nicht nur einen redaktionellen Mitarbeiter hat, sodass bei Krankheit, Urlaub oder anderen Ausfällen trotzdem weiter an der Dokumentation gearbeitet werden kann. Meist setzt sich das Team des Dienstleisters aus einer Vielzahl von Spezialisten zusammen, die ihre Erfahrungen in den Dokumentationsprozess einbringen können. Hierzu gehören u.a. auch technische Illustratoren und Übersetzer.
IT-Dienstleister bieten im Rahmen der Softwaredokumentation verschiedene Dienstleistungen an. Sie können beispielsweise bei der Text-Konzeption und der Content-Erstellung für die Benutzerdokumentation unterstützen. Sie können ebenso bei der Erstellung der Entwicklerdokumentation, der Systemdokumentation und auch bei der Erstellung von Schulungsdokumenten und Tutorials behilflich sein.
IT-Dienstleister können auch sicherstellen, dass die Softwaredokumentation komplett, korrekt und auf dem neuesten Stand ist, indem sie Prüfungen bzw. Überprüfungen durchführen. Im Rahmen der Dokumentation können zahlreiche IT-Dienstleister unter anderem auch die Dokumentationen in verschiedene Sprachen übersetzen.
Zu den gängigen Arbeiten eines IT-Dienstleisters im Bereich der Softwaredokumentation gehören:
Die Kosten für Dienstleistungen im Rahmen der Technischen Dokumentation für Softwareprodukte können je nach Umfang und Art stark variieren. Je mehr Inhalte dokumentiert werden müssen, desto mehr Zeit und Ressourcen werden benötigt, was sich auf den Preis auswirken kann. Wenn die Dokumentation sehr spezialisiert ist, erfordert dies in der Regel mehr Fachwissen und Erfahrung, was sich ebenfalls auf die Kosten auswirkt. Die Kosten variieren natürlich auch je nach Art der Dokumentation (z.B. für Handbücher, Installationsanleitungen oder Schulungsunterlagen und Tutorials etc.). Hierbei ist auch zu berücksichtigen, ob diese Dokumentation neu erstellt werden soll oder eine Überarbeitung notwendig ist, beispielsweise nach einem Upgrade bzw. einer neuen Version der Software.
Achten Sie bei einem Kostenvergleich darauf, ob beispielsweise die Erstellung von Formatvorlagen, Grafiken, Stichwortverzeichnis etc. enthalten sind. Ist ein Korrekturlauf im Preis bzw. im Angebot einkalkuliert? Denken Sie daran, sich die entsprechenden Nutzungsrechte an den Dokumentationen zu sichern und achten Sie darauf, ob Sie bei Lieferung auch die Quelldaten bekommen.
Die Stundensätze von Dienstleistern im Bereich der Technischen Dokumentation liegen im Schnitt bei rund 70 Euro.
