0 %

schneller

Erstelle deine Topics schneller. Mehr Output, kurze Laufzeiten. Beispiel: 300 h -> 210 h

0 %

kürzer

Schreibe kurze, knackige Texte für deine User.
Beispiel: 100 Seiten -> 70 Seiten

0 %

mehr Nutzen

Fertig: dein User kann sich selbständig einarbeiten und professionell arbeiten

Workshop: Schreibe schneller gute Anleitungen

Lerne das perfekte System kennen, mit dem du raketenschnell gute und kurze Anleitungen schreibst. Das zielorientierte Schreiben gibt dir klare Strukturen für die unterschiedlichen Informationstypen. Du kannst sie einfach abarbeiten und erhältst optimale Topics, die zusammen deine erfolgreiche Anleitung ergeben. Nie wieder vor dem leeren Blatt Papier sitzen, nie wieder die Hab-ich-Alles-Frage, nie wieder Angst vor Anwender-Feedback. Du bist immer sicher, dass deine Anleitung funktioniert.

Gute Software braucht gute Anleitung

Eins ist klar! Gute Software spart deinem Anwender sehr viel Routinearbeit, vereinfacht Prozesse und macht viele Dinge erst möglich.
Und – gute Software ist übersichtlich und intuitiv.
„Leider“ muss dein Anwender trotzdem zuerst ein bisschen lernen, um das Konzept und die vielen praktischen Features zu verstehen.
Dazu brauchst Du eine Anleitung! Vielleicht auch eine Onlinehilfe, Video, Augmented Reality oder oder. Dazu später mehr.

Gute Anleitungen helfen

Eine gute Anleitung gibt deinem Anwender die richtige Information zum Verstehen und zum Handeln. Er verstehst das Konzept, er weiss wo die Reise hingeht und er weiss, was was bewirkt. Im Idealfall funktioniert das sofort: Er hat es verstanden, er hat den Nutzen und kann weitere Features erkunden.

Schlechte Anleitungen kosten Zeit und Geld

Wenn die Anleitung nicht klar ist, muss der User ausprobieren: lesen, einstellen, testen … geht nicht … Neuer Versuch… Das kostet Zeit und Nerven. Mit jeder Runde steigt sein Frustrationspegel und die Lust auf diese Software sinkt.

Du schreibst gute Anleitungen

Natürlich schreibst du gute Anleitungen, perfekt gegliedert, verständlich geschrieben, normgerecht und nach allen Regeln der Kunst.

Oder zweifelst du manchmal: „Lesen die überhaupt meine Anleitungen, warum rufen so viele User an, wie könnte ich noch besser, noch kürzer, noch übersichtlicher schreiben … ? Geht das überhaupt?“

Geht es besser?

Untersuchungen zeigen, dass Anleitungen häufig zu lang und zu kompliziert sind und dass entscheidende Informationen fehlen.

Das geht besser! Vor allem moderne Software, die übersichtlich und intuitiv ist, profitiert von neuen Ansätzen und Methoden.

Workshop „Besser schreiben – Erfolgreiche Software-Anleitungen“

Du wirst nach diesem Workshop bessere Anleitungen schreiben. Anleitungen, die deine Software übersichtlich machen, klar zum Handeln anleiten und alle Features rüberbringen.

  • Du erkennst wann dein Kunde die Anleitung zur Hand nimmt
  • Du antizipierst seinen Informationsbedarf
  • Du kennst die richtigen Informationstypen und die passenden Informationsstrukturen
  • Du kannst strukturiert schreiben
  • Du kannst mit diesem Baukasten eine geniale Anleitung für deine geniale Software komponieren.

Nach dem Workshop wirst du Spaß am Schreiben haben, dein Ergebnis genießen und ungeduldig auf Feedback deiner Kunden warten. 
Du kannst sicher sein: es wird positiv!

Wie gut ist deine Anleitung?

Du bist unsicher, ob deine Anleitung gut ist, du weist nicht, was du besser machen kannst, du weißt nicht, ob es überhaupt gute Anleitungen geben kann.

Damit bist du nicht allein und du und andere trösten sich mit dem Satz „die Anleitungen werden doch nicht gelesen“. Das stimmt bei Anleitungen für einfache Geräte, solche, die der Anwender schon kennt und solche bei denen er selber ausprobieren kann. Dann bist du aus dem Schneider!

Wenn deine Software etwas komplexer ist oder wenn du siehst, dass deine Anwender viele praktische Features gar nicht entdecken und wenn du mehr möchtest, bist du hier richtig.

Gut schreiben kannst du lernen!

Der Workshop ist ein Muss für alle, die erfolgreiche Software-Anleitungen schreiben möchten. Und das Beste: er funktioniert!

„Ich schreibe heute viel schneller und bin sicher, dass meine Anwender klar kommen. Dafür bekomme ich viel positives Feedback“

Bei uns ist
das anders

Wir arbeiten agil … 

Dann bist Du hier trotzdem richtig.
Anleitungen in agiler Softwareentwicklung brauchen 
1.) eine klare Anleitung für die Basis (Konzept, UI)
2.) ein Konzept für Handlungs- und Feature-Module
3.) agile Prozesse

Die ersten beiden schaffen wir im Workshop.

Wir wollen kein herkömmliches Handbuch …

Du träumst von ganz anderen Anleitungen, wie Video, Augmented Reality oder noch besser … Auch dann bist du hier richtig, denn die Grundlagen brauchst du immer: „Wie tickt mein Anwender? Welche Fragen hat er? Welche Infos braucht er? Wie informiere ich zielsicher“ sind die Basis für jede Informationsaufbereitung. Nur mit diesem Wissen startest du sicher zu neuen „Irgendwie-Besser-Anleitungen“.

Inhalte *

Der Workshop bietet dir alles Wissen und alle Methoden, um dich auf deinen Anwender einzustellen, seine Fragen zu antizipieren, Informationen zielgerecht zu schreiben, richtig zu gliedern und mit Bildern anschaulich zu machen. Inhalte ausführlich unten

1. Was will dein Anwender?
Lerne die Standardfragen
Dein Anwender will nicht alles auf einmal
Dein Anwender lernt in Phasen
Was weiss er schon und wie kannst du dich auf ihn einstellen?
2. Richtig gliedern
Wann nimmt der Anwender die Anleitung zur Hand?
Was will er in diesem Moment?
Wie findet er seine Information?
Wie kannst du ihn führen?
Eine Gliederung für alle Fälle
3. Diese vier Inhalte braucht dein Anwender
Was ist das, was kann er damit machen?
Was ist wo auf dem Bildschirm und wofür ist es?
Wie kann er handeln?
Welche Features gibt es?
4. Leistung und Screens
Kategorie und Nutzen (bestimmungsgemäßer Gebrauch)
Überblick und Screenaufteilung
Navigation
5. Anleiten zum Handeln
Schritt für Schritt, aber richtig
Warum das Handlungsziel besonders wichtig ist
flexibel anleiten, je nach Funktion und Informationsbedarf
Alternativen, wenn Schritt für Schritt nicht geht
6. Funktionen beschreiben
Vorteile der gemeinsamen Beschreibung
Konzepte für die funktionsweise Beschreibung
Viele Funktionen mit wenig Text beschreiben
Funktionen erklären – reicht das zum Handeln?
7. Ganzheitliche Ansätze
Andere Möglichkeiten anzuleiten
Andere Medien
Gesamtplan, Arbeitsteilung, Abstimmung
Synergien nutzen
8. Mehr Einsicht mit Bildern
Abstraktes visualisieren
was bringt das Bild?
der Weg zum Bild (Begriffe, Zusammenhänge, Ordnung)
deine Lösungen, deine Fragen
Zusatzmodul – 14 Tage später
Previous
Next

Durchführung und Dauer

Der Workshop findet als Zoom-Meeting statt.

  • Die ersten Inhalte kommen per Video vorab. Das sind ein paar Grundlagen über Software, Zielgruppen und Use Cases unserer Anleitungen.
  • Am ersten Kurstag betrachten wir noch mal die Use Cases und entwickeln eine passende Gliederung. Wir betrachten dann vor allem die Möglichkeiten zum Handeln anzuleiten. Das ist mehr als Schritt für Schritt.
  • Am zweiten Tag konzentrieren wir uns auf die funktionsweise Beschreibung. Sie macht die Anleitung übersichtlich und kurz. Denn die funktionsweise Beschreibung kann ganz viel weglassen und ganz anders anleiten. Sei gespannt.
  • Am dritten Tag betrachten wir das Ganze als Ganzes, als Zusammenspiel, als Antwort bei Fragen, als Reihenfolge zur Einarbeitung, zum Querlesen beim Weiterlernen.
    Und wir setzen Bilder ein, denn es ist ganz einfach komplexe Konzepte, Systeme oder Prozesse zu visualisieren und mit Text kapierbar zu machen.
  • Danach hast du Pause und kannst anwenden. Deine neue Sichtweise, die Strukturen mit Formulierungshilfen, deine Ideen, dein Gesamtwerk.
  • Nach ca. zwei Wochen treffen wir uns noch mal als Gruppe, mit deinen Ergebnissen, deinen Fragen und deinen Ideen.

Benefit

Nach drei Tagen Workshop gehst du erfrischt an die Arbeit. Frische Ideen, Strukturen zum Festhalten und eine klare Vorstellung, wie eine gute Anleitung aussehen muss. Du wirst feststellen, dass es Spaß macht, strukturiert zu schreiben und die Anleitung mehr und mehr wachsen zu sehen. Zum Schluss kannst du dein Ergebnis genießen: Eine tolle Anleitung, in kurzer Zeit, mit viel weniger Wörtern und 100% mehr Nutzen für deinen Anwender.

Preise

Gesamtpreis

nur 590 €

zzgl. MWSt., zahlbar nach Rechnung, 14 Tage vor Termin. 
Sonderpreis für Selbstzahler und Studenten möglich.

Dieser Workshop lohnt sich!

  • Du stärkst dein Repertoire verständlich zu schreiben
  • du hast Problemlöser für komplexe Fälle
  • du schreibst schnell und effizient
  • du erreichst mehr Anwender
  • deine Anwender können die Software professioneller nutzen
  • deine Anwender schätzen die Software und deine Anleitung
  • deine Kollegen vertrauen deiner Professionalität

Melde dich jetzt an

Hier kannst du dich unverbindlich anmelden.

  • Damit sicherst du dir einen Platz im nächsten Workshop
  • wir halten dich auf dem Laufenden und bieten dir Termine an
  • Du bist noch nicht gebucht und kannst jederzeit stornieren.

Ich interessiere mich für den Workshop „Software-Anleitungen verständlich schreiben“.

Kontakt und Impressum

Dietrich Juhl
Auxonner Str. 19
55262 Ingelheim am Rhein (bei Mainz)

Tel. 06132 / 972 02 02
Fax 06132 / 972 02 03
Mobil 0171 / 36 19 325

dietrich@juhl.de
www.juhl.de

Dietrich Juhl. Technische Dokumentation. Technischer Redakteur und Dozent.

Du möchtest mich vorab kennen lernen …

oder deine speziellen Wünsche mit mir besprechen?
Nichts leichter als das: Triff mich in einer Videokonferenz, spontan und unkompliziert. Schicke mir einfach einen Terminvorschlag, dann organisiere ich ein Zoommeeting.

Module zum erfolgreichen Schreiben

Jedes Modul wird Dich verändern. Jedes Modul gibt dir neue Einblicke, Anregungen und Methoden. Spätestens nach Modul 8 schreibst du deine perfekten Anleitungen, in deinem Stil.

Modul 1: Was will dein Anwender?

Sich in den Anwender hineinzuversetzen wäre die Antwort … aber das ist nicht ganz einfach. Meistens sind es die gleichen Fragen, die dein Anwender stellt. Und ein paar Tricks helfen auch.

  • Lerne die Standardfragen 
  • Dein Anwender will nicht alles auf einmal
  • Dein Anwender lernt in Phasen
  • Was weiss er schon und wie kannst du dich auf ihn einstellen? (Zielgruppeneinschätzung und Personadarstellung)

Modul 2: Richtig gliedern

Als TR ordnest du die Inhalte für deinen Anwender, um ihn zu führen (z.B. bei der Einarbeitung) und ihm einen schnellen Zugriff zu geben. Die Leitlinien sind die Situationen, in denen er die Anleitung zur Hand nimmt.

  • Wann nimmt der Anwender die Anleitung zur Hand?
  • Was will er in diesem Moment?
  • Wie findet er seine Information?
  • Wie kannst du ihn führen?
  • Eine Gliederung für alle Fälle

Modul 3: Diese vier Inhalte braucht dein Anwender

Jeder erfolgreiche TR muss diese vier Inhalte kennen, klar unterscheiden, separieren und gezielt beschreiben. Eine Erst-Mal-Gliederung ermöglicht eine Reihenfolge, die wir später noch mal überdenken können.

Die Anwenderfragen:

  1. Was ist das, was kann ich damit machen? (bestimmungsgemäßer Gebrauch)
  2. Was ist wo auf dem Bildschirm und wofür ist es?
  3. Wie kann ich handeln?
  4. Welche Features gibt es?

Modul 4: Leistungsbeschreibung und Screenbeschreibung

Eigentlich bin ich gegen lange Einleitungen. Trotzdem brauchen unsere Anwender gewisse Grundlagen.

  • „Was ist das?“ Warum wir (als TR) eine Antwort geben müssen
  • „Was ist das?“ Ordne ein und beschreibe strukturiert den Nutzen
  • Erkläre deinem Anwender den Bildschirm.
  • Überblick geben und Navigation beschreiben

Modul 5: Anleiten zum Handeln

Dein Anwender will handeln! 
Erklär es ihm … Nein: zeig es ihm … Nein: leite ihn Schritt für Schritt an. 

  • Die Juhlsche Handlungsanleitung hat sich bewährt
  • Warum das Handlungsziel bei Software besonders wichtig ist
  • Schritt für Schritt, aber richtig
  • flexibel anleiten, je nach Funktion und Informationsbedarf
  • es gibt auch Alternativen, wenn Schritt für Schritt nicht funktioniert

Modul 6: Funktionen beschreiben

Moderne Software ist gut geordnet: Funktionen sind gut gebündelt und können gut gemeinsam beschrieben werden.

  • Vorteile der gemeinsamen Beschreibung
  • Konzepte für die funktionsweise Beschreibung
  • Viele Funktionen mit wenig Text beschreiben
  • Funktionen erklären, reicht das zum Handeln?

Modul 7: Ganzheitliche Ansätze

Deine eine Anleitung steht nicht allein. 

Gute Software bietet schon in der Oberfläche Hilfe, vielleicht gibt es Videos, Tutorials, eine Hotline, Schulungen … Dann ist es gut, wenn alles aufeinander abgestimmt ist und ganzheitlich funktioniert.

  • Andere Möglichkeiten anzuleiten
  • Andere Medien
  • Gesamtplan, Zusammenwirken, Abstimmung
  • Synergien nutzen

Modul 8: Mehr Einsicht mit Bildern

Systeme, Prozesse, Beteiligte sind abstrakt und oft schwer zu verstehen.
Mit Bildern kannst du Abstraktes begreifbar machen.

  • was heißt „abstrakt“?
  • was bringt ein Bild?
  • wie kommst du zum Bild?

Zusatzmodul: deine Lösung, deine Fragen

Jetzt bist du dran. Du hast umgesetzt, geschrieben, optimiert.
Zeige uns deine Lösungen und stelle sie zur Diskussion.
Was können wir von Dir lernen?

Was ist Software-Dokumenation?

Die  Spanne reicht von Benutzer-Dokumentation, Benutzeranleitung, Systemdokumentation, Administratorendokumentation, Prozessdokumentation.

Installation
Konfiguration
Betrieb
Fehlerbehebung
Anpassungen
Aktualisierung
Wartung
Deinstallation

Anforderungen an Software-Dokumentation

Anleitungen geben Antwort auf alle Fragen der Benutzer. Das umfasst den gesamten Produktlebenszyklus von der Installation über die Konfiguration, Einstellungen des Administrators, Benutzung, Fragen des Benutzers zu einzelnen Handlungen, Nachschlagen, Lernen, Sofortanleitung usw.

Informationsbedarf

Der Informationsbedarf der Anwender ist vielfältig. Dabei gibt es sehr unterschiedliche Lerntypen, die anders an eine Sache herangehen.

Software-Anleitungen schreiben, Softwareanleitungen erstellen

Auf dieser Seite geht es darum, wie man verständliche Bedienungsanleitungen für Software schreibt. Software ist intuitiv bedienbar hat eine übersichtliche UI bzw. Bedienoberfläche ist optimiert für User Experiance. Software-Dokumentation muss kurz und für alle Use Cases geeignet sein. 

Richtlinien und Normen

Gibt es Normen und Richtlinien für eine sichere Technische Dokumentation von Software bzw. Softwareanleitungen.

Hier die wichtigsten Normen:

ISO/IEC 82079-1: „Erstellen von Gebrauchsanleitungen – Gliederung, Inhalt und Darstellung“

ISO/IEC 26514: „Requirements for designers and developers of user documentation“

ISO IEC IEEE 26511: „Anforderungen an Manager von Informationen für Benutzer von Systemen, Software und Services“

ISO IEC IEEE 26512: „Anforderungen an Erwerber und Lieferanten von Informationen für Benutzer“

ISO IEC IEEE 26513: „Anforderungen an Tester und Gutachter der Benutzerdokumentation“

ISO IEC IEEE 26515: „Entwicklung von Benutzerdokumentation in einem agilen Umfeld“

ISO 15289: Systems and software engineering – Content of life-cycle information items (documentation)

User Experiance

User Experience Konzeption

Bewährte UX-Konzeptionsmodule

User Experience Design

Der Begriff User Experience (Abkürzung UX, wörtlich ‚Nutzererfahrung‘, ‚Nutzererlebnis‘ ‚Nutzungserlebnis‘ – nach Norm DIN EN ISO 9241 heißt es ‚Benutzererlebnis‘) Er umschreibt alle Aspekte der Eindrücke eines Nutzers bei der Interaktion mit einem Produkt. Dazu zählen auch Software und IT-Systeme. Der Begriff User Experience kommt meist im Zusammenhang mit der Gestaltung von Websites oder Apps zur Anwendung, umfasst jedoch jegliche Art der Produktinteraktion, also unter anderem auch die nicht-digitale, physische Nutzung.

Strukturierte Anleitungen

Schreibe nach Funktionsdesign oder Information Mapping oder Zielprogrammierung. Strukturiere mit IIRDS oder DITA, XML oder XSLT.

Modular und crossfield Publishing, interaktiv

Softwareentwicklung

Software-Anleitungen verständlich schreiben

Strukturen, Seminare, Workshops für Technische Redakteure

agile
agile process
objektorientiert
use cases
Klassen
Interaktion Interaction
User Interface
User Desig
Time to market
github

Software-Arten

WebApp
Smartphone APP
Windows Linux macos ios
Appstore

Software Bedienungsanleitungen

Schritt für Schritt
Handlungsanweisung
Tutorial
Referenzguide, Reference Guide
Manual, Helptext
Help, Hilfe, Onlinehilfe
PDF, HTML, CHM
kontextsensitiv
Release Notes

Onlinehilfen

digitale Hilfe
elektronische Anleitung
Onlinehelp
Content Delivery
intelligente Information
agile Doku
Knowledge Base
Metadaten
CCMS CMS Content Management
responsive
eBook epub

Technische Dokumentation

Terminologie Management
Best Practice
Technische Kommunikation
Conversation Design
User orientiert
Podcast Chatbots Videos
Content Global Content
technical writing
Benutzerinformation
Development Documentaion
Topics Microdocs
ai-based
XML DITA
Smart Content

Vorlagen für Software-Anleitungen

Häufig werden einfache Vorlagen benötigt, mit denen man ein Layout und eine Gliederung bekommt. Word ist dabei gerne das Standardtool. Andere benutzen auch Adobe Indesign, oder FrameMaker. Wichtig ist, dass Formatvorlagen benutzt werden, um das Dokument einheitlich und konsistent zu gestalten.

Tools und CCMS

bzw CMS

Moderne Tools bieten die Möglichkeit die Inhalte modular zu erstellen, um so leicht Varianten und Versionen erstellen zu können. Außerdem ist es wichtig, dass das Tool bzw. das System in viele Onlineformate exportieren kann, z.B. PDF, HTML 5, CHM, Onlinehelp.

Webentwicklung

In der Webentwicklung ist es üblich mit Usertests optimale UX zu entwickeln.

responsive
Usability Lab
gamification