[kde-guidelines] Styleguide: Help system

Heiko Tietze heiko.tietze at user-prompt.com
Tue Jul 9 14:32:17 UTC 2013


User Assistance: Help system
* Support the user by an elaborated interface or per [[help system]]. 

http://techbase.kde.org/Projects/Usability/HIG/HelpSystem

== Purpose ==
The help system should be used as a secondary mechanism to support users’ complete and better understanding of tasks — the primary mechanism should be the user interface itself. Users consult the help system only if they can't accomplish a task with the UI.

== Examples ==

== Guidelines ==
Try to make Help unnecessary in the first place:
* Make common tasks easy to discover and perform.
* Provide clear main instructions as well as concise control labels that are goal- and task-oriented.
* Provide supplemental instructions and explanations where needed.
* Avoid problems by using controls constrained to valid choices, providing suitable default values, handling all input formats, and preventing errors.
* Write error messages that provide a clear solution or action for the user to take.
* Usually, the help system is activated by F1 respectively Ctrl+F1 for context sensitive information and via menu. 

== Implementation ==
* http://www.kde.org/support/

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-guidelines/attachments/20130709/4d6cd118/attachment.html>


More information about the kde-guidelines mailing list