Thematische Kreation

Warum sollten Sie Themen statt Dokumente schreiben? Es ist einfacher, Themen zu schreiben als ein Dokument zu schreiben, so wie es einfacher ist, eine lange Strecke zurückzulegen, wenn man Schritt für Schritt vorgeht. Außerdem ist es für Prüfer einfacher, Themen zu überprüfen und für Tester einfacher zu testen. Von all diesen leicht zu schreibenden Themen sind Aufgaben am einfachsten zu schreiben.

Themenbasiertes Authoring bedeutet, dass Sie Themen und keine Dokumente schreiben. Die Themen werden dann in gedruckten Dokumenten (Handbüchern, Ratgebern oder Online-Hilfen) zusammengefasst. Themenautoren beschreiben Themen nach Typ: Konzept, Aufgabe und Referenz. Sie können andere, weniger verbreitete Typen erstellen, aber ich möchte mich auf diese konzentrieren.

Aufgabenthemen sind leicht zu identifizieren, da sie nur aus einer Aufgabe und nichts anderem bestehen. Aus dem gleichen Grund sind Aufgabenthemen einfach zu schreiben. Das Schreiben von Aufgaben ist einfacher als jede andere Art des technischen Schreibens, vor allem, wenn Sie sich nicht mit der Frage herumschlagen müssen, was Sie sonst noch einbeziehen sollten. Die Antwort ist nichts. Es ist ein Absolutes. Sie schreiben den Thementitel, dann die Schritte und fügen nichts anderes ein, außer vielleicht einen Link „Weitere Informationen …“. OK, manchmal können Sie eine Anmerkung oder einen Haftungsausschluss hinzufügen, aber sonst nichts.

Referenztypen von Konzepten und Themen sind schwieriger zu quantifizieren, aber genauso einfach aufzuschreiben. In der Regel beschreiben konzeptionelle Überschriften einen allgemeinen Informationsbereich, beispielsweise eine Einleitung oder eine Betriebstheorie.

Referenzthemen hingegen enthalten Informationen, auf die der Leser möglicherweise zugreifen muss, um eine Aufgabe abzuschließen. Referenzinformationen können eine Tabelle mit Zündkerzen nach Fahrzeugtyp, eine Liste gängiger Symbole für medizinische Geräte oder ein Preisindex sein. Informationen, die der Benutzer möglicherweise benötigt, die für ihn jedoch nicht sichtbar sein sollten, es sei denn, er möchte sie ausdrücklich.

Regeln und Richtlinien für die thematische Erstellung
Die erste Regel beim themenbasierten Schreiben besteht darin, zuerst alle Aufgaben zu schreiben. Für mich war es zunächst schwierig. Ich habe von oben nach unten und von vorne nach hinten geschrieben. Es war einfach logisch. Natürlich stieß ich auf Fallstricke mit Informationen, die in bereits geschriebenen Kapiteln fehlten oder hinzugefügt wurden, aber so war es nun einmal. GESETZ?

Wider besseres Wissen und zwanzig Jahre Erfahrung nahm ich die Herausforderung an und begann, Aufgaben zu schreiben. Das bedeutet natürlich, dass sich jede Aufgabe in einer eigenen Datei befindet, was sehr seltsam war. Das Ergebnis war jedoch erstaunlich. Ich konnte fast sofort den Vorteil erkennen, die Aufgaben einfach aufzuschreiben und jede Aufgabe als ein einzelnes Thema zu schreiben:

• Ich erlangte schmerzlos Produktwissen, indem ich mich darauf konzentrierte, was jedes Element des Produkts oder der Anwendung bewirkte.
• Ich war in der Lage, Themen zu organisieren und neu zu ordnen, wenn mir neues Wissen zukam.
• Ich musste keine Angaben mehr machen. Wenn das Projektteam eine neue Funktion entwickelte, konnte ich die Aufgaben schreiben und sie für sie zusammenstellen.
• Ich habe sofort Übersetzungskosten gespart. Indem ich nur die Aufgaben aufschrieb, wurde mir klar, dass viele der Sätze von Aufgabe zu Aufgabe gleich waren, und ich begann, mir diese Sätze zunutze zu machen. Denn je genauer die Übereinstimmungen, desto besser.
• Ich könnte Redundanzen in meinem Schreiben reduzieren. Während ich die Themen schrieb, wurde alles, was keine Aufgabe war, in einen „späteren“ Ordner gelegt. Als ich den Ordner herauszog, konnte ich deutlich erkennen, welche Teile Referenzteile waren, also begann ich mit dem Zusammenbau. Ich könnte jegliche Redundanz, die auftritt, wenn Aufgaben dieselben zusätzlichen Informationen haben, leicht beseitigen.

Nachdem Sie alle Aufgaben oder alle Aufgaben, von denen Sie zu diesem Zeitpunkt wissen, aufgeschrieben haben, was machen Sie dann mit all den Informationen im Ordner „später“? Hierbei handelt es sich um Informationen, z. B. warum Sie diese Option dieser Option vorziehen oder was jede Option bedeutet.

Als ich schließlich die Referenzthemen schrieb, landeten die meisten davon in Tabellen oder Listen mit Aufzählungszeichen. Bei der Überprüfung von Aufgaben können Sie bei Bedarf Querverweise zu diesen Themen hinzufügen. Wenn Sie in DITA verfassen, können Sie auch eine relative Tabelle in Ihrer Ditamap erstellen. Es ist sehr cool und wenn Sie die Möglichkeit haben, sollten Sie es ausprobieren.

Für Online-Hilfe benötigen Sie selten konzeptionelle Informationen. Konzeptionelle Themen kommen meist nur in gedruckten Materialien zum Tragen. Wenn Sie ein Single-Source-Autor sind, können Sie dieselben Themen, die Sie für die Online-Hilfe erstellt haben, in Ihren gedruckten Materialien neu organisieren und wiederverwenden. Normalerweise müssen Sie jedoch das zuvor erwähnte Einführungsmaterial hinzufügen. Sehen Sie, was ich hier gemacht habe? Ich habe die Diskussion von der Themenerstellung auf die Erstellung einer einzelnen Quelle verlagert. Tatsächlich gehören sie zusammen.

Beispielsweise können Sie in einem Benutzerhandbuch ein konzeptionelles Thema für den Anfang jedes Kapitels schreiben. Bei Bedarf können Sie ein Konzeptthema in das Kapitel für einen ähnlichen Informationsabschnitt aufnehmen. Da es sich bei allen um Einzelthemen handelt, können Sie sie für einen Ausgabetyp – ein Handbuch oder einen Leitfaden – auf eine Art organisieren und sie dann mit mehr oder weniger Themen für einen anderen Ausgabetyp – Online-Hilfe oder ein Kurzreferenzdokument – ​​neu anordnen.

Ich habe diese Ergebnisse erhalten, als ich zum ersten Mal die Betrefferstellung verwendet habe:

• Meine Wortzahl ist gesunken.
• Meine genauen Übereinstimmungen für die Übersetzung haben zugenommen.
• Unsere Bewertungen zur Benutzerfreundlichkeit der Online-Hilfe sind deutlich gestiegen.

Einige Tipps und Tricks

Manche Gewohnheiten, die wir uns beim Schreiben aneignen, können uns verfolgen, und es ist schwer, diese Gewohnheiten aufzugeben. Hier sind jedoch einige Dinge, die ich gelernt habe:

• Wenn Sie aus Anforderungsdokumenten schreiben oder Ihre Informationen von Entwicklern erhalten, stellen Sie sicher, dass Sie nicht mehr Informationen bereitstellen, als der Endbenutzer benötigt.

Einige Entwickler möchten, dass alle ihre Denkprozesse einbezogen werden, und dem Benutzer ist es wirklich völlig egal, was erforderlich ist, um diese Steuerung in dieser Umgebung zum Laufen zu bringen. Vermeiden Sie auch Marketingbotschaften. Sie haben das Gerät oder die App bereits gekauft und wollen sich von der Qualität wirklich nicht unterkriegen lassen.

• Endbenutzer möchten auch kein Ergebnis lesen, das sie sehen können.

Sagen Sie ihnen beispielsweise nicht, dass das Filterfenster geöffnet wird, wenn sie „Filter“ auswählen. Wenn durch die Auswahl eines Steuerelements ein bestimmtes Fenster, beispielsweise ein Filterfenster, geöffnet wird, können sie es sehen. Wenn Sie wirklich eine Art Bestätigung hinzufügen müssen, beginnen Sie die nächste Aufgabe mit „Im Filterfenster …“. Dadurch sollte ihnen alles gesagt werden, was sie brauchen, um sicherzustellen, dass sie sich am richtigen Ort befinden.

• Wenn Sie ein Thema über eine Funktion schreiben, die in einem anderen Fenster ausgeführt wird, können Sie normalerweise einige Schritte für dieses Fenster kopieren und einfügen. Zum Beispiel, wenn Ihr Thema ist FiltersteuerungenDer erste Schritt ist wahrscheinlich so etwas wie „Wählen Sie in der Menüleiste Filter aus“.

Das Filterfenster selbst verfügt natürlich über eine Hilfeschaltfläche. Kopieren Sie daher alle Schritte aus dem Thema „Filtern“ bis auf den ersten Schritt. Kopieren Sie die Schritte 2 und fügen Sie sie ein NICHT im Thema Ihres Filterdialogfelds und Sie haben einige Arbeit gespart. Darüber hinaus stehen Ihnen jetzt genau passende Schritte für die Übersetzung zur Verfügung.

Um Ihre Frage vorwegzunehmen: Ja, wenn Sie eine Online-Hilfe erstellen, benötigen Sie zwei separate Themen: eines, um den Benutzern zu zeigen, wie sie auf das Dialogfeld „Filter“ zugreifen und es verwenden, und das andere für das Dialogfeld „Filter“ selbst. Einer befindet sich im Index unten Kontrollen, Filterung während Sie das andere Thema der Schaltfläche „Filterfenster“ zuordnen. Denk darüber nach.

Der eigentliche Vorteil der themenbasierten Erstellung besteht darin, dass Sie die meisten Online-Hilfethemen für alle erforderlichen gedruckten Materialien nutzen können. Sie erhalten ein Thema, klar und prägnant für den Leser und mehrere Ergebnisse für das Unternehmen. Es bedeutet viel für Ihr Geld.

Das nächste Mal: Single-Source-Erstellung

Source by Diane L Thompson