Schreiben von Error Messages

Das Schreiben von Error-Messages ist nicht so deine Lieblingsaufgabe?

Ich kann es gut verstehen, dass weniger schreibbegeisterte Softwareentwickler*innen sich manchmal gerne über diese Tätigkeit hinwegschummeln wollen.

Tatsächlich hast aber auch DU etwas davon, wenn du genauere Error Messages schreibst:

💡 Nämlich beim Debuggen!

Wenn da nur eine kurze Message steht wie: “Es ist ein Fehler aufgetreten.”
(und welcher wollen wir wohl lieber nicht wissen 😂)
– dann musst du bei der Fehlersuche von vorne anfangen.

Wenn du dir aber im Vorhinein überlegst, welche Fehler auftreten können und für diese Cases spezifischere Error-Meldungen ausgibst, wie z. B:

❗“Beim Speichern der Daten ist ein Fehler aufgetreten.”

❗“Die Daten wurden erfolgreich gespeichert, aber der Vorgang xy wurde nicht durchgeführt.”

… dann ist deine Fehlersuche schon einmal auf einen gewissen Bereich im Code eingeschränkt.

Sollte der Fehler bei deinen Usern auftreten, sind sie in der Lage dir eine bessere Rückmeldung zu geben.

Wenn du oder Kolleg*innen Code erweitern müsst, seit ihr auch schneller mit dem Lesen und Verstehen, wenn ihr wisst welche Fehlerquellen sich dahinter verstecken können.

An solchen Stellen braucht es also auch weniger detaillierte Dokumentation.

☑️ Ein gutes Error Handling – einmal eingerichtet – spart also auch Zeit und Nerven für dich!
(und für die User sowieso!)

Aber Vorsicht! Das gilt nur für Systeme, die intern laufen.

So logisch die IT-Welt erscheint, so paradox kann sie doch manchmal sein, wenn man tiefer in sie eintaucht oder securitytechnische Aspekte mit einbezieht:

Es gibt nämlich auch Fälle, wo es besser sein kann, kryptische Fehlermeldungen à la: error 187: contact your sys-admin zu verwenden!

Nämlich dann, wenn es um Systeme geht, die im WEB stehen, v. a. wenn APIs im Einsatz sind.

Angreifer können detaillierte Fehlermeldungen nämlich dazu benutzen, eine Schwachstelle zu finden.

Wer sich mit meiner Meinung nicht anfreunden kann, dem möchte ich als Alternative einen Link zum Artikel von Christian Heitzmann anbieten:
Christian hat auf meinen LinkedIn Beitrag reagiert und diese interessante Perspektive eingeworfen.
Sein Artikel „The Use of Random IDs in Software Development and Everyday Life“ geht auch auf das Thema Error Messages ein.

_________________________

Rubina Weinzettl ist WebDeveloperin bei