Jetzt buchen: „Software-Anleitungen verständlich schreiben – Konzepte, Strukturen, Beispiele“

Workshop Software-Anleitungen verständlich erstellen, Dietrich Juhl, Systematik, skalierbare Strukturen

Nächste Termine:
Freitag, 07. Juni 2019, in Ingelheim
Montag, 24. Juni 2019 in Nürnberg
Dienstag, 25. Juni 2019 (Visualisieren) in Nürnberg

Anleitungen für Software stellen besondere Anforderungen an Technische Redakteure. Denn oft machen hier intuitive Bedienkonzepte „viel Anleitung“ überflüssig. Stattdessen gilt es, Features und Funktionen zu erklären. Mit den herkömmlichen Schritt-für-Schritt-Anleitungen kommen Sie nicht weit. Sie brauchen neue Konzepte und Strukturen, die sich flexibel an die Eigenarten der jeweiligen Software anpassen lassen. Im Workshop stelle ich Ihnen mehr als 10 systematische Beschreibungsansätze vor. Richtig kombiniert, leiten Sie den Anwender zur Handlung an oder vermitteln ihm Funktionswissen. Bedarfsgerecht, nachvollziehbar und auf den Punkt.

Der intensive Workshop richtet sich an Technische Redakteure, die Software-Anleitungen schneller, leichter und systematischer erstellen wollen. Dabei bleibt es nicht bei der Theorie. Sie üben die neuen Beschreibungsmodelle an eigenen Beispielen, können das Erlernte sofort erproben und erhalten direktes Feedback.

Die Inhalte

Das von mir entwickelte zielorientierte Schreiben hat sich als der Schlüssel für strukturiertes, verständliches Schreiben von Anleitungen bewährt. Ein großer Vorteil: Das strukturierte Vorgehen lässt sich flexibel an den unterschiedlichen Bedarf moderner Software anpassen.

Die Kernthesen aus Buch und Workshop:

  • Intuitiv bedienbare Software braucht meist keine Schritt-für-Schritt-Anleitung.
  • Stattdessen gilt es, Handlungsmöglichkeit aufzuzeigen, Funktions-Parameter zu erklären und Funktionen durch ihre Regeln zu charakterisieren.
  • Insgesamt steht ein Set von 12 Strukturelementen zur Verfügung, die ein Technischer Redakteur beherrschen muss.
  • Auch die funktionsorientierte Beschreibung ist bei gut geordneter Software möglich.
  • Ansätze wie Tutorials (ggf. als Screencast), FAQs oder Tipps können als Ergänzung einer systematischen Anleitung in die Überlegungen einbezogen werden.

Im Workshop werden die Strukturen und Definitionsbereiche gemeinsam entwickelt, erläutert und angewendet. In der kleinen Gruppe können eigene Beispiele und Fragen eingebracht, gelöst und geübt werden. Im Einzelnen geht es um diese Punkte:

  • Aufbau und Zielstellung der Software-Anleitung
  • Leistungsbeschreibung: wichtige Grundinformation für Anwender
  • Vermittlung von Softwarekonzepten
  • EPPO-Ansatz (“Every Page is Page One” von Mark Baker)
  • Anleiten zum Handeln (flexible Skalierung einer erweiterten Handlungsanweisung)
  • Funktionsbeschreibungen (systematische Erklärung von Funktionen, bedarfsweise mit Handlungsanweisungen)
  • Zusammenspiel von Anleitung und Referenzteil, zwischen Handlungsanleitungen und Funktionsbeschreibungen
  • Andere Ansätze (Tutorials, Vermittlung von Systematik, FAQs, Tipps)
  • Use Cases einer Anleitung (Welche Erwartung hat der Anwender?)
  • Ganze Anleitungen (Verschiedene Ansätze, Zusammenwirken der Beschreibungskomponenten)
  • Weitere Fragestellungen (Fragen der Teilnehmer)

Zielgruppe

Erfahrene Technische Redakteure,

    • die Software-Anleitungen schreiben,
    • die leicht und sicher formulieren wollen,
    • die mit mehr Systematik schneller gute Anleitungen erstellen möchten.

Visualisieren in Software-Anleitungen

Beim Termin in Nürnberg können Sie optional am Folgetag am Seminar „Visualisieren in Software-Anleitungen“ teilnehmen.

Die Inhalte:

  • Von der didaktischen Absicht zur Bildfunktion.
    Neue Erkenntnisse zum zielorientierten Visualisieren.
  • Darstellungsarten
    Die Palette an möglichen Bildern, vom Screenshot zum Blockdiagramm
  • Inhalte visualisieren
    Praktische Ansätze und Beispiele Inhalte durch Bilder verständlich zu machen.

Fachbuch inklusive

Alle Teilnehmer des Workshops erhalten ein Gratis-Exemplar des Fachbuchs „Software-Anleitungen verständlich schreiben. Konzepte, Strukturen, Beispiele“ vom Autor und Workshop-Leiter Dietrich Juhl. Wurde das Buch vorher erworben, wird dies bei der Workshop-Buchung angerechnet.

Daten

  • nächste Termine:
  • Freitag, 07. Juni 2019 in Ingelheim
  • Montag, 24. Juni 2019 in Nürnberg
  • Dienstag, 25. Juni 2019 in Nürnberg (Visualisieren)
  • 490 € Workshop „Software-Anleitungen“ von 9:00 bis 17:00
  • 250 € „Visualisieren“ von 9:00 bis 14:00 (optional, auch einzeln buchbar)
  • Bitte eigenen Laptop und Beispiele mitbringen
  • 3 – 10 Teilnehmer
  • Alle Preise inklusive Getränke und Mittagessen (zzgl. MWSt.)
  • (Sonderkonditionen für Studenten oder Selbstzahler sind möglich)

Anmeldung und Fragen

  • Bitte schreiben Sie mir oder rufen Sie mich an.
  • Auch Ihre Fragen sind willkommen!

Dietrich Juhl
06132 / 972 02 02
dietrich@juhl.de

Interesse am Workshop

Tragen Sich sich unverbindlich in die Liste ein, damit ich Sie benachrichtigen kann, wenn ein Workshop in Ihrer Nähe stattfindet.

Interesse an:
Vorname Name:
Email:
Bevorzugter Veranstaltungsort:
Nachricht an Juhl (falls gewünscht):

Beziehungsbilder

Jeder Technische Redakteur benutzt Bilder, um die Anleitung verständlicher und interessanter zu machen. Doch was macht das Bild eigentlich beim Benutzer? Welche Funktion haben Bilder und wie kann ich sie noch gezielter und effektiver einsetzen?

Für mein neues Buch* habe ich Bildfunktionen gesammelt, geordnet und systematisiert. Dabei kamen viele bekannte und einige neue Aspekte heraus:

Bilder illustrieren, machen anschaulich und konkretisieren. Kennen wir … könnte man aber noch viel zu sagen.

Neu für mich war, wie sehr Bilder den Bezug zwischen Anleitung und Gerät herstellen. Der Anwender hat zwei Dinge vor sich:

Mehr lesen

Visualisieren ist mehr als das Zeigen von Realität

In Anleitungen verwenden wir Bilder vielfach um die Realität zu zeigen oder den Bezug zur Realität herzustellen.
Doch Bilder können viel mehr. Vor allem gewähren sie neue Einblicke, spezielle Sichten und die Visualisierung abstrakter Modelle.
Als Technische Redakteure erdenken wir solche Bilder, stellen sie her und komponieren perfekte Informationen aus Bild und Text.
Ein paar Beispiele:


 

Bilder in Anleitungen zeigen die Realität, veranschaulichen, zeigen Teile (mit Benennung) und Handlungen. (Bildquelle: Brother)


Mehr lesen

Neues Buch: Technik visualisieren

in Arbeit, erscheint demnächst

Jeder Technische Redakteur setzt Bilder ein, um die Anleitung attraktiv und verständlich zu machen.
Genauer betrachtet sind die Bildfunktionen sehr viel weitreichender und geben uns die Chance Verstehensprozesse noch gezielter zu unterstützen. Im Buch habe ich sehr viele Aspekte herausgearbeitet, die mir vorher nicht so deutlich waren, z.B.:

  • Das Bild stellt auf einfache Weise den Bezug zwischen Anleitungsseite und Geräteteil her.
  • Ein Bild zeigt nicht nur Realität, sondern visualisiert mentale Modelle oder Betrachtungen (z.B. ein Spannungsverlauf)
  • Das Bild stellt bei einer Text-Bildkombination einen Fixpunkt dar und wird durch die Erklärungen immer mehr durch Bedeutung gefüllt.
  • Ein Bild ist eine gute Kommunikationsgrundlage: Alle akzeptieren das Gezeigte als richtig (oder diskutieren Details) und können durch Zeigen den Fokus auf ein Detail lenken.

Weitere Kapitel beschäftigen sich mit den Inhalten, die wir visualisieren (Aufbau und Funktion, Handlungen, Technische Unterlagen), zeigen die Vielfalt der Darstellungsarten und sehr viele praktische Aspekte:

  • Wie kann ich Bilder beim Schreiben mitdenken?
  • Wie stelle ich einen optimalen Bild-Text-Bezug her?
  • Was muss ich beim Fotografieren beachten?
  • und vieles mehr …

Das Buch ist in Arbeit und soll vor dem Sommer fertig werden.
Wenn Sie das Thema interessiert, Sie Aspekte mit mir vorab diskutieren wollen, Fragen oder gute Beispiele haben,
würde ich mich über eine Kontaktaufnahme freuen.

Dietrich Juhl dietrich@juhl.de

 

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

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

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