User guide techniques

We choose a page size that is appropriate to the style of guide and the purpose for which it is to be used.

We design a page layout that makes a visual impact and makes the users want to read the guides.

We use appropriate fonts for headings and text to identify levels of importance and make information accessible to the reader.

We leave an appropriate amount of white space on the page. As a rule of thumb, between 30% and 50% of each page should remain blank in order that the guide does not appear to be cluttered.

We keep sentences short. A good general guideline is to restrict all sentences to a maximum of 20 words.

We provide easy-to-understand introductions and high level explanations. It is important that the reader has an understanding of concepts, and the implications of carrying out a task, before actually starting it.

We provide a clear step by step breakdown of each task that users may need to carry out.

We coordinate carefully the relationship between text and graphics. Graphics often do a better job than words. Graphics and text presented together create more memory patterns in the reader's mind than either alone.

We use call-outs where appropriate to summarise the key actions that can be carried out at a screen.

If appropriate, we use cartoons to create a friendly feel and avoid the manual feeling 'heavy' (even though some of the content may be!).

  © Armada 2010

Legal notices