Projects/Usability/HIG/SOU Workspace/How to write KDE4 Human Interface Guidelines

From KDE TechBase
Revision as of 17:30, 22 September 2008 by Colomar (talk | contribs) (New page: == How to write KDE4 human Interface Guidelines == The KDE4 human interface guidelines are meant to be concise and easy to read. Favor the use of bulleted lists when writing guidelines fo...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

How to write KDE4 human Interface Guidelines

The KDE4 human interface guidelines are meant to be concise and easy to read. Favor the use of bulleted lists when writing guidelines for an item. Use images to show what's being described as much as possible, and link to other items within the guidelines when needed.

The most up-to-date guidelines can be found here - however don't consider them final yet. They might still need review.

The usability wiki is a list of items brainstormed for the KDE HIG - but most of them are out of date. Use those only as a starting point for finding what guidelines still need to be written.

Use the current KDE guidelines and the HIG as a resource while writing. A general outline to get started:

  • Definition of item
  • Screenshot of how item should be/should not be
  • Guidelines - Consider when to use the item, how to use it and its general layout. Use screenshots or mock ups to illustrate important points.

Also, if necessary:

  • Accessibility Notes
  • Implementation Suggestions - use simple wireframe-like mock ups with description
  • See Also / Related to - and related items that help understand the current