Technische handbucher erstellen


PRICE: FREE

INFORMATION

ISBN: 514223545
FORMAT: PDF EPUB MOBI TXT
DATEIGROSSE: 6,64

ERLAUTERUNG:

Technische handbucher erstellen

Begleitinformationen zur Anwendung sind so alt wie der Mensch selbst: Schon unsere Steinzeit-Vorfahren erklärten die Verwendung bestimmter Werkzeuge in ihren Felsmalereien. Wer für seine Kunden gute Handbücher erstellt, schafft den Unterschied zwischen einer positiven Benutzererfahrung und einem enttäuschenden Anwendererlebnis.

Allerdings gibt es auch bei der technischen Kommunikation einige No-Gos zu beachten. Sicher ist auch Ihnen bereits die ein oder andere Produktdokumentation begegnet, die im besten Fall zum Schmunzeln anregte, im schlimmsten Fall zur Verzweiflung führte.

Was also macht eine gelungene Benutzerdokumentation aus, und was gehört dazu, gute Bedienungsanleitungen zu schreiben? Die technische Dokumentation wird auch TD, Benutzerdokumentation oder Produktdokumentation genannt.

Sie umfasst unter anderem Benutzerhandbücher z. Hier sehen Sie eine Montageanleitung für ein IKEA-Regal. Auch ohne Text sind die Instruktionen dank Diagrammen und Bildern klar und leicht verständlich. Auch erfahrene Anwender werfen hin und wieder einen Blick in die Bedienungsanleitung eines Produkts, wenn sie etwas vergessen haben, ein Problem auftritt oder wenn sie eine bestimmte Funktion nutzen möchten, die sie bisher noch nicht verwendet haben. Vielleicht denken Sie jetzt: Ein Handbuch erstellen ist doch keine Kunst!

Alles, was man braucht, sind ein paar kurze Erklärungen, wie man das Produkt anwendet, und damit ist der Fall erledigt. Eine gute Bedienungsanleitung zu schreiben erfordert mehr, als nur Anweisungen aneinanderzureihen. Kunden wenden sich nicht nur an den Kundenservice, wenn ein Problem auftritt, sondern auch, wenn sie allgemeine Fragen oder Verständnisprobleme haben.

Unterstützen Sie Ihre Kundenbetreuer, indem Sie möglichst nützliche und anwenderfreundliche Handbücher erstellen. Auch wenn der Name es vermuten lässt: Die Benutzerdokumentation wird nicht nur für den Endnutzer erstellt. Auch für Ihre Kundenbetreuer stellen Produkthandbücher wichtige Informationsquellen dar, die sie beim Gespräch mit einem Kunden zu Rate ziehen können. Erleichtern Sie Ihren Mitarbeitern die Arbeit, indem Sie Ihre Produktdokumentation mit einem Inhaltsverzeichnis oder Index versehen, sodass die gewünschten Informationen bei Bedarf schnell auffindbar sind.

Bei elektronischen Dokumenten ist eine Suchfunktion ideal. Hierzu erfahren Sie weiter unten noch mehr. Wie bereits erwähnt wenden sich viele Anwender bei Fragen direkt an den Kundenservice. Wenn Kunden die benötigten Informationen selbst finden können, ist die Wahrscheinlichkeit eines Anrufs weitaus geringer. Natürlich kann selbst die beste Produktdokumentation nicht alle Anrufe verhindern.

Doch solange Sie Anleitungen und Handbücher erstellen, die umfassend, leicht verständlich, klar und prägnant sind, werden Sie sehen, dass die Anfragen bei Ihrer Kundenbetreuung deutlich zurückgehen werden. Ebenso wie jedes Produkt einzigartig ist, gibt es auch keine Universalanleitung, um gute Handbücher zu erstellen. Nichts ist frustrierender für Kunden als unverständliche Anweisungen. Niemand fühlt sich gerne dumm. Vermitteln Sie Ihren Kunden niemals das Gefühl, dass sie Ihrem Produkt nicht gewachsen sind.

Halten Sie sich den Leitsatz vor Augen: Sie schreiben für den Anwender, nicht für den Entwickler. Das mag selbstverständlich klingen. Doch oft ist es schwieriger, als man denkt, ein Produkt, das man in- und auswendig kennt, für Laien zu beschreiben. Sie selbst sind mit dem Fachwortschatz, mit Abkürzungen und anderem Insiderwissen vertraut.

Auf viele Ihrer Kunden trifft das nicht zu. Was für Sie völlig natürlich ist, kann Ihre Kunden verwirren und entmutigen. Um zu gewährleisten, dass Ihre Benutzerdokumentation einfach zu lesen ist:. Das gilt sowohl für den Inhalt als auch das Design Ihrer Benutzerhandbücher. Lange Textblöcke und vollgefüllte Seiten überfordern das Auge des Betrachters.

Wenn Anleitungen nicht übersichtlich gestaltet sind, greifen Nutzer mit hoher Wahrscheinlichkeit lieber zum Telefon, als dass sie versuchen, selbst Antworten zu finden. Damit erweisen Sie weder Ihren Kundenbetreuern noch der Benutzererfahrung einen Dienst. Mit visuellen Elementen wie Bildern, Screenshots mit Anmerkungen, Grafiken und Videos vermitteln Sie Ihren Kunden schnell und präzise, wie sie mit Ihrem Produkt umgehen müssen. Ersparen Sie ihnen das mühsame Lesen und zeigen Sie ihnen lieber direkt, was Ihr Produkt zu bieten hat!

Zu den beliebtesten Methoden, um mehr Bildmaterial in die technische Dokumentation einzubinden, ehören ScreenshotsBildschirmaufnahmen und Video-Tutorials. Sagt Ihnen der Begriff SUI-Grafik etwas? Damit können Sie Informationen innerhalb Ihrer Bilder aufs Wesentlichste reduzieren und überflüssige bzw. Wenn Sie jemandem erklären möchten, wo die Funktion Mobilgerät verbinden zu finden ist, ist das zweite Bild eindeutig die bessere Wahl, da es unnötige und störende Informationen verbirgt.

Der Betrachter sieht auf einen Blick, was zu tun ist. Vermutlich haben Sie SUI-Grafiken bereits im Alltag gesehen, ohne dass sie Ihnen aufgefallen sind. Das Erstellen von Screenshots geht einfach über bestimmte Tastenkombinationen Ihres Computers. Jedes Produkt dient der Lösung eines Problems. Leider sind viele Hersteller so begeistert von all den coolen Funktionen ihrer Produkte, dass sie vergessen, den eigentlichen Nutzen für den Verbraucher hervorzuheben.

Aber es ist besser, dies beiläufig zu tun, also während Sie Ihren Kunden erläutern, wie sie Ihr Produkt zur Lösung eines bestimmten Problems einsetzen. Ein Video-Tutorial zur Softwaredokumentation kann beispielsweise veranschaulichen, wie man eine bestimmte Funktion des Programmes nutzt, um ein gewünschtes Ergebnis zu erzielen.

Die Lösung steht dabei im Vordergrund, doch gleichzeitig erhält der Kunde einen Einblick in die Funktionsvielfalt der Software. Gute technische Dokumentation weist eine klare Hierarchie mit Überschriften und Unterüberschriften auf, die dem Leser auf Anhieb deutlich macht, welche Informationen wo zu finden sind.

Ein logischer Aufbau hilft dem Anwender dabei, das Produkt möglichst effizient einzusetzen. Achten Sie, wenn Sie Ihre Bedienungsanleitung schreiben, darauf, dass Sie den Leser nicht verwirren: Gehen Sie nicht auf komplizierte Funktionen ein, bevor Sie die Grundlagen des Produkts eingehend erklärt haben.

Arbeiten Sie sich langsam von einfach bis kompliziert vor, sodass der Nutzer seinen Kenntnisstand Schritt für Schritt erweitern kann. Ein Inhaltsverzeichnis ermöglicht Ihren Kunden, schnell und problemlos gewünschte Informationen oder Antworten auf ihre Fragen zu finden. So müssen sie nicht zahllose Seiten Text durchsuchen und damit wertvolle Zeit vergeuden. Das Inhaltsverzeichnis sollte alle in der Benutzeranleitung verwendeten Haupt- und Nebenüberschriften aufführen.

Bis vor Kurzem war es gang und gäbe, Benutzeranleitungen in gedruckter Form zum Produkt mitzuliefern. Heutzutage macht es mehr Sinn, elektronische Handbücher zu erstellen, da die meisten von uns jederzeit ein Smartphone zur Hand haben. Ebenso wie das Inhaltsverzeichnis vereinfacht das elektronische Format die Suche nach bestimmten Inhalten und trägt damit dazu bei, Anfragen beim Kundenservice zu reduzieren.

Bemühen Sie sich, Handbücher zu erstellen, die für alle Anwender zugänglich sind. Von Blinden und Sehbehinderten über Taube und Schwerhörige bis hin zu Menschen mit körperlichen Einschränkungen sollten all Ihre Kunden Ihre technische Dokumentation nutzen können. Bei elektronischen Bedienungsanleitungen lässt sich Barrierefreiheit mit geringem Zusatzaufwand umsetzen.

Halten Sie sich daher Ihre Kunden beim Design Ihrer Produktdokumentation stets vor Augen. Ihr Ziel ist es, Anleitungen so praktisch und anwenderfreundlich wie möglich zu gestalten. Vermeiden Sie lange Absätze und textlastige Seiten, um Nutzer nicht zu überwältigen. Nutzen Sie nach Möglichkeit Grafiken und Bilder, um Vorgänge zu illustrieren, statt diese zu beschreiben. In elektronischen Formaten bieten sich Videos und Gifs an.

Verwenden Sie einheitliche Schriftarten und Farben über Ihre gesamte technische Kommunikation hinweg. Achten Sie darauf, dass Ihre Anleitung dem Gestaltungsleitfaden Ihres Unternehmens entspricht. Falls Sie noch keinen Gestaltungsleitfaden haben, sollten Sie dies schnell nachholen. Der einzige Weg, um sicherzugehen, dass Ihre technische Kommunikation Endnutzern auch wirklich hilft, ist, diese zu befragen.

Nur ein Outsider kann Ihnen sagen, wo etwas unklar ist und wo weiterer Erklärungsbedarf besteht. Teilen Sie Ihren Kunden mit, wo sie weitere Informationen zu Ihrem Produkt und dessen Anwendung finden können. In elektronischen Bedienungsanleitungen bieten sich Links zu Video-Tutorials, FAQ-Seiten, Nutzerforen und mehr an.

Gedruckte Anleitungen sollten zumindest die URLs von weiterführenden Webseiten sowie die Telefonnummer Ihrer Kundenbetreuung enthalten. Teilen Sie Ihre Anleitungen nach Möglichkeit in einzelne Schritte auf. So können Sie lange Textpassagen vermeiden und komplexe Prozesse besser verständlich erklären. Noch anwenderfreundlicher werden Ihre Anleitungen, wenn Sie diese mit Bildern und Grafiken illustrieren. Snagit bietet eine praktische Funktion, um mit wenig Aufwand Schritt-für-Schritt-Anleitungen zu erstellen.

Mit der Funktion Bilder kombinieren können Sie einzelne Screenshots und Fotos zu einem Bild zusammenführen und damit den Bearbeitungsprozess vereinfachen. Bevor Sie anfangen, Ihre Bedienungsanleitung zu schreiben, sollten Sie sich Zeit zum Planen nehmen. Überlegen Sie, wie Sie Ihren Anwendern am besten helfen können.

Die Antworten auf diese Fragen bieten einen wichtigen Leitfaden bei der Erstellung Ihrer technischen Dokumentation. Je mehr Zeit Sie in die Planung investieren, desto weniger Zeit benötigen Sie für die Umsetzung. Auch das endgültige Format Ihrer technischen Dokumentation ist eine Überlegung wert. Wollen Sie ein gedrucktes oder ein rein elektronisches Dokument erstellen?

Wo können Anwender Ihre Benutzerdokumentation finden? In den allermeisten Fällen ist es empfehlenswert, neben gedruckten Anleitungen auch elektronische Versionen bereitzustellen. Smartphones, Computer und Tablets bieten Informationen auf Abruf, egal zu welcher Tageszeit oder wo wir uns gerade befinden. Auch Ihre Benutzerdokumentation sollte diese Flexibilität bieten. Für Ihre Kunden ist das viel bequemer, als im Bedarfsfall Ordner oder Schubladen nach einer gedruckten Anleitung zu durchsuchen.

Darüber hinaus ist es einfacher, elektronische Dokumente barrierefrei zu gestalten. Oder haben Sie vor, Ihr Handbuch auch in Blindenschrift drucken zu lassen? Wie sieht es bei Nutzern mit eingeschränkter Motorik der Finger und Hände aus? Mit Hilfe von Tools wie Barrierefinder können Sie die Barrierefreiheit elektronischer Dokumente garantieren.

Wir sind DIE Experten, um Ihr Produktwissen zielführend zu vermitteln - impulsgebend und auf Augenhöhe. Wir helfen Ihnen, den Rahmen Ihres Budgets einzuhalten. So haben Sie trotz kurzer Produktlebenszyklen, vieler Varianten, Sprachen und Zielgruppen alles im Griff. Unsere Projektmanager planen den Zieltermin Ihrer Dokumentation mit Ihnen bei Projektbeginn und setzen unsere Ressourcen für Ihr Projekt optimal ein.

Setzen Sie auf Erfahrung in Dokumentationsprojekten für die Branchen Maschinenbau, Medizintechnik und Software. Ihr Produkt ist entwickelt, vielleicht schon ausgeliefert oder im Beta-Stadium verfügbar. Nun möchten Sie für Ihren Kunden noch ein professionelles Handbuch. Gut, wenn Ihre Entwickler begeisterte Schriftsteller sind. Aber was, wenn nicht? Dann stellen wir Ihnen gern unser Know-How zur Verfügung. Sie haben Erwartungen - zum Beispiel an Ihre Entwickler. Das Wissen Ihrer Entwickler ist bare Münze wert - wenn es Ihrem Kunden nutzt.

Doch wie bringen Sie das Wissen Ihrer Entwickler didaktisch gut aufbereitet zu Papier? Sie haben viel zu tun. Sie überlegen, welche Arbeiten Sie als erstes liegen lassen müssen? Oder welche Tätigkeiten Sie extern vergeben können? Professionelle Unterstützung ist nah - Sie sind schon auf der richtigen Seite. Ändert sich Ihre Auftragslage oder kommt es bei Ihnen anderweitig zu Engpässen, erleichtern unsere Mitarbeiter Ihnen die kurzfristige Personalplanung und sind sofort einsatzbereit.

Ich kann die Handbuch Experten jedem empfehlen, der schnell, kompetent und nachhaltig Inhalte, Strukturen und Methoden im Bereich der Technischen Dokumentation vorantreiben und verbessern will. Vor dem Hintergrund unserer guten Erfahrungen kann ich die Zusammenarbeit mit den Handbuch Experten aus voller Überzeugung empfehlen.

Wir haben uns für die Handbuch Experten entschieden, da wir hier die von uns geforderte Kompetenz gefunden haben. Schnell wurde das Projekt zusammen mit unserem Partner und uns umgesetzt. Unterschiede zwischen Anleitungen für Hardware und Software kennen, verstehen und nutzen. Ein Interview mit unseren Redakteuren, die jeden Tag dafür verantwortlich sind, dass neue Maschinen und Erfindungen verständliche Handbücher bekommen.

Diese haben zwei Funktionen: Zum einen sind sie erforderlich für die grundlegende Funktionalität unserer Website. Hierzu werden pseudonymisierte Daten von Website-Besuchern gesammelt und ausgewertet. Diese Informationen helfen uns zu verstehen, wie unsere Besucher unsere Website nutzen. Sie tun dies, indem sie Besucher über Websites hinweg verfolgen.

Kosteneffizient Wir helfen Ihnen, den Rahmen Ihres Budgets einzuhalten. Verbindliche Termine Unsere Projektmanager planen den Zieltermin Ihrer Dokumentation mit Ihnen bei Projektbeginn und setzen unsere Ressourcen für Ihr Projekt optimal ein. Spezialisierte Mitarbeiter Setzen Sie auf Erfahrung in Dokumentationsprojekten für die Branchen Maschinenbau, Medizintechnik und Software. Hohe Automatisierung und starke Tools Sparen Sie Zeit und Geld durch automatisch generierte produktspezifische Dokumentation.

Wir erstellen das passende Handbuch für Ihr Produkt. Erfahren Sie mehr. Gern unterstützen wir Sie dabei mit unseren erfahrenen Redakteuren und Ingenieuren. Neues aus unserem Blog Was ist für Software-Anleitungen relevant? Der Kopf hinter den Handbüchern Ein Interview mit unseren Redakteuren, die jeden Tag dafür verantwortlich sind, dass neue Maschinen und Erfindungen verständliche Handbücher bekommen.

Externe Medien. Google Analytics. Google Optimize. Google Ads. Google Maps. Persönliche Werbung und Remarketing auf Drittseiten, sozialen Kanälen, Suchmaschinen oder Seiten von Kooperationspartnern.