<?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>A geek with a blog &#187; documentation</title>
	<atom:link href="http://www.torand.net/tag/documentation/feed/" rel="self" type="application/rss+xml" />
	<link>http://www.torand.net</link>
	<description>writings of a regular geek</description>
	<lastBuildDate>Fri, 09 Apr 2010 13:37:08 +0000</lastBuildDate>
	<generator>http://wordpress.org/?v=2.8.4</generator>
	<language>en</language>
	<sy:updatePeriod>hourly</sy:updatePeriod>
	<sy:updateFrequency>1</sy:updateFrequency>
			<item>
		<title>Documentation is a four letter word</title>
		<link>http://www.torand.net/2009/08/documentation-is-a-four-letter-word/</link>
		<comments>http://www.torand.net/2009/08/documentation-is-a-four-letter-word/#comments</comments>
		<pubDate>Wed, 12 Aug 2009 19:04:35 +0000</pubDate>
		<dc:creator>Scott</dc:creator>
				<category><![CDATA[Howto]]></category>
		<category><![CDATA[Installs]]></category>
		<category><![CDATA[documentation]]></category>
		<category><![CDATA[project]]></category>

		<guid isPermaLink="false">http://www.torand.net/?p=54</guid>
		<description><![CDATA[Completing documentation is never high on the priority list of any system admin. This is usually the last thing that is done after the product is in place. Sometimes it is done weeks or even months after the install is finished. It is the vital part of the project that the program manager never puts [...]]]></description>
			<content:encoded><![CDATA[<p>Completing documentation is never high on the priority list of any system admin. This is usually the last thing that is done after the product is in place. Sometimes it is done weeks or even months after the install is finished. It is the vital part of the project that the program manager <strong>never</strong> puts into the Gantt charts. If you are like most admins I know, the only time you document something is because you are tired of explaining the process to someone else or are forced to by your manager.</p>
<p>In either case because even though it is not part of the project does not mean you can ignore it. On my current project we are expected to document, but as usual we are given no time to accomplish that goal. Here are some ways to block that time and get your documentation done.</p>
<h4>Add the time you will need to do documentation into the schedule</h4>
<p>This sounds easy but in reality it is the hardest thing to do. From working in the computer field for 20+ years, I can tell you that telling your customer that you will need X hours in addition to the time to install to do documentation, will be a hard sell. Remember your customer could not only be the client, but could be your manager, or your PM. The key to this, is to sell them on the benefit that documenting this process will bring to them. This could be many things, faster installs in the future, better problem resolution, not being reliant on a single person (you) for problem resolutions, lower cost of training. The reason will have to be tailored to the audience, but to get time to do the documentation you will need to show some benefit for what in the past they were getting for free.</p>
<h4>Add the hours to your estimate of the time spent on the project.</h4>
<p>This may sound a lot like the previous point, well it is. The main difference is in how it is presented to the client. There are going to be clients that want a breakdown of every minute you are working on a project, and there are some clients that just want to bottom line, <strong>How long will it take?</strong>. In that instance you add your documentation time into your estimate for completion. If you know it is going to take 8 hours to complete the project, and you guess it will take 2 hours to document, then 10 hours will complete the project.</p>
<h4>Is there a documentation Genie?</h4>
<p>Um.. no. After you get buy in from everyone, then you just have to slog through the process of documentation. One of the best things you can do is to take lots of notes during the install process, <strong>NEVER</strong> rely on your memory as a note taking apparatus. You will forget things, usually minor things, but they will make your documentation incomplete. Set aside some time that you will not be disturbed. Writing documentation means you are reliving your install process and you will need a quiet time to process your thoughts and get them in the right order.</p>
<p>Writing documentation is never fun, but keeping a well documented process will help in the long run.</p>
]]></content:encoded>
			<wfw:commentRss>http://www.torand.net/2009/08/documentation-is-a-four-letter-word/feed/</wfw:commentRss>
		<slash:comments>0</slash:comments>
		</item>
	</channel>
</rss>
