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
OpenEdition suggests that you cite this post as follows:
comtechp7 (November 17, 2015). Implementation and benefits of minimalism in technical writing. ComTech Paris Cité. Retrieved December 10, 2024 from https://doi.org/10.58079/n1y7