Amélie Allard, Tyffanie Boniou, Camille Hubert, and Nicolas Philippe
July 2013
Abstract
Harmonizing technical documentation content is one of the main goals of technical writers. However, harmonizing technical writing styles is one of the most difficult tasks to implement in companies. In most cases, information models, style guides and editorial styles are used to structure and guide the editorial writing process. But these editorial best practices are not sufficient to provide optimal and long-lasting editorial consistency. Indeed, in a company, it is common to find inconsistencies within a document and across several documents making up a document set. This article deals with both cases.
First, we will present the current state of the art in this domain. Then, we will focus on the writing tools and guidelines used by four software editors: Dassault Systèmes (3D Software), HR Access (Human Resources), KXEN (Knowledge Extraction Engine) and SAP (Systems, Application and Products for data processing). In the third part of the article, we will analyze the strengths and weaknesses of the tools and guidelines previously presented. Finally, we will propose solutions to improve the job of technical writers and editors in their challenge to implement a unified writing style.
Read the full article (PDF): Challenges of harmonizing technical writing styles
OpenEdition suggests that you cite this post as follows:
comtechp7 (November 5, 2015). Challenges of harmonizing technical writing styles. ComTech Paris Cité. Retrieved December 11, 2024 from https://doi.org/10.58079/n1y5