<?xml version='1.0' encoding='UTF-8'?><?xml-stylesheet href="http://www.blogger.com/styles/atom.css" type="text/css"?><feed xmlns='http://www.w3.org/2005/Atom' xmlns:openSearch='http://a9.com/-/spec/opensearchrss/1.0/' xmlns:georss='http://www.georss.org/georss' xmlns:gd='http://schemas.google.com/g/2005' xmlns:thr='http://purl.org/syndication/thread/1.0'><id>tag:blogger.com,1999:blog-8561105343828481976</id><updated>2011-08-02T15:11:15.956-04:00</updated><category term='technical writing'/><category term='release notes'/><category term='technical communications'/><category term='g1 user manual technical writing'/><category term='stc'/><category term='michael hughes'/><category term='customer service'/><title type='text'>Where writing and customer service collide.</title><subtitle type='html'>Customer self-service is growing at a fast clip, which means your product documentation needs to shine. 

Is yours shining?</subtitle><link rel='http://schemas.google.com/g/2005#feed' type='application/atom+xml' href='http://andrewlight.blogspot.com/feeds/posts/default'/><link rel='self' type='application/atom+xml' href='http://www.blogger.com/feeds/8561105343828481976/posts/default?max-results=100'/><link rel='alternate' type='text/html' href='http://andrewlight.blogspot.com/'/><link rel='hub' href='http://pubsubhubbub.appspot.com/'/><author><name>Andrew Light</name><uri>http://www.blogger.com/profile/10918032199292987770</uri><email>noreply@blogger.com</email><gd:image rel='http://schemas.google.com/g/2005#thumbnail' width='16' height='16' src='http://img2.blogblog.com/img/b16-rounded.gif'/></author><generator version='7.00' uri='http://www.blogger.com'>Blogger</generator><openSearch:totalResults>8</openSearch:totalResults><openSearch:startIndex>1</openSearch:startIndex><openSearch:itemsPerPage>100</openSearch:itemsPerPage><entry><id>tag:blogger.com,1999:blog-8561105343828481976.post-4250436274494101781</id><published>2010-01-02T09:19:00.018-05:00</published><updated>2010-01-04T22:41:16.762-05:00</updated><category scheme='http://www.blogger.com/atom/ns#' term='technical writing'/><category scheme='http://www.blogger.com/atom/ns#' term='customer service'/><title type='text'>The Great Morale Reversal of 2009</title><content type='html'>&lt;a onblur="try {parent.deselectBloggerImageGracefully();} catch(e) {}" href="http://3.bp.blogspot.com/_pLTSQcpi5TY/Sz-hAAXhu2I/AAAAAAAAC1c/c-KXNULsAns/s1600-h/happy.jpg"&gt;&lt;img style="float:right; margin:0 0 10px 10px;cursor:pointer; cursor:hand;width: 122px; height: 120px;" src="http://3.bp.blogspot.com/_pLTSQcpi5TY/Sz-hAAXhu2I/AAAAAAAAC1c/c-KXNULsAns/s200/happy.jpg" border="0" alt="" id="BLOGGER_PHOTO_ID_5422229497848118114" /&gt;&lt;/a&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt;&lt;br /&gt;&lt;/span&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt;This holiday season, I found myself in a downward morale spiral - a combination of bad weather, crowded malls and a long shopping list. Thinking it would save me some time, I ordered a pair of boots from Zappos.com but, upon reading the shipping notice, I discovered that I had ordered the women's version of the boots and not the men's. So much for saving time. I picked up the phone, lowered my expectations and called Zappos.com. This is when the great morale reversal of 2009 began.&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt;&lt;br /&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt;I called at around 8:00 in the morning. Someone answered the phone on the 1st ring. A real person. A real person who wasn't in a call center on the other side of the world.  I explained to her my mistake and asked her how I go about fixing it. I would need the correct boots ordered and shipped and a return of the wrong boots which hadn't arrived yet.&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt;&lt;br /&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt;The customer service rep then said, "the men's boots are actually more expensive than the women's,&lt;b&gt; &lt;/b&gt;&lt;/span&gt;&lt;span class="Apple-style-span"  style="font-size:large;"&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt;&lt;b&gt;but I'll give you the lower price&lt;/b&gt;&lt;/span&gt;&lt;/span&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt;". &lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt;&lt;br /&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt;Then she said, "I'll ship these new ones to you overnight&lt;/span&gt;&lt;span class="Apple-style-span"  style="font-size:large;"&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt;&lt;b&gt; &lt;/b&gt;&lt;/span&gt;&lt;span class="Apple-style-span"  style="font-size:large;"&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt;&lt;b&gt;so you don't have to wait any longer&lt;/b&gt;&lt;/span&gt;&lt;/span&gt;&lt;/span&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt; to get them."&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt;&lt;br /&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt;Let me remind you that this whole issue was &lt;/span&gt;&lt;i&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt;my &lt;/span&gt;&lt;/i&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt;fault - I ordered the wrong pair of boots - I caused this.&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt;&lt;br /&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt;Anyway, Zappos didn't have to go to these lengths to make me happy, but they did. And because of this, I tell other people to shop there and I plan to shop there again in the future. That means more revenue for Zappos, plain and simple.&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt;&lt;br /&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt;This isn't a new story. We've all read about and maybe even experienced customer service like this (L.L. Bean comes to mind).  But what surprises me is that it's still the exception rather than the rule. Maybe because it's difficult, companies don't pursue it. Maybe because it's hard to link good customer service with increased revenue, companies don't spend the money to make it happen.&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt;&lt;br /&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt;And why am I writing about this? Because technical writers create what often represents the first customer service "touch-point" for a product. When one opens a toy, one must read the directions. When one buys software, one must read the manual. &lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt;&lt;br /&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt;That customer is my audience so I think about these things a lot. This isn't to say that technical writers can make software users as happy as Zappos made me but, if we acknowledge that Zappos has set the bar, and we aim for it, our readers will be glad we did. Plain and simple.&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt;&lt;br /&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:georgia;"&gt;Happy New Year!&lt;/span&gt;&lt;/div&gt;&lt;div class="blogger-post-footer"&gt;&lt;img width='1' height='1' src='https://blogger.googleusercontent.com/tracker/8561105343828481976-4250436274494101781?l=andrewlight.blogspot.com' alt='' /&gt;&lt;/div&gt;</content><link rel='replies' type='application/atom+xml' href='http://andrewlight.blogspot.com/feeds/4250436274494101781/comments/default' title='Post Comments'/><link rel='replies' type='text/html' href='http://www.blogger.com/comment.g?blogID=8561105343828481976&amp;postID=4250436274494101781&amp;isPopup=true' title='0 Comments'/><link rel='edit' type='application/atom+xml' href='http://www.blogger.com/feeds/8561105343828481976/posts/default/4250436274494101781'/><link rel='self' type='application/atom+xml' href='http://www.blogger.com/feeds/8561105343828481976/posts/default/4250436274494101781'/><link rel='alternate' type='text/html' href='http://andrewlight.blogspot.com/2010/01/great-morale-reversal-of-2009.html' title='The Great Morale Reversal of 2009'/><author><name>Andrew Light</name><uri>http://www.blogger.com/profile/10918032199292987770</uri><email>noreply@blogger.com</email><gd:image rel='http://schemas.google.com/g/2005#thumbnail' width='16' height='16' src='http://img2.blogblog.com/img/b16-rounded.gif'/></author><media:thumbnail xmlns:media='http://search.yahoo.com/mrss/' url='http://3.bp.blogspot.com/_pLTSQcpi5TY/Sz-hAAXhu2I/AAAAAAAAC1c/c-KXNULsAns/s72-c/happy.jpg' height='72' width='72'/><thr:total>0</thr:total></entry><entry><id>tag:blogger.com,1999:blog-8561105343828481976.post-742232674758371131</id><published>2009-11-24T11:20:00.001-05:00</published><updated>2010-01-31T14:34:18.282-05:00</updated><category scheme='http://www.blogger.com/atom/ns#' term='technical communications'/><category scheme='http://www.blogger.com/atom/ns#' term='stc'/><category scheme='http://www.blogger.com/atom/ns#' term='michael hughes'/><title type='text'>User Guide as a Guide</title><content type='html'>&lt;div&gt;&lt;span class="Apple-style-span" style=" "&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;I recently read an article by Michael Hughes called "Users as Decision Makers".&lt;/span&gt;&lt;/span&gt;&lt;/span&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;&lt;br /&gt;&lt;/span&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;&lt;br /&gt;&lt;/span&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;His article is here: &lt;/span&gt;&lt;/span&gt;&lt;a href="http://www.divshare.com/download/6513696-0d8"&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;http://www.divshare.com/download/6513696-0d8&lt;/span&gt;&lt;/span&gt;&lt;/a&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;Michael's Blog is here: &lt;/span&gt;&lt;/span&gt;&lt;a href="http://user-assistance.blogspot.com/"&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;http://user-assistance.blogspot.com/&lt;/span&gt;&lt;/span&gt;&lt;/a&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;&lt;br /&gt;&lt;/span&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;&lt;br /&gt;&lt;/span&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;The gist is that product documentation often fails in its lack of guidance. In other words, there's too much information on what one &lt;/span&gt;&lt;/span&gt;&lt;span class="Apple-style-span" style="font-style: italic;"&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;can &lt;/span&gt;&lt;/span&gt;&lt;/span&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;do and not enough information on what one &lt;/span&gt;&lt;/span&gt;&lt;span class="Apple-style-span" style="font-style: italic;"&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;should &lt;/span&gt;&lt;/span&gt;&lt;/span&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;do. &lt;/span&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;&lt;br /&gt;&lt;/span&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;And it's a very good point. &lt;/span&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;&lt;br /&gt;&lt;/span&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;Knowing that a software setting can go from 1-89 is important, but what are the implications of the different values?  What &lt;/span&gt;&lt;/span&gt;&lt;span class="Apple-style-span" style="font-style: italic;"&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;should &lt;/span&gt;&lt;/span&gt;&lt;/span&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;I set it to so that I achieve my desired outcome?&lt;br /&gt;&lt;/span&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;&lt;br /&gt;&lt;/span&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;Maybe this is one of the reasons that product documentation gets a bad rap from user communities; why they hate being told to "consult the manual" before calling for support. Most users of software are very good at recognizing the various interface elements and how they work - drop-down menus, radio buttons, fields and forms - these things don't need to be explained, at least not as much as what users should do with them.&lt;/span&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;&lt;br /&gt;&lt;/span&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;Instead of "Click the drop-down menu and select a value between 1 and 89", a manual should explain how the settings will affect the user's goal. The user guide should really be a &lt;/span&gt;&lt;/span&gt;&lt;span class="Apple-style-span" style="font-style: italic;"&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;guide&lt;/span&gt;&lt;/span&gt;&lt;/span&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;.&lt;/span&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;&lt;br /&gt;&lt;/span&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-family:arial;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;Anyway, Michael's article makes a great point - one that all technical communicators should keep in mind. Read it and I think you'll agree.&lt;/span&gt;&lt;/span&gt;&lt;/div&gt;&lt;div class="blogger-post-footer"&gt;&lt;img width='1' height='1' src='https://blogger.googleusercontent.com/tracker/8561105343828481976-742232674758371131?l=andrewlight.blogspot.com' alt='' /&gt;&lt;/div&gt;</content><link rel='replies' type='application/atom+xml' href='http://andrewlight.blogspot.com/feeds/742232674758371131/comments/default' title='Post Comments'/><link rel='replies' type='text/html' href='http://www.blogger.com/comment.g?blogID=8561105343828481976&amp;postID=742232674758371131&amp;isPopup=true' title='0 Comments'/><link rel='edit' type='application/atom+xml' href='http://www.blogger.com/feeds/8561105343828481976/posts/default/742232674758371131'/><link rel='self' type='application/atom+xml' href='http://www.blogger.com/feeds/8561105343828481976/posts/default/742232674758371131'/><link rel='alternate' type='text/html' href='http://andrewlight.blogspot.com/2009/02/user-guide-as-guide.html' title='User Guide as a Guide'/><author><name>Andrew Light</name><uri>http://www.blogger.com/profile/10918032199292987770</uri><email>noreply@blogger.com</email><gd:image rel='http://schemas.google.com/g/2005#thumbnail' width='16' height='16' src='http://img2.blogblog.com/img/b16-rounded.gif'/></author><thr:total>0</thr:total></entry><entry><id>tag:blogger.com,1999:blog-8561105343828481976.post-4096531206933374715</id><published>2009-02-01T20:45:00.000-05:00</published><updated>2009-02-06T16:02:44.346-05:00</updated><title type='text'>What size are your blinders?</title><content type='html'>&lt;a onblur="try {parent.deselectBloggerImageGracefully();} catch(e) {}" href="http://3.bp.blogspot.com/_pLTSQcpi5TY/SYyj_gFyZ_I/AAAAAAAABs4/kKEXir80Ke8/s1600-h/blinders.jpg"&gt;&lt;img style="float:right; margin:0 0 10px 10px;cursor:pointer; cursor:hand;width: 150px; height: 200px;" src="http://3.bp.blogspot.com/_pLTSQcpi5TY/SYyj_gFyZ_I/AAAAAAAABs4/kKEXir80Ke8/s200/blinders.jpg" border="0" alt="" id="BLOGGER_PHOTO_ID_5299791172849526770" /&gt;&lt;/a&gt;&lt;br /&gt;I got a very friendly email recently informing me that my website contained a typo &lt;span class="Apple-style-span"  style="font-size:small;"&gt;(Thank you again for that, emailer who will remain nameless)&lt;/span&gt;.&lt;div&gt;&lt;br /&gt;&lt;/div&gt;&lt;div&gt;And sure enough it did - a glaring one. Well, at least I'm not in the writing business.  Wait... oh.&lt;/div&gt;&lt;div&gt;&lt;br /&gt;&lt;/div&gt;&lt;div&gt;Here's the thing - we all have blinders on. We may not be born with them, but we develop them over years of doing the same tasks over and over again. Anyone who has ever poured juice into their cereal or tried to start a running car knows this.&lt;/div&gt;&lt;div&gt;&lt;br /&gt;&lt;/div&gt;&lt;div&gt;For me, it's all about comfort zones. When you're in a comfort zone, your attentiveness sort of idles. When you're out of a comfort zone, your survival skills kick in, boosting your attention to things around you.&lt;/div&gt;&lt;div&gt;&lt;br /&gt;&lt;/div&gt;&lt;div&gt;"So what?", you ask? So, be sure to exercise your attention to detail by leaving your comfort zone from time to time. It may not feel productive, but it will likely keep those blinders from growing into the side of your face.&lt;/div&gt;&lt;div class="blogger-post-footer"&gt;&lt;img width='1' height='1' src='https://blogger.googleusercontent.com/tracker/8561105343828481976-4096531206933374715?l=andrewlight.blogspot.com' alt='' /&gt;&lt;/div&gt;</content><link rel='replies' type='application/atom+xml' href='http://andrewlight.blogspot.com/feeds/4096531206933374715/comments/default' title='Post Comments'/><link rel='replies' type='text/html' href='http://www.blogger.com/comment.g?blogID=8561105343828481976&amp;postID=4096531206933374715&amp;isPopup=true' title='0 Comments'/><link rel='edit' type='application/atom+xml' href='http://www.blogger.com/feeds/8561105343828481976/posts/default/4096531206933374715'/><link rel='self' type='application/atom+xml' href='http://www.blogger.com/feeds/8561105343828481976/posts/default/4096531206933374715'/><link rel='alternate' type='text/html' href='http://andrewlight.blogspot.com/2008/12/what-size-are-your-blinders.html' title='What size are your blinders?'/><author><name>Andrew Light</name><uri>http://www.blogger.com/profile/10918032199292987770</uri><email>noreply@blogger.com</email><gd:image rel='http://schemas.google.com/g/2005#thumbnail' width='16' height='16' src='http://img2.blogblog.com/img/b16-rounded.gif'/></author><media:thumbnail xmlns:media='http://search.yahoo.com/mrss/' url='http://3.bp.blogspot.com/_pLTSQcpi5TY/SYyj_gFyZ_I/AAAAAAAABs4/kKEXir80Ke8/s72-c/blinders.jpg' height='72' width='72'/><thr:total>0</thr:total></entry><entry><id>tag:blogger.com,1999:blog-8561105343828481976.post-8849286880583872112</id><published>2008-10-15T15:00:00.004-04:00</published><updated>2008-10-15T15:01:48.673-04:00</updated><category scheme='http://www.blogger.com/atom/ns#' term='technical writing'/><category scheme='http://www.blogger.com/atom/ns#' term='release notes'/><title type='text'>The bigger picture</title><content type='html'>&lt;div dir="ltr"&gt;Most enterprise software companies write up a special Release Notes document to accompany a new version of their product. The majority of Release Notes that I have come across are filled with the obligatory "fixed bugs" and "new features" lists.&lt;/div&gt;&lt;div dir="ltr"&gt;&lt;br /&gt;&lt;/div&gt;&lt;div dir="ltr"&gt;&lt;span class="Apple-style-span"  style="font-size:large;"&gt;I know for a fact that most customers do read Release Notes.&lt;/span&gt; They need to in order to check for bug fixes that impact their implementation or to learn about features that might help their users.&lt;/div&gt;&lt;div dir="ltr"&gt;&lt;br /&gt;&lt;/div&gt;&lt;div dir="ltr"&gt;&lt;span class="Apple-style-span"  style="font-size:large;"&gt;What a great opportunity to shine a spotlight on your application, regardless of what's new or fixed?&lt;/span&gt;&lt;/div&gt;&lt;div dir="ltr"&gt;&lt;br /&gt;&lt;/div&gt;&lt;div dir="ltr"&gt;Who says the Release Notes have to be exclusively about that release? Why not emphasize new features in the context of existing ones? Or highlight fixed bugs and how they now allow for increased productivity in your product.&lt;/div&gt;&lt;div dir="ltr"&gt;&lt;br /&gt;&lt;/div&gt;&lt;div dir="ltr"&gt;In other words, give the facts but don't miss an opportunity to show your customers the &lt;span class="Apple-style-span"  style="font-size:large;"&gt;bigger &lt;/span&gt;picture.&lt;/div&gt;&lt;div class="blogger-post-footer"&gt;&lt;img width='1' height='1' src='https://blogger.googleusercontent.com/tracker/8561105343828481976-8849286880583872112?l=andrewlight.blogspot.com' alt='' /&gt;&lt;/div&gt;</content><link rel='replies' type='application/atom+xml' href='http://andrewlight.blogspot.com/feeds/8849286880583872112/comments/default' title='Post Comments'/><link rel='replies' type='text/html' href='http://www.blogger.com/comment.g?blogID=8561105343828481976&amp;postID=8849286880583872112&amp;isPopup=true' title='1 Comments'/><link rel='edit' type='application/atom+xml' href='http://www.blogger.com/feeds/8561105343828481976/posts/default/8849286880583872112'/><link rel='self' type='application/atom+xml' href='http://www.blogger.com/feeds/8561105343828481976/posts/default/8849286880583872112'/><link rel='alternate' type='text/html' href='http://andrewlight.blogspot.com/2008/10/bigger-picture.html' title='The bigger picture'/><author><name>Andrew Light</name><uri>http://www.blogger.com/profile/10918032199292987770</uri><email>noreply@blogger.com</email><gd:image rel='http://schemas.google.com/g/2005#thumbnail' width='16' height='16' src='http://img2.blogblog.com/img/b16-rounded.gif'/></author><thr:total>1</thr:total></entry><entry><id>tag:blogger.com,1999:blog-8561105343828481976.post-1519581805070845427</id><published>2008-10-01T08:00:00.002-04:00</published><updated>2008-10-01T08:38:26.086-04:00</updated><title type='text'>Recipe for success</title><content type='html'>&lt;div dir="ltr"&gt;I enjoy cooking and I wonder if it has anything to do with the documentation involved.&lt;/div&gt;&lt;div dir="ltr"&gt;&lt;br /&gt;&lt;/div&gt;&lt;div dir="ltr"&gt;&lt;div style="text-align: center;"&gt;&lt;span class="Apple-style-span" style=""&gt;&lt;span class="Apple-style-span" style="font-weight: bold;"&gt;&lt;span class="Apple-style-span"  style="font-size:large;"&gt;Documentation for cooking = RECIPE&lt;/span&gt;&lt;/span&gt;&lt;/span&gt;&lt;span class="Apple-style-span" style="font-weight: bold;"&gt;&lt;span class="Apple-style-span"  style="font-size:large;"&gt;.&lt;/span&gt;&lt;/span&gt;&lt;br /&gt;&lt;/div&gt;&lt;div&gt;&lt;br /&gt;I can honestly say that, without the reliable format of the common recipe, I would neither excel at nor enjoy cooking.&lt;/div&gt; &lt;div&gt;&lt;br /&gt;&lt;a onblur="try {parent.deselectBloggerImageGracefully();} catch(e) {}" href="http://www.amazon.com/Joy-Cooking-75th-Anniversary-2006/dp/0743246268/ref=pd_bbs_sr_1?ie=UTF8&amp;amp;s=books&amp;amp;qid=1222454368&amp;amp;sr=8-1"&gt;&lt;img style="float:right; margin:0 10px 10px 0;cursor:pointer; cursor:hand;" src="http://3.bp.blogspot.com/_pLTSQcpi5TY/SN0tQ-KoOMI/AAAAAAAABFs/DWHFjpS3iL8/s200/cook.jpg" border="0" alt="" id="BLOGGER_PHOTO_ID_5250402510172600514" /&gt;&lt;/a&gt;According to my friendly neighborhood etymologist (&lt;a href="http://www.etymonline.com/"&gt;http://www.etymonline.com&lt;/a&gt;), the word &lt;span class="Apple-style-span" style="font-style: italic;"&gt;recipe &lt;/span&gt;was originally used by physicians who wrote it at the head of prescriptions. It meant  "instructions for preparing food". So, there is no question that these instructions needed to be both precise and concise. &lt;/div&gt;&lt;div&gt;&lt;br /&gt;&lt;/div&gt;&lt;div&gt;Look at any recipe today and you'll most likely find the following elements:&lt;br /&gt;&lt;/div&gt;&lt;div&gt;&lt;br /&gt;&lt;/div&gt;&lt;div&gt;There is a title: &lt;span class="Apple-style-span" style="font-style: italic;"&gt;what you will be cooking&lt;/span&gt;&lt;/div&gt;&lt;div&gt;There is a list of ingredients: &lt;span class="Apple-style-span" style="font-style: italic;"&gt;what you will need in order to cook it&lt;/span&gt;&lt;/div&gt; &lt;div&gt;There are the steps of preparation: &lt;span class="Apple-style-span" style="font-style: italic;"&gt;how you will cook it&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;br /&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-size:large;"&gt;Isn't simplicity delicious?&lt;/span&gt;&lt;/div&gt;&lt;/div&gt;&lt;div class="blogger-post-footer"&gt;&lt;img width='1' height='1' src='https://blogger.googleusercontent.com/tracker/8561105343828481976-1519581805070845427?l=andrewlight.blogspot.com' alt='' /&gt;&lt;/div&gt;</content><link rel='replies' type='application/atom+xml' href='http://andrewlight.blogspot.com/feeds/1519581805070845427/comments/default' title='Post Comments'/><link rel='replies' type='text/html' href='http://www.blogger.com/comment.g?blogID=8561105343828481976&amp;postID=1519581805070845427&amp;isPopup=true' title='0 Comments'/><link rel='edit' type='application/atom+xml' href='http://www.blogger.com/feeds/8561105343828481976/posts/default/1519581805070845427'/><link rel='self' type='application/atom+xml' href='http://www.blogger.com/feeds/8561105343828481976/posts/default/1519581805070845427'/><link rel='alternate' type='text/html' href='http://andrewlight.blogspot.com/2008/10/recipe-for-success.html' title='Recipe for success'/><author><name>Andrew Light</name><uri>http://www.blogger.com/profile/10918032199292987770</uri><email>noreply@blogger.com</email><gd:image rel='http://schemas.google.com/g/2005#thumbnail' width='16' height='16' src='http://img2.blogblog.com/img/b16-rounded.gif'/></author><media:thumbnail xmlns:media='http://search.yahoo.com/mrss/' url='http://3.bp.blogspot.com/_pLTSQcpi5TY/SN0tQ-KoOMI/AAAAAAAABFs/DWHFjpS3iL8/s72-c/cook.jpg' height='72' width='72'/><thr:total>0</thr:total></entry><entry><id>tag:blogger.com,1999:blog-8561105343828481976.post-3723446301840056015</id><published>2008-09-26T11:00:00.005-04:00</published><updated>2008-09-26T11:05:52.220-04:00</updated><category scheme='http://www.blogger.com/atom/ns#' term='g1 user manual technical writing'/><title type='text'>Hot off the presses</title><content type='html'>&lt;div dir="ltr"&gt;I'm the proud owner (but not quite possessor) of the new &lt;a href="http://www.t-mobileg1.com/"&gt;G1 smart phone from T-Mobile&lt;/a&gt;. I get to wait a month before I get to actually have it so, in anticipation of my new toy, I got a hold of the &lt;a href="http://support.t-mobile.com/knowbase/root/public/tm30235.pdf"&gt;Getting Started&lt;/a&gt; guide for the G1.&lt;div&gt;&lt;br /&gt;&lt;/div&gt;&lt;div&gt;I did this for two reasons: 1) to learn about what I had actually bought and, 2) to see how T-Mobile approached this new user manual.&lt;/div&gt;&lt;div&gt;&lt;br /&gt;&lt;/div&gt;&lt;div&gt;Aside from the unfortunate and glaring typo on page 18 (Goggle Mail), it's a nice piece of writing. &lt;a onblur="try {parent.deselectBloggerImageGracefully();} catch(e) {}" href="http://www.t-mobileg1.com/"&gt;&lt;img style="float:right; margin:0 0 10px 10px;cursor:pointer; cursor:hand;" src="http://1.bp.blogspot.com/_pLTSQcpi5TY/SNz5i6_HOtI/AAAAAAAABFA/Qxe4DIQ4oW0/s200/g1.jpg" border="0" alt="" id="BLOGGER_PHOTO_ID_5250345643951995602" /&gt;&lt;/a&gt;It informs readers on the basic anatomy of the phone, how to turn it on, and other requisite details, but it succeeds particularly well for 2 reasons. &lt;/div&gt; &lt;div&gt;&lt;br /&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span" style="font-weight: bold;"&gt;&lt;span class="Apple-style-span"  style="font-size:large;"&gt;Layout&lt;/span&gt;&lt;/span&gt; The document is written primarily in landscape layout with 2 "pages" of content on each real page. This means that the writer didn't really expect people to print out the file - good assumption - and that, to maximize what a person will see on their computer screen, landscape was the way to go because computer screens are oriented in landscape themselves. Smart.&lt;/div&gt; &lt;div&gt;&lt;br /&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span" style="font-weight: bold;"&gt;&lt;span class="Apple-style-span"  style="font-size:large;"&gt;Just the Facts&lt;/span&gt;&lt;/span&gt; The sections of the document are very short and straight forward, instructing readers on how to accomplish simple tasks. There's little to no fluff. Good.&lt;/div&gt; &lt;div&gt;&lt;br /&gt;&lt;/div&gt;&lt;div&gt;Add these characteristics together and you've got a very readable document. Maybe more importantly, you've got a document that's easy to skim - who's really going to read anything like this cover to cover anyway?&lt;/div&gt; &lt;div&gt;&lt;br /&gt;&lt;/div&gt;&lt;div&gt;So, T-Mobile, you succeeded in knowing your audience and giving them a very friendly user manual. I am sorry though that today's modern spell-checkers can't catch it when you spell perhaps your most important business partner's name wrong. Call me - I do proofreading.&lt;/div&gt; &lt;/div&gt;&lt;div class="blogger-post-footer"&gt;&lt;img width='1' height='1' src='https://blogger.googleusercontent.com/tracker/8561105343828481976-3723446301840056015?l=andrewlight.blogspot.com' alt='' /&gt;&lt;/div&gt;</content><link rel='replies' type='application/atom+xml' href='http://andrewlight.blogspot.com/feeds/3723446301840056015/comments/default' title='Post Comments'/><link rel='replies' type='text/html' href='http://www.blogger.com/comment.g?blogID=8561105343828481976&amp;postID=3723446301840056015&amp;isPopup=true' title='0 Comments'/><link rel='edit' type='application/atom+xml' href='http://www.blogger.com/feeds/8561105343828481976/posts/default/3723446301840056015'/><link rel='self' type='application/atom+xml' href='http://www.blogger.com/feeds/8561105343828481976/posts/default/3723446301840056015'/><link rel='alternate' type='text/html' href='http://andrewlight.blogspot.com/2008/09/hot-off-presses.html' title='Hot off the presses'/><author><name>Andrew Light</name><uri>http://www.blogger.com/profile/10918032199292987770</uri><email>noreply@blogger.com</email><gd:image rel='http://schemas.google.com/g/2005#thumbnail' width='16' height='16' src='http://img2.blogblog.com/img/b16-rounded.gif'/></author><media:thumbnail xmlns:media='http://search.yahoo.com/mrss/' url='http://1.bp.blogspot.com/_pLTSQcpi5TY/SNz5i6_HOtI/AAAAAAAABFA/Qxe4DIQ4oW0/s72-c/g1.jpg' height='72' width='72'/><thr:total>0</thr:total></entry><entry><id>tag:blogger.com,1999:blog-8561105343828481976.post-3288306142877476165</id><published>2008-09-22T08:00:00.001-04:00</published><updated>2008-09-22T09:02:40.373-04:00</updated><title type='text'>Don't build a closet for your skeletons.</title><content type='html'>&lt;a onblur="try {parent.deselectBloggerImageGracefully();} catch(e) {}" href="http://andrewlight.blogspot.com/"&gt;&lt;img style="float:right; margin:0 0 10px 10px;cursor:pointer; cursor:hand;" src="http://4.bp.blogspot.com/_pLTSQcpi5TY/SNPlaP9iBKI/AAAAAAAABDA/6i0iknoXOSw/s320/skel2.gif" border="0" alt="Boo." id="BLOGGER_PHOTO_ID_5247790229940733090" /&gt;&lt;/a&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;&lt;br /&gt;&lt;/span&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;If the software you're selling is going to have a few skeletons - and most likely it will - then don't give them a closet to hide in.&lt;br /&gt;&lt;/span&gt;&lt;/div&gt;&lt;p class="mobile-photo"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;It's difficult to design software that is 100% self informative and logical in its use, especially if that software is complex or has more "under the covers" than on top. And your customers know this - they most likely don't expect perfection.&lt;/span&gt;&lt;/p&gt;&lt;p class="mobile-photo"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;So, if your product has some areas that might not make the most sense, or are downright confusing,&lt;/span&gt;&lt;span class="Apple-style-span" style="font-weight: bold;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt; say so&lt;/span&gt;&lt;/span&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;.&lt;/span&gt;&lt;span&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;&lt;span&gt;&lt;/span&gt;&lt;/span&gt;&lt;/span&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt; Don't pretend in your documentation that these areas are normal or logical if they aren't.  &lt;/span&gt;&lt;/p&gt;&lt;div dir="ltr"&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;Now, I'm not suggesting you write a chapter called&lt;/span&gt;&lt;span class="Apple-style-span" style="font-weight: bold;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt; Where Our Product Sucks and Will Drive You Crazy&lt;/span&gt;&lt;/span&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;, but you should include a section for &lt;/span&gt;&lt;span class="Apple-style-span" style="font-weight: bold;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;Possible Problems&lt;/span&gt;&lt;/span&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt; where you can provide tips for navigating the tricky areas. Your customers will show their appreciation for this by a) not calling your &lt;/span&gt;&lt;span class="blsp-spelling-corrected" id="SPELLING_ERROR_0"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;help desk&lt;/span&gt;&lt;/span&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;, b) training their colleague users, and c) not being annoyed with you.&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;&lt;br /&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;Those are nice outcomes for such a simple thing, don't you think?&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;&lt;br /&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;(Oh, and for your next release, maybe you can improve on those tricky areas and use the same &lt;/span&gt;&lt;span class="Apple-style-span" style="font-weight: bold;"&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt;Possible Problems&lt;/span&gt;&lt;/span&gt;&lt;span class="Apple-style-span"  style="font-size:small;"&gt; section to brag about the improvements you've made.)&lt;/span&gt;&lt;/div&gt;&lt;/div&gt;&lt;div class="blogger-post-footer"&gt;&lt;img width='1' height='1' src='https://blogger.googleusercontent.com/tracker/8561105343828481976-3288306142877476165?l=andrewlight.blogspot.com' alt='' /&gt;&lt;/div&gt;</content><link rel='replies' type='application/atom+xml' href='http://andrewlight.blogspot.com/feeds/3288306142877476165/comments/default' title='Post Comments'/><link rel='replies' type='text/html' href='http://www.blogger.com/comment.g?blogID=8561105343828481976&amp;postID=3288306142877476165&amp;isPopup=true' title='0 Comments'/><link rel='edit' type='application/atom+xml' href='http://www.blogger.com/feeds/8561105343828481976/posts/default/3288306142877476165'/><link rel='self' type='application/atom+xml' href='http://www.blogger.com/feeds/8561105343828481976/posts/default/3288306142877476165'/><link rel='alternate' type='text/html' href='http://andrewlight.blogspot.com/2008/09/dont-build-closet-for-your-skeletons.html' title='Don&apos;t build a closet for your skeletons.'/><author><name>Andrew Light</name><uri>http://www.blogger.com/profile/10918032199292987770</uri><email>noreply@blogger.com</email><gd:image rel='http://schemas.google.com/g/2005#thumbnail' width='16' height='16' src='http://img2.blogblog.com/img/b16-rounded.gif'/></author><media:thumbnail xmlns:media='http://search.yahoo.com/mrss/' url='http://4.bp.blogspot.com/_pLTSQcpi5TY/SNPlaP9iBKI/AAAAAAAABDA/6i0iknoXOSw/s72-c/skel2.gif' height='72' width='72'/><thr:total>0</thr:total></entry><entry><id>tag:blogger.com,1999:blog-8561105343828481976.post-5172125992210025312</id><published>2008-09-18T05:31:00.009-04:00</published><updated>2008-09-18T17:08:50.591-04:00</updated><title type='text'>What matters most?</title><content type='html'>I'm not an English major, so I know from experience that perfect grammar doesn't equate to perfect documentation. So what matters most?&lt;div&gt;&lt;br /&gt;&lt;/div&gt;&lt;div&gt;Here're my top 5 writing priorities when it comes to helping your customers help themselves:&lt;/div&gt;&lt;div&gt;&lt;div&gt;&lt;br /&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span" style="font-weight: bold;"&gt;Know what you're writing:&lt;/span&gt; Do your customers need a reference document with organized lists and tables of data? Do they need a step-by-step cookbook for how to progress through a process? Or maybe they just need some well thought-out diagrams?  If someone's expecting one type, and you give them another, you're wasting their time and they aren't likely to forgive you.&lt;/div&gt;&lt;div&gt;&lt;br /&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span" style="font-weight: bold;"&gt;Know who you're writing for:&lt;/span&gt; Yes, I know I shouldn't end a phrase with a preposition, but I'm ok with it. I trust you'll be ok with it. See that? I know who I'm writing for. Seriously though, if you're writing for techies, then give them what they need. If you're writing for parents who need to know how to assemble a toy, give them what they need. Your audience should guide your writing almost as much as your product should.&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span" style="font-weight: bold;"&gt;&lt;br /&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span" style="font-weight: bold; "&gt;Call it what it is:&lt;/span&gt; If it's a box, say so. If it's a button, say so. If it's a tab, well, you get the idea. So many products these days, especially in the software world, create their own interface elements and try to create new language for them. So, do your customers a favor and call the things what they are.&lt;br /&gt;&lt;/div&gt;&lt;div&gt;&lt;br /&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span" style="font-weight: bold;"&gt;Don't create dead ends&lt;/span&gt;: Never allow your customers to get trapped in your product documentation. Make sure your writing always has a way out or a way sideways.&lt;/div&gt;&lt;div&gt;&lt;br /&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span" style="font-weight: bold;"&gt;Let your product be heard:&lt;/span&gt; I've helped a number of companies write their product documentation and most of them feel inclined to write about every detail, option, variable and setting. But if the product informs the user about a certain feature, why waste time and space writing about it? &lt;/div&gt;&lt;div&gt;&lt;br /&gt;&lt;/div&gt;&lt;div&gt;The best self-service option is the one that isn't needed. If you do this well enough, you won't even need product documentation. &lt;span class="Apple-style-span"  style="font-size:large;"&gt;&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&lt;br /&gt;&lt;/div&gt;&lt;div&gt;&lt;span class="Apple-style-span"  style="font-size:large;"&gt;Can you imagine that?&lt;/span&gt;&lt;/div&gt;&lt;/div&gt;&lt;div class="blogger-post-footer"&gt;&lt;img width='1' height='1' src='https://blogger.googleusercontent.com/tracker/8561105343828481976-5172125992210025312?l=andrewlight.blogspot.com' alt='' /&gt;&lt;/div&gt;</content><link rel='replies' type='application/atom+xml' href='http://andrewlight.blogspot.com/feeds/5172125992210025312/comments/default' title='Post Comments'/><link rel='replies' type='text/html' href='http://www.blogger.com/comment.g?blogID=8561105343828481976&amp;postID=5172125992210025312&amp;isPopup=true' title='0 Comments'/><link rel='edit' type='application/atom+xml' href='http://www.blogger.com/feeds/8561105343828481976/posts/default/5172125992210025312'/><link rel='self' type='application/atom+xml' href='http://www.blogger.com/feeds/8561105343828481976/posts/default/5172125992210025312'/><link rel='alternate' type='text/html' href='http://andrewlight.blogspot.com/2008/09/what-matters-most.html' title='What matters most?'/><author><name>Andrew Light</name><uri>http://www.blogger.com/profile/10918032199292987770</uri><email>noreply@blogger.com</email><gd:image rel='http://schemas.google.com/g/2005#thumbnail' width='16' height='16' src='http://img2.blogblog.com/img/b16-rounded.gif'/></author><thr:total>0</thr:total></entry></feed>
