<?xml version="1.0" encoding="UTF-8"?><rss version="2.0"
	xmlns:content="http://purl.org/rss/1.0/modules/content/"
	xmlns:dc="http://purl.org/dc/elements/1.1/"
	xmlns:atom="http://www.w3.org/2005/Atom"
	xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
	xmlns:series="http://unfoldingneurons.com/"
		>
<channel>
	<title>Comments on: A Mile Wide and 30 Seconds Deep: A Metaphor for Help from Mike Hughes</title>
	<atom:link href="http://idratherbewriting.com/2009/07/08/a-mile-wide-and-30-seconds-deep-a-metaphor-for-help-from-mike-hughes/feed/" rel="self" type="application/rss+xml" />
	<link>http://idratherbewriting.com/2009/07/08/a-mile-wide-and-30-seconds-deep-a-metaphor-for-help-from-mike-hughes/</link>
	<description>The Latest Trends in Technical Communication</description>
	<lastBuildDate>Tue, 14 Feb 2012 08:22:46 +0000</lastBuildDate>
	<sy:updatePeriod>hourly</sy:updatePeriod>
	<sy:updateFrequency>1</sy:updateFrequency>
	<generator>http://wordpress.org/?v=3.3.1</generator>
	<item>
		<title>By: Milan Davidovic</title>
		<link>http://idratherbewriting.com/2009/07/08/a-mile-wide-and-30-seconds-deep-a-metaphor-for-help-from-mike-hughes/comment-page-1/#comment-142047</link>
		<dc:creator>Milan Davidovic</dc:creator>
		<pubDate>Thu, 09 Jul 2009 02:31:14 +0000</pubDate>
		<guid isPermaLink="false">http://www.idratherbewriting.com/?p=3994#comment-142047</guid>
		<description>So, if you talk to some people the topics need to be small and focused; others say that you need fuller topics that provide context.

Time for something more than anecdotal evidence, I guess...</description>
		<content:encoded><![CDATA[<p>So, if you talk to some people the topics need to be small and focused; others say that you need fuller topics that provide context.</p>
<p>Time for something more than anecdotal evidence, I guess&#8230;</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Harry Miller</title>
		<link>http://idratherbewriting.com/2009/07/08/a-mile-wide-and-30-seconds-deep-a-metaphor-for-help-from-mike-hughes/comment-page-1/#comment-142046</link>
		<dc:creator>Harry Miller</dc:creator>
		<pubDate>Thu, 09 Jul 2009 02:13:31 +0000</pubDate>
		<guid isPermaLink="false">http://www.idratherbewriting.com/?p=3994#comment-142046</guid>
		<description>Sure, it makes sense. But which one does the user need? Does he or she care about this distinction? One of the biggest complaints I hear from users is that the help gives details without context, and they often need the context to know how to use the details. Of course, there are also people who know exactly what they want and just want to look up the details as quickly as possible. But I rarely hear them complain that there&#039;s too much information in a single topic (as long as it&#039;s not trivial waffle filling space).

Perhaps that&#039;s because if you get one 14-page file that has all the information you need about a limited, targeted subject, you can CTRL+F to search just that page, or use the internal jump links, or scan the headings if you want some quick context. 

If the information is broken into four topics that are intermingled with your search results, you have to know the subject well enough already to know you just want to insert or you just want to format. Also you have to know that those two things can be separate steps, so you need to keep scanning the search results to get that context.</description>
		<content:encoded><![CDATA[<p>Sure, it makes sense. But which one does the user need? Does he or she care about this distinction? One of the biggest complaints I hear from users is that the help gives details without context, and they often need the context to know how to use the details. Of course, there are also people who know exactly what they want and just want to look up the details as quickly as possible. But I rarely hear them complain that there&#8217;s too much information in a single topic (as long as it&#8217;s not trivial waffle filling space).</p>
<p>Perhaps that&#8217;s because if you get one 14-page file that has all the information you need about a limited, targeted subject, you can CTRL+F to search just that page, or use the internal jump links, or scan the headings if you want some quick context. </p>
<p>If the information is broken into four topics that are intermingled with your search results, you have to know the subject well enough already to know you just want to insert or you just want to format. Also you have to know that those two things can be separate steps, so you need to keep scanning the search results to get that context.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Milan Davidovic</title>
		<link>http://idratherbewriting.com/2009/07/08/a-mile-wide-and-30-seconds-deep-a-metaphor-for-help-from-mike-hughes/comment-page-1/#comment-142045</link>
		<dc:creator>Milan Davidovic</dc:creator>
		<pubDate>Thu, 09 Jul 2009 01:44:26 +0000</pubDate>
		<guid isPermaLink="false">http://www.idratherbewriting.com/?p=3994#comment-142045</guid>
		<description>@Harry -- it looks to me as though the reasoning goes like this: a *manual* (user or reference) should have all that stuff together, but a *help file* should have the information in smaller chunks. If the user wants a small chunk of info on the fly, should they have to wade through the entire topic?

Does that make sense to you?</description>
		<content:encoded><![CDATA[<p>@Harry &#8212; it looks to me as though the reasoning goes like this: a *manual* (user or reference) should have all that stuff together, but a *help file* should have the information in smaller chunks. If the user wants a small chunk of info on the fly, should they have to wade through the entire topic?</p>
<p>Does that make sense to you?</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Harry Miller</title>
		<link>http://idratherbewriting.com/2009/07/08/a-mile-wide-and-30-seconds-deep-a-metaphor-for-help-from-mike-hughes/comment-page-1/#comment-142044</link>
		<dc:creator>Harry Miller</dc:creator>
		<pubDate>Thu, 09 Jul 2009 01:38:20 +0000</pubDate>
		<guid isPermaLink="false">http://www.idratherbewriting.com/?p=3994#comment-142044</guid>
		<description>Arg, tough subject. The answer is probably in the middle - sometimes people want a short, quick reference topic, and sometimes they want a pretty complete reference in a single topic. I don&#039;t know if I&#039;d break up that field codes article; it kinda looks like you need all the parts to use field codes effectively, so why not keep them together? On the other hand, there are some reference topics that stand better alone, even though they&#039;re related to similar things, like descriptions of all the built-in macros (though you&#039;d want a complete list somewhere with links to the descriptions).</description>
		<content:encoded><![CDATA[<p>Arg, tough subject. The answer is probably in the middle &#8211; sometimes people want a short, quick reference topic, and sometimes they want a pretty complete reference in a single topic. I don&#8217;t know if I&#8217;d break up that field codes article; it kinda looks like you need all the parts to use field codes effectively, so why not keep them together? On the other hand, there are some reference topics that stand better alone, even though they&#8217;re related to similar things, like descriptions of all the built-in macros (though you&#8217;d want a complete list somewhere with links to the descriptions).</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Matthew Dyer</title>
		<link>http://idratherbewriting.com/2009/07/08/a-mile-wide-and-30-seconds-deep-a-metaphor-for-help-from-mike-hughes/comment-page-1/#comment-142035</link>
		<dc:creator>Matthew Dyer</dc:creator>
		<pubDate>Wed, 08 Jul 2009 19:17:05 +0000</pubDate>
		<guid isPermaLink="false">http://www.idratherbewriting.com/?p=3994#comment-142035</guid>
		<description>Quick disclaimer: I work at TechSmith, although I didn&#039;t write the help files mentioned above. What follows doesn&#039;t represent the views or policies of TechSmith, just my own personal opinions/questions about trying to write helpful stuff.

With that out of the way, I wanted to comment a bit and ask some questions.

Trying to replace Google is a mistake (not that I think you&#039;re advocating this appraoch). Content authors are never going to be able to match the massive amount of user generated content available with a quick Google search. Instead, we can rely on the behavior that Google teaches users and do our best to support it. I definitely agree with you there. 

In the long tail example, the key ingredient of online stores competing with brick and mortors is location. In this case, the help file is a static chunk of data, like brick and mortor stores. Maybe it should focus on mainstream products/topics? Is it the wrong tool for the task of providing help in the Google age? For one author, trying to cover every niche quickly becomes a Sisyphean task. One person is never going to be able anticipate all the problems that might crop up; in fact, some might not even crop up until after the product ships.

When it comes to niches, there are some topics that receive the majority of traffic, and it&#039;d be foolish to not include these in the help file. But without the data to know which topics those are, how do you pick what to include? 

Looking at user forums, Google analytics from online tutorials and other data points are great ideas when you have them available to you. When writing for a 1.0 though, or as a consultant where that data just isn&#039;t there, how do you choose? Throwing as many topics as you can come up with at the wall/user to see what sticks is one way, but it doesn&#039;t feel very efficient. My gut tells me there&#039;s a better way to do it than that.

I&#039;ve always thought the hardest part about writing a help file is figuring out what goes in and what stays out. Maybe if you can manage to get everything in there, the new hardest part is making sure it&#039;s all SEO&#039;d. 

And it&#039;s not as if we have Google search algorithms available either. The search available in a CHM file is a bit more primitive. We could easily be overloading users&#039; intake bandwidth on search results, just as we fear to do in ToCs. 

With big products (and after 15 major versions between them, Snagit and Camtasia are very feature rich), it might eventually become impactical to cover all the niches. There&#039;s a real danger of becoming 100 miles wide and 5 seconds deep. 

I&#039;m really interested if you had any examples of what niches you thought were missing from the TechSmith help files you looked at (since I&#039;m pretty familiar with those :) ). I&#039;m also really curious how you&#039;re identifying the niche tasks in your own work. 

Great post. It&#039;s really got me thinking about how to provide the help users need and how we assemble and display that information once it has been identified.</description>
		<content:encoded><![CDATA[<p>Quick disclaimer: I work at TechSmith, although I didn&#8217;t write the help files mentioned above. What follows doesn&#8217;t represent the views or policies of TechSmith, just my own personal opinions/questions about trying to write helpful stuff.</p>
<p>With that out of the way, I wanted to comment a bit and ask some questions.</p>
<p>Trying to replace Google is a mistake (not that I think you&#8217;re advocating this appraoch). Content authors are never going to be able to match the massive amount of user generated content available with a quick Google search. Instead, we can rely on the behavior that Google teaches users and do our best to support it. I definitely agree with you there. </p>
<p>In the long tail example, the key ingredient of online stores competing with brick and mortors is location. In this case, the help file is a static chunk of data, like brick and mortor stores. Maybe it should focus on mainstream products/topics? Is it the wrong tool for the task of providing help in the Google age? For one author, trying to cover every niche quickly becomes a Sisyphean task. One person is never going to be able anticipate all the problems that might crop up; in fact, some might not even crop up until after the product ships.</p>
<p>When it comes to niches, there are some topics that receive the majority of traffic, and it&#8217;d be foolish to not include these in the help file. But without the data to know which topics those are, how do you pick what to include? </p>
<p>Looking at user forums, Google analytics from online tutorials and other data points are great ideas when you have them available to you. When writing for a 1.0 though, or as a consultant where that data just isn&#8217;t there, how do you choose? Throwing as many topics as you can come up with at the wall/user to see what sticks is one way, but it doesn&#8217;t feel very efficient. My gut tells me there&#8217;s a better way to do it than that.</p>
<p>I&#8217;ve always thought the hardest part about writing a help file is figuring out what goes in and what stays out. Maybe if you can manage to get everything in there, the new hardest part is making sure it&#8217;s all SEO&#8217;d. </p>
<p>And it&#8217;s not as if we have Google search algorithms available either. The search available in a CHM file is a bit more primitive. We could easily be overloading users&#8217; intake bandwidth on search results, just as we fear to do in ToCs. </p>
<p>With big products (and after 15 major versions between them, Snagit and Camtasia are very feature rich), it might eventually become impactical to cover all the niches. There&#8217;s a real danger of becoming 100 miles wide and 5 seconds deep. </p>
<p>I&#8217;m really interested if you had any examples of what niches you thought were missing from the TechSmith help files you looked at (since I&#8217;m pretty familiar with those <img src='http://idratherbewriting.com/wp-includes/images/smilies/icon_smile.gif' alt=':)' class='wp-smiley' />  ). I&#8217;m also really curious how you&#8217;re identifying the niche tasks in your own work. </p>
<p>Great post. It&#8217;s really got me thinking about how to provide the help users need and how we assemble and display that information once it has been identified.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Milan Davidovic</title>
		<link>http://idratherbewriting.com/2009/07/08/a-mile-wide-and-30-seconds-deep-a-metaphor-for-help-from-mike-hughes/comment-page-1/#comment-142033</link>
		<dc:creator>Milan Davidovic</dc:creator>
		<pubDate>Wed, 08 Jul 2009 18:12:55 +0000</pubDate>
		<guid isPermaLink="false">http://www.idratherbewriting.com/?p=3994#comment-142033</guid>
		<description>So, in the example you provide, the topic could be broken up into
- Learn about fields
- Insert codes
- Format codes
- Code syntax
etc.

or some such, yes?

Interesting thoughts, Tom; thanks for pointing us to Hughes&#039; original article, too.</description>
		<content:encoded><![CDATA[<p>So, in the example you provide, the topic could be broken up into<br />
- Learn about fields<br />
- Insert codes<br />
- Format codes<br />
- Code syntax<br />
etc.</p>
<p>or some such, yes?</p>
<p>Interesting thoughts, Tom; thanks for pointing us to Hughes&#8217; original article, too.</p>
]]></content:encoded>
	</item>
</channel>
</rss>

