Terminologie in der Softwaredokumentation

Teile diesen Beitrag
Terminologie in der Softwaredokumentation

Wählen, aktivieren oder Klicken?

Welche Regelungen gelten für die Terminologie von Softwaredokumentation und Online-Hilfen?

Wann ist es besser, vereinheitlichte Begriffe zu verwenden? Und wann ist es besser, Bedienelemente und Aktionen genau zu bezeichnen?

Nicht nur viele Benutzer, auch mancher Redakteur gerät angesichts der Begriffsvielfalt ins Straucheln: Da wird geklickt, aktiviert, angewählt, abgewählt oder ausgewählt. Mal laufen auf Rechnern Programme, mal auf Computern, Software, dann wieder laufen Anwendungen oder Applikationen auf PCs, Maschinen oder Workstations.

Um für eine Vereinheitlichung der Begriffe zu sorgen, bemühen sich verschieden große Softwarehersteller in Normen und Styleguides um Standardisierung. Doch auch hier sind die Empfehlungen unterschiedlich und obendrein oft nur in englischer Sprache verfügbar.

Buchtipp – Ergonomische Gestaltung von Benutzungsschnittstellen: Kommentar zur Grundsatznorm DIN EN ISO 9241-110*

ANZEIGE

Diversifizierter Stil oder vereinheitlicher Stil

Bevor es an die Details geht, sollten Sie zunächst eine Grundsatzentscheidung treffen. Den bei der Beschreibung von Interaktionen mit Software gibt es zwei unterschiedliche Stile: dieversifiziert und vereinheitlicht.

Diversifizierter Stil – hier verwenden Sie für jedes Bedienelement und für jede Handlung einen speziellen, eindeutigen Begriff. Der Vorteil ist, dass jeder Begriff eindeutig angibt, wo Nutzer handeln und welche Art von Aktion sie ausführen müssen. Die Nachteile sind eine größere Begriffsvielfalt und meist geringfügig längere Texte.

Beispiel für diversifizierten Stil:

  1. Wählen Sie den Menüpunkt
    Datei > Drucken.
  2. Aktivieren Sie die Registerkarte
    Druckereinstellungen.
  3. Klicken Sie auf die Schaltfläche
    Seitenformat.

Vereinheitlicher Stil – hier verwenden Sie so wenig verschiedene Verben und Bezeichnungen wie möglich. Fast immer heißt es dann einfach „klicken Sie auf …“. Dies macht die Texte sprachlich sehr einfach, kann aber dazuführen, dass Nutzer länger nach dem geminten Bedienelement suchen müssen. Weder das Verb noch ein anderer Bezeichner lässt erkennen, um welchen Typ von Bedienelement es sich handelt. Das vorige Beispiel vereinheitlichen Stil:

  1. Klicken Sie auf Datei > Drucken.
  2. Klicken Sie auf Druckereinstellungen.
  3. Klicken Sie auf Seitenformat.

Microsoft verfolgte einige Jahre einen weitgehend vereinheitlichen Stil, kehrt in letzter Zeit jedoch zu einem diversifizierten Stil zurück.

Unserer Empfehlung: Verwenden Sie den vereinheitlichen Stil nur in sehr kurzen Dokumenten. Geeignet ist ein weitgehend vereinheitlicher Stil auch dann, wenn Sie davon ausgehen, dass Ihr Dokument von Nutzern gelesen wird, die wenig Erfahrung mit Technischer Dokumentation besitzen. Oder auch dann, wenn Ihr Text von Nutzern gelesen wird, deren Muttersprache nicht mit der Sprache des Texts übereinstimmt.

Buchtipp – Ergonomische Gestaltung von Benutzungsschnittstellen: Kommentar zur Grundsatznorm DIN EN ISO 9241-110*

ANZEIGE

Verkürzte oder ausführliche Form

Wenn Sie davon ausgehen können, dass Ihren Lesern klar ist, von welchem Bedienelement Sie sprechen, reicht auch bei diversifiziertem Stil häufig eine verkürzte Form, bei der Sie die Bezeichnung des Bedienlementtyps weglassen. Beispiel ausführliche Form:

  • Aktivieren Sie das Kontrollkästchen Testseite drucken.

Beispiel verkürzte Form:

  • Aktivieren Sie Testseite drucken.

Eine verkürzte Form ist inbesondere dann eine gute Wahl, wenn ein Fenster nur wenige Bedienelemente besitzt.

Reihenfolge im Satz

Machen Sie es Ihren Lesern leicht, Ihrem Text Schritt für Schritt zu folgen. Bringen Sie Ihr Wörter in dieselbe Reihenfolge wie die Schritte, die die Leser zum Identifizieren und Bedienen eines Elements durchlaufen müssen.

Nicht:

  • Klicken Sie auf Öffnen im Menü Datei.

Besser:

Erst den Hauptmenüpunkt („Datei“) nennen, den die Leser zuerst finden und anklicken müssen, um den Unterpunkt („Öffnen“) überhaupt zu sehen.

  • Klicken Sie im Menü Datei auf Öffnen.

Nicht:

  • Klicken Sie auf die Drucken-Schaltfläche.

Besser:

Erwähnen Sie zuerst, dass es sich um eine Schaltfläche handelt, da dies die Suche nach dem Schriftzug „Drucken“ beschleunigt.

  • Klicken Sie auf die Schaltfläche Drucken.

Buchtipp – Ergonomische Gestaltung von Benutzungsschnittstellen: Kommentar zur Grundsatznorm DIN EN ISO 9241-110*

ANZEIGE

Auf Bedienelemente beziehen

Zitieren Sie Begriffe immer in genau derselben Form, in der sie in der Benutzeroberfläche vorkommen – einschließlich Groß- und Kleinschreibung. Ausnahem: Stehen hinter einem Begriff oder Menüpunkt drei Pünktchen, lassen Sie diese Pünktchen weg.

Beispiel:

  • Wählen Sie den Menüpunkt Datei > Speichern unter.

Hat ein Bedienelement keine Beschriftung, finden Sie selbst eine treffende Bezeichnung und verwenden Sie die Bezeichnung und verwenden Sie diese Bezeichnung durchgängig. Wenn zum Beispiel eine Schaltfläche nur ein Lupen-Symbol enthält und eine Suche startet:

  • Klicken Sie auf die Schaltfläche Suchen.

Voreinstellungen

Verwenden Sie die Bezeichnungen Default und Defaultwert ausschließlich in einer Dokumentation für Entwickler. Verwenden Sie ansonsten:

  • bei Einstellungen von Optionen den Begriff Voreinstellung
  • bei Zahlenwerten den Begriff Vorgabewert

Beispiel:

  • Die Voreinstellung für das Dateiformat ist HTML.
  • Der Vorgabewert ist 1 mm.

Oft ist es am besten, die Wörter Voreinstellung und Vorgabewert ganz zu vermeiden.

Beispiel:

  • Wenn Sie kein Format auswählen, speichert das Programm die Datei im HTML-Format.

Nicht verfügbare Elemente

Vermeiden Sie den Begriff deaktiviert für „ausgegraute“ Elemente, denn dies kann zu Verwechslung mit deaktivierten Kontrollkästchen und deaktivierten Programmfunktionen führen. Verwenden Sie die Formulierung ist nicht verfügbar.

Beispiel:

  • Bei der Arbeit mit einem Textdokument sind die Funktionen zur Bildbearbeitung nicht verfügbar.

Maus

Auch für Vorgänge mit der Maus existieren typische Formulierungsmuster:

  • Klicken Sie auf Save.
  • Klicken Sie mit der rechten Maustaste auf …
  • Klciken Sie bei gedrückter [STRG]-Taste, um …
  • Um eine Beschreibung zu sehen, halten Sie den Mauszeiger über das Symbol.
  • Ziehen Sie die Schaltfläche auf die Symbolleiste.

Tasten

Typische Formulierungsmuster im Zusammenhang mit Tasten sind:

  • Zum Öffnen der Hilfe drücken Sie [F1],
  • Um die Suche zu öffnen, drücken Sie [STRG]+[F],
  • Um die Einfügemarke zu bewegen, verwenden Sie die Pfeiltasten.
  • Halten Sie [F8] gedrückt, während Sie den Computer neu starten.
  • Drücken Sie [ESC] und unmittelbar danach [N].

Fenster, Dialoge, Meldungen

Fenster, Dialoge und Meldungen erscheinen. Vermeiden Sie umständliche Konstruktionen wie wird angezeigt, wird eingeblendet oder öffnet sich.

Beispiel:

  • Das Fenster Bearbeiten erscheint.
  • Der Dialog Drucken erscheint.

Oft ist es allerdings besser, einen Objektnamen direkt in den folgfenden Handlungsschritt aufzunehmen und gar nicht explizit erwähnen, das ein Fenster erscheint. Die Benutzer sehen dies ja ohnehin auf dem Bildschirm. In einer Handlungsanleitung müssen Sie das Erscheinen nur dann explizit erwähnen, wenn Sie den Lesern Sicherheit geben wollen, alle Handlungen richtig durchgeführt zu haben.

Also meist nicht:

  • Es erscheint das Fenster Bearbeiten. Wählen Sie die Option Layout.

Sondern oft besser:

  • Wählen Sie im Fenster Bearbeiten die Option Layout.
  • Das Programm zeigt nun das von Ihnen gewähltes Bild.
  • Eine Meldung weist darauf hin, dass …

Löschen, entfernen

Verwenden Sie löschen, wenn Sie eine dauerhafte Beseitigung von Daten oder Dingen meinen. Benutzer löschen zum Beispiel Dateien aus einem aus einem Ordner. Oder sie löschen einen Absatz aus einem Dokument.

Verwenden Sie entfernen, wenn Daten lediglich an einen anderen Ort verschoben oder temporär verborgen werden. Benutzer entfernen zum Beispiel eine nicht benötigte Symbolleiste. Oder sie entfernen einen Eintrag aus einer Liste.

Beispiel:

  • Löschen Sie alle nicht mehr benötigten Dateien
  • Klicken Sie auf Management Ansicht, um die Spalte Details zu entfernen.

Speichern, sichern

Verwenden Sie im Normalfall immer das Verb speichern. Verwenden Sie das Verb sichern nur dann, wenn Sie tatsächlich einen besonderen Schutz vor Datenverlust meinen.

Beispiel:

  • Um die Datei zu speichern, drücken Sie [Strg] + [S].
  • Das Programm speichert Ihre Einstellungen automatisch.
  • Die Einstellungen sind in der Datei Settings.ini gespeichert.
  • Sichern Sie regelmäßig alle Daten auf einem externen Speichermedium.

Buchtipp – Ergonomische Gestaltung von Benutzungsschnittstellen: Kommentar zur Grundsatznorm DIN EN ISO 9241-110*

ANZEIGE

Computer, Programme

Abschließend bin ich noch eine Empfehlung schuldig, ob es nun besser Computer, Rechner, Workstation, PC, Client oder gar Maschine heißt und ob dort Softare, Programme, Applikationen, Anwendungen, Utilities oder Tools laufen: Durchgesetzt haben sich vorrangig die Begriffe Computer und Programm. Geht es um die Kombination aus beidem, handelt es sich um das System.

Lassen Sie die Programmnamen Versionsnummern nach Möglichkeit immer weg. Sie reduzieren dadurch nicht nur den Pflegeaufwand bei Aktualisierungen, Sie ersparen Ihren Lesern durch das Weglassen auch eine „Information“, die in den meisten Fällen gar keine echte Information darstellt, sondern schlicht überflüssigen Ballast.

Wenn Sie aus inhaltlichen Gründen tatsächlich einmal eine Versionsnummer nenne müssen, halten Sie die Versionsnummer so einfach wie möglich. Sprechen Sie also Besser vom DemoSoft anstatt von DemoSoft 5, besser von DemoSoft 5 anstatt von DemoSoft 5.3. Beim Blick in Vergangenheit und Zukunft: Sprechen Sie von früheren Versionen, jedoch nicht von höheren oder niedrigeren Versionen.

Vermeiden Sie auch die Begriffe ältere Versionen und neuere Versionen, da diese Begriffe von vielen Nutzern als Wertung verstanden werden.

Ach ja: Sie starten und verlassen Programme, öffnen und schließen Dateien, aber beenden eine Verbindung.

In diesem Sinne: guten Gelingen!

Buchtipp – Ergonomische Gestaltung von Benutzungsschnittstellen: Kommentar zur Grundsatznorm DIN EN ISO 9241-110*

ANZEIGE

Standardformulierungen für Bedienelemente

  • Menüs
  • Multifunktionsleiste
  • Symbolleiste
  • Registerkarten
  • Schaltflächen
  • Links
  • Symbole
  • Programmsymbole
  • Gruppenfelder
  • Kontrollkästchen
  • Optionsfelder
  • Felder
  • Kombinationsfelder
  • Drehfeld-Steuerelemente
  • Schieberegler
  • Listenfelder
  • Drop-Down-Listen
  • Strukturansichten
  • Steuerelement zur Schrittweisen Anzeige

Standardformulierungen für die o.g. Bedienelemente mit Textbeispielen finden Sie hier.

Teile diesen Beitrag

Mustafa Acar

Mustafa Acar ist Business Architect aus Stuttgart und befasst sich gerne mit Themen rund um Mixed Reality, Technische Dokumention, Content Development und der dazugehörigen technischen Umsetzung. Als studierter Kommunikation und Medienmanager hat er zudem eine große Sympathie für benutzerspezifische produktorientierte Informationsaufbereitung.

Das könnte Dich auch interessieren …