<?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"
	>
<channel>
	<title>Comments on: Why Is Documentation So Hard?</title>
	<atom:link href="http://www.thecrumb.com/2008/01/31/why-is-documentation-so-hard/feed/" rel="self" type="application/rss+xml" />
	<link>http://www.thecrumb.com/2008/01/31/why-is-documentation-so-hard/</link>
	<description>ColdFusion, Ant, jQuery and other geeky stuff with the occasional motorcycle post.</description>
	<pubDate>Sun, 07 Sep 2008 07:03:25 +0000</pubDate>
	<generator>http://wordpress.org/?v=2.6</generator>
		<item>
		<title>By: Sebastiaan</title>
		<link>http://www.thecrumb.com/2008/01/31/why-is-documentation-so-hard/#comment-4954</link>
		<dc:creator>Sebastiaan</dc:creator>
		<pubDate>Thu, 21 Feb 2008 11:09:19 +0000</pubDate>
		<guid isPermaLink="false">http://www.thecrumb.com/2008/01/31/why-is-documentation-so-hard/#comment-4954</guid>
		<description>Hi,

documentation is a drag to write, but I have good experiences letting the users of the system writing the documentation. This way they get all the stuff out of the way only programmers think a user needs to know ;-) And only write down the sutff they need foor their daily jobs.</description>
		<content:encoded><![CDATA[<p>Hi,</p>
<p>documentation is a drag to write, but I have good experiences letting the users of the system writing the documentation. This way they get all the stuff out of the way only programmers think a user needs to know <img src='http://www.thecrumb.com/wp-includes/images/smilies/icon_wink.gif' alt=';-)' class='wp-smiley' /> And only write down the sutff they need foor their daily jobs.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Jim</title>
		<link>http://www.thecrumb.com/2008/01/31/why-is-documentation-so-hard/#comment-4818</link>
		<dc:creator>Jim</dc:creator>
		<pubDate>Fri, 01 Feb 2008 13:57:28 +0000</pubDate>
		<guid isPermaLink="false">http://www.thecrumb.com/2008/01/31/why-is-documentation-so-hard/#comment-4818</guid>
		<description>@Geoff - I'm going to check out the 5.0 release at some point :)

I certainly wasn't pointing the finger at just FarCry!  I think many times we get wrapped up in the application and forget the simple things like a basic readme.txt.</description>
		<content:encoded><![CDATA[<p>@Geoff - I&#8217;m going to check out the 5.0 release at some point <img src='http://www.thecrumb.com/wp-includes/images/smilies/icon_smile.gif' alt=':)' class='wp-smiley' /> </p>
<p>I certainly wasn&#8217;t pointing the finger at just FarCry!  I think many times we get wrapped up in the application and forget the simple things like a basic readme.txt.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Lola LB</title>
		<link>http://www.thecrumb.com/2008/01/31/why-is-documentation-so-hard/#comment-4815</link>
		<dc:creator>Lola LB</dc:creator>
		<pubDate>Fri, 01 Feb 2008 12:36:59 +0000</pubDate>
		<guid isPermaLink="false">http://www.thecrumb.com/2008/01/31/why-is-documentation-so-hard/#comment-4815</guid>
		<description>Agreed.  After having worked with a client to convert her site using Joomla (PHP), I was curious about CF-based CMS.  So, I decide to give FarCry a tryout.  Documentation was sadly lacking, and I couldn't figure out what was the best way to get it installed.  So, I consigned the folder to trash.</description>
		<content:encoded><![CDATA[<p>Agreed.  After having worked with a client to convert her site using Joomla (PHP), I was curious about CF-based CMS.  So, I decide to give FarCry a tryout.  Documentation was sadly lacking, and I couldn&#8217;t figure out what was the best way to get it installed.  So, I consigned the folder to trash.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Geoff Bowers</title>
		<link>http://www.thecrumb.com/2008/01/31/why-is-documentation-so-hard/#comment-4813</link>
		<dc:creator>Geoff Bowers</dc:creator>
		<pubDate>Fri, 01 Feb 2008 11:18:30 +0000</pubDate>
		<guid isPermaLink="false">http://www.thecrumb.com/2008/01/31/why-is-documentation-so-hard/#comment-4813</guid>
		<description>We hear you.  The Fortress (5.0) release has a focus on a new installer, more inline help, and better documentation.  

Unfortunately, FarCry is not just a CMS, but a framework designed to build web applications.  Many prominent members of the FarCry community spend their time writing bespoke CMS solutions and other web applications.  Typically these solutions are delivered complete with documentation -- but its not necessarily documentation that is relevant or can be distributed.

One of my jobs for the Fortress release is to provide better hooks to existing documentation -- of which there is lots.  But as you say its currently a bit overwhelming in terms of where you start as a someone new to the framework.</description>
		<content:encoded><![CDATA[<p>We hear you.  The Fortress (5.0) release has a focus on a new installer, more inline help, and better documentation.  </p>
<p>Unfortunately, FarCry is not just a CMS, but a framework designed to build web applications.  Many prominent members of the FarCry community spend their time writing bespoke CMS solutions and other web applications.  Typically these solutions are delivered complete with documentation &#8212; but its not necessarily documentation that is relevant or can be distributed.</p>
<p>One of my jobs for the Fortress release is to provide better hooks to existing documentation &#8212; of which there is lots.  But as you say its currently a bit overwhelming in terms of where you start as a someone new to the framework.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: clark</title>
		<link>http://www.thecrumb.com/2008/01/31/why-is-documentation-so-hard/#comment-4804</link>
		<dc:creator>clark</dc:creator>
		<pubDate>Fri, 01 Feb 2008 00:24:59 +0000</pubDate>
		<guid isPermaLink="false">http://www.thecrumb.com/2008/01/31/why-is-documentation-so-hard/#comment-4804</guid>
		<description>Aha! I believe the answer to your rhetorical question is closely related to the truth you seek. Everyone hates making revisions to documentation...so we write documentation when the application is complete. However, as we all know applications are never complete. And therein lies the rub.

So it looks like the only option is to write the documentation in parallel to the app. Ugh. Like anyone has time to write anything other than code. Not gonna work.

I like your suggestion. Get the users to write it. Adobe kinda halfway tried that with Livedocs. I think it was half a solution, the missing ingredient was someone on the Adobe side willing to maintain the docs and revise them in line with user comments. It would have made sense to offer a threaded discussion model as part of the view.</description>
		<content:encoded><![CDATA[<p>Aha! I believe the answer to your rhetorical question is closely related to the truth you seek. Everyone hates making revisions to documentation&#8230;so we write documentation when the application is complete. However, as we all know applications are never complete. And therein lies the rub.</p>
<p>So it looks like the only option is to write the documentation in parallel to the app. Ugh. Like anyone has time to write anything other than code. Not gonna work.</p>
<p>I like your suggestion. Get the users to write it. Adobe kinda halfway tried that with Livedocs. I think it was half a solution, the missing ingredient was someone on the Adobe side willing to maintain the docs and revise them in line with user comments. It would have made sense to offer a threaded discussion model as part of the view.</p>
]]></content:encoded>
	</item>
</channel>
</rss>
