Discussion
Loading...

#Tag

  • About
  • Code of conduct
  • Privacy
  • Users
  • Instances
  • About Bonfire
Criss 😈 yBliss boosted
Stefan Gast
@notbobbytables@infosec.exchange  ·  activity timestamp 4 days ago

To the user-interface designers and programmers out there: If the unfortunate event happens and you have to show an error message, please make sure the message is actually helpful for identifying the issue. You might think that hiding technical details is user-friendly, but in fact, the opposite is true. Do not make us guess what is wrong, tell us what you know!

You might be afraid that this confuses users who are less tech-savvy. Not necessarily, if you give them a rough idea first (maybe in a more emphasized font) and then continue with the details you have (maybe in a smaller font). I am quite sure users are able to ignore the parts they do not understand, and if they need support, at least the person giving support has something to work with.

Some simple examples:

❌ "Cannot connect to bluetooth device."
❓ "Okay, but why?"
✅ "Cannot connect to bluetooth device 'foo' (maybe it is turned off?): The device does not respond."

❌ "Cannot open file."
❓ "Which file? And again, why?"
✅ "Cannot open file 'testfile.txt' for reading: Permission denied"

❌ "Something went wrong when trying to load the website."
❓ "Again, what's the problem? Is the network interface down? Is the DNS server down? Is the target server itself down? Give me a hint, please!"
✅ "Cannot load the website. Maybe your computer is not connected to the Internet? Details: No route to host (192.168.10.1) when attempting to connect to the DNS server."

This is nothing new. In fact, it is just an adaptation of the top-down writing approach we also use when writing scientific papers, for example: You begin with a rough overview and give increasingly more details later in the text.
But do not omit the details completely!

#usability #userinterfaces #userinterfacedesign #errormessages #programming #writing #technicalwriting

A useless satirical error message box with the title "Oops!". The message reads: "Something went wrong. We will not tell you what exactly. If you want to fix this problem: Good luck!" The dialog has a confirmation button labeled "Great!".
A useless satirical error message box with the title "Oops!". The message reads: "Something went wrong. We will not tell you what exactly. If you want to fix this problem: Good luck!" The dialog has a confirmation button labeled "Great!".
A useless satirical error message box with the title "Oops!". The message reads: "Something went wrong. We will not tell you what exactly. If you want to fix this problem: Good luck!" The dialog has a confirmation button labeled "Great!".
  • Copy link
  • Flag this post
  • Block
Stefan Gast
@notbobbytables@infosec.exchange  ·  activity timestamp 4 days ago

To the user-interface designers and programmers out there: If the unfortunate event happens and you have to show an error message, please make sure the message is actually helpful for identifying the issue. You might think that hiding technical details is user-friendly, but in fact, the opposite is true. Do not make us guess what is wrong, tell us what you know!

You might be afraid that this confuses users who are less tech-savvy. Not necessarily, if you give them a rough idea first (maybe in a more emphasized font) and then continue with the details you have (maybe in a smaller font). I am quite sure users are able to ignore the parts they do not understand, and if they need support, at least the person giving support has something to work with.

Some simple examples:

❌ "Cannot connect to bluetooth device."
❓ "Okay, but why?"
✅ "Cannot connect to bluetooth device 'foo' (maybe it is turned off?): The device does not respond."

❌ "Cannot open file."
❓ "Which file? And again, why?"
✅ "Cannot open file 'testfile.txt' for reading: Permission denied"

❌ "Something went wrong when trying to load the website."
❓ "Again, what's the problem? Is the network interface down? Is the DNS server down? Is the target server itself down? Give me a hint, please!"
✅ "Cannot load the website. Maybe your computer is not connected to the Internet? Details: No route to host (192.168.10.1) when attempting to connect to the DNS server."

This is nothing new. In fact, it is just an adaptation of the top-down writing approach we also use when writing scientific papers, for example: You begin with a rough overview and give increasingly more details later in the text.
But do not omit the details completely!

#usability #userinterfaces #userinterfacedesign #errormessages #programming #writing #technicalwriting

A useless satirical error message box with the title "Oops!". The message reads: "Something went wrong. We will not tell you what exactly. If you want to fix this problem: Good luck!" The dialog has a confirmation button labeled "Great!".
A useless satirical error message box with the title "Oops!". The message reads: "Something went wrong. We will not tell you what exactly. If you want to fix this problem: Good luck!" The dialog has a confirmation button labeled "Great!".
A useless satirical error message box with the title "Oops!". The message reads: "Something went wrong. We will not tell you what exactly. If you want to fix this problem: Good luck!" The dialog has a confirmation button labeled "Great!".
  • Copy link
  • Flag this post
  • Block
Alan Zimmerman boosted
Strfnurfn
@earthtoneone@mstdn.social  ·  activity timestamp 4 months ago

Anyone know an open-source project, even a small one, that needs API docs created or improved? Asking for a #technicalWriting pro who wants more experience with API documentation. #FOSS #techcomm (bonus points if it hits interests like politics, food, beer, auto racing, mapping/OSM, civil engineering, social good...)

  • Copy link
  • Flag this post
  • Block
Strfnurfn
@earthtoneone@mstdn.social  ·  activity timestamp 4 months ago

Anyone know an open-source project, even a small one, that needs API docs created or improved? Asking for a #technicalWriting pro who wants more experience with API documentation. #FOSS #techcomm (bonus points if it hits interests like politics, food, beer, auto racing, mapping/OSM, civil engineering, social good...)

  • Copy link
  • Flag this post
  • Block
Log in

bonfire.cafe

A space for Bonfire maintainers and contributors to communicate

bonfire.cafe: About · Code of conduct · Privacy · Users · Instances
Bonfire social · 1.0.0-rc.3.21 no JS en
Automatic federation enabled
  • Explore
  • About
  • Members
  • Code of Conduct
Home
Login