<?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: First Principles of Technical Writing</title>
	<atom:link href="http://www.gryphonmountain.net/2010/01/first-principles-of-technical-writing/feed/" rel="self" type="application/rss+xml" />
	<link>http://www.gryphonmountain.net/2010/01/first-principles-of-technical-writing/</link>
	<description>Technical Communication and Other Writing Topics, by Ben Minson</description>
	<lastBuildDate>Wed, 11 Jan 2012 04:05:49 +0000</lastBuildDate>
	<sy:updatePeriod>hourly</sy:updatePeriod>
	<sy:updateFrequency>1</sy:updateFrequency>
	<generator>http://wordpress.org/?v=3.0.4</generator>
	<item>
		<title>By: Milan Davidovic</title>
		<link>http://www.gryphonmountain.net/2010/01/first-principles-of-technical-writing/#comment-456</link>
		<dc:creator>Milan Davidovic</dc:creator>
		<pubDate>Fri, 19 Feb 2010 18:40:16 +0000</pubDate>
		<guid isPermaLink="false">http://www.gryphonmountain.net/?p=857#comment-456</guid>
		<description>What I said? What I *meant*,,,</description>
		<content:encoded><![CDATA[<p>What I said? What I *meant*,,,</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Milan Davidovic</title>
		<link>http://www.gryphonmountain.net/2010/01/first-principles-of-technical-writing/#comment-455</link>
		<dc:creator>Milan Davidovic</dc:creator>
		<pubDate>Fri, 19 Feb 2010 18:35:17 +0000</pubDate>
		<guid isPermaLink="false">http://www.gryphonmountain.net/?p=857#comment-455</guid>
		<description>What I said was it may be that ingenuity comes to us more easily than empathy. If so, it might explain why we build stuff that is not intuitive to use. This in turn might explain the need for technical communication, user assistance, etc.. But I don&#039;t think people practicing in these fields are necessarily more empathic than anyone else, so it seems to me that they need systems to help walk them through the necessary steps that they might naturally take if they were more empathic.</description>
		<content:encoded><![CDATA[<p>What I said was it may be that ingenuity comes to us more easily than empathy. If so, it might explain why we build stuff that is not intuitive to use. This in turn might explain the need for technical communication, user assistance, etc.. But I don&#8217;t think people practicing in these fields are necessarily more empathic than anyone else, so it seems to me that they need systems to help walk them through the necessary steps that they might naturally take if they were more empathic.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Ben</title>
		<link>http://www.gryphonmountain.net/2010/01/first-principles-of-technical-writing/#comment-454</link>
		<dc:creator>Ben</dc:creator>
		<pubDate>Fri, 19 Feb 2010 05:07:16 +0000</pubDate>
		<guid isPermaLink="false">http://www.gryphonmountain.net/?p=857#comment-454</guid>
		<description>I don&#039;t know if you were suggesting this, but I&#039;ve never thought of the possibility that our profession stems from empathy—from feeling others&#039; pain and wanting to help. I do get some enjoyment from being able to help people solve problems.

Of course, there&#039;s the possibility that we help users so that they&#039;ll keep coming back to buy more products and we&#039;ll get paid.

Though technical writers work in areas other than commercial ones, so I suppose those kinds of people work out of some degree of empathy or desire to help.</description>
		<content:encoded><![CDATA[<p>I don&#8217;t know if you were suggesting this, but I&#8217;ve never thought of the possibility that our profession stems from empathy—from feeling others&#8217; pain and wanting to help. I do get some enjoyment from being able to help people solve problems.</p>
<p>Of course, there&#8217;s the possibility that we help users so that they&#8217;ll keep coming back to buy more products and we&#8217;ll get paid.</p>
<p>Though technical writers work in areas other than commercial ones, so I suppose those kinds of people work out of some degree of empathy or desire to help.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Milan Davidovic</title>
		<link>http://www.gryphonmountain.net/2010/01/first-principles-of-technical-writing/#comment-453</link>
		<dc:creator>Milan Davidovic</dc:creator>
		<pubDate>Thu, 18 Feb 2010 01:09:52 +0000</pubDate>
		<guid isPermaLink="false">http://www.gryphonmountain.net/?p=857#comment-453</guid>
		<description>Well, you did bring up the idea of fundamentals -- I&#039;m just working at the idea rather than sitting back and uncritically admiring it...

As you&#039;ve just put it, it appears to me that knowing your audience is a means to an end, and that end is helping the user. Why help the user? S/he doesn&#039;t always need help, but certainly can use the help when technology is not intuitive. This lack of intuitiveness perhaps is the result of a lack of empathy -- technology makers can achieve greater capacity more easily than greater usability. It then falls to usability and communication specialists to fill the gap.

This &quot;empathy deficit&quot; might also explain the need to avoid assumptions, and instead to rely on systematic investigation to ensure that we know our audiences and our subject matter well enough to help the two connect.

So, if I were to take a stab at a first principle, I&#039;d say that ingenuity comes to us more easily than empathy. But let&#039;s see how it stands up before accepting it.</description>
		<content:encoded><![CDATA[<p>Well, you did bring up the idea of fundamentals &#8212; I&#8217;m just working at the idea rather than sitting back and uncritically admiring it&#8230;</p>
<p>As you&#8217;ve just put it, it appears to me that knowing your audience is a means to an end, and that end is helping the user. Why help the user? S/he doesn&#8217;t always need help, but certainly can use the help when technology is not intuitive. This lack of intuitiveness perhaps is the result of a lack of empathy &#8212; technology makers can achieve greater capacity more easily than greater usability. It then falls to usability and communication specialists to fill the gap.</p>
<p>This &#8220;empathy deficit&#8221; might also explain the need to avoid assumptions, and instead to rely on systematic investigation to ensure that we know our audiences and our subject matter well enough to help the two connect.</p>
<p>So, if I were to take a stab at a first principle, I&#8217;d say that ingenuity comes to us more easily than empathy. But let&#8217;s see how it stands up before accepting it.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Ben</title>
		<link>http://www.gryphonmountain.net/2010/01/first-principles-of-technical-writing/#comment-452</link>
		<dc:creator>Ben</dc:creator>
		<pubDate>Thu, 18 Feb 2010 00:48:51 +0000</pubDate>
		<guid isPermaLink="false">http://www.gryphonmountain.net/?p=857#comment-452</guid>
		<description>I see that, though not a logic or philosophy expert, you&#039;d like to talk lines of logic. :)

Well, I&#039;ll have to start with my opinion here, which is that the objective of technical writing is to make the user successful in whatever his goal is. A corollary to that could be to make the user successful quickly.

Given that, knowing your audience is fundamental because if you know who the user is, what her goals are, what she already knows, what her environment is like, the constraints she&#039;s operating under, and so on, then you know what information to provide and how to structure it so she can accomplish her task and do so as quickly as possible.

If you make assumptions about your user in any of the areas I&#039;ve mentioned or others, you&#039;ll likely reduce the effectiveness of your communication. You&#039;re leaving your user out of the conversation because you&#039;re essentially talking to someone else. When the communication doesn&#039;t connect with the user, she&#039;s less likely to accomplish her aim. You may get lucky and nail your audience, or your audience may be able to interpret what you&#039;re saying into something that makes sense to them. But the first case isn&#039;t likely, and the second case makes more work for the user.

Assumptions also apply to the subject or product you&#039;re communicating about. If you assume things about your subject matter, you may very well mislead the audience, and consequences can range from inconvenience to disaster.

In short, if you don&#039;t know your audience and you make assumptions, your communication is likely to fail to some degree.

What answer would you give to your question?</description>
		<content:encoded><![CDATA[<p>I see that, though not a logic or philosophy expert, you&#8217;d like to talk lines of logic. <img src='http://www.gryphonmountain.net/wp-includes/images/smilies/icon_smile.gif' alt=':)' class='wp-smiley' /> </p>
<p>Well, I&#8217;ll have to start with my opinion here, which is that the objective of technical writing is to make the user successful in whatever his goal is. A corollary to that could be to make the user successful quickly.</p>
<p>Given that, knowing your audience is fundamental because if you know who the user is, what her goals are, what she already knows, what her environment is like, the constraints she&#8217;s operating under, and so on, then you know what information to provide and how to structure it so she can accomplish her task and do so as quickly as possible.</p>
<p>If you make assumptions about your user in any of the areas I&#8217;ve mentioned or others, you&#8217;ll likely reduce the effectiveness of your communication. You&#8217;re leaving your user out of the conversation because you&#8217;re essentially talking to someone else. When the communication doesn&#8217;t connect with the user, she&#8217;s less likely to accomplish her aim. You may get lucky and nail your audience, or your audience may be able to interpret what you&#8217;re saying into something that makes sense to them. But the first case isn&#8217;t likely, and the second case makes more work for the user.</p>
<p>Assumptions also apply to the subject or product you&#8217;re communicating about. If you assume things about your subject matter, you may very well mislead the audience, and consequences can range from inconvenience to disaster.</p>
<p>In short, if you don&#8217;t know your audience and you make assumptions, your communication is likely to fail to some degree.</p>
<p>What answer would you give to your question?</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Milan Davidovic</title>
		<link>http://www.gryphonmountain.net/2010/01/first-principles-of-technical-writing/#comment-451</link>
		<dc:creator>Milan Davidovic</dc:creator>
		<pubDate>Tue, 16 Feb 2010 23:39:58 +0000</pubDate>
		<guid isPermaLink="false">http://www.gryphonmountain.net/?p=857#comment-451</guid>
		<description>OK -- so, if we want to get down to fundamentals, why do we say &quot;know your audience&quot; and &quot;never assume anything&quot;?</description>
		<content:encoded><![CDATA[<p>OK &#8212; so, if we want to get down to fundamentals, why do we say &#8220;know your audience&#8221; and &#8220;never assume anything&#8221;?</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Ben</title>
		<link>http://www.gryphonmountain.net/2010/01/first-principles-of-technical-writing/#comment-450</link>
		<dc:creator>Ben</dc:creator>
		<pubDate>Tue, 16 Feb 2010 23:25:31 +0000</pubDate>
		<guid isPermaLink="false">http://www.gryphonmountain.net/?p=857#comment-450</guid>
		<description>I&#039;m not a philosopher or student of philosophy, so I wasn&#039;t even aware of that definition. By first principles (an arbitrarily chosen term in this case), I mean the basic or fundamental concepts behind something. For example, if I said, &quot;I don&#039;t know the first thing about hog-tying a wild bear,&quot; I would mean that I don&#039;t know the beginning steps or the concepts behind the action.</description>
		<content:encoded><![CDATA[<p>I&#8217;m not a philosopher or student of philosophy, so I wasn&#8217;t even aware of that definition. By first principles (an arbitrarily chosen term in this case), I mean the basic or fundamental concepts behind something. For example, if I said, &#8220;I don&#8217;t know the first thing about hog-tying a wild bear,&#8221; I would mean that I don&#8217;t know the beginning steps or the concepts behind the action.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Milan Davidovic</title>
		<link>http://www.gryphonmountain.net/2010/01/first-principles-of-technical-writing/#comment-449</link>
		<dc:creator>Milan Davidovic</dc:creator>
		<pubDate>Tue, 16 Feb 2010 22:12:18 +0000</pubDate>
		<guid isPermaLink="false">http://www.gryphonmountain.net/?p=857#comment-449</guid>
		<description>Myself, I wouldn&#039;t call these &quot;first principles&quot; - they are presented as instructions, which must be derived from something prior (such as a goal) and thus are not &quot;first&quot;.

I&#039;m no expert on logic or philosophy, though; I read about first principles here:

http://en.wikipedia.org/wiki/First_principles

Are you working from a different definition of &quot;first principles&quot;?</description>
		<content:encoded><![CDATA[<p>Myself, I wouldn&#8217;t call these &#8220;first principles&#8221; &#8211; they are presented as instructions, which must be derived from something prior (such as a goal) and thus are not &#8220;first&#8221;.</p>
<p>I&#8217;m no expert on logic or philosophy, though; I read about first principles here:</p>
<p><a href="http://en.wikipedia.org/wiki/First_principles" rel="nofollow">http://en.wikipedia.org/wiki/First_principles</a></p>
<p>Are you working from a different definition of &#8220;first principles&#8221;?</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Larry Kunz</title>
		<link>http://www.gryphonmountain.net/2010/01/first-principles-of-technical-writing/#comment-448</link>
		<dc:creator>Larry Kunz</dc:creator>
		<pubDate>Fri, 22 Jan 2010 15:04:31 +0000</pubDate>
		<guid isPermaLink="false">http://www.gryphonmountain.net/?p=857#comment-448</guid>
		<description>Great post, Ben. I daresay the world would be a much better place if every technical writer had these two principles hanging on the office wall (in cross-stitch, PowerPoint, or whatever).</description>
		<content:encoded><![CDATA[<p>Great post, Ben. I daresay the world would be a much better place if every technical writer had these two principles hanging on the office wall (in cross-stitch, PowerPoint, or whatever).</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Ben</title>
		<link>http://www.gryphonmountain.net/2010/01/first-principles-of-technical-writing/#comment-447</link>
		<dc:creator>Ben</dc:creator>
		<pubDate>Fri, 22 Jan 2010 15:00:36 +0000</pubDate>
		<guid isPermaLink="false">http://www.gryphonmountain.net/?p=857#comment-447</guid>
		<description>Haitham, that&#039;s a great idea about the flowchart. Sometimes we struggle with ways to accommodate both the experienced and inexperienced, the savvy and the struggling. A fellow member of my STC chapter said he has implemented a one-thirds/two-thirds layout in some documents, where a column that&#039;s one-third of the width of the page gives the quick instructions, and the other column gives more detail and explanation. I like the simple flowchart concept. Thanks for sharing that. I agree that anyone who interacts with users regularly is a great resource.</description>
		<content:encoded><![CDATA[<p>Haitham, that&#8217;s a great idea about the flowchart. Sometimes we struggle with ways to accommodate both the experienced and inexperienced, the savvy and the struggling. A fellow member of my STC chapter said he has implemented a one-thirds/two-thirds layout in some documents, where a column that&#8217;s one-third of the width of the page gives the quick instructions, and the other column gives more detail and explanation. I like the simple flowchart concept. Thanks for sharing that. I agree that anyone who interacts with users regularly is a great resource.</p>
]]></content:encoded>
	</item>
</channel>
</rss>

