Software-Anleitungen – handlungs- oder funktionsorientiert?

Vortrag in Hamburg, am 08. Mai 2018. 18-20 Uhr, tekom RG-Nord
Referent: Dietrich Juhl
Der Vortrag hat stattgefunden und war sehr gut besucht, vielen Dank an alle.

Wer Software-Anleitungen schreibt, kennt die Diskussion:
Können wir Funktionen beschreiben oder braucht der Anwender unbedingt eine Schritt-für-Schritt-Anleitung?
Entwickler und Programmierer plädieren mehr für Funktionen, während wir in der Technischen Dokumentation gelernt haben, konkret zum Handeln anzuleiten.
Allerdings hat sich in den letzten Jahren viel geändert: Software ist intuitiver geworden und Anwender gehen mit Software heute sehr viel kompetenter um.

Dietrich Juhl stellt beide Beschreibungsmöglichkeiten vor, zeigt neue Wege zum Handeln anzuleiten (teilweise ohne Schritt-für-Schritt!) und demonstriert wie Funktionsbeschreibungen interessant und sinnvoll eingesetzt werden können.

  • Wann ist was besser?
  • Wie geht es richtig?

Ein spannender Vortrag mit viel Systematik für alle die Software-Anleitungen schreiben. Geeignet für Anfänger und alte Hasen.

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

Seminare und Workshops

Seminare und Workshops für Technische Redakteure in Technische Dokumentation

Knowhow für Technische Redakteure zu allen Fragen der Technischen Dokumentation. Wie schreiben oder erstellen TRs Bedienungsanleitungen strukturiert und gut gegliedert.

tekom Zertifizierung

Hauptberuflich oder nebenberuflich schreibende Technische Redakteure oder Autoren (technical writer author) schreiben oder erstellen Bedienungsanleitungen, Betriebsanleitungen, Handbücher, Manuals, Tutorials für Technische Geräte, Anlagen oder Software. Solche Anleitungen müssen gut gegliedert sein (Gliederung, Muster, Template) müssen rechtssicher sein, nach DIN EN 82017 oder ANSI 535, mit Warnzeichen und nach SAFE strukturiert. Visualisierung, Anweisung, Betreiberpflichten, Anleitung, Produktlebenszyklus, Analysen, Zielgruppenanalyse, Produktanalyse, Konzept, Layoutkonzept, verständlich schreiben nach Hamburger Verständlichkeitsmodell, bestimmungsgemäßer Gebrauch, Produkthaftung, Zielgruppe und Persona-Methode, Persona-Darstellung, Benutzer, Anwender, Administrator.

Als Coach und Trainer mit langjähriger praktischer Erfahrung biete ich Seminare und Workshops zum verständlichen Schreiben:

  • Personal Training „verständlich schreiben“
    Intensivtraining in kleinen Gruppen. Preiswert für Studenten und angehende Technische Redakteure.
    … mehr
  • Workshop „Software-Anleitungen verständlich schreiben – Konzepte, Strukturen, Beispiele“
    Neue Strukturen und systematische Ansätze zur Vermittlung von Wissen und Handlungswissen bei Software.
    Ein-Tagesseminar jeden Monat an wechselnden Standorten.
    Nächste Termine: Ende September in Mainz
    … mehr

Von der Anleitung zum Handlungsnavi – ein Gedankenspiel

Ein Navi merkt sofort wenn Sie falsch fahren und gibt alsbald neue Instruktionen.
Bei einer Anleitung ist das anders: Die Schritte stehen fix hintereinander, egal wie Sie handeln, der nächste Schritt bleibt statisch.
Wäre es theoretisch möglich, dass die Anleitung die aktuelle Position des Anwenders kennt und den nächsten Schritt entsprechend berechnet?

  • Aber wie soll das gehen?
  • wie kann der Anwender das Ziel  eingeben?
  • wie kann die Anleitung erkennen, wo sich der Anwender jetzt innerhalb der Handlung befindet?
  • was ist der folgerichtige nächste Schritt?
  • lässt sich der berechnen wie beim Navi?

Mehr lesen

Buchempfehlung: Every Page is Page One von Mark Baker

EPPO-Topics

 

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