-
Notifications
You must be signed in to change notification settings - Fork 344
Low cognitive burden and discoverability
Gracjan Polak edited this page Feb 21, 2016
·
1 revision
Historically Haskell Mode provided a lot of functionality that:
- Was hard to discover.
- Even if discovered was easy to forget.
- Was hard to remember how to use correctly.
There are rules of thumb to follow to make it easier for users to remember and use functionality provided:
- Use default Emacs mechanisms whenever possible. Those are given and do not need to be discovered.
- Follow well accepted written or unwritten conventions.
- Follow parallels. For example if there is a set of keybinding with similar functionality try to devise a variation of that so that users can use their prior knowledge to remember new functionality.
- Use hyperlinking in docstrings.
- Functionality must be described in official Haskell Mode manual.
- Add visual screen casts to manual.
- In error messages hint how to proceed.