<?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: Can Blogs Work as a Web Platform for Help? [Organizing Content 16]</title>
	<atom:link href="http://idratherbewriting.com/2010/06/23/can-blogs-work-as-a-web-platform-for-help-organizing-content-16/feed/" rel="self" type="application/rss+xml" />
	<link>http://idratherbewriting.com/2010/06/23/can-blogs-work-as-a-web-platform-for-help-organizing-content-16/</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: July Technical Linkdump &#124; Idiotprogrammer</title>
		<link>http://idratherbewriting.com/2010/06/23/can-blogs-work-as-a-web-platform-for-help-organizing-content-16/comment-page-1/#comment-155131</link>
		<dc:creator>July Technical Linkdump &#124; Idiotprogrammer</dc:creator>
		<pubDate>Wed, 07 Jul 2010 22:51:21 +0000</pubDate>
		<guid isPermaLink="false">http://idratherbewriting.com/?p=6611#comment-155131</guid>
		<description>[...] made this comment about footnotes: Footnotes have fallen out of favor on the Internet, but they still have an important role to play. [...]</description>
		<content:encoded><![CDATA[<p>[...] made this comment about footnotes: Footnotes have fallen out of favor on the Internet, but they still have an important role to play. [...]</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Justin Brock</title>
		<link>http://idratherbewriting.com/2010/06/23/can-blogs-work-as-a-web-platform-for-help-organizing-content-16/comment-page-1/#comment-155115</link>
		<dc:creator>Justin Brock</dc:creator>
		<pubDate>Wed, 07 Jul 2010 14:31:44 +0000</pubDate>
		<guid isPermaLink="false">http://idratherbewriting.com/?p=6611#comment-155115</guid>
		<description>I love Wordpress, too, and the custom menus component of their newest 3.0 release makes creating hierarchies pretty easy, even with the date-oriented publication.

The real problem with using any blogging platform for technical documentation is that of re-use, even if you categorize and tag your posts and pages. I think you may be able to overcome this, however, by trying the following:

First, consider all posts topics. Posts are your reusable chunks that can appear in any context. Tag them with all the relevant tags, but only give them one category. Tags should be granular [Installing, administration, etc.], and categories, broad [Product A, Feature X].

Second, think of pages - or a set of subpages - as your publication targets. On each page, then, you could include titles and excerpts from the appropriate posts/topics. 

Page 1, which is an overview, includes:
topic 1.1
topic 2.1
topic 3.1

Page 2, which is the complete guide, includes:
topic 1.1
  topic 1.2
  topic 1.3
topic 2.1
  topic 2.2
topic 3.1
  topic 3.2
  topic 3.3

You could probably also do the same thing with the custom menus in Wordpress 3.0.

Just a brainstorm really, but the point is that you probably could create indexes of structured TOCs this way if you think of posts as the reusable topic chunks of your project.</description>
		<content:encoded><![CDATA[<p>I love WordPress, too, and the custom menus component of their newest 3.0 release makes creating hierarchies pretty easy, even with the date-oriented publication.</p>
<p>The real problem with using any blogging platform for technical documentation is that of re-use, even if you categorize and tag your posts and pages. I think you may be able to overcome this, however, by trying the following:</p>
<p>First, consider all posts topics. Posts are your reusable chunks that can appear in any context. Tag them with all the relevant tags, but only give them one category. Tags should be granular [Installing, administration, etc.], and categories, broad [Product A, Feature X].</p>
<p>Second, think of pages &#8211; or a set of subpages &#8211; as your publication targets. On each page, then, you could include titles and excerpts from the appropriate posts/topics. </p>
<p>Page 1, which is an overview, includes:<br />
topic 1.1<br />
topic 2.1<br />
topic 3.1</p>
<p>Page 2, which is the complete guide, includes:<br />
topic 1.1<br />
  topic 1.2<br />
  topic 1.3<br />
topic 2.1<br />
  topic 2.2<br />
topic 3.1<br />
  topic 3.2<br />
  topic 3.3</p>
<p>You could probably also do the same thing with the custom menus in WordPress 3.0.</p>
<p>Just a brainstorm really, but the point is that you probably could create indexes of structured TOCs this way if you think of posts as the reusable topic chunks of your project.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: KellyK</title>
		<link>http://idratherbewriting.com/2010/06/23/can-blogs-work-as-a-web-platform-for-help-organizing-content-16/comment-page-1/#comment-154407</link>
		<dc:creator>KellyK</dc:creator>
		<pubDate>Thu, 24 Jun 2010 19:58:46 +0000</pubDate>
		<guid isPermaLink="false">http://idratherbewriting.com/?p=6611#comment-154407</guid>
		<description>I like the idea of using tags to organize help content.  

As far as hierarchy, I agree that that&#039;s important.  What about creating a Table of Contents page that lists all the important categories in an outline format, so you can easily see what falls under what?  It doesn&#039;t put the posts themselves in order, but at least gives some framework for organizing info.  You could also mess with the ordering to put a particular post for each category (the basics of that category perhaps) at the top.</description>
		<content:encoded><![CDATA[<p>I like the idea of using tags to organize help content.  </p>
<p>As far as hierarchy, I agree that that&#8217;s important.  What about creating a Table of Contents page that lists all the important categories in an outline format, so you can easily see what falls under what?  It doesn&#8217;t put the posts themselves in order, but at least gives some framework for organizing info.  You could also mess with the ordering to put a particular post for each category (the basics of that category perhaps) at the top.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Robert Nagle</title>
		<link>http://idratherbewriting.com/2010/06/23/can-blogs-work-as-a-web-platform-for-help-organizing-content-16/comment-page-1/#comment-154399</link>
		<dc:creator>Robert Nagle</dc:creator>
		<pubDate>Thu, 24 Jun 2010 16:01:14 +0000</pubDate>
		<guid isPermaLink="false">http://idratherbewriting.com/?p=6611#comment-154399</guid>
		<description>Funny, I just wrote a few paragraphs on footnotes and web pages a day or so ago: 

&lt;blockquote&gt; 
Footnotes have fallen out of favor on the Internet, but they still have an important role to play. If you have checked Wikipedia recently, you will know the reason. Many external links which were added are now dead. Sometimes, valuable information is available online in an offline source like a book or print newspaper. Wikipedia made a decision a few years ago to require that the main text body of their articles link to footnotes at the bottom. The footnotes themselves would contain the hyperlinks to the third party sources. 

That is generally a good practice. First, it allows the page citing the source to include bibliographic information in an unobtrusive manner on the bottom of the page. Second, it gives the reader more clues for finding the original source if the third party source has gone offline or if the URL has changed. Sometimes, when the URL has changed on a third party link, if you know the title or some identifying keywords, it can be relatively easy to find the new line if it is still online. Sometimes it is just helpful to keep information about the source on the same page for the reader&#039;s convenience. 

While HTML has made it easy to create links to external sources, making footnotes is clumsy and time-consuming (even for people relatively comfortable with HTML). Perhaps the concept of the footnote does not translate well to the browser page; nonetheless,a CMS that automates the use of anchors can simplify the process somewhat of creating and maintaining footnotes.  
&lt;/blockquote&gt;</description>
		<content:encoded><![CDATA[<p>Funny, I just wrote a few paragraphs on footnotes and web pages a day or so ago: </p>
<blockquote><p>
Footnotes have fallen out of favor on the Internet, but they still have an important role to play. If you have checked Wikipedia recently, you will know the reason. Many external links which were added are now dead. Sometimes, valuable information is available online in an offline source like a book or print newspaper. Wikipedia made a decision a few years ago to require that the main text body of their articles link to footnotes at the bottom. The footnotes themselves would contain the hyperlinks to the third party sources. </p>
<p>That is generally a good practice. First, it allows the page citing the source to include bibliographic information in an unobtrusive manner on the bottom of the page. Second, it gives the reader more clues for finding the original source if the third party source has gone offline or if the URL has changed. Sometimes, when the URL has changed on a third party link, if you know the title or some identifying keywords, it can be relatively easy to find the new line if it is still online. Sometimes it is just helpful to keep information about the source on the same page for the reader&#8217;s convenience. </p>
<p>While HTML has made it easy to create links to external sources, making footnotes is clumsy and time-consuming (even for people relatively comfortable with HTML). Perhaps the concept of the footnote does not translate well to the browser page; nonetheless,a CMS that automates the use of anchors can simplify the process somewhat of creating and maintaining footnotes.
</p></blockquote>
]]></content:encoded>
	</item>
	<item>
		<title>By: Daniel</title>
		<link>http://idratherbewriting.com/2010/06/23/can-blogs-work-as-a-web-platform-for-help-organizing-content-16/comment-page-1/#comment-154385</link>
		<dc:creator>Daniel</dc:creator>
		<pubDate>Thu, 24 Jun 2010 10:53:38 +0000</pubDate>
		<guid isPermaLink="false">http://idratherbewriting.com/?p=6611#comment-154385</guid>
		<description>A blogging platform seems like a good option, the difficult part is to sell the idea to the PM. Yours insights may help a lot.
By the way, the address of the first footnote lacks some www.</description>
		<content:encoded><![CDATA[<p>A blogging platform seems like a good option, the difficult part is to sell the idea to the PM. Yours insights may help a lot.<br />
By the way, the address of the first footnote lacks some www.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Debbie</title>
		<link>http://idratherbewriting.com/2010/06/23/can-blogs-work-as-a-web-platform-for-help-organizing-content-16/comment-page-1/#comment-154380</link>
		<dc:creator>Debbie</dc:creator>
		<pubDate>Thu, 24 Jun 2010 08:41:24 +0000</pubDate>
		<guid isPermaLink="false">http://idratherbewriting.com/?p=6611#comment-154380</guid>
		<description>Hello,
i don&#039;t like the footnotes either, they are pretty distracting.
Why not just give the links at the end of the article. If you&#039;re interested in reading the info you will click them there.

On a practicle note; i read these posts via an RSS feed in Outlook. When you click the little footnotes you are directed to the top of the page, not to the bottom where the actual links are posted.</description>
		<content:encoded><![CDATA[<p>Hello,<br />
i don&#8217;t like the footnotes either, they are pretty distracting.<br />
Why not just give the links at the end of the article. If you&#8217;re interested in reading the info you will click them there.</p>
<p>On a practicle note; i read these posts via an RSS feed in Outlook. When you click the little footnotes you are directed to the top of the page, not to the bottom where the actual links are posted.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Jay Maechtlen</title>
		<link>http://idratherbewriting.com/2010/06/23/can-blogs-work-as-a-web-platform-for-help-organizing-content-16/comment-page-1/#comment-154376</link>
		<dc:creator>Jay Maechtlen</dc:creator>
		<pubDate>Thu, 24 Jun 2010 05:38:23 +0000</pubDate>
		<guid isPermaLink="false">http://idratherbewriting.com/?p=6611#comment-154376</guid>
		<description>Hi, Tom
The hyperlink at footnote #1  is broken, or someone changed the rules?

http://dotnet.blogengine.net/  doesn&#039;t work

http://www.dotnetblogengine.net/ does.

bother.</description>
		<content:encoded><![CDATA[<p>Hi, Tom<br />
The hyperlink at footnote #1  is broken, or someone changed the rules?</p>
<p><a href="http://dotnet.blogengine.net/" rel="nofollow">http://dotnet.blogengine.net/</a>  doesn&#8217;t work</p>
<p><a href="http://www.dotnetblogengine.net/" rel="nofollow">http://www.dotnetblogengine.net/</a> does.</p>
<p>bother.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: trainey</title>
		<link>http://idratherbewriting.com/2010/06/23/can-blogs-work-as-a-web-platform-for-help-organizing-content-16/comment-page-1/#comment-154355</link>
		<dc:creator>trainey</dc:creator>
		<pubDate>Wed, 23 Jun 2010 19:30:50 +0000</pubDate>
		<guid isPermaLink="false">http://idratherbewriting.com/?p=6611#comment-154355</guid>
		<description>Not a huge fan of the footnotes either - I actually think they&#039;re more distracting than the links. We&#039;ve gotten used to expecting linked text - a footnote adds another second of distraction. Although some data might suggest links are distracting - I personally think most of us have gotten used to them. We click what we want to see more of and use the back button if the original article was compelling enough to call us back.
The footnotes almost seem counter-intuitive/counter-productive when on a web platform (versus print). Print has no other alternative...</description>
		<content:encoded><![CDATA[<p>Not a huge fan of the footnotes either &#8211; I actually think they&#8217;re more distracting than the links. We&#8217;ve gotten used to expecting linked text &#8211; a footnote adds another second of distraction. Although some data might suggest links are distracting &#8211; I personally think most of us have gotten used to them. We click what we want to see more of and use the back button if the original article was compelling enough to call us back.<br />
The footnotes almost seem counter-intuitive/counter-productive when on a web platform (versus print). Print has no other alternative&#8230;</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Kristi</title>
		<link>http://idratherbewriting.com/2010/06/23/can-blogs-work-as-a-web-platform-for-help-organizing-content-16/comment-page-1/#comment-154351</link>
		<dc:creator>Kristi</dc:creator>
		<pubDate>Wed, 23 Jun 2010 17:04:41 +0000</pubDate>
		<guid isPermaLink="false">http://idratherbewriting.com/?p=6611#comment-154351</guid>
		<description>I like where you&#039;re taking us, too, but I am concerned about that flat structure you mention. I find the hierarchy not only useful for indicating how topics are related and their relative importance, but it also helps &lt;i&gt;me&lt;/i&gt; keep those things straight when I&#039;m writing.

Tagging and categorizing are such intuitive tasks to complete when I&#039;m writing a blog post--I would love to have that ease when I&#039;m writing a help topic. Perhaps having subcategories would be sufficient structure to establish relationships.

I could see writing this way, with a standard, though evolving, set of available tags and categories to keep things consistent.

I&#039;m not digging the footnotes, either. I&#039;m interested in trying it out for at least a while, though. It&#039;s a web habit of mine to click and explore as a I read. Often I open the links in new windows and look at them later. The footnote still stops my eye, and then I want to scroll to it. I didn&#039;t scroll, though, because I read about what you are trying to achieve.

In &lt;i&gt;Don&#039;t Make Me Think&lt;/i&gt;, Steve Krug talks about following established web conventions, and that if you don&#039;t, the benefits of the deviation should outweigh the cognitive dissonance it produces. I wonder which will win in the case of links vs. footnotes.</description>
		<content:encoded><![CDATA[<p>I like where you&#8217;re taking us, too, but I am concerned about that flat structure you mention. I find the hierarchy not only useful for indicating how topics are related and their relative importance, but it also helps <i>me</i> keep those things straight when I&#8217;m writing.</p>
<p>Tagging and categorizing are such intuitive tasks to complete when I&#8217;m writing a blog post&#8211;I would love to have that ease when I&#8217;m writing a help topic. Perhaps having subcategories would be sufficient structure to establish relationships.</p>
<p>I could see writing this way, with a standard, though evolving, set of available tags and categories to keep things consistent.</p>
<p>I&#8217;m not digging the footnotes, either. I&#8217;m interested in trying it out for at least a while, though. It&#8217;s a web habit of mine to click and explore as a I read. Often I open the links in new windows and look at them later. The footnote still stops my eye, and then I want to scroll to it. I didn&#8217;t scroll, though, because I read about what you are trying to achieve.</p>
<p>In <i>Don&#8217;t Make Me Think</i>, Steve Krug talks about following established web conventions, and that if you don&#8217;t, the benefits of the deviation should outweigh the cognitive dissonance it produces. I wonder which will win in the case of links vs. footnotes.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Larry Kunz</title>
		<link>http://idratherbewriting.com/2010/06/23/can-blogs-work-as-a-web-platform-for-help-organizing-content-16/comment-page-1/#comment-154350</link>
		<dc:creator>Larry Kunz</dc:creator>
		<pubDate>Wed, 23 Jun 2010 15:50:10 +0000</pubDate>
		<guid isPermaLink="false">http://idratherbewriting.com/?p=6611#comment-154350</guid>
		<description>&gt; how are you liking these footnotes?

I&#039;m not, thanks for asking. From an aesthetic point of view, I find them far more distracting than hypertext links. But I suspect that&#039;s just my personal taste. From a practical point of view, why make me click twice (first to get to the bottom of this page, then again to follow the link) when I used to click just once?

Anent this post: I like where you&#039;re taking us. Looking forward to number 17.</description>
		<content:encoded><![CDATA[<p>&gt; how are you liking these footnotes?</p>
<p>I&#8217;m not, thanks for asking. From an aesthetic point of view, I find them far more distracting than hypertext links. But I suspect that&#8217;s just my personal taste. From a practical point of view, why make me click twice (first to get to the bottom of this page, then again to follow the link) when I used to click just once?</p>
<p>Anent this post: I like where you&#8217;re taking us. Looking forward to number 17.</p>
]]></content:encoded>
	</item>
</channel>
</rss>

