Grundlagen TD

Volltextsuche in mehreren PDFs

Dietrich.Juhl

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 →

Mit „Use Cases“ zur optimalen Anleitungen

Dietrich.Juhl

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 →

Zielgruppenanalyse und wie wir uns auf die Zielgruppe einstellen können

Dietrich.Juhl

Zielgruppenanalyse, Zielgruppe, Technische Dokumentation

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 →

Voraussetzungen in Handlungsanweisungen

Dietrich.Juhl

Der Punkt „Voraussetzungen“ in Handlungsanweisungen führt immer wieder zu Fragen. Deswegen möchte ich ein paar Gedanken hier näher ausführen.
Dabei beziehe ich mich auf die Struktur der Handlungsanweisung (Juhl’sche Handlungsanweisung).

Unter Voraussetzungen verstehe ich Zustände, die bereits vorhanden sein müssen,  damit die Handlung (sinnvoll) durchgeführt werden kann, z.B.:

  • Es müssen mindestens zwei Benutzer angelegt sein (bei Windows, um einen Benutzer ohne Adminrechte zu definieren)
  • Das Bild muss im Format RGB vorliegen (bei Photoshop, um die Filter zu benutzen)
  • Der Pfad muss geschlossen sein (bei Photoshop, um die Pfadfläche zu füllen)
  • Sie müssen über ein Bankkonto verfügen und VR-Net-Key und Passwort vorliegen haben.

Mehr lesen →

Nicht lineare Dokumentation – was wird anders?

Dietrich.Juhl

Früher haben wir Anleitungen geschrieben, bei denen der Inhalt für das (lineare) Buch gegliedert war:

  • alles steht hintereinander, vom Titelblatt bis zur letzten Seite
  • die Inhalte sind kapitelweise hierarchisch gegliedert

Diese Reihenfolge soll es dem Anwender ermöglichen seinen aktuellen Informationsbedarf zu decken, der inter- und intra-individuell durchaus unterschiedlich sein kann:

  • Einarbeiten: Bedienelemente kennen lernen, Grundbedienung erlernen, ausprobieren, anwenden …
  • Nachschlagen: Sehr unterschiedlicher Informationsbedarf in allen Phasen der Anwendung (vom „wie kann ich XY tun?“ bis „welches Drehmoment brauche ich bei …?“)
  • Weiter lernen: Ich gehe davon aus, dass ein Anwender zuerst die Grundfunktionen kennen lernen will und sich danach, vielleicht auch viel später, weitere Funktionen erschließt (bei Bedarf oder auch als „was gibt es sonst noch?“).

Heute nennen wir das gerne Use Cases. Die Anleitung muss geeignet sein, Antworten bei allen Use Cases zu geben (gemeint sind die Use Cases der Anleitung).

Mehr lesen →

Gehört Fachwissen in eine Anleitung?

Dietrich.Juhl

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 →

Spezifische, unspezifische Information

Dietrich.Juhl

***  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 →

Terminologiearbeit (Überblick)

Dietrich.Juhl

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).