TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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? :-)
/kevin
> -----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.
[snip]
> 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.
IPCC 01, the IEEE International Professional Communication Conference,
October 24-27, 2001 at historic La Fonda in Santa Fe, New Mexico, USA.
CALL FOR PAPERS OPEN UNTIL MARCH 15. http://ieeepcs.org/2001/
---
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 http://www.raycomm.com/techwhirl/ for more resources and info.
