Users' documentation preferences (1)

At the Bransom User Group meeting in April 2007, TechScribe researched users' experiences of the software documentation that they receive. TechScribe used a questionnaire to ask the users about their job roles, their documentation preferences, and their experiences of the Bransom user guide.

This summary shows some of the results from the first two sections of the survey. We show the questions that we asked, but not the answer options, because the results show the answer options. (The text on the charts is simplified. The questionnaire contained more detail to help people to reply accurately.)

We received 29 replies from 64 people.

Bransom and its users

Bransom Retail Systems (www.bransom.co.uk) supplies computer systems to retail jewellers. Bransom's Jewellery Stock Management system is recommended by the National Association of Goldsmiths.

The software is used by a range of customers, from small independent jewellers with only one shop to well-known national chains.

Respondents have many different job roles:

Preferred delivery format

Question: what delivery format do you prefer, if any?

Printed: 8; on-screen: 2; no preference: 17; do not read documentation: 2

More people prefer printed documentation than on-screen documentation. However, most people have no preference. Possibly, what is most important to people is that the content answers their questions.

Method of finding information

Question: when you need to find information in a book about performing a task, which of these do you use? Tick all that apply.

Look at contents page: 16; look at index: 13; scan the book: 3; ask a colleague: 7; phone the help desk: 9

Almost half the respondents use both the service desk and the documentation. Bransom is proud of its service desk. "It's easier to ring the helpline," said one respondent. Good documentation can decrease telephone calls to a service desk. However, if the service desk is a selling point, a business case for decreasing the telephone calls possibly does not exist.

Importance of background information

Question: how important is background information about how the product works?

Not important: 10; important: 19

Background information about software is important to two-thirds of the users. Therefore, good documentation includes concepts of operation, explanations of workflows, and explanations of how the software is related to business procedures. Good design makes sure that people who are not interested can see that the information is an option for the people who are interested.

Type of documentation

Question: which of these types of documentation do you prefer?

'how to' guide: 16; reference material: 0; both equally useful: 12; no reply: 1

No users prefer reference manuals to 'how to' user guides. However, almost half the users think that reference information is as useful as procedural 'how to' information. Clearly, reference manuals are important.

Method of explanations

Question: do you prefer explanations using visuals, descriptions or both?

Visuals: 4; descriptions: 0; visuals and descriptions: 22; no reply: 3

Although people learn in different ways, most users prefer explanations that mix both words and images.

Conclusions

The results show what people want from user documentation. (We do not claim that the results are statistically significant.)

Clearly, we cannot please everyone. However, these results show that the strategy we use at TechScribe is a practical solution that usually helps most people.

See also

Users' documentation preferences (2)

Printed and online documentation trade-offs

Relative costs of printed and online documentation

RSS feed