“Using Comics in Technical Documentation” by Rajdeep Gupta

January 27th, 2008

When conversing with a friend the other day, he said that technical documents are not like magazines or comic books that can keep users engaged. They are only meant to be read when required. He is correct, but wait! He mentioned comics. Hmm…technical documentation as comics, I thought.

I did not answer, but that set my mind moving. I have always been curious to find out how end-users go through our technical documents, and to be honest, I am sometimes dismayed at their approach to reading the documentation. I have always wanted to find out an approach of making technical documentation livelier. This article of mine is based on the research and feedback that I have received from numerous writing and design specialists on how to engage technical document users in a natural dialogue.

How it Started

I read an article by Rebekah Sedaca entitled “Comics: Not just for Laughs!” (http://www.boxesandarrows.com/view/comics-not-just-for), where she suggests using comics to capture reader interest, advance understanding, and utilize the knowledge in purchasing. Her ultimate objective is to use comics as a medium of communication wherein complex thoughts are broken into simpler tones for various audiences. Great, I thought.  We deal with a lot of technical topics that are complex and difficult to explain; a medium like comics could contribute to the purpose of simplifying technical documentation without eliminating the fun factor.

Benefits of This Approach

Many people say that technical documentation is not supposed to be fun. That is exactly what I am trying to refute. Almost 50% of technical documents lie on shelves. Some are untouched; and, some documents are read whenever its need arises. If  documents are being wasted, can we try something new? What is the harm in making it interesting? Disregarding opinions in opposition of my idea, I started working on it. I considered developing a chat messenger to help writers use the comic techniques, and I decided to create an online help guide on how to use this messaging system.

Problems with This Approach

The following are some of the common problems with using comics in technical documents:

• Comics or cartoon characters can be interpreted in different ways. What may seem creative to the designer/writer could be offensive to the reader.
• A lot of thought needs to go into every aspect. For example, the customs, nationality of the character, dress, and dialogue may be viewed differently by individual readers.
• For technical documents, if the information needs to be corrected, that can be done easily. If incorrect information is presented through a comic, the time and cost to change it will be too great.

• Kids like comic art. Adults like it only if it is witty. We do not want our documentation to be witty, do we? We want it to be informative. Even if we make an informative comic, an adult reader may ask, “Why are they doing this to me? I just want to quickly learn how to do a particular thing, not view a cartoon strip.”
• When viewed for the second time, a cartoon or comic strip loses its charm. If users want to refer to a technical document again, they may be very frustrated to see the same comic a second time, even if they liked it initially.
• Printing costs will increase substantially.
• Translation will be an issue.
Suggestions from the Experts

I pitched my idea to several design and writing professionals, and they suggested the following ideas: 

• Analysis of the interaction between audience, content and the drawing style should be done before starting the writing. The mindset of using the comic style could trivialize the material or it must only be used for humor. Therefore, to avoid confusion, documentation must be entirely done in either the comic style or a more serious style. This initial analysis is pretty similar to technical writers working on a documentation analysis before setting up to start with the first draft.
• The panel structure of comic art is also a nice way to show a sequence of actions because the time concept is built into the design pattern. Using a comics style also allows the artist to over-exaggerate critical details or to adjust the view to make small details easier to see.
• Comics might also be an effective way to engage readers who might not typically turn to a book for instruction. For example, the United States Army using the comic book style for heavy equipment manuals and service bulletins could be an effective way of communicating with the mechanics in the maintenance departments.
• The critical factor here is to understand the users and the context of use and to make design decisions that enhance usability (for the appropriate people trying to meet their goals. This is similar to the awareness of end-users in technical documentation.
• Understanding the culture and mapping it into technical documentation is one of the critical factors in making the document useful.
• Anything that reduces cognitive overhead in communication is welcome. Whatever the medium, usability testing to check on the deliverables is recommended.

Development

I am developing an online help website wherein I am using comics as an interactive medium. On successful completion of it, I will be forwarding it to my colleagues and listening to their responses. Using comics for interactive learning is worth a try. Whether it will work or not would be something to watch out for in the days to come.
– Rajdeep Gupta is a writer with Infosys Technologies and is currently the Bangalore STC City Representative. He has more than three years of work experience in Technical Documentation and Usability Testing. He is the Assistant Organizer of the Bangalore Technical Writers Meetup group and a quizmaster. You can browse through his blog for a collection of his writings http://coloredwritings.blogspot.com/

 

End of year update

December 21st, 2007

Hello ITC members!

As the  ITC manager, I just wanted to post a few updates and requests for help.

1.  We are actively making plans for the 2008 conference in Philadeliphia, PA, USA.  ITC and GALA are excited to once again host the International Pavilion, with help from the STC office. Watch for updates AND be thinking of short presentations that you may want to give if you are attending the conference.  As well, ITC members can volunteer to help translate for STC attendees and/or staff the pavilion for short periods of time.  More details will be posted here in January/February 2008.

 2.  Theodora Landgren has done a fantastic job organizing a progression session for the 2008 conference.  We will have notes on participants as they become available.

3.  The STC publication, Intercom, is now in the process of working with articles and authors for the May 2008 issue which will focus on international technical communication. 

4.  The STC handbook is in a near-final phase of this version.  Along with members of the ITC leadership team, I have been editing the handbook to address specific issues for international members and SIGs.

5.  We are currently looking for a new volunteer to handle membership for ITC and the listserv.  If you are interested, please email me at kelly@epd.engr.wisc.edu.

6.  We could also use some volunteers to help us with a conversion of content from our old website (http://stcsig.org/itc) to this one.  Interested?  Please email me at kelly@epd.engr.wisc.edu.  Ann Wiley has been a driving force for this project, but we could use more people to help us out.

Have a great end-of-year!

Traci Nathans-Kelly,  ITC manager

Bangalore Technical Writers Meetup (STC India) Follow Up

October 1st, 2007

The Bangalore Technical Writers Meetup, supported by STC India, was held at Continuous Computing on September 29, 2007. Over 25 people from various companies- ranging from Huawei to Infosys -attended. There were two sessions: ”Programming Concepts for Writers on C++” by Rajeev Jain of Zilog and “Introduction to Structured Writing and Structured FrameMaker” by Makarand Pandit of Technowrites.

Rajeev Jain started his presentation by stating “Concepts are important, not language.” He then explained the basics of C++, concentrating on the API/ SDK documentation. He also provided an API template, which is the first step towards API Reference Guide documentation. The training material is available at the following link:  http://techwriter.meetup.com/2/files

Makarand Pandit covered “Structured Writing & Structured FrameMaker.”  Mak provided a demonstration of Adobe FrameMaker 8.0. He explained what Element Definition Document (EDD) and Document Type Definition (DTD) are, and he showed how to edit an EDD, importing a DTD, and all the other tricks that will come handy to the naïve user of FrameMaker 8.0. Pandit was asked questions on all the recent developments in Information Development field. One such question was on DITA. He then explained, in brief, what DITA is and how it has evolved over the years.

You can view the photos of the meetup by clicking the following URL: http://techwriter.meetup.com/2/photos/?photoAlbumId=225090 (requires sign up).
Report submitted by Rajdeep Gupta

XML/DITA Weekend

September 30th, 2007

UK Chapter of STC. 10/11 November 2007, Manchester, England. Details on the STC Forum: http://stcforum.org/viewtopic.php?pid=4163#p4163

All site navigation found world wide

September 30th, 2007

On the news page at http://www.smh.com.au click the “show site sections” widget near the top middle to see “all site” navigation.

This technical is also used at http://amazon.com (mouse over the “See all 41 product categories” tab) and http://thottbot.com (mouse over the category links below the search box).

Some European news websites have begun to show the entire homepage at the bottom of each article.

Examples are:

French: http://www.20minutes.fr/article/184129/Monde-L-emissaire-special-de-l-ONU-recoit-un-visa-pour-la-Birmanie.php

Swedish: http://www.expressen.se/nyheter/1.858431/robban-hjalper-dig-bli-av-med-telefonforsaljarna

Norvegian: http://www.aftenposten.no/nyheter/uriks/article2018950.ece  

IPCC 2008

September 30th, 2007

Call for Panel and Paper Proposals: IEEE International Professional Communication Conference 2008 (IPCC 2008)

Conference Theme: Opening the Information EconomyConference

Location: Concordia University, Montréal, Canada

Conference Dates: July 13-16, 2008

The information economy is based on the collection and the exchange of data and ideas. We all either contribute to or use materials from the information economy in most aspects of our everyday lives. As a result, the information economy exists as an environment in which we are all contributors and consumers. Within this system, effective communication is essential to success, allowing individuals to contribute ideas and information effectively and to make efficient use of the goods and services. Few of us, however, understand all of the nuances of the information economy or the communication factors that affect its operations.This conference seeks to examine or to “open” this economic model by examining the connections between communication practices and the products, practices, and services that constitute the information economy. The objective of such an examination will be to help attendees better understand and participate in the information economy as both contributors and consumers.

The conference will take place on the campus of Concordia University in Montréal, Canada and will consist of paper presentations and panel discussions that focus on various communication, design, social, and cultural aspects of the information economy.

POSSIBLE TOPIC AREAS
Suggested topic areas include but are not limited to the following:

* Establishing and assessing the value of knowledge work and knowledge products
* Information design, usability, and accessibility
* Virtual teams, online collaboration, and distributed models of work
* Cross-cultural communication, globalization, outsourcing, translation, and localization
* Legal policies and social issues related to the information economy
* Media selection and multimodality
* The role of and perspectives on teaching and training within the information economy
* Content management, open source software, single sourcing, and XML

PROPOSAL SUBMISSION PROCESS AND SUBMISSION DATES
Send 1-2 page (250-500 word) proposals to IPCC2008@gmail.com by
* 15 October 2007 (deadline for submissions to be considered for early acceptance)
* 15 January 2008 (deadline for regular submissions)

For conference- or proposal-related questions contact: IPCC2008@gmail.com

 

Bangalore Technical Writers Meetup –Supported by the Society for Technical Communication India Chapter, 2 sessions

September 26th, 2007

The Bangalore Technical Writers Meetup –supported by the Society for Technical Communication India Chapter- is pleased to conduct two sessions on September 29 at Continous Computing. This event starts at 10:30am sharp with a welcoming note by Rajdeep Gupta, followed by our guest speakers’ presentations. The venue for the sessions is at Continuous Computing India Pvt Ltd, 4th Floor, Pine Valley, (above Mcaffee and Daimler Chrysler) Embassy Golf Links Business Park, Intermediate Ring Road, Koramangala, Bangalore, India and the contact no. is 9900-171161.

Rajiv Jain, Documentation Manager of Zilog Systems, will present the first of the sessions on “Programming Concepts for Writers (with C++).” The session is intended for writers involved in API/SDK documentation or those who want to learn fundamental Programming concepts. This presentation provides high level overview of programming concepts (sequence, selection, and iteration) with C++ as example. This is helpful to all those who are involved in API/SDK related documentation irrespective of programming language used by them, as concepts remain the same for all the languages. This presentation will help participants to understand the programming concepts, read the APIs, and contribute as writers in APD guides. It also helps us to understand what parameters are and to return values which will help to add value in content and decrease the dependency on SMEs. You will definitely add value in the content instead of just cutting, pasting, formatting, or implementing the style guide.

Next, we have the veteran and the versatile Makrand Pandit providing ”An Introduction to Structured Writing and Structured FrameMaker.” During the course of the presentation, learn about the advantages and disadvantages of structured writing; in addition, there will be more insights on EDD and SFM files. 

If this interests you, please feel free to an email to rguptaz@gmail.com . The session is open and FREE to all. Further updates on the group’s website at http://techwriter.meetup.com/2/calendar/6200981/

State of the ITC SIG, Sept 2007

September 26th, 2007

by Traci  Nathans-Kelly, ITC SIG Manager 

This is a quick overview of the state of the ITC SIG.

As the new manager of the International Technical Communication SIG for STC, I am making many efforts to continue the great work inherited from Kit Brown, those managers before her, and the leadership teams.  Below are some notes about the 2007 conference in Minneapolis (with our beginning plans for the conference in 2008), along with other calls for help for some ITC projects.

–2007 Conference:  ITC hosted the first “International Pavilion” at the STC Conference in May 2007 in Minneapolis.  We had corporate and academic sponsors, along with great speakers that addressed issues in many areas of concern to ITC professionals and technical communicators as a whole.  We had a large area with seating, which was substantially more than the table/2 chairs provided for others in the vendors/SIG info space.  It was incredible, and a large team of people really worked hard to make it a success.

–2008 Conference. The next annual conference is scheduled for Philadelphia, Pennsylvania, USA, June 1-8, 2008.  We are planning to host the International Pavilion again, and we hope to be more fully integrated into the overall conference format and schedule.  The ITC Leadership Team has already begun work towards this goal.

ITC SIG members are encouraged to submit proposals to the 2008 conference.  There is more information at  http://stc.org/cfp/index.aspx

–We have provided a Community Status Report to the STC SIG advocate that noted that our SIG is in good health.  We have over 1000 members worldwide, we have projects that have come to fruition (like the International Pavilion), and we have plenty of good energy.

–We requested and were approved for a modest budget by the STC office.  Most of the money goes towards our SIG’s activities at the annual conference.  Other money goes for operating costs, such as leadership team phone calls and the like.

–We are working hard to make this website/newsletter a valuable resource for SIG members and the field of international technical communication. If you have ideas or would like to help, write to kelly@epd.engr.wisc.edu

–As well, if you would like to work as a volunteer editor for a section or content area of the website/newsletter, please register on this site and send a message to ann@annlwiley.com asking to become a Contributor. Then make a post in plain text and Ann will write to you about the role you’d like to play.

Thank you, and please contact me with any questions or comments.  We need volunteers to act as liaisons to regions/areas.  We need volunteers to help us update our website content, and so forth.  Let us know if you are interested!

Online Event Notice: Avoiding Eurobabble: How Linguistic Standards are Delivering the Right Word

September 25th, 2007

To mark the European Day of Languages on September 26 2007, SDL invites you to attend a webinar to discuss the importance of using language standards in delivering multilingual communications and the implications for European governments.

The European Day of Languages — a day for celebrating linguistic diversity — was set up in 2000 by the Committee of Ministers of The Council of Europe in 2000. It aims to celebrate increase plurilingualism and intercultural understanding; promote the rich linguistic and cultural diversity of Europe; and encourage lifelong language learning.

The webinar will feature expert speakers who will give you an insight into the importance of translation and localization standards to the production of EU laws and regulations.

Speakers include:

  • Laura Vrabie, Terminologist at the European Institute of Romania (IER), the body responsible for translating all EU policy into Romanian for this new member state
  • Arle Lommel of the LISA organization (Localization Industry Standards Association), an expert on both governmental issues and linguistic standards

Attend this webinar and gain insight into the importance of localization standards to the production of EU laws and regulations.

To register, go to www.sdl.com and click on the flash banner.

Karen Schriver at France Chapter meeting

September 13th, 2007

The STC France Chapter of the Society for Technical Communication is starting off the season on September 24 with ”Saveurs et Savoirs “. This evening meeting will start with a buffet cocktail followed by our guest speaker’s presentation.

Karen Schriver will present, ”If You’re So Smart, Why Does Your Writing Suck? ”

Subject-matter experts often have trouble writing for general audiences. Experts may fail to understand what audiences need to know and create texts permeated with insider jargon and content that is too difficult, too complex, and not focused on what readers expect. It may be easy to attribute experts’ problem to arrogance and cluelessness, but this interpretation is too simple. Research into the cognition of expertise offers insights into why subject-matter experts have trouble transforming their knowledge for audiences. This work suggests that sophisticated subject-matter knowledge can be both an advantage and a disadvantage. Come learn about domain experts writing for smart people outside of their field. Get ideas for working with people who may believe that clear writing waters down their thinking.

Dr. Karen Schriver is a researcher, consultant, and educator in information design. Her early work at Carnegie Mellon University (Pittsburgh, Pennsylvania) charted new territory in understanding the integration of word and image, audience analysis, and people-centered design. Her book, Dynamics in Document Design: Creating Texts for Readers (Wiley & Sons), now in its 9th printing, is regarded as an essential work in the field. Winner of nine awards for research, Karen has made a significant impact on how information designers around the world think about their work. Karen is a Fellow of STC and a frequent keynote speaker. She has taught at universities in the US, Holland and South Africa, and is on the board of directors for the Communications Research Institute (Australia) and the Center for Plain Language (Washington, DC).

Karen will speak in English. The meeting takes place Monday, September 24 19:00 - 21:30, at FIAP Jean Monnet, 1st floor 30 rue Cabanis 75014 Paris Métro: Glacière (line 6) or Denfert-Rochereau (lines 4, 6, RER B)

Space is limited. Register before 15/Sept/2007 by sending an e-mail with your name and membership number (members of STC, IABC, or CRT) to secretary@stcfrance.org. Payment at the door, cash or check: 10 euros students or members of STC, CRT, or IABC 25 euros non-members .