Documentation

Styleguides

The use of styleguides for implementing user interfaces is undisputed. "Styleguides give projects a clear framework and guidelines on the subject. When correctly employed and coached they ensure uniformity of design, administration and interaction in projects." - Jürgen Birkholz, HOD in subject architecture atFiducia AG. (The complete interview can be found in the book "User Interface Tuning", in the chapter, "styleguides" by Joachim Machate and Michael Burmester). A styleguide should contain, among other things, the following information:

• Margin constraints, basic ergonomics
• Windowing, menu design / access to functions, data organisation
• Basic and complex elements
• Interactive techniques
• Terminology, Internationalisation, Graphic resources

Styleguide development is no longer limited to computer based applications. It has been introduced into other areas, too, e.g. in the development of mobile applications, in industry areas and in consumer areas. The acceptance of a styleguide depends largely on the topicality and relevance of its information to the developers. It is advantageous when developers are involved in the creation of the styleguide right from the start as representative users. The styleguide is seen as a "living document". It is flexible and can integrate new needs for future releases.

User Interface Specifications

A good specification is one that is thorough and can accurately be used in implementing the user interface. Paper-based and representative prototypes alone are not sufficient, nor is styleguide reference sufficient. In professional environments there are often numerous teams involved in the development and often the implementation is taken care of by an external service provider. In such cases it is imperative that specifications be very clear. Unlike a styleguide the user interface specifications consist of detailed information:

• Window contents, elements of use
• Navigation within a window and connections between windows
• Detailed contents of all menus, including key combinations and symbol contents
• Online help, tool tips

UID Documentation Services

With your co-operation we can develop accurate styleguides and detailed specifications for your user interfaces. An online version of your styleguide, accessible via your intranet, can save you time and effort.