Aurélien Delattre, Yann-Olivier Grohan
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
Marion L., Catherine S., Jean-Michel V.D.B., Laureen Z.
During the last few years, DITA has spread in many companies and sectors and is often considered as the “must have” tool for technical writing thanks to its flexibility and adaptability. However, does DITA really live up to its reputation? We start with noting that the concept of DITA was designed to serve this purpose. We then try to learn more about DITA and its implementation through webinars, specialized articles, surveys about DITA, and especially one that we conducted from March to May 2015. We came to two main conclusions. First, financially speaking, DITA remains relatively affordable for larger or smaller companies, as long asthey are not looking into specialization, and provided that the implementation plan is complete and fully backed by management. In addition, the productivity gains they get from transitioning to DITA are mainly determined by the implication of companies and the context of the implementation. Secondly, DITA is not restricted to the software sector. It brings a lot to a wide variety of domains thanks to its universal benefits: content reuse, its linking system, the expansion of electronic documentation and the possibility to be specialized. Besides, even though DITA is for now mostly used by documentation teams composed of professional technical writers, LightWeight DITA seems to be quite promising in improving the spread of DITA outside the documentation departments.
Read the full article (PDF): DITA, A universal solution?