probing the use of charts and graphs in technical documentation through analysis and pragmatic collaboration
A continuous priority for technical writers is to increase user comprehension of concepts and statistical information in technical documentation. Improvements in the written language such as consistent terminology, use of an established writing style, accurate indexing, advanced search capabilities, and so on, address some of the user pain points. The complexities of certain topics do not always translate well into writing; therefore, there is a need for other aids such as information graphics to assist with visualization and to increase the efficacy of information communication [1]. The benefits of information graphics in documentation and learning modules are well documented by the works of Levin and Pane [2, 3]. The conclusion is simple according to Davison, Pane, and Bertrancourt: if graphics are crafted correctly with the intent to enhance understanding then the quality of the documentation will improve and ultimately enrich the user experience and comprehension [4, 5, 6]. With this sage advice, one might expect implementation to be straightforward, perhaps even easy. This is unfortunately not the case. Careful consideration is necessary to construct an information graphic. Many questions may arise during the process, such as how many graphics, and which type, are needed, and where best to insert them in order to convey the concept clearly. Some information graphics, such as charts and graphs, require further thought since their visual representation is derived from data. In this case, the challenge lies in shaping the data into what is truly useful for users' comprehension, and in skillfully rendering the graphics with sound design principles. This paper presents the authors' recent experiences in collaborative design of charts and graphs, and demonstrates that the responsibility of communicating effectively should not lie on one person's shoulders alone, but rather on all development and documentation professionals who bring their collective expertise to fruition in a partnership.
charts graphs documentation technical writer translation information graphics globalization graphic design