RE: How do I develop a doc plan....

Subject: RE: How do I develop a doc plan....
From: KMcLauchlan -at- chrysalis-its -dot- com
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 13 Mar 2001 16:15:38 -0500

If this is relatively new-tech, then you should
probably also document "why-to".

When I started documenting our crypto hardware
products, the industry was so very "emerging"
that many of the people who were trying to set
up PKIs or VPNs knew only that:

a) someone had told them to do it (whatever it is...) and
b) if you put one of those Luna devices in it, it
works better or is more secure, or somethin'... I guess.

So, I had to begin with some background whys and wherefores
and some basic security concepts before leading into
what our devices were for, and then how they were to
be installed, configured and used.

Documentalist bootstrapping? :-)


> -----Original Message-----
> >...when there are NO functional specs or feature
> >documents in place? None whatsoever (small start up).
> >All they have is a beta version of the system they'd
> >like documented.

> That's about the way to do it. Also consider if you need to document
> "how to" perform certain tasks that the software is designed to
> accomplish, from beginning to end. This is different than documenting
> interface and how to use the interface.
> This will make the document larger, or create a need for a
> second document.


Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**New Dates!!** San Francisco (Apr 16-17), San Jose (Mar 29-30) or 800-646-9989.

IPCC 01, the IEEE International Professional Communication Conference,
October 24-27, 2001 at historic La Fonda in Santa Fe, New Mexico, USA.

You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit for more resources and info.

Previous by Author: RE: writing quality
Next by Author: RE: Step structure (was RE: a question about verb tense/is or was ?)
Previous by Thread: RE: How do I develop a doc plan....
Next by Thread: RE: How do I develop a doc plan....

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

Sponsored Ads