Grundlagen TD

Wußten Sie schon, dass man PDFs so ausstatten kann, dass in mehreren Dateien gesucht wird? Genauer gesagt heißt das „Indizieren“, bei Acrobat heißt die Funktion „Catalog“ (was nicht sehr sprechend ist).
Ich habe bisher wenig Kollegen getroffen, die diese Möglichkeit kennen, meistens noch nicht mal vom Hören-Sagen.
Dabei wäre es gerade für Anleitungen, die über viele PDFs verteilt sind oder viele Zulieferer-PDFs mitliefern, sicher sinnvoll so eine Volltextsuche anzubieten. Dadurch dass der Index eingebettet ist, läuft die Suche auch sehr schnell.
Auch einzelne Dateien kann man indizieren und damit die Volltextsuche verbessern.

• Sie benötigen Adobe Acrobat
• die Handhabung ist einfach aber doch ein bisschen „tricky“
• Leider muss man auch dem Anwender der PDF-Dateien noch eine Anleitung geben, damit er die Volltextsuche über mehrere Dateien nutzen kann.

Wie es geht habe ich in einer Anleitung beschrieben, die Sie sich hier gerne herunterladen können:

Mehr lesen →

Wenn ein Anwender eine Anleitung zur Hand nimmt, erwartet er schnelle Hilfe zu genau seiner Frage oder seinem Problem.
Die Betrachtung dieser Use Cases ist der Schlüssel für die Entwicklung effizienter Technischer Dokumentation auf Papier, Online oder als App.

Was sind Use Cases?

Um es noch mal deutlich zu sagen: Ich spreche hier über die Use Cases der Anleitung, also die Situationen, in denen der Anwender Hilfe benötigt. Zunächst auch unabhängig davon, ob er die Anleitung zur Hand nimmt oder nicht.

Mehr lesen →

Das Web hat unsere Art zu lesen stark verändert. Besonders die stete Verfügbarkeit und per Suche zugängliche Information verleitet uns punktuell nach einer Lösung unseres Problems zu suchen. Auch Leser von Bedienungsanleitungen lesen die Anleitung nicht von vorne nach hinten und verschaffen sich nicht einen Zugang über das Inhaltsverzeichnis, sondern suchen mit Google oder einer Volltextsuche gezielt nach einer Lösung zu genau einem Problem.

„Jede Seite, die diese Anwender betreten ist die erste Seite“, bringt es Mark Baker auf den Punkt. Und diese Seite muss funktionieren!

Mehr lesen →

Wer eine Anleitung schreibt, MUSS über die Zielgruppe nachdenken, um sich in Sprache und Stil auf die potentiellen Anwender einzustellen.
Dabei gibt es mehrere Möglichkeiten die Zielgruppe einzuschätzen. Meistens sprechen wir von einer „Zielgruppenanalyse“, was aber nicht so ganz stimmt, wie der folgende Beitrag zeigt.
Das obige Bild soll deutlich machen, wie umfangreich und unterschiedlich Fachwissen sein kann und wie wichtig es folglich ist, dieses Fachwissen zu kennen und zu berücksichtigen.

Welche Eigenschaften der Zielgruppe interessieren uns?

Wir schreiben Anleitungen für Anwender, die schon etwas wissen und können.
Um uns beim Schreiben auf diese Anwender einzustellen, interessiert uns besonders:

• Welche Fachkenntnisse hat der Anwender? (Grundwissen, Fachtermini, Handlungswissen, Sicherheitsbewusstsein).
• Welche Erfahrung hat er mit ähnlicher Technik bereits gemacht?

Mehr lesen →

Fachwissen gehört eigentlich nicht in eine Anleitung!
Eine Anleitung vermittelt das notwendige Geräte- und Handlungswissen zu einem Gerät / zu einer Maschine / zu einer Software.
Als Anleitungsschreiber kann und muss man davon ausgehen, dass der Anwender das notwendige Fachwissen bereits mitbringt, oder falls er es nicht hat, sich anderweitig besorgt.
Grundsätzlich steht es Ihnen als TR aber frei, Fachwissen in die Anleitung aufzunehmen.

Mehr lesen →

***  Dieser Beitrag ist noch nicht ganz fertig, ***
*** ich stelle ihn trotzdem schon mal zur Diskussion ***

In letzter Zeit betrachte ich häufiger, wie wir als Technische Redakteure Informationen für unsere Anwender aufbereiten. Dabei differenziere ich momentan gerne „spezifische“ und „unspezifische“ Information. Wahrscheinlich kommt Ihnen das zunächst etwas akademisch vor, ich meine aber, es lohnt sich, sich mit dieser Unterscheidung zu befassen.

Spezifische Information

Spezifische Information nenne ich solche, die eine konkrete Antwort auf eine Frage gibt. Z.B. „Wie kann ich das Gerät einschalten?“ wird durch ein Kapitel „Einschalten“ beantwortet. Weitere Beispiele:

Mehr lesen →

„Habe ich alles?“, „was fehlt noch?“, „wo habe ich etwas vergessen?“.
Stellen Sie sich diese Fragen kurz vor Veröffentlichung?

Nie mehr etwas vergessen!

Mein Tipp:

Mehr lesen →

Der folgende kurze Abriss soll nur einen Überblick über die Terminologiearbeit geben.
Zu jedem Punkt könnte man noch viel schreiben.

• Sensibilisierung, dass bei der Benennung von Teilen nicht immer die gleichen Termini benutzt werden.
• Beispiele aus der aktuellen Praxis
• Entschluss Terminologiearbeit einzuführen
• Extraktion aller Benennungen
  (z.B. aus allen Dokumenten im Unternehmen)
• Erkennung von Dubletten (welche Benennungen meinen das Gleiche?)
• Gründung eines Terminologie-Arbeitskreises
• Festlegen auf eine Benennung (im Arbeitskreis)
• Festhalten der gewünschten und der nicht gewünschten Benennungen
  (in einer Datenbank, Excelliste … ggf. mit Definition und Übersetzungen)
• Publizieren (die Datenbank muss für alle zugänglich sein)
• Verpflichtend! (Die Einhaltung muss von der Geschäftsleitung gefordert werden).