Software-Anleitungen handlungs- oder funktionsorientiert?

Größe: px

Ab Seite anzeigen:

Download "Software-Anleitungen handlungs- oder funktionsorientiert?"

Rolf Rosenberg
vor 5 Jahren
Abrufe

1 Software-Anleitungen handlungs- oder funktionsorientiert? Vortrag tekom RG-Nord Referent: Dietrich Juhl Hamburg Grundsätzlicher Aufbau Die Gliederung einer Anleitung muss dem Benutzer Informationen zu allen Use Cases liefern Informationen zur Einarbeitung Handlungswissen Wissen über das Funktionsangebot zum Weiterlernen und Nachschlagen Dietrich Juhl 2

Entwickler und Programmierer plädieren mehr für Funktionen, während wir in der Technischen Dokumentation gelernt haben, konkret zum Handeln anzuleiten.

2 Software-Anleitungen - handlungs- oder funktionsorientiert? 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. Dietrich Juhl 3 Software-Anleitungen Wenn Du eine Software erklären willst, dann erkläre nicht wie man es tut, sondern lehre die Sehnsucht nach dem Möglichen. (frei nach Saint-Exupéry) nicht Schritt-für-Schritt sondern: Ziel der Handlung Dietrich Juhl 4

ist möglich lang, langweilig Funktionsbeschreibung aus Software-Sicht beschreibend à

3 Was ist der Unterschied? Handlungsanweisung aus Anwendersicht Schritt für Schritt konkret direktes Handeln ist möglich lang, langweilig Funktionsbeschreibung aus Software-Sicht beschreibend à aber wie? mit Zusammenhängen in Ordnung der Software wie-handeln bleibt offen Dietrich Juhl 5 Handlungsanleitung Schritt für Schritt Dietrich Juhl 6

4 die Juhlsche Handlungsanweisung Überschrift Ziel der Handlung Voraussetzungen Überblick über die Handlung Schritt für Schritt aktive Anrede jeder Schritt ein Absatz ggf. mit Zwischenergebnissen Handlungsergebnis Ausblick besonders wichtig: Ziel der Handlung (Südsee ;-) wenn BO intuitiv ist: ohne Schritt für Schritt! Dietrich Juhl 7 bei Software: die erweiterte Handlungsanweisung Überschrift Ziel der Handlung Anzeigen und Bedienelemente SW-Konzept Voraussetzungen Aufruf der Funktion Überblick über die Handlung Step by Step Parameter Regeln Handlungsergebnis Ausblick der Informationsbedarf bei Handlungen in Software ist sehr unterschiedlich! Dietrich Juhl 8

Beispiel: Ziel der Handlung formulieren Dietrich Juhl 9 Ziel der Handlung - Formulierungsmühen Sie können Protokolle drucken. Sie können Protokolle speichern.

5 Beispiel: Ziel der Handlung formulieren Dietrich Juhl 9 Ziel der Handlung - Formulierungsmühen Sie können Protokolle drucken. Sie können Protokolle speichern. Sie können festlegen, dass ein Fehlerprotokoll gespeichert wird. Sie können festlegen, dass ein Fehlerprotokoll regelmäßig gespeichert wird. Sie können festlegen, dass zu regelmäßigen Terminen ein Fehlerprotokoll gespeichert wird. Sie können festlegen, dass zu regelmäßigen Terminen ein Fehlerprotokoll gespeichert und als versandt wird. Sie können festlegen, dass zu regelmäßigen Terminen ein Fehlerprotokoll gespeichert und als versandt wird. Das ist z.b. praktisch, um den Systemzustand lückenlos zu dokumentieren. ich formuliere bis es passt! Dietrich Juhl 10

6 Funktionsbeschreibung Dietrich Juhl 11 der Blick auf Funktionen... Software ist meistens wohlgeordnet: sinnvolle Zusammenstellung von Funktionen Zusammenhänge und Unterschiede sind sichtbar und können zusammen gut erklärt werden Dietrich Juhl 12

Funktionsbeschreibung - Struktur Überschrift Zweck der Funktion Anzeigen und

Handlungsprinzipien (Step by Step + Ergebnis) Schalter / Parameter Regeln Ausblick und

Beispiel: Funktionsbeschreibung was ist der Nutzen?

7 Funktionsbeschreibung - Struktur Überschrift Zweck der Funktion Anzeigen und Bedienelemente SW-Konzept Voraussetzungen Aufruf der Funktion Handlungsmöglichkeiten Handlungsprinzipien (Step by Step + Ergebnis) Schalter / Parameter Regeln Ausblick und Bezüge ähnlich der Handlungsanweisung flexible Struktur viele Elemente Dietrich Juhl 13 Beispiel: Funktionsbeschreibung was ist der Nutzen? (der gesamten Funktion) was kann man machen? (nicht: Referenz!) Handlungsanleitungen bedarfsweise Ziel: kürzer, übersichtlicher, selbst bestimmter 14

8 handlungs- / funktionsorientiert? Dietrich Juhl 15 Was ist der Unterschied? Handlungsanweisungen sind konkret gängeln (aber auch) vermitteln (meist) kein übergreifendes Wissen sind meistens lang und manchmal überflüssig Funktionsbeschreibungen können übergreifendes Verständnis aufbauen fordern den Anwender mehr (er muss überlegen, wie er handelt) fördern mehr Selbsterkundung der BO (das muss der Anwender ja sowieso) ermöglichen mehr selbstbestimmtes Lernen produzieren vielleicht eher intelligente Anwender Dietrich Juhl 16

9 Wann ist was besser? Wir brauchen meistens beides: Handlungsanweisungen wenn die Handlung an unterschiedliche Orten stattfindet am Anfang des Lernfortschrittes Achtung: teilweise ohne Schritt-für-Schritt Funktionsbeschreibungen für Funktionen, die über die Grundlagen hinausgehen für die Masse der Funktionen für optionale Funktionen ggf. mit einzelnen Handlungsanweisungen (Schritt-für-Schritt) Dietrich Juhl 17 wie geht es richtig? Dietrich Juhl 18

strukturiert, flexibel Flexible Handlungsanweisung Überschrift Ziel der Handlung Anzeigen und Bedienelemente SW-Konzept

Flexible Funktionsbeschreibung Überschrift Zweck der Funktion Anzeigen und Bedienelemente SW-Konzept Voraussetzungen Aufruf

Bezüge + plus ggf. Handlungen Dietrich Juhl 19 Software-Anleitungen - handlungs- oder funktionsorientiert?

10 strukturiert, flexibel Flexible Handlungsanweisung Überschrift Ziel der Handlung Anzeigen und Bedienelemente SW-Konzept Voraussetzungen Aufruf der Funktion Überblick über die Handlung Step by Step Parameter Regeln Handlungsergebnis Ausblick Flexible Funktionsbeschreibung Überschrift Zweck der Funktion Anzeigen und Bedienelemente SW-Konzept Voraussetzungen Aufruf der Funktion Handlungsmöglichkeiten Handlungsprinzipien (Step by Step + Ergebnis) Schalter / Parameter Regeln Ausblick und Bezüge + plus ggf. Handlungen Dietrich Juhl 19 Software-Anleitungen - handlungs- oder funktionsorientiert? weitere Informationen im Blog blog.juhl.de ein bisschen mehr im Workshop mit Übungen oder im Buch mehr Details und viele Beispiele Dietrich Juhl 20

Ähnliche Dokumente

Verbesserung und Pflege der Dokumentation der DPP-Software Saros

Verbesserung und Pflege der Dokumentation der DPP-Software Saros Meike Johannsen Freie Universität Berlin Seminar "Beiträge zum Software Engineering", 2011 Inhalt Motivation Ziele dieser Diplomarbeit Vorgehensweise