Volltextsuche in mehreren PDFs

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.

Mehr lesen

Mit „Use Cases“ zur optimalen Anleitungen

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

Voraussetzungen in Handlungsanweisungen

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

Mehr lesen

Schritt-für-Schritt – oder geht es auch anders?

Step by Step, Karikatur von Tiki Küstenmacher
Zeichnung: Tiki Küstenmacher

Die Schritt-für-Schritt-Anleitung ist die konkreteste Form, einen Anwender zu einer Handlung anzuleiten. Das passt in vielen Fällen. In anderen häufigen Fällen passt es aber nicht und wir fragen uns, welche Alternativen es gibt.

Die Schritt-für-Schritt-Anleitung ist bei TRs beliebt und wird heute in den meisten Anleitungen konsequent angewendet, weil sie eine klare Strukturvorgabe hat, sie leicht zu schreiben ist und aus Anwendersicht leicht nach zu handeln ist. Bei manchen Handlungen scheint die Schritt-für-Schritt-Anleitung aber übertrieben zu sein, ist umständlich oder scheint gar nicht zu funktionieren. Anhand von ein paar Beispielen möchte ich zeigen, welche Alternative denkbar sind.

Mehr lesen

Zehn Schritte zur Software-Anleitung

Software-Anleitung schreiben - Software Anleitung erstellen - Muster

Anleitungen für Software sollen den Anwender in die Lage versetzen, sich selbstständig einzuarbeiten und bei Bedarf schnell die notwendigen Informationen zu finden.


Das Buch von Dietrich Juhl wendet sich an erfahrene Technische Redakteure, die Anleitungen für moderne Software kurz und verständlich schreiben wollen. Es entwickelt neue Konzepte und zeigt Strukturen und Beispiele.

Hardcover, 270 Seiten, 1. Auflage 04/2018. ISBN: 978-3752815528
Erhältlich im Buchhandel und im Juhlshop.


Die folgende Darstellung soll einen Überblick über die wesentlichen Prozessschritte geben.

Software Anleitungen strukturiert erstellen, schreiben

Software-Anleitungen können handlungsorientiert oder funktionsorientiert geschrieben werden. Eine Auszeichnung mit XML ist optional. Wichtig ist vor allem die Verständlichkeit. Wie kann die Software-Anleitung gegliedert werden? Wie lassen sich Handlungsanweisungen strukturiert schreiben? Sind Schritt-für-Schritt-Anleitungen sinnvoll?

Mehr lesen

Etwas mehr Selbstbewusstsein bitte

Wenn TD-Kollegen unser Metier als „notwendiges Übel“ darstellen oder den Zweck von Technischer Dokumentation auf die „Abwendung juristischer Ansprüche“ reduzieren, geht das m.E. völlig an der Sache vorbei und verkennt, was wir heute leisten und vielleicht noch mehr leisten können.

Gute TD ist die zentrale Festschreibung des aktuellen Entwicklungsstandes und das Zur-Verfügung-stellen der Informationen für alle Beteiligten in allen Produktlebensphasen. Gut gemacht erspart TD viele Stunden der Verwirrungen, Rückfragen,  Mehr lesen

Blogs in Richtung TD (Links)

Hier ein paar Blogs zum Thema „Technische Dokumentation“ und ähnlich.

Blog der Firma itl: Blog

Blog der Firma Doctima mit Prof. Dr. Markus Nickl: Blog

Blog der Hochschule Luzern zum Thema „Verständlich kommunizieren“: Blog

Blog der Firma Handbuch Experten: Blog

Blog der Firma tecteam: Blog

Blog von Schmeling+Consultants: Blog

Blog der Firma Parson: Blog

Blog der Firma Fritz-Communikation mit Beiträgen zur Terminologie: Blog

Blog der Firma Instruktiv: Blog
interessant auch der Beitrag über Tools und so: Technical Writing Tools: The Ultimate Choice of 83 Experts (2018 UPDATE)

Blog von PQRM (Satz KONTOR): Blog

… wird noch ergänzt …