Inclusive writing and user-centric strategies in technical communication

BEAUVALLET Mathis, BERANGER Charlotte, HIBON Gaëlle

Paris University, July 2021

Abstract

Documentation and technical communication have gone beyond the stage of secondary support, to become a necessary product while creating a product that reflects its target users is now a common strategy. Then, could inclusive writing be relevant in technical communication to meet users’ expectations?
By interviewing technical communication professionals on their products and experience, cross-checked with research, we are seeking to answer this question. From technical guides to marketplace interfaces, we were able to identify how inclusivity could be integrated into their products and learn when it added value.
While businesses take every precaution to be seen as inclusive, we could imagine that it would show in the content they create. Inclusive writing is the ultimate lever to women and men’s equality in language. Yet, its cultural and political association added with the variety of its form can make any company think twice before incorporating it.
Technical communicators are confronted with a brand-new way of writing content that can sometimes go against the sacred rules of Technical Communication1. At the same time, it implies great change management, not only for users but for collaborators as well. Even though technology might answer most of the drawbacks and complications, is inclusive writing worth the risk?

Read the full article in PDF: Inclusive writing and user-centric strategies in technical communication

Technical innovation: what impact on quality in technical writing?

Deepa HANS, Cécile LEANG, Anne RIVIÈRE
Paris Diderot University, July 2017

Abstract

Nowadays, innovation is considered as a race for companies. Companies need to win this race in order to stay ahead of the game. In this frantic pursuit of innovation, it is important to keep in mind that innovation for innovation’s sake is pointless. To bring value to companies, innovation must lead to quality improvement and cost reduction. Like any other profession, technical writers are compelled to innovate in order to stay relevant. The most obvious expression of innovation lies in the introduction of new tools in the documentation process.
This article explores the impact of technical innovation on the documentation process and product. To be valuable, technical innovation needs to enhance the quality of the process or the product. This article aims at answering the following question: to what extent does technical innovation impact the quality of the documentation process and product? To a lesser extent, we also analyze the role of innovation-driven companies in fostering innovation for technical writers.
In addition to reading articles on innovation, quality and the relationship between the two, we also carried out a survey aimed at technical writers. From the results, we found out that while technical innovation improves both the documentation process and product, the most significant impact may actually come from rethinking information flows and team organization.

Read the full article (PDF): Technical innovation: what impact on quality in technical writing?

Hardware or software products: What impact on technical documentation?

Agnès Carchereux, Marion Groix, Amandine Kempf, Harriet Logan, Camille Pépin

July 2015

Abstract

As apprentices in the software, hardware and embedded systems industries, we wondered whether the type of product had an impact on documentation. After collecting the existing literature on the subject, we sent a questionnaire to technical writers with hands-on experience in order to learn more about their methods and skills. Their answers on the subject underlined that having direct access to the product is essential, but that the methods and skills are different depending on the type of product documented. Indeed, for security reasons, hardware industry documents contain more legal requirements than software documents and have a different documentation structure. The type of deliverables and whether the product is published online or in hardcopy depend on how the product is used on site. Terminology and syntax, the illustration workload, and project management methods are also discussed in this article.

Read the full article (PDF): Hardware or software products: What impact on technical documentation?