<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0"
	xmlns:content="http://purl.org/rss/1.0/modules/content/"
	xmlns:wfw="http://wellformedweb.org/CommentAPI/"
	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:slash="http://purl.org/rss/1.0/modules/slash/"
	>

<channel>
	<title>Stuff and Junk &#187; documentation</title>
	<atom:link href="http://www.zanfar.com/tag/documentation/feed/" rel="self" type="application/rss+xml" />
	<link>http://www.zanfar.com</link>
	<description>The Ramblings of an OCD Engineer</description>
	<lastBuildDate>Mon, 09 Jan 2012 23:08:16 +0000</lastBuildDate>
	<language>en</language>
	<sy:updatePeriod>hourly</sy:updatePeriod>
	<sy:updateFrequency>1</sy:updateFrequency>
	<generator>http://wordpress.org/?v=3.3.1</generator>
		<item>
		<title>The Uselessness of Documentation</title>
		<link>http://www.zanfar.com/2009/the-uselessness-of-documentation/</link>
		<comments>http://www.zanfar.com/2009/the-uselessness-of-documentation/#comments</comments>
		<pubDate>Tue, 02 Jun 2009 09:35:18 +0000</pubDate>
		<dc:creator>Matthew</dc:creator>
				<category><![CDATA[Rants]]></category>
		<category><![CDATA[documentation]]></category>

		<guid isPermaLink="false">http://www.zanfar.com/?p=6</guid>
		<description><![CDATA[I've long been a fan of documentation, it was one of my favorite roles at Data Doctors, and no matter what employment I find, it seems I'm always documenting some procedure or standard. Documentation allows me to exercise both my interest in writing, and my OCD tendencies at the same time. However, I came to [...]]]></description>
			<content:encoded><![CDATA[<p>I've long been a fan of documentation, it was one of my favorite roles at Data Doctors, and no matter what employment I find, it seems I'm always documenting some procedure or standard. Documentation allows me to exercise both my interest in writing, and my OCD tendencies at the same time.</p>
<p>However, I came to a startling revelation today, and that is that documentation is, 90% of the time, worthless.</p>
<p><span id="more-6"></span></p>
<p>Now I work in an industry that relies on documentation. Without datasheets from semiconductor manufacturers, I would be out of a job, and an industry. So when I speak of documentation here, I'm referring to "explaining to people what they should do," or, procedural and standards documentation.</p>
<p>It started today at work. A number of us in the lab are working on design/layout projects simultaneously for the next revision of the <a href="http://wisardnet.nau.edu/">WiSARD</a>. Part of this is generating schematics that not only are correct, but are readable when printed, and have some sort of versioning or tracking information printed on them. In my world, this is usually done with a sheet template (see below).</p>
<div id="attachment_8" class="wp-caption aligncenter" style="width: 310px"><img class="size-medium wp-image-8" title="Circuit Schematic Title Block" src="http://www.zanfar.com/wp-content/uploads/2009/06/schematic-title-block-300x166.png" alt="Circuit Schematic Title Block" width="300" height="166" /><p class="wp-caption-text">Circuit Schematic Title Block</p></div>
<p>Now, I was the first to reach this stage in my project (I had the easier project) and when I needed to know what the lab's standards were for this, I simply looked up previous schematics, and made mine match as closely as possible using the tools available. There might have been some document in the repository that explained exactly how I was supposed to accomplish this task, but I didn't even look. I simply figured it out.</p>
<p>I ignored the documentation because I'm intelligent enough not to need it.</p>
<p>A few minutes later, Dan needed to do the same thing, and Kenji asked me to show him what I did. I spent the next 5 minutes looking over his shoulder, explaining step-by-step which options to check and buttons to press. On the way back to my desk, I realized that I could have simply handed him my schematic, and had him match it. It would have saved me about 4.5 minutes, and he would have easily figured it out.</p>
<p>Dan could have ignored the documentation because he's intelligent enough, but I forced him to use it, and it wasted us both time.</p>
<p>Later that evening, I was having lunch with a friend who is involved in my school's switch between webmail providers. One of the issues they're facing is how to educate students so that they can transfer their address book between products. After only a few minutes of conversation, we declared that it didn't matter, because the intelligent users are going to take the 15 seconds to <a href="http://www.google.com/#q=importing+contacts+into+gmail">Google the answer</a>, and the unintelligent ones aren't even going to try, they'll just call support.</p>
<p>The users who need the documentation, and can't figure it out on their own, aren't going to look for it. Any way you cut it, creating documentation is just a waste of time.</p>
<p>Now, this isn't a 100% rule, there are times, like component documentation, where you won't be able to sell your product without it. Other times, like in a reasearch or grant project, you will be required to document things. But in the cases where you have a choice, it's pretty much <a href="http://www.myscienceproject.org/j-wall.html">nailing Jello to the wall</a>.</p>
]]></content:encoded>
			<wfw:commentRss>http://www.zanfar.com/2009/the-uselessness-of-documentation/feed/</wfw:commentRss>
		<slash:comments>3</slash:comments>
		</item>
	</channel>
</rss>

