The use of eBooks and interactive multimedia as alternative forms of technical documentation

ABSTRACT

The use of eBooks and interactive multimedia in technical documentation is an emerging and important trend for delivering abstract and complex technical information that is enticing, engaging, and -most important of all- effective. With the substantial (and growing) number of documents available electronically, it is a non-trivial task for technical writers to even reach their target audience, let alone engage them. Both eBooks and interactive multimedia feature unique characteristics that serve two important functions: piquing the interest in the user, and aiding in the transmittal of complex technical information. Further, the use of eBooks and interactive multimedia in technical documentation helps to differentiate from the myriad other technical documents. At the IBM Toronto Software Laboratory, the Media Design Studio (MDS) works collaboratively with the information development community to produce graphics and diagrams for technical documentation. This paper explores alternative forms of IBM technical documentation in the form of two case studies-one an eBook and the other a Macromedia Flash-based interactive multimedia presentation. Both projects were co-developed by the writers and graphic designers, with a mandate to create a rich, graphical approach to entice and engage users to read and understand complex technical concepts.

REFERENCES

• 1: Gartner, Jason (2002). Administration Made Easier: New and Improved Tools in DB2 Universal Database (p.4).
• 2: IBM's Autonomic Computing overview http://www.research.ibm.com/autonomic/overview/
• 3: DB2 Autonomic Computing eBook http://www.db2mag.com/epub/autonomic/
• 4: Levin, J., Anglin, G., & Carney, R. (1987). On empirically validating functions of pictures in prose. In D. Willows & H. Houghton (Eds.), The psychology of illustration, volume 1: Instructional issues (pp. 51--85). New York: Springer-Verlag.
• 5: Rieber, L., b (2000), Computers, Graphics, and Learning, Chapter 6--Review of Instructional Visual Research: Animated Visuals (p. 160).
• 6: Rieber, L., b (2000), Computers, Graphics, and Learning, Chapter 6--Review of Instructional Visual Research: Animated Visuals (p. 159).
• 7: Pane, John F., Corbett, Albert T., John, Bonnie E. Assessing Dynamics in Computer-Based Instruction.
• 8: Betrancourt, M., Bauer Morrison, J., Tversky, B. (2002). Animation: can it facilitate? (p. 9--11).
• 9: Wikipedia, the Free Encyclopedia, Newton's laws of motion-law of inertia http://en.wikipedia.org/wiki/Newton's_laws_of_motion#Newton.27s_First_Law_:_Law_of_Inertia
• 10: Levin, J., Anglin, G., & Carney, R. (1987). On empirically validating functions of pictures in prose. In D.Willows & H. Houghton (Eds.), The psychology of illustration, volume 1: Instructional issues (p.73). New York: Springer-Verlag.
• 11: Rieber, L., b (2000), Computers, Graphics, and Learning, Review of Instructional Visual Research:Static Visuals (p. 150).
• 12: Betrancourt, M., Bauer Morrison, J., Tversky, B. (2002). Animation: can it facilitate? (p. 21 and 19 respectively).

INDEX TERMS

Primary Classification:
  H. Information Systems
  H.5 INFORMATION INTERFACES AND PRESENTATION (I.7)
      H.5.0 General

General Terms:
Design, Documentation, Human Factors

Keywords:
animation, audio, diagrams, documentation, eBook, graphic design, human factors, illustrations, user testing, visualization