Richtlinien für das Verfassen von Spickzetteln
Mit Spickzetteln und kombinierte Spickzetteln kann ein Benutzer eine Zielvorgabe umsetzen, indem er durch eine Abfolge von Schritten geführt wird. Die vorliegenden Richtlinien erläutern, in welchen Situationen Spickzettel eingesetzt werden sollten, und beschreiben die optimale Vorgehensweise beim Schreiben eines Spickzettels.
Situationen für die Erstellung von Spickzetteln
Spickzettel sind sehr gut für Tasks geeignet, die aus Schritten bestehen, mit denen eine materielle Zielvorgabe wie beispielsweise die Erstellung einer einfachen Anwendung erreicht werden kann. Das Ziel muss genau definiert sein, damit der Benutzer nach Abschluss aller Schritte im Spickzettel einen erkennbaren Erfolg erzielt. Lernprogramme sind häufig eine gute Einsatzmöglichkeit für Spickzettel. In einem Lernprogramm besteht das Ziel darin, die Ausführung einer bestimmten Task zu erlernen. Spickzettel enthalten normalerweise bis zu 10 Schritte und können in maximal 30 Minuten durchgearbeitet werden.
Bei längeren Tasks empfiehlt sich die Verwendung eines kombinierten Spickzettels.
Situationen für die Erstellung von kombinierten Spickzetteln
Kombinierte Spickzettel werden eingesetzt, um einen Benutzer durch eine Task zu führen, die entweder für die Beschreibung durch einen einfachen Spickzettel zu umfangreich ist oder mehrere Zielsetzungen aufweist. Mit einem kombinierten Spickzettel können Sie eine Abfolge von Tasks beschreiben, die jeweils auf der vorangegangenen Task aufbauen.
Ungeeignete Situationen für Spickzettel
Spickzettel sind immer dann hervorragend geeignet, wenn eine Aufgabenstellung durch eine Abfolge von einfachen Schritten gelöst werden kann. Sie stellen keinen Ersatz für die Hilfefunktion dar, bei der die Erstellung von HTML-Seiten mit detaillierten Grafiken sowie ein wahlfreier Zugriff auf Informationen durch Suchvorgänge und Hyperlinks möglich ist. Spickzettel sind für Tasks, bei denen der Benutzer große Textmengen eingeben muss, nicht geeignet.
Richtlinien für die Erstellung eines Spickzettels
- Wählen Sie einen kurzen und aussagekräftigen Titel aus.
- Setzen Sie in Spickzetteltasks Links zur Hilfefunktion ein, wann immer dies möglich ist, um Hintergrundinformationen oder ausführlichere Angaben bereitzustellen.
- Erstellen Sie bei mehr als 10 Schritten einen kombinierten Spickzettel.
- Setzen Sie nach Möglichkeit Befehle ein, um einfache und monotone Tasks wie das Öffnen von Perspektiven oder Ressourcen und die Ausführung von Assistenten vorzunehmen. Stellen Sie außerdem unbedingt eine Beschreibung zur Verfügung, wie dieselbe Wirkung ohne Verwendung des Befehls erreicht werden kann.
- Stellen Sie sicher, dass Befehle übersprungen werden können, falls der Benutzer die Schritte manuell ausführt.
- Verwenden Sie bei Schritten, die Dialoge öffnen, die Angabe dialog="true". Hierdurch wird der Spickzettel in einer vertikalen Leiste geöffnet, der sich bei den meisten Dialogen auf der rechten Seite befindet.
- Ordnen Sie die Schritte so an, dass der Benutzer häufig Zeichen des Erfolgs erkennt. Ein Spickzettel, der eine Reihe von unterschiedlichen Änderungen an einer Java-Quelle vornimmt und anschließend eine Anwendung startet, sollte möglicherweise so umgeschrieben werden, dass die Anwendung nach jeder Änderung der Quelle gestartet wird.
- Stellen Sie sicher, dass der Benutzer nachvollziehen kann, warum die einzelnen Schritte ausgeführt werden müssen.
- Statt mehrere Vorgehensweisen für die Ausführung eines Schrittes zu beschreiben, sollten Sie die einfachste Methode wählen, die mit dem geringsten Aufwand beschrieben werden kann.
- Verbessern Sie die Lesbarkeit durch den Einsatz von Tags für Zeilenschaltungen (<br/>).
- Durch Unterelemente können Sie Schritte in kleinere Einheiten untergliedern.
- Nicht bei allen Spickzetteln sind Unterelemente erforderlich.
- Beginnen Sie die Bezeichnung eines Unterelements mit einem Verb (z. B. "Erweitern", "Wählen", "Importieren" usw.).
- Machen Sie bei Bezeichnungen für Unterelemente Schnittstellentext mit Anführungszeichen eindeutig erkennbar, damit die Benutzer den Anweisungstext vom Schnittstellentext unterscheiden können, den sie suchen müssen und mit dem sie interagieren müssen.
- Jedes Unterelement sollte aus einer atomaren Task wie beispielsweise der Eingabe eines Wertes bestehen.
- Fügen Sie zum letzten Schritt eines Spickzettels immer ein Element <onCompletion> hinzu.
- Testen Sie Spickzettel unterschiedlicher Größe in der Sicht "Spickzettel".
- Testen Sie Spickzettel bei geöffneter Sicht "Fehlerprotokoll", damit Sie bemerken, wenn Warnungen in das Protokoll geschrieben werden.
Richtlinien für die Erstellung eines kombinierten Spickzettels
- Ein kombinierter Spickzettel sollte Tasks enthalten, die durch ein gemeinsames Thema miteinander in Beziehung stehen.
- Jede Task in einem kombinierten Spickzettel sollte eine genau definierte Zielsetzung aufweisen.
- Verwenden Sie Elemente <onCompletion>, damit der Erfolg für den Benutzer erkennbar ist.
- Tasknamen sollten kurz und prägnant sein.
- Komplexe Aufgabenstellungen können durch die Verwendung von Tasks umgesetzt werden, die jeweils auf der vorangegangenen Task aufbauen.
- Verwenden Sie die Angabe skip="true", wenn eine Task optional ist.
- Stellen Sie zur Wahrung der Konsistenz sicher, dass die Einführung und der Name des einfachen Spickzettels mit der Einführung und dem Namen übereinstimmen, die im kombinierten Spickzettel angegeben sind.
- Machen Sie bei Taskbeschreibungen Schnittstellentext eindeutig durch Formatierung in Fettschrift erkennbar.
- Taskfolgen sollten nur dann verwendet werden, wenn unbedingt eine bestimmte Reihenfolge beim Starten der Task eingehalten werden muss.
Links zu verwandten Themen
Mit Spickzetteln arbeiten
Mit kombinierten Spickzetteln arbeiten
Einfache Spickzettel
Kombinierte Spickzettel