Re: Good Systems Documentation?

["W. Kelly Oja" <judbasiner -at- gmail -dot- com>]

Here is a look at how I set up the manual I created for my company. I
cannot provide an actual example, but I hope the cut-up demonstates
the actual feel. Most likely this is not going to display correctly in
every e-mail window,, but what can you do?

7.2           TOPIC 

                7.2.1	Definition

	                What is it?

	7.2.2	Origin

		Where does the data come from?

	7.2.3	Process

		What do you do with the data?

	7.2.4	Schedule

		When do you do the task?

	7.2.5	Objective

		What is the desired outcome?

	7.2.6	Location

		7.2.6.1	LAN	
		
			Document located on LAN
			
		7.2.6.2	Print

			Location of hard copy document

	7.2.7	Related Documents

		Other docs in this manual you might want to take a look at.

	7.2.8	Additional Information

		Additional information that does not fit in one of the above categories

-- 
Kelly
"Look after yourselves and lead good lives"
-Anonymous

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l

Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.