<?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: 9 Tips On Writing Documentation For Other People</title> <atom:link href="http://www.pcmech.com/article/9-tips-on-writing-documentation-for-other-people/feed/" rel="self" type="application/rss+xml" /><link>http://www.pcmech.com/article/9-tips-on-writing-documentation-for-other-people/</link> <description>Helping Normal People Get Their Geek On</description> <lastBuildDate>Wed, 15 Feb 2012 10:29:00 +0000</lastBuildDate> <sy:updatePeriod>hourly</sy:updatePeriod> <sy:updateFrequency>1</sy:updateFrequency> <generator>http://wordpress.org/?v=3.3.1</generator> <item><title>By: SAP</title><link>http://www.pcmech.com/article/9-tips-on-writing-documentation-for-other-people/comment-page-1/#comment-20096</link> <dc:creator>SAP</dc:creator> <pubDate>Fri, 30 Jan 2009 13:10:58 +0000</pubDate> <guid
isPermaLink="false">http://www.pcmech.com/article/9-tips-on-writing-documentation-for-other-people/#comment-20096</guid> <description>Good and useful article.However - to be strictly accurate - the example in section 7 is incomplete and/or wrong ;-)The section assumes that:
- the bulb is a screw type, rather than bayonet or strip fluorescent or any other of the myriad fixings that are used.
- bulb is removable without undoing any part of the fitting.
- the bulb is hanging from the ceiling, rather than e.g. in a standard lamp. This affects where the TOP of the bulb is - perhaps should have used a word that is not dependent on the orientation of the bulb.So I think I would add a couple of extra suggestions:- state your assumptions. This is touched on in section 5 - and perhaps 2 - but is missing from the example. Section 7 itself mentions that left and right are confusing to some people, but could mention that the words also depend on the orientation of the bulb. Better to choose words that are orientation independent - e.g. clockwise/anti-clockwise.- road test the instructions ...</description> <content:encoded><![CDATA[<p>Good and useful article.</p><p>However &#8211; to be strictly accurate &#8211; the example in section 7 is incomplete and/or wrong <img
src='http://pcmech.pcmediainc.netdna-cdn.com/wp-includes/images/smilies/icon_wink.gif' alt=';-)' class='wp-smiley' /></p><p>The section assumes that:<br
/> - the bulb is a screw type, rather than bayonet or strip fluorescent or any other of the myriad fixings that are used.<br
/> - bulb is removable without undoing any part of the fitting.<br
/> - the bulb is hanging from the ceiling, rather than e.g. in a standard lamp. This affects where the TOP of the bulb is &#8211; perhaps should have used a word that is not dependent on the orientation of the bulb.</p><p>So I think I would add a couple of extra suggestions:</p><p>- state your assumptions. This is touched on in section 5 &#8211; and perhaps 2 &#8211; but is missing from the example. Section 7 itself mentions that left and right are confusing to some people, but could mention that the words also depend on the orientation of the bulb. Better to choose words that are orientation independent &#8211; e.g. clockwise/anti-clockwise.</p><p>- road test the instructions &#8230;</p> ]]></content:encoded> </item> <item><title>By: Merzin</title><link>http://www.pcmech.com/article/9-tips-on-writing-documentation-for-other-people/comment-page-1/#comment-20062</link> <dc:creator>Merzin</dc:creator> <pubDate>Thu, 29 Jan 2009 18:14:42 +0000</pubDate> <guid
isPermaLink="false">http://www.pcmech.com/article/9-tips-on-writing-documentation-for-other-people/#comment-20062</guid> <description>Thanks for this post Rich;This is must reading for those wishing to help on others fourm&#039;s.
Many people mean so well, but
people ton fourms assume so much. For folks like myself
we really like instructions like, go to this page click here,
right click this tab, change this number to 666, etc.You did a great job on the Ustream show (1/28/09). Taking my confusion and making it so clear.Thanks again</description> <content:encoded><![CDATA[<p>Thanks for this post Rich;</p><p>This is must reading for those wishing to help on others fourm&#8217;s.<br
/> Many people mean so well, but<br
/> people ton fourms assume so much. For folks like myself<br
/> we really like instructions like, go to this page click here,<br
/> right click this tab, change this number to 666, etc.</p><p>You did a great job on the Ustream show (1/28/09). Taking my confusion and making it so clear.</p><p>Thanks again</p> ]]></content:encoded> </item> </channel> </rss>
<!-- Performance optimized by W3 Total Cache. Learn more: http://www.w3-edge.com/wordpress-plugins/

Minified using apc
Page Caching using apc
Database Caching 33/43 queries in 0.016 seconds using apc
Content Delivery Network via pcmech.pcmediainc.netdna-cdn.com

Served from: www.pcmech.com @ 2012-02-15 11:54:21 -->
