Specs for documentation projects?

Subject: Specs for documentation projects?
From: Geoff Hart <ghart -at- videotron -dot- ca>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 02 Aug 2005 15:51:28 -0400

Anthony Hernandez wondered: << Is there a process for documentaiton projects similar to writing specs for software; a process for spelling out the purpose of the documentaton, intended audience, etc?>>

Of course. You've already seen the Hackos version of this mentioned, but the traditional approach to writing _anything_ has always been exactly what you suggest: identify who will be using the information and learn as much as you can about their characteristics, propose a style and approach that will meet the unique and not-so-unique needs of this audience, then develop a detailed outline of the documentation that will meet those needs.

It's not rocket science, though the more refined methodology described by Hackos can be a lifesaver in large, complex, or expensive projects. But it pays to remember that people have been planning writing projects since the first clay tablets were developed to store cuneiform--and possibly longer.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --
Geoff Hart ghart -at- videotron -dot- ca
(try geoffhart -at- mac -dot- com if you don't get a reply)
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -


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

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.


Specs for documentation projects?: From: A.H.

Previous by Author: English to Japanese Machine Translation?
Next by Author: Biz: The value of a little solicitousness
Previous by Thread: Re: Specs for documentation projects?
Next by Thread: Re: Specs for documentation projects?

What this post helpful? Share it with friends and colleagues:

Sponsored Ads