If you're regularly writing error messages for software or for hardware, then you're probably used to the conventions and wordings your company or organization has adopted to remain consistency. If you often use a style guide, then good for you. However, as evidenced by the hundreds of forums out there complaining about cryptic and obtuse errors, there's always room for improvement.
A straightforward and well-written reference is from Microsoft's Dev Center-Desktop web site. Now, don't start rolling your eyes and vomiting - you might soil your Fedora machine or Mac. Microsoft operating systems and their software are guilty of the worst error messages in the world, particularly the infamously incomprehensible missives from the days of Windows 98SE. However, remember that Microsoft has been in the industry for decades and drawing generalizations is unfair, especially since Windows 7 has come a long way from the dark days of XP and BSODs.
The articles on the Windows Dev Center are written by professional technical writers with extensive experience and have probably contributed to other platforms such as Linux and Unix as well. Having read several articles on the site recently have made me realize the guidelines are sensible and accessible. Moreover, they're a great reference even for long-time technical writers (who become numb to the changes in technology after years of sloshing through manuals). Plus, the User Experience Interaction Guidelines are free and although they're meant for software written for Windows, the tips are universal and can apply to any type of user interface.
The Guidelines section has fairly comprehensive articles on Design principles, controls, Commands, Text, Messages (which include errors, warnings, and confirmations), and User interaction. I particularly liked the lighthearted and self-effacing article on Error messages, which gave examples from Windows' own dubious database of error pop-ups.
As a Linux user, I freely admit Linux interface messages aren't always the easiest to decipher. Sure, man pages via the Terminal are hands down superior to any Help file in Windows or MacOSX, but they're not exactly always very friendly to the innocent and even eager novice. Moreover, one of the common complaints of users who try Linux and give up a day a later is the madness-inducing error messages that occasionally pop up (e.g. the old SELinux messages). Linux veterans and devotees can turn their nose up as much as they want but that's not going to inspire new converts. A little improvement in error-writing and user interface can go a long way. And references such as those in the Dev Center, are great sources of inspiration and assistance when used right.
0 comments:
Post a Comment