Wie schreiben Sie eine Benutzerdokumentation, die konsistent ist und auf Ihre Markenstimme und Ihren Ton abgestimmt ist?

1 Kennen Sie Ihre Zielgruppe

Bevor Sie mit dem Schreiben beginnen, müssen Sie verstehen, wer Ihre Zielbenutzer sind, was ihre Ziele und Probleme sind und wie sie Informationen am liebsten konsumieren. Sie können Benutzerpersönlichkeiten, Umfragen, Interviews, Analysen und Feedback verwenden, um Erkenntnisse über Ihre Zielgruppe zu sammeln. Auf diese Weise können Sie Ihre Inhalte auf ihre Bedürfnisse, Erwartungen und Vorlieben abstimmen. Sie können beispielsweise je nach Hintergrund, Kontext und Stimmung Ihres Publikums unterschiedliche Ebenen der Technik, Formalität und des Humors verwenden.

2 Definieren Sie Ihre Stimme und Ihren Ton

Ihre Stimme und Ihr Tonfall sind Ausdruck Ihrer Markenpersönlichkeit und Ihrer Werte. Ihre Stimme ist über alle Ihre Kommunikationskanäle hinweg konsistent, während Ihr Ton je nach Situation und Emotion, die Sie vermitteln möchten, variieren kann. Zum Beispiel kann Ihre Stimme freundlich, professionell und selbstbewusst sein, während Ihr Ton je nach Thema, Zweck und Zielgruppe Ihrer Benutzerdokumentation eher locker, formell oder einfühlsam sein kann. Sie können einen Sprach- und Tonleitfaden verwenden, um Ihre Stilrichtlinien und Beispiele für Ihre Autoren und Redakteure zu dokumentieren.

3 Verwenden Sie eine einfache und klare Sprache

Eines der Hauptziele der Benutzerdokumentation ist es, Ihren Kunden zu helfen, Ihr Produkt ohne Verwirrung oder Frustration zu verstehen und zu verwenden. Um dies zu erreichen, müssen Sie eine einfache und klare Sprache verwenden, die Jargon, Mehrdeutigkeit und unnötige Komplexität vermeidet. Sie können einfache englische Prinzipien verwenden, z. B. die Verwendung von Aktivstimmen, kurzen Sätzen, gebräuchlichen Wörtern und positiven Aussagen. Sie können auch Tools wie Hemingway oder Grammarly verwenden, um Ihre Lesbarkeit und Grammatik zu überprüfen.

4 Strukturieren Sie Ihre Inhalte logisch

Eine weitere Möglichkeit, Ihre Benutzerdokumentation leicht verständlich und verdaulich zu gestalten, besteht darin, Ihre Inhalte logisch und konsistent zu strukturieren. Sie können Überschriften, Unterüberschriften, Listen, Tabellen und Diagramme verwenden, um Ihre Informationen in Blöcken und Hierarchien zu organisieren. Sie können auch Navigationselemente wie Menüs, Links, Breadcrumbs und Suchleisten verwenden, damit Ihre Benutzer schnell und einfach finden, wonach sie suchen. Sie können ein Inhaltsmodell oder eine Vorlage verwenden, um Ihre Inhaltstypen und -elemente zu definieren.