Topic-basiertes Schreiben

Topics sind kleine Informationshappen, die für sich alleinstehen und unabhängig von anderen Topics sind. Topics stillen einen konkreten Informationsbedarf und behandeln genau ein Thema. Wir können sie in verschiedenen Kontexten kombinieren und wiederverwenden. Damit eignen sich Topics perfekt für die technische Dokumentation, insbesondere die Online-Dokumentation.

In dieser Schulung lernen Sie, wie Sie topic-basierte Dokumentation erstellen, die auf Ihre Zielgruppen und Ihre Anwendungsumgebung zugeschnitten ist.

Für wen ist die Schulung?

  • Technische Redakteure
  • Mitarbeiter in der Entwicklung und Konstruktion, die Dokumentation schreiben

Vorkenntnisse

  • Sie schreiben bereits technische Dokumentation.

Zeitaufwand

  • Ein Tag

Schulungsformat

Schulungsinhalte

Grundlagen des topic-basierten Schreibens

Am Anfang der Schulung erfahren Sie etwas über die Grundlagen und Vorteile von topic-basiertem Schreiben. Sie lernen:

  • Was ist topic-basiertes Schreiben
  • Was ist ein Topic und welche Eigenschaften hat es?
  • Welche Vorteile bietet topic-basiertes Schreiben?

Typische Topic-Arten

Die drei grundlegenden Topic-Arten sind Handlungsanweisung, Konzept und Referenz.

  • Sie lernen, diese Topic-Arten voneinander abzugrenzen und richtig zu verwenden.

Topics richtig strukturieren

Jede Topic-Art folgt einer Struktur und ist konsistent hinsichtlich Formulierung und Gestaltung. So erkennen die Anwender sofort, um welche Art von Information es sich handelt und was von ihnen erwartet wird: Soll ich hier etwas tun? Kann ich mir Hintergrundwissen aneignen? Oder kann ich hier etwas nachschlagen? Sie lernen:

  • Welche Strukturierungselemente eignen sich für die verschiedenen Topic-Arten?
  • Wie formuliere ich Überschriften?
  • Was sind mögliche Standardstrukturen für Handlungsanweisung, Konzept und Referenz?

Zielgruppen und Topic-Arten

Um Topics anwendergerecht zu schreiben, müssen wir unsere Zielgruppen kennen. Sie lernen:

  • Eine Zielgruppe analysieren: Was wissen die Mitglieder der Zielgruppe, welches Wissen benötigen sie und in welchem Umfeld und Kontext lesen sie die Dokumentation?
  • Was sind typische Zielgruppen und mit welchen Methoden erfasse ich ihren Informationsbedarf?

Inhaltstypen zuordnen und Topics schreiben

In praktischen Übungen lernen Sie: 

  • Inhaltstypen in Dokumenten identifizieren und Informationen neu in Topics zusammenzustellen
  • Eigene Topics schreiben
  • Anwenderorientiert und minimalistisch schreiben

Vom Topic zur Dokumentation

Wie stellen wir Topics zu einem Informationsprodukt zusammen? Sie lernen unter anderem:

  • Welche Informationsprodukte werden typischerweise topic-basiert erstellt?
  •  Wie gehe ich vor, um Topics zu einem Informationsprodukt zusammenzustellen? 
  • Welche Auslieferungsformate eignen sich und was muss ich dabei beachten?

Zum Lernportal von parson