<?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: How to Write a User Guide</title>
	<atom:link href="http://www.technicalcommunicationcenter.com/online-classes/how-to-write-a-user-guide/feed/" rel="self" type="application/rss+xml" />
	<link>http://www.technicalcommunicationcenter.com</link>
	<description>Technical Writing &#38; Communication Tips, Trends &#38; Tutorials by Ugur Akinci, Ph.D.</description>
	<lastBuildDate>Tue, 07 Feb 2012 19:44:52 +0000</lastBuildDate>
	<sy:updatePeriod>hourly</sy:updatePeriod>
	<sy:updateFrequency>1</sy:updateFrequency>
	<generator>http://wordpress.org/?v=3.3.1</generator>
	<item>
		<title>By: admin</title>
		<link>http://www.technicalcommunicationcenter.com/online-classes/how-to-write-a-user-guide/comment-page-1/#comment-13642</link>
		<dc:creator>admin</dc:creator>
		<pubDate>Fri, 02 Sep 2011 14:01:13 +0000</pubDate>
		<guid isPermaLink="false">http://www.technicalcommunicationcenter.com/?page_id=3509#comment-13642</guid>
		<description>Bharat, thanks! Glad to help. Ugur</description>
		<content:encoded><![CDATA[<p>Bharat, thanks! Glad to help. Ugur</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Bharat</title>
		<link>http://www.technicalcommunicationcenter.com/online-classes/how-to-write-a-user-guide/comment-page-1/#comment-13636</link>
		<dc:creator>Bharat</dc:creator>
		<pubDate>Fri, 02 Sep 2011 10:12:23 +0000</pubDate>
		<guid isPermaLink="false">http://www.technicalcommunicationcenter.com/?page_id=3509#comment-13636</guid>
		<description>Hey,

It was nice to read about the article like technical writing and Function Spec

Bharat</description>
		<content:encoded><![CDATA[<p>Hey,</p>
<p>It was nice to read about the article like technical writing and Function Spec</p>
<p>Bharat</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: admin</title>
		<link>http://www.technicalcommunicationcenter.com/online-classes/how-to-write-a-user-guide/comment-page-1/#comment-3240</link>
		<dc:creator>admin</dc:creator>
		<pubDate>Sun, 01 Aug 2010 13:11:23 +0000</pubDate>
		<guid isPermaLink="false">http://www.technicalcommunicationcenter.com/?page_id=3509#comment-3240</guid>
		<description>Yes, certainly, you can do that too. There is some flexibility about what you can include in the Introduction. If you believe that system requirements deserve a section (or chapter?) of their own, you can create a separate section/chapter as well. Same goes for the other two topics you&#039;ve mentioned. That&#039;s a personal judgment call you need to make as a writer unless your client- or corporate-guidelines dictate otherwise.</description>
		<content:encoded><![CDATA[<p>Yes, certainly, you can do that too. There is some flexibility about what you can include in the Introduction. If you believe that system requirements deserve a section (or chapter?) of their own, you can create a separate section/chapter as well. Same goes for the other two topics you&#8217;ve mentioned. That&#8217;s a personal judgment call you need to make as a writer unless your client- or corporate-guidelines dictate otherwise.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Marie-Louise Flacke</title>
		<link>http://www.technicalcommunicationcenter.com/online-classes/how-to-write-a-user-guide/comment-page-1/#comment-3237</link>
		<dc:creator>Marie-Louise Flacke</dc:creator>
		<pubDate>Sun, 01 Aug 2010 07:44:39 +0000</pubDate>
		<guid isPermaLink="false">http://www.technicalcommunicationcenter.com/?page_id=3509#comment-3237</guid>
		<description>System requirements in the introduction? 
Why not a section with a title like:
- &quot;System requirements&quot;
- &quot;Preparing the installation&quot;
- &quot;Getting started&quot;
etc.
?</description>
		<content:encoded><![CDATA[<p>System requirements in the introduction?<br />
Why not a section with a title like:<br />
- &#8220;System requirements&#8221;<br />
- &#8220;Preparing the installation&#8221;<br />
- &#8220;Getting started&#8221;<br />
etc.<br />
?</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: admin</title>
		<link>http://www.technicalcommunicationcenter.com/online-classes/how-to-write-a-user-guide/comment-page-1/#comment-3223</link>
		<dc:creator>admin</dc:creator>
		<pubDate>Sat, 31 Jul 2010 12:12:30 +0000</pubDate>
		<guid isPermaLink="false">http://www.technicalcommunicationcenter.com/?page_id=3509#comment-3223</guid>
		<description>Marie-Louise, you&#039;ve raised an interesting and excellent question. &quot;Is the end-user interested in Introduction?&quot; My answer is: it depends... on the end-user and the context.

The list provided above still assumes &quot;codex&quot; (The Book) as the main format. However we all know that more and more in technical communication &quot;topic&quot; based &quot;structured authoring&quot; is replacing the traditional book-style documentation. And, you&#039;re right, in that kind of environment Introduction does not make sense and no one reads it because they do not use the document in a linear fashion. They just jump to whatever topic they&#039;re interested in to save time and energy.

However, the behavior described above is that of an intermediate or advanced user. A totally novice user may prefer a more incremental and gradual approach where one would start reading a manual from page 1 and proceed accordingly. In that context an Introduction of course makes sense. And for the sake of completion I listed it in the above article.

There&#039;s one other reason why Introduction might be necessary -- legal reasons. If certain crucial &quot;system requirements&quot; or other critical operational information are not included in the Introduction (or similar) chapter there may be a law suit if and when anything goes wrong due to lack of such information. So by including an Introduction (or Front Matter, Preface, etc.) the author may protect herself from such an eventuality. I recommend all technical communicators to consult their clients and the legal departments of their companies to understand the legal implications of including (or excluding) such information.

Again, thanks for the excellent question!  Ugur</description>
		<content:encoded><![CDATA[<p>Marie-Louise, you&#8217;ve raised an interesting and excellent question. &#8220;Is the end-user interested in Introduction?&#8221; My answer is: it depends&#8230; on the end-user and the context.</p>
<p>The list provided above still assumes &#8220;codex&#8221; (The Book) as the main format. However we all know that more and more in technical communication &#8220;topic&#8221; based &#8220;structured authoring&#8221; is replacing the traditional book-style documentation. And, you&#8217;re right, in that kind of environment Introduction does not make sense and no one reads it because they do not use the document in a linear fashion. They just jump to whatever topic they&#8217;re interested in to save time and energy.</p>
<p>However, the behavior described above is that of an intermediate or advanced user. A totally novice user may prefer a more incremental and gradual approach where one would start reading a manual from page 1 and proceed accordingly. In that context an Introduction of course makes sense. And for the sake of completion I listed it in the above article.</p>
<p>There&#8217;s one other reason why Introduction might be necessary &#8212; legal reasons. If certain crucial &#8220;system requirements&#8221; or other critical operational information are not included in the Introduction (or similar) chapter there may be a law suit if and when anything goes wrong due to lack of such information. So by including an Introduction (or Front Matter, Preface, etc.) the author may protect herself from such an eventuality. I recommend all technical communicators to consult their clients and the legal departments of their companies to understand the legal implications of including (or excluding) such information.</p>
<p>Again, thanks for the excellent question!  Ugur</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Marie-Louise Flacke</title>
		<link>http://www.technicalcommunicationcenter.com/online-classes/how-to-write-a-user-guide/comment-page-1/#comment-3219</link>
		<dc:creator>Marie-Louise Flacke</dc:creator>
		<pubDate>Sat, 31 Jul 2010 08:20:20 +0000</pubDate>
		<guid isPermaLink="false">http://www.technicalcommunicationcenter.com/?page_id=3509#comment-3219</guid>
		<description>Who reads the introduction? Are you sure the end-user is interested in the introduction?</description>
		<content:encoded><![CDATA[<p>Who reads the introduction? Are you sure the end-user is interested in the introduction?</p>
]]></content:encoded>
	</item>
</channel>
</rss>

