Informationshilfe - dies ist ein wesentlicher Bestandteil jedes Produkts oder jeder Dienstleistung. Es hilft Benutzern, das Gerät der angebotenen Funktionen zu verstehen, ihre Fragen zu beantworten und ihnen bei der Bewältigung von Problemen zu helfen. Um eine effektive Referenzdokumentation zu erstellen, sollten Sie sich an einen bestimmten Aktionsplan halten.
Der erste Schritt beim Erstellen einer Informationshilfe besteht darin, die Zielgruppe zu analysieren. Bestimmen Sie, wer Ihr Produkt verwenden wird und wie technisch kompetent es sein kann. Auf diese Weise können Sie den Detailgrad und die technische Tiefe der zu erstellenden Referenz abschätzen. Wenn Ihr Produkt für ein breites Publikum gedacht ist, empfiehlt es sich, die Hilfe in der einfachsten und verständlichsten Sprache zu schreiben. Wenn Ihr Produkt jedoch auf fortgeschrittene Benutzer ausgerichtet ist, benötigen Sie möglicherweise eine detailliertere Beschreibung der Funktionalität.
Der zweite Schritt besteht darin, das Format und die Struktur auszuwählen. Sie können zwischen verschiedenen Hilfeformaten wählen: Webseite, PDF-Dokument, integrierte Hilfe im Programm usw. Legen Sie fest, welches Format für Ihre Benutzer am bequemsten und zugänglichsten ist. Definieren Sie die Struktur der Hilfe. Welche Abschnitte werden am wichtigsten sein? Welche Art der Bereitstellung von Informationen wird am logischsten sein? Verfeinern Sie alle erforderlichen Abschnitte für jedes Element Ihres Produkts. Wenn Ihr Produkt beispielsweise Software ist, können Sie Abschnitte mit Installationsanweisungen, Hauptfunktionen, Anweisungen zur Verwendung und zur Problemlösung angeben.
Schritte zum Erstellen einer Referenz
Schritt 1: Identifizieren Sie das Ziel und die Zielgruppe der Referenz. Wenn Sie verstehen, für welchen Zweck die Hilfe erstellt wird und wer sie verwenden wird, können Sie die erforderlichen Abschnitte und Informationen ermitteln.
Schritt 2: Strukturieren Sie den Hilfeinhalt. Brechen Sie die Informationen in logische Blöcke auf und erstellen Sie für jeden einen Header. Dies ermöglicht es den Lesern, die benötigten Informationen schnell zu finden.
Schritt 3: Schreiben Sie eine Einleitung. Erklären Sie im ersten Absatz den Zweck der Hilfe und wie sie für die Leser nützlich sein kann. Beschreiben Sie dann kurz den Inhalt der Abschnitte.
Schritt 4: Entwickeln Sie detaillierte Anweisungen für jeden Abschnitt. Verwenden Sie eine klare und klare Sprache. Die Anweisungen müssen strukturiert und konsistent sein, damit die Leser ihnen leicht folgen können.
Schritt 5: Verwenden Sie visuelle Elemente. Markieren Sie Schlüsselwörter oder Phrasen aus Gründen der Übersichtlichkeit mit Fett- oder Kursivschrift. Verwenden Sie nummerierte Listen oder Aufzählungslisten, um Informationen auf bequeme Weise darzustellen.
Schritt 6: Bearbeiten und korrigieren Sie. Überprüfen Sie die Struktur und Klarheit der Referenz. Stellen Sie sicher, dass die Anweisungen leicht verständlich und konsistent sind. Korrigieren Sie alle Grammatikfehler und Interpunktionsfehler.
Schritt 7: Testen Sie die Hilfe. Bitten Sie mehrere Leser, Ihre Hilfe zu lesen und Feedback zu geben. Verwenden Sie ihre Kommentare und Vorschläge, um die Hilfe zu verbessern.
Schritt 8: Geben Sie ein Zertifikat aus. Verwenden Sie Markup, um Überschriften, Absätze und Listen zu erstellen. Stilisieren Sie die Hilfe, um ihre Lesbarkeit und Attraktivität zu verbessern.
Schritt 9: Stellen Sie den Benutzern Hilfe zur Verfügung. Veröffentlichen Sie die Hilfe auf Ihrer Website oder in Ihrer App. Stellen Sie sicher, dass es leicht zugänglich ist und Benutzer schnell die benötigten Informationen finden können.
Festlegen der ursprünglichen Ziele
Bevor Sie mit der Erstellung einer Referenz beginnen, müssen Sie die Ziele definieren, die Sie erreichen möchten. Wenn Sie Ihre ursprünglichen Ziele festlegen, können Sie klar verstehen, was genau Sie Ihren Lesern vermitteln möchten und was das Endergebnis sein wird.
Beachten Sie bei der Definition von Zielen die folgenden Fragen:
- Wer ist Ihre Zielgruppe? Wer wird die Informationsbescheinigung lesen?
- Welches Problem oder welche Frage möchten Sie lösen oder beantworten?
- Welche Kenntnisse, Fähigkeiten oder Informationen möchten Sie vermitteln?
- Welches Format eignet sich am besten für Ihre Referenz: text, Grafik oder kombiniert?
- Welche Menge an Informationen müssen Sie weitergeben?
Die Antworten auf diese Fragen helfen Ihnen dabei, den Inhalt, die Struktur und den Stil Ihrer Referenz zu bestimmen und zu beurteilen, wie erfolgreich Ihre Ziele im Endergebnis erreicht wurden.
