<?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/"
		>
<channel>
	<title>Comments on: A Microcosm of Technical Writing in the Kitchen While Cooking a Banana Cream Pie</title>
	<atom:link href="http://www.idratherbewriting.com/2009/11/27/a-microcosm-of-technical-writing-in-the-kitchen-while-cooking-a-pie-for-thanksgiving/feed/" rel="self" type="application/rss+xml" />
	<link>http://www.idratherbewriting.com/2009/11/27/a-microcosm-of-technical-writing-in-the-kitchen-while-cooking-a-pie-for-thanksgiving/</link>
	<description>Technical Communication Blog / Technical Writing Blog</description>
	<lastBuildDate>Mon, 15 Mar 2010 08:23:46 +0000</lastBuildDate>
	<generator>http://wordpress.org/?v=2.9.2</generator>
	<sy:updatePeriod>hourly</sy:updatePeriod>
	<sy:updateFrequency>1</sy:updateFrequency>
		<item>
		<title>By: propane gauge</title>
		<link>http://www.idratherbewriting.com/2009/11/27/a-microcosm-of-technical-writing-in-the-kitchen-while-cooking-a-pie-for-thanksgiving/comment-page-1/#comment-148002</link>
		<dc:creator>propane gauge</dc:creator>
		<pubDate>Sat, 16 Jan 2010 13:41:58 +0000</pubDate>
		<guid isPermaLink="false">http://www.idratherbewriting.com/?p=5095#comment-148002</guid>
		<description>There are lot of dishes that we can make from banana. All are delicious.</description>
		<content:encoded><![CDATA[<p>There are lot of dishes that we can make from banana. All are delicious.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: propane burner</title>
		<link>http://www.idratherbewriting.com/2009/11/27/a-microcosm-of-technical-writing-in-the-kitchen-while-cooking-a-pie-for-thanksgiving/comment-page-1/#comment-147997</link>
		<dc:creator>propane burner</dc:creator>
		<pubDate>Sat, 16 Jan 2010 02:53:50 +0000</pubDate>
		<guid isPermaLink="false">http://www.idratherbewriting.com/?p=5095#comment-147997</guid>
		<description>Thanks for the recipe. When I see new recipe, I copy it in my notepad and try at home. If I found its nice and tasty, I will send a feedback. In this case too I will do like that.</description>
		<content:encoded><![CDATA[<p>Thanks for the recipe. When I see new recipe, I copy it in my notepad and try at home. If I found its nice and tasty, I will send a feedback. In this case too I will do like that.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: mike</title>
		<link>http://www.idratherbewriting.com/2009/11/27/a-microcosm-of-technical-writing-in-the-kitchen-while-cooking-a-pie-for-thanksgiving/comment-page-1/#comment-146961</link>
		<dc:creator>mike</dc:creator>
		<pubDate>Mon, 07 Dec 2009 05:13:38 +0000</pubDate>
		<guid isPermaLink="false">http://www.idratherbewriting.com/?p=5095#comment-146961</guid>
		<description>Well, the writer can try to anticipate where there are going to be problems (ie, where the reader will be expected to understand something) and provides links to the relevant information before the steps of the procedure begin. A sort of &quot;Before you do this, make sure you know the following ...&quot;. In my world, this might come out along the lines of &quot;The following procedure assumes that you are familiar with the scaffolding model&quot; or something like that, followed by a link.

The problem with the links scattered throughout is not that they&#039;re not helpful for those who need them, but that they are a kind of &quot;too much information&quot; for those who do know all that stuff and would prefer a more straightforward trip through the steps. 

To be sure, it&#039;s not a cut-and-dried issue. When I was writing about this, I really exaggerated the effect of too many links; and of course, one of the major benefits of online documentation is the ability for &quot;just in time&quot; linking. 

I think your example underscores, however, that it can be difficult to write for users of all abilities in a single piece of documentation. As we know, it&#039;s tough to make everyone happy. :-)</description>
		<content:encoded><![CDATA[<p>Well, the writer can try to anticipate where there are going to be problems (ie, where the reader will be expected to understand something) and provides links to the relevant information before the steps of the procedure begin. A sort of &#8220;Before you do this, make sure you know the following &#8230;&#8221;. In my world, this might come out along the lines of &#8220;The following procedure assumes that you are familiar with the scaffolding model&#8221; or something like that, followed by a link.</p>
<p>The problem with the links scattered throughout is not that they&#8217;re not helpful for those who need them, but that they are a kind of &#8220;too much information&#8221; for those who do know all that stuff and would prefer a more straightforward trip through the steps. </p>
<p>To be sure, it&#8217;s not a cut-and-dried issue. When I was writing about this, I really exaggerated the effect of too many links; and of course, one of the major benefits of online documentation is the ability for &#8220;just in time&#8221; linking. </p>
<p>I think your example underscores, however, that it can be difficult to write for users of all abilities in a single piece of documentation. As we know, it&#8217;s tough to make everyone happy. <img src='http://www.idratherbewriting.com/wp-includes/images/smilies/icon_smile.gif' alt=':-)' class='wp-smiley' /> </p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Tom Johnson</title>
		<link>http://www.idratherbewriting.com/2009/11/27/a-microcosm-of-technical-writing-in-the-kitchen-while-cooking-a-pie-for-thanksgiving/comment-page-1/#comment-146960</link>
		<dc:creator>Tom Johnson</dc:creator>
		<pubDate>Mon, 07 Dec 2009 04:59:37 +0000</pubDate>
		<guid isPermaLink="false">http://www.idratherbewriting.com/?p=5095#comment-146960</guid>
		<description>Mike, thanks for the link to the post you wrote about recipes. That&#039;s so relevant to my post here -- can&#039;t believe I didn&#039;t see it earlier. I see your point about not wanting to distract the reader into other paths. But I kind of like all those hyperlinks in there. What exactly is your solution for getting around this? Isn&#039;t more information usually better?</description>
		<content:encoded><![CDATA[<p>Mike, thanks for the link to the post you wrote about recipes. That&#8217;s so relevant to my post here &#8212; can&#8217;t believe I didn&#8217;t see it earlier. I see your point about not wanting to distract the reader into other paths. But I kind of like all those hyperlinks in there. What exactly is your solution for getting around this? Isn&#8217;t more information usually better?</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: mike</title>
		<link>http://www.idratherbewriting.com/2009/11/27/a-microcosm-of-technical-writing-in-the-kitchen-while-cooking-a-pie-for-thanksgiving/comment-page-1/#comment-146959</link>
		<dc:creator>mike</dc:creator>
		<pubDate>Mon, 07 Dec 2009 04:59:18 +0000</pubDate>
		<guid isPermaLink="false">http://www.idratherbewriting.com/?p=5095#comment-146959</guid>
		<description>Tom, I think that links in the middle of procedures can be overdone. If there&#039;s critical information that a reader needs to have to succeed with the recipe, linking to that information while the steps are underway isn&#039;t always the best solution -- when you&#039;re pouring batter, you don&#039;t want to stop and have to go read something.

Then again, few people don&#039;t at least review a recipe before they get underway, probably.</description>
		<content:encoded><![CDATA[<p>Tom, I think that links in the middle of procedures can be overdone. If there&#8217;s critical information that a reader needs to have to succeed with the recipe, linking to that information while the steps are underway isn&#8217;t always the best solution &#8212; when you&#8217;re pouring batter, you don&#8217;t want to stop and have to go read something.</p>
<p>Then again, few people don&#8217;t at least review a recipe before they get underway, probably.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Tom Johnson</title>
		<link>http://www.idratherbewriting.com/2009/11/27/a-microcosm-of-technical-writing-in-the-kitchen-while-cooking-a-pie-for-thanksgiving/comment-page-1/#comment-146955</link>
		<dc:creator>Tom Johnson</dc:creator>
		<pubDate>Mon, 07 Dec 2009 04:54:36 +0000</pubDate>
		<guid isPermaLink="false">http://www.idratherbewriting.com/?p=5095#comment-146955</guid>
		<description>Thanks for the comment, Sarah. I agree that this is a common issue. Perhaps adding cross references and links to additional material like the getting started guide you mention is the solution. Had this recipe included a cross reference in the step about stirring the hot batter back and forth into the eggs -- a link to an explanation in the back with more detail -- it would have been perfect. Online help formats can simply include hyperlinks to pages with more details.</description>
		<content:encoded><![CDATA[<p>Thanks for the comment, Sarah. I agree that this is a common issue. Perhaps adding cross references and links to additional material like the getting started guide you mention is the solution. Had this recipe included a cross reference in the step about stirring the hot batter back and forth into the eggs &#8212; a link to an explanation in the back with more detail &#8212; it would have been perfect. Online help formats can simply include hyperlinks to pages with more details.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Tom Johnson</title>
		<link>http://www.idratherbewriting.com/2009/11/27/a-microcosm-of-technical-writing-in-the-kitchen-while-cooking-a-pie-for-thanksgiving/comment-page-1/#comment-146953</link>
		<dc:creator>Tom Johnson</dc:creator>
		<pubDate>Mon, 07 Dec 2009 04:50:45 +0000</pubDate>
		<guid isPermaLink="false">http://www.idratherbewriting.com/?p=5095#comment-146953</guid>
		<description>Thanks Rhonda. I appreciate the link. I&#039;ll keep that resource handy the next time I&#039;m in the kitchen. My larger problem with cooking is lack of desire, but perhaps that&#039;s based on my failing experiences more than anything else.</description>
		<content:encoded><![CDATA[<p>Thanks Rhonda. I appreciate the link. I&#8217;ll keep that resource handy the next time I&#8217;m in the kitchen. My larger problem with cooking is lack of desire, but perhaps that&#8217;s based on my failing experiences more than anything else.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Tom Johnson</title>
		<link>http://www.idratherbewriting.com/2009/11/27/a-microcosm-of-technical-writing-in-the-kitchen-while-cooking-a-pie-for-thanksgiving/comment-page-1/#comment-146834</link>
		<dc:creator>Tom Johnson</dc:creator>
		<pubDate>Thu, 03 Dec 2009 18:56:12 +0000</pubDate>
		<guid isPermaLink="false">http://www.idratherbewriting.com/?p=5095#comment-146834</guid>
		<description>Kirsty, good point. I do tend to provide explanations in my documentation when I think a step is weird or unintuitive. But I also appreciate concision as much as the next person, so I can imagine that having this same explanation in 30 different recipes throughout the book would get old.</description>
		<content:encoded><![CDATA[<p>Kirsty, good point. I do tend to provide explanations in my documentation when I think a step is weird or unintuitive. But I also appreciate concision as much as the next person, so I can imagine that having this same explanation in 30 different recipes throughout the book would get old.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Kirsty</title>
		<link>http://www.idratherbewriting.com/2009/11/27/a-microcosm-of-technical-writing-in-the-kitchen-while-cooking-a-pie-for-thanksgiving/comment-page-1/#comment-146764</link>
		<dc:creator>Kirsty</dc:creator>
		<pubDate>Tue, 01 Dec 2009 03:18:46 +0000</pubDate>
		<guid isPermaLink="false">http://www.idratherbewriting.com/?p=5095#comment-146764</guid>
		<description>Since originally reading this post last week, I&#039;ve been ponding a particular point. The &quot;pour (a bit of) A into B, then B into (rest of) A. No reason given for this&quot;
(my inserts in parentheses)

Do you often give your audience a reason for every step in a task? Maybe this is messed up a bit with power user vs novice, but generally in our doco, we&#039;re very presriptive and just tell the audience what to do in order to achieve their goal. 
*If* there&#039;s some potential for confusion, such as what kind of address to enter - the supplier&#039;s address or the delivery address - then, we might give some further explantion, but otherwise we don&#039;t really give a reason for putting data in the address field. It&#039;s just one element of achieving the ultimate goal, which might be creating a purchase requisition. 
That&#039;s probably a simplistic comparison, and when we&#039;re documenting entering data into fields, there&#039;s nothing to me that seems quite like the &quot;put a little bit of A into B, then the whole of B into the rest of A&quot; example. 

I have observed with my husband that he is much more literal with recipes than I am. That&#039;s probably diminished over the last few years as he does all of the cooking, but even still he&#039;s a &quot;follow the rules&quot; guy. I tend not to be, and will go with my gut more when I&#039;m baking.  

Oh, and I think the easiest way to become more accustomed to the user jargon in recipes is to do more cooking. ;)</description>
		<content:encoded><![CDATA[<p>Since originally reading this post last week, I&#8217;ve been ponding a particular point. The &#8220;pour (a bit of) A into B, then B into (rest of) A. No reason given for this&#8221;<br />
(my inserts in parentheses)</p>
<p>Do you often give your audience a reason for every step in a task? Maybe this is messed up a bit with power user vs novice, but generally in our doco, we&#8217;re very presriptive and just tell the audience what to do in order to achieve their goal.<br />
*If* there&#8217;s some potential for confusion, such as what kind of address to enter &#8211; the supplier&#8217;s address or the delivery address &#8211; then, we might give some further explantion, but otherwise we don&#8217;t really give a reason for putting data in the address field. It&#8217;s just one element of achieving the ultimate goal, which might be creating a purchase requisition.<br />
That&#8217;s probably a simplistic comparison, and when we&#8217;re documenting entering data into fields, there&#8217;s nothing to me that seems quite like the &#8220;put a little bit of A into B, then the whole of B into the rest of A&#8221; example. </p>
<p>I have observed with my husband that he is much more literal with recipes than I am. That&#8217;s probably diminished over the last few years as he does all of the cooking, but even still he&#8217;s a &#8220;follow the rules&#8221; guy. I tend not to be, and will go with my gut more when I&#8217;m baking.  </p>
<p>Oh, and I think the easiest way to become more accustomed to the user jargon in recipes is to do more cooking. <img src='http://www.idratherbewriting.com/wp-includes/images/smilies/icon_wink.gif' alt=';)' class='wp-smiley' /> </p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Rhonda</title>
		<link>http://www.idratherbewriting.com/2009/11/27/a-microcosm-of-technical-writing-in-the-kitchen-while-cooking-a-pie-for-thanksgiving/comment-page-1/#comment-146735</link>
		<dc:creator>Rhonda</dc:creator>
		<pubDate>Sun, 29 Nov 2009 22:17:44 +0000</pubDate>
		<guid isPermaLink="false">http://www.idratherbewriting.com/?p=5095#comment-146735</guid>
		<description>Something else that might help you and Larry -- step-by-step cooking videos from sites such as Rouxbe (pron. &#039;ruby&#039;): http://rouxbe.com/</description>
		<content:encoded><![CDATA[<p>Something else that might help you and Larry &#8212; step-by-step cooking videos from sites such as Rouxbe (pron. &#8216;ruby&#8217;): <a href="http://rouxbe.com/" rel="nofollow">http://rouxbe.com/</a></p>
]]></content:encoded>
	</item>
</channel>
</rss>
