<?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: Great Documentation: 10 Tips</title>
	<atom:link href="http://greatdocuments.net/great-documentation-10-tips/feed/" rel="self" type="application/rss+xml" />
	<link>http://greatdocuments.net/great-documentation-10-tips/</link>
	<description>Technical Writing by Keith Johnson</description>
	<lastBuildDate>Thu, 11 Mar 2010 23:38:13 -0800</lastBuildDate>
	<generator>http://wordpress.org/?v=2.8.3</generator>
	<sy:updatePeriod>hourly</sy:updatePeriod>
	<sy:updateFrequency>1</sy:updateFrequency>
		<item>
		<title>By: Great Documentation: 10 Tips &#171; Dave&#8217;s Blog</title>
		<link>http://greatdocuments.net/great-documentation-10-tips/comment-page-1/#comment-516</link>
		<dc:creator>Great Documentation: 10 Tips &#171; Dave&#8217;s Blog</dc:creator>
		<pubDate>Fri, 12 Jun 2009 23:11:13 +0000</pubDate>
		<guid isPermaLink="false">http://greatdocuments.net/?p=81#comment-516</guid>
		<description>[...] Great Documentation: 10&#160;Tips By archdave  For more detail click the link. [...]</description>
		<content:encoded><![CDATA[<p>[...] Great Documentation: 10&nbsp;Tips By archdave  For more detail click the link. [...]</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Bookmarks about Documentation</title>
		<link>http://greatdocuments.net/great-documentation-10-tips/comment-page-1/#comment-103</link>
		<dc:creator>Bookmarks about Documentation</dc:creator>
		<pubDate>Thu, 14 Aug 2008 08:00:07 +0000</pubDate>
		<guid isPermaLink="false">http://greatdocuments.net/?p=81#comment-103</guid>
		<description>[...] - bookmarked by 4 members originally found by bakster on 2008-07-21  Great Documentation: 10 Tips  http://greatdocuments.net/great-documentation-10-tips/ - bookmarked by 3 members originally found [...]</description>
		<content:encoded><![CDATA[<p>[...] &#8211; bookmarked by 4 members originally found by bakster on 2008-07-21  Great Documentation: 10 Tips  <a href="http://greatdocuments.net/great-documentation-10-tips/" rel="nofollow">http://greatdocuments.net/grea.....n-10-tips/</a> &#8211; bookmarked by 3 members originally found [...]</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Keith Johnson</title>
		<link>http://greatdocuments.net/great-documentation-10-tips/comment-page-1/#comment-74</link>
		<dc:creator>Keith Johnson</dc:creator>
		<pubDate>Tue, 15 Jul 2008 11:18:56 +0000</pubDate>
		<guid isPermaLink="false">http://greatdocuments.net/?p=81#comment-74</guid>
		<description>@ Chris: Thanks Chris for your comment! I totally agree with your comments and hope others visiting this blog scroll down to see your feedback in light of the post. All The Best, Keith  :)</description>
		<content:encoded><![CDATA[<p>@ Chris: Thanks Chris for your comment! I totally agree with your comments and hope others visiting this blog scroll down to see your feedback in light of the post. All The Best, Keith  <img src='http://greatdocuments.net/wp-includes/images/smilies/icon_smile.gif' alt=':)' class='wp-smiley' /> </p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Chris</title>
		<link>http://greatdocuments.net/great-documentation-10-tips/comment-page-1/#comment-73</link>
		<dc:creator>Chris</dc:creator>
		<pubDate>Tue, 15 Jul 2008 03:29:47 +0000</pubDate>
		<guid isPermaLink="false">http://greatdocuments.net/?p=81#comment-73</guid>
		<description>Nice article, Keith.  A lot of these are simple tips, but it&#039;s always nice to document how to document :)

I totally agree with the acronyms.  Being a new member on a project is hard enough, but acronyms should be defined early in the document.

A few additions if I may:

1.  Bullets/numbered lists better than paragraphs.  More visual this way.
2.  Embed screen shots within documentation.  This usually comes up for me because my company documents on a wiki (which leads to point 3).  I don&#039;t want to have to read something and then scroll up to open an attachment.  Although, sometimes attachments are necessary.
3.  Wiki is a nice publishing tool because it&#039;s searchable.  My company&#039;s even indexes attached files so if you search &quot;test&quot; that key word gets returns matches in the wiki text or attached file text.  I agree with TOC and index in Word doc, but searchability is even better.
4.  Embedded hyperlinks to other topics to jump around document is also useful to quickly understand a concept presented previously or later in the document.

I hope these help.</description>
		<content:encoded><![CDATA[<p>Nice article, Keith.  A lot of these are simple tips, but it&#8217;s always nice to document how to document <img src='http://greatdocuments.net/wp-includes/images/smilies/icon_smile.gif' alt=':)' class='wp-smiley' /> </p>
<p>I totally agree with the acronyms.  Being a new member on a project is hard enough, but acronyms should be defined early in the document.</p>
<p>A few additions if I may:</p>
<p>1.  Bullets/numbered lists better than paragraphs.  More visual this way.<br />
2.  Embed screen shots within documentation.  This usually comes up for me because my company documents on a wiki (which leads to point 3).  I don&#8217;t want to have to read something and then scroll up to open an attachment.  Although, sometimes attachments are necessary.<br />
3.  Wiki is a nice publishing tool because it&#8217;s searchable.  My company&#8217;s even indexes attached files so if you search &#8220;test&#8221; that key word gets returns matches in the wiki text or attached file text.  I agree with TOC and index in Word doc, but searchability is even better.<br />
4.  Embedded hyperlinks to other topics to jump around document is also useful to quickly understand a concept presented previously or later in the document.</p>
<p>I hope these help.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Keith Johnson</title>
		<link>http://greatdocuments.net/great-documentation-10-tips/comment-page-1/#comment-72</link>
		<dc:creator>Keith Johnson</dc:creator>
		<pubDate>Mon, 14 Jul 2008 11:25:26 +0000</pubDate>
		<guid isPermaLink="false">http://greatdocuments.net/?p=81#comment-72</guid>
		<description>@Torley: Thanks! You are indeed right about the power of video, it is great for tutorials as well.</description>
		<content:encoded><![CDATA[<p>@Torley: Thanks! You are indeed right about the power of video, it is great for tutorials as well.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Torley Lives</title>
		<link>http://greatdocuments.net/great-documentation-10-tips/comment-page-1/#comment-69</link>
		<dc:creator>Torley Lives</dc:creator>
		<pubDate>Sun, 13 Jul 2008 22:40:34 +0000</pubDate>
		<guid isPermaLink="false">http://greatdocuments.net/?p=81#comment-69</guid>
		<description>Keith, thanks for sharing this. Some of these are very simple but very true — and it can only help to reinforce them.

One thing I&#039;d add is: when words and still pictures won&#039;t do, make a video tutorial (also known as a screencast). It can actually be faster and smoother to create a quick one than labor over how to explain it with more static media.

A growing number of websites (and I&#039;m a visual guy too) are using vidtuts to both attract people to use their products or services, and teach them new skills to help them get more value out of their experiences.

Take care!</description>
		<content:encoded><![CDATA[<p>Keith, thanks for sharing this. Some of these are very simple but very true — and it can only help to reinforce them.</p>
<p>One thing I&#8217;d add is: when words and still pictures won&#8217;t do, make a video tutorial (also known as a screencast). It can actually be faster and smoother to create a quick one than labor over how to explain it with more static media.</p>
<p>A growing number of websites (and I&#8217;m a visual guy too) are using vidtuts to both attract people to use their products or services, and teach them new skills to help them get more value out of their experiences.</p>
<p>Take care!</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Keith Johnson</title>
		<link>http://greatdocuments.net/great-documentation-10-tips/comment-page-1/#comment-68</link>
		<dc:creator>Keith Johnson</dc:creator>
		<pubDate>Sun, 13 Jul 2008 20:29:45 +0000</pubDate>
		<guid isPermaLink="false">http://greatdocuments.net/?p=81#comment-68</guid>
		<description>@Nesrine: Thank you, Nesrine, for your nice comment on this blog post!</description>
		<content:encoded><![CDATA[<p>@Nesrine: Thank you, Nesrine, for your nice comment on this blog post!</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: nesrine</title>
		<link>http://greatdocuments.net/great-documentation-10-tips/comment-page-1/#comment-64</link>
		<dc:creator>nesrine</dc:creator>
		<pubDate>Fri, 11 Jul 2008 14:07:04 +0000</pubDate>
		<guid isPermaLink="false">http://greatdocuments.net/?p=81#comment-64</guid>
		<description>I&#039;ll take these tips into consideration :)</description>
		<content:encoded><![CDATA[<p>I&#8217;ll take these tips into consideration <img src='http://greatdocuments.net/wp-includes/images/smilies/icon_smile.gif' alt=':)' class='wp-smiley' /> </p>
]]></content:encoded>
	</item>
</channel>
</rss>
