Re: Structuring a manual - trying to make it easy for everyone

Subject: Re: Structuring a manual - trying to make it easy for everyone
From: "Anthony Markatos" <tonymar -at- hotmail -dot- com>
To: cpeterso -at- komo -dot- com, techwr-l -at- lists -dot- raycomm -dot- com
Date: Thu, 27 Jan 2000 10:45:35 PST

Carlon Peterson asks:

1.) Is there any guide that can help setup a documentation structure that can 'follow' changes made to a 'part'?

2.) How can I setup a manual to be modular - to make it easy for us to assemble - and keep it organized so it is 'user friendly'?
are there any good books on this topic?

Tony Markatos responds:

1.) Create data flow diagrams showing the essential tasks accomplished using the product and how all these tasks interrelate. Then organize your manuals per the data flow diagrams - one task on the dfd correlates with one documentation heading. This is GREAT for documentation change management. When the product changes, you change your dfds - doing this will very clearly tell you required documentation changes.

2.) Ahhh, So you want modularity. Go through the introductory DFD example (assembling the toy sail boat) in the following book. It will "rock" you. 'Structured Systems Analysis and Specification by Tom DeMarco. Yourdon Press, 1979.'

Tony Markatos
(tonymar -at- hotmail -dot- com)





______________________________________________________
Get Your Private, Free Email at http://www.hotmail.com





Previous by Author: Re: Good tech writing schools?
Next by Author: RE: Interviewing writers
Previous by Thread: Structuring a manual - trying to make it easy for everyone
Next by Thread: Need referral for document management software


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

Sponsored Ads


Sponsored Ads