Harry Miller's Technical Writing Blog

Mostly podcasts about documentation, technical writing, and technical editing.

Thinking Visually

I want to use more illustrations and other graphics in our documentation. Graphics can help clarify ideas that are hard to understand from textual explanations, they can add useful redundancy to the communication, and they provide more learning channels. Plus they're often fun to look at.

The documentation I've worked on hasn't used graphics or art much, so I'm not used to thinking visually. That's not a Microsoft thing, it's more the style of the individual writers (like me) who generally think in words. In fact, Developer Division User Education has a designer/artist, Monique Bailey, who creates art for the docs (among her other design duties). To get a better understanding of this important area, I met with Monique to talk about how to turn concepts and ideas into pictures.

This podcast is 7.16 MB in size, and is 10 minutes, 25 seconds long.

Download this podcast

Published Friday, July 21, 2006 8:31 AM by HarryMiller

Comment Notification

If you would like to receive an email when updates are made to this post, please register here

Subscribe to this post's comments using RSS

Comments

 

Harry Miller's Technical Writing Blog said:

Graphic artists and designers are an important part of documentation, but until lately I didn't look...
July 27, 2006 6:28 PM
 

John said:

Recently I had to do my own art (at another company). Most of their existing Visio stuff was miserably overwhelmed by text. And the graphics were enormous, too, spanning pages! Art is best when it's painfully simple. People need imagery they can hold on to when reading explanatory text. Blurring the two into one complex an annotated graphic is Not the best plan. Yet that's exactly what happens when geeks use Visio.
August 15, 2006 6:44 PM
 

Judy Horton said:

In your discussion during this podcast, you seem to be restricting yourself to when to use visuals in software documentation.  However, illustrations are becoming increasingly important in many types of technical documentation.  Product documentation for technical products is a good example of this.  In many cases documentation must use CAD drawings as the basis for illustrations.  The process of gaining access to CAD drawings and then converting those into illustrations or graphics which will add value to technical documentation is often a very time-consuming task or series of tasks.  

Recently, I've been learning a bit about using a software product from Right Hemisphere which facilitates producing 3D illustrations and animations from CAD files.  I believe their product even allows XML tags to be associated with illustrations or parts of illustrations.  According to the Aberdeen Group, companies are implementing 3D publishing to "reduce time to market, lower product development costs, and create higher quality product documentation...Best in class companies are 50% more likely than other companies to be using 3D publishing to reduce time to market and communicate manufacturing instructions to the plant and to use graphics to overcome language barriers.  

Since translation costs are so high, using graphics or animation offers a "universal language" approach which lets technical documenters minimize words and simplify the documentation.    It seems to me that, as we look to the future, we will more and more be trying to provide virtually "wordless" documentation.

August 14, 2007 5:21 PM
 

Attorney Search » Thinking Visually said:

April 20, 2008 6:44 PM

Leave a Comment

(required) 
(optional)
(required) 
Submit

This Blog

Syndication

Tags

No tags have been created or used yet.

News

All postings are provided "AS IS" with no warranties, and confer no rights. This site contains my personal opinions. These opinions do not represent my employer's view in any way. Also, I'll probably change my mind at some point.

© 2008 Microsoft Corporation. All rights reserved. Terms of Use  |  Trademarks  |  Privacy Statement
Microsoft
Page view tracker