Was ist der beste Ansatz zum Erstellen von Benutzerhandbüchern?

Benutzerhandbücher dienen als Anleitung zum Zusammenbau, zur Installation und zur Verwendung eines Produkts. Benutzerhandbücher können verschiedene Formen haben, z. B. Benutzeranweisungen, Benutzerhandbücher, Schnellstartanleitungen, Anleitungen für den Einstieg oder technische Dokumentationen.

Wer ist am technischen Schreiben beteiligt und wie wird es durchgeführt?

Normalerweise erstellen Unternehmen technische Texte , darunter Benutzer- und Bedienungsanleitungen, auf drei verschiedene Arten. Sehen wir uns an, welcher Ansatz der beste ist und wie Sie jede Methode optimal nutzen können.

1. Bitten Sie das technische Personal, das Benutzerhandbuch zu schreiben

Viele Unternehmen neigen dazu, einen oder mehrere technische Mitarbeiter mit der Schreibarbeit zu beauftragen. Das mag nach einer cleveren Idee klingen.

Zu diesem Team gehören Produktingenieure, Entwickler und Designer. Sie sind die Väter, die Schöpfer. Sie wissen also alles (wenn nicht jeder für sich, aber vielleicht alles zusammen). Kurz gesagt, sie sind die Fachexperten. Und wenn es einen Bug oder Fehler gibt, sind sie auch die beste Referenz.

Warum sollte man sich schließlich die Mühe machen, einen zusätzlichen Mitarbeiter einzustellen und zu bezahlen, wenn die besten Ressourcen bereits vorhanden sind? Das ist weder die beste noch die wirtschaftlichste Idee. Obwohl das technische Personal eine der Referenzen für ein Handbuch ist, sind sie nicht unbedingt die besten Leute, um ein Schulungshandbuch zu erstellen. Hier ist der Grund:

Erstens: Sind sie gute Autoren? Viele technische Mitarbeiter, deren Hauptaufgabe darin besteht, ein Produkt zu entwerfen und zu entwickeln, sind nicht am Schreiben und Dokumentieren interessiert; aus demselben Grund haben sie das Schreiben auch nicht beruflich verfolgt. Sie denken vielleicht, sie hätten andere dringende Dinge zu tun, was angesichts ihrer Hauptaufgaben und -verantwortlichkeiten auch stimmt. Daher sind sie möglicherweise keine guten Autoren und nicht bereit, diese Fähigkeiten zu erwerben. Wenn Ihre technischen Mitarbeiter jedoch gute Autoren sind oder sich für das Schreiben interessieren, haben Sie Glück. Aber das ist noch nicht alles.

Zweitens haben die an der technischen Entwicklung eines Produkts beteiligten Personen unterschiedliche Ansichten darüber. Sie neigen dazu, viele Informationen als offensichtlich vorauszusetzen, während ein Erstbenutzer sicherlich Erläuterungen benötigt. Sie tappen wahrscheinlich in diese technische Schreibfalle und geben detaillierte technische Informationen weiter, die sie für wesentlich halten, die jedoch für einen Benutzer nicht hilfreich sind.

Manche Details sind für Ingenieure wichtig, helfen aber dem durchschnittlichen Benutzer nicht weiter. Für Benutzer sind die Ergebnisse des technischen Prozesses und die Art und Weise, wie er ihre Bedürfnisse erfüllt, wichtig, nicht das, was hinter dem Prozess steckt.

Handbücher müssen präzise und zurückhaltend in technischen Details sein, aber großzügig in Anweisungen und Warnungen. Fachexperten verwenden häufig Fachbegriffe und Fachjargon und denken, das sei in Ordnung. Sie erklären Fachbegriffe vielleicht sogar mit Verweisen auf andere Begriffe, was zu Verwirrung führt.

Tipps für den Erfolg dieser Methode:

Wenn Sie Ihr aktuelles technisches Personal mit dem Schreiben des Handbuchs beauftragen möchten, beziehen Sie das gesamte Team mit ein. Auf diese Weise können Sie sicherstellen, dass unterschiedliche Perspektiven zum Tragen kommen.

2. Bitten Sie das technische Personal, das Handbuch zu schreiben und es von einem Redakteur/Autor Korrektur lesen zu lassen.

Und so läuft es ab. Techniker schreiben einen Entwurf und übergeben ihn einem Redakteur/technischen Redakteur. Auf diese Weise ist es wahrscheinlicher, dass die Schreibstandards eingehalten werden. Der Autor vereinfacht einige Teile, ersetzt Fachjargon durch gebräuchlichere Wörter, vereinheitlicht den gesamten Stil, wendet einige Tricks an und gestaltet ihn ansprechender.

Diese Methode klingt viel besser. Aber können Sie sicherstellen, dass die Redakteure die Lücken füllen, die das technische Personal ursprünglich verursacht hat? Sie können wahrscheinlich nicht alle fehlenden Teile erraten und das, was sie erhalten haben, verbessern.

Tipps, um das Beste aus dieser Methode herauszuholen:

• Eine gute Zusammenarbeit kann zu einem professionellen Ergebnis führen. Stellen Sie sicher, dass Sie die Fachexperten (Ihr technisches Team) mit dem Autor/Redakteur zusammenbringen, und bitten Sie nicht einfach beliebige Autoren, ein Dokument ohne Hintergrundinformationen zu bearbeiten.
• Stellen Sie sicher, dass der Autor sich häufig an das technische Team wenden kann, um verschiedene Teile zu besprechen oder wenn eine Frage vorliegt. Lassen Sie das technische Team außerdem das bearbeitete Dokument überprüfen, um sicherzustellen, dass der technische Inhalt richtig wahrgenommen und kommuniziert wurde.

3. Lassen Sie einen technischen Redakteur die Arbeit in enger Zusammenarbeit mit dem technischen Team erledigen

Einen technischen Redakteur einzustellen, klingt nach der idealen Methode. Ein technischer Redakteur, der das Handbuch von Anfang an erstellt und gleichzeitig die Möglichkeit hat, eng mit dem technischen Team zusammenzuarbeiten, das Produkt zu verwenden, zu testen und zu untersuchen, ist die fehlende Zutat für ein perfekt gestaltetes Benutzerhandbuch. Es wird dringend empfohlen, einen technischen Redakteur mit dem Schreiben des Handbuchs zu beauftragen. Fachexperten können das Handbuch überprüfen, kommentieren, erklären und bearbeiten, während sie die Funktionen und Merkmale des Produkts besprechen.

Der Zaubertrick ist das gemeinsame Schreiben.

Bei allen drei Ansätzen ist Zusammenarbeit der Schlüssel zu besser geschriebenen Texten. Dokumentationstools, die auf Teamarbeit ausgerichtet sind und Raum für effektive Zusammenarbeit bieten, könnten diesen Prozess erleichtern. Viele Online-Tools versuchen, es einfacher zu machen. Zur Förderung der Zusammenarbeit gehört viel mehr als nur die Möglichkeit, verschiedene Teile zu teilen, zu kommentieren und zu diskutieren.

Sonat konzentriert sich zunehmend auf die Förderung des kollaborativen Schreibens, indem es Workflow-Funktionen verbessert, mit denen Sie einen automatisierten Prozess definieren können. In diesen Prozess kann jeder in einer Organisation einbezogen werden, und es ist möglich, unterschiedliche Aufgaben und Zugriffsebenen zuzuweisen und gleichzeitig automatische Regeln anzuwenden. Dadurch wird viel Bearbeitungszeit gespart.

Mit Sonat können Sie die Veröffentlichung minderwertiger und unkontrollierter Dokumente verhindern und Ihren Redakteuren und Experten viel Zeit sparen.

Erfahren Sie hier mehr über die Zusammenarbeitsfunktionen von Sonat.