Compelling documentation: a way to improve the user experience?

Laure Bach-Barast – Laetitia Bossu – Justine Gaucherand- Sarah Lasaracina
Paris Diderot University, 2017, July 31

Abstract

Most people do not read user guides on their own initiative. When they do, it is often because they have no choice, or when they encounter a problem and need a solution. According to the general public composed of a representative sample of 105 people surveyed for our research purpose, guides are deemed plain, unattractive and people usually feel compelled to read them. Indeed, reading user manuals require a certain effort that people are not always ready or willing to make. Hence, they already have a somewhat biased view of the guide even before opening it. Thus, it might be interesting to wonder if a compelling documentation can improve user experience. User Experience implies not only the use of the product, but also the quality of documentation, if it answers questions and solves potential problems in the best, quickest, and most fluent way. User Experience is a cause-and-effect relationship between documentation and the product: the better the information, the better the use will be. However, is it possible to make documentation more compelling in the first place? How can technical writers alleviate the global reluctance to user guides? This paper provides possible solutions in order to make user manuals more compelling to users.

Read the full article (PDF): Compelling documentation: a way to improve the user experience?

Implementation and benefits of minimalism in technical writing

Aurélien Delattre, Yann-Olivier Grohan

July 2013

Abstract

This article explains how minimalism can improve the quality and effectiveness of technical documentation. In the first part, we will define minimalism and its main principles, such as action-oriented approach and topic-based authoring. In the second part, we will conduct a comparative analysis based on the technical documentation of two working environments: Societe Générale Corporate Investment Banking and HR Access. We will analyse how  minimalism impacts the effectiveness and searchability of the documentation. These different minimalism approaches depend on quality criteria adopted for documentation. As a consequence, the decision to apply minimalism or not depends on the context (targeted-audience, access to users feedback). To conclude, we will identify some of the best practices to implement minimalism in any  documentation department.

Read the full article (PDF): Implementation and benefits of minimalism in technical writing