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?

The impact of the digital enterprise on technical communication

Sarah Consentino, Paul Desreux, Alexandre Dias Da Silva, Vincent Perrot

Paris Diderot University, July 2016

Abstract

The digital revolution has changed consumer behavior in the software industry, and digital organizations must keep up with all those changes to stay competitive. As a result, understanding customers’ needs has become part of technical communication. By compiling recent data and studies, this article aims at answering the following question: to what extent have technologies impacted the way that technical communicators assist users to offer them the best experience possible? We first analyzed how companies are starting to place more emphasis on customer experience through digital channels, and to what extent those changes have impacted the way technical communicators present the information and talk to customers. Then, we investigated and found out why technical communication is now perceived as a measurable added business value for companies.

Read the full article (PDF): The impact of the digital enterprise on technical communication

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?

Technical writers and translators: a win-win relationship?

Fanny Bellaïche, Juliette Massardier and Marielle Morizot

August 2014

Abstract

Traditionally, technical communication leverages both technical writing and translation expertise. As both professions share some common skills and objectives, the activities of technical writers and translators are sometimes mixed up. However, they remain two clearly separated occupations and thus complement each other. Based on our working and academic experience as technical writers and translators, we are particularly aware of the importance of a balanced collaboration to align the documentation process with the requirements of today’s industry practice. Current research on the relationship between technical writers and translators mainly focuses on the study of their competences . This paper intends to go beyond the mere analysis of competences and to explore some best practices in order to bridge the gap between both professions: more specifically, to which extent can we consider the translator as a useful resource to improve the writing process? Firstly, we examine why technical writers and translators often collaborate to deliver efficient documentation in their respective fields of expertise. Secondly, we try to understand how technical writers and translators develop shared tools, such as style guides, in order to take advantage of each other’s work. Finally, we show that enhancing this relationship is not the only way to deliver professional  documentation.

Read the full article (PDF): Technical writers and translators: a win-win relationship?

The stakes of collaborative writing

Simon Saint-Georges, Chloé Jaouen

July 2013

Abstract

The arrival of Web 2.0 has changed the ways of working, especially for writers. A wide range of tools now exists, enabling different people to participate in the writing of one single document and introducing new methods of work within teams. These new work methods rely on tools that are constantly evolving. While some companies remain skeptical, others are already embracing these new practices.
Either way, our position of apprentice makes us ideal observers concerning the choices made by our companies and the difficulties that the adoption of these new work methods raises. Such a change can be a real challenge, and selecting the right options to fit one particular situation can be a difficult task.
We will first present the results of our research on the current state of the art in collaborative writing and how and why companies tend to use more and more collaborative writing methods.
We will then explain the situation in the two companies that we work for, Atlas Copco (industrial tooling and equipment) and CNES (Centre National d’Etudes Spatiales, the French space agency), two companies which are heading in opposite directions in terms of collaborative writing. We will observe the practices, tools, processes and work dynamics involved in writing for both companies.
Finally, based on what we found and observed in the first two parts, we will compare theory and reality concerning collaborative writing in companies.

Read the full article (PDF): The stakes of collaborative writing