TechWhirl Sponsors

---

 

[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

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

Subject: Re: How do I develop a doc plan....
From: Scott Turner <sturner -at- airmail -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 13 Mar 2001 14:07:44 -0600

...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.

Am I correct to assume that I need to sit down and go
through each user interface and determine the tasks
involved and write down all the procedures that will
need to be documented, using this to develop a ToC? I
am used to working with at least developers' specs but
in this instance they have abandoned all methodology
and just developed a system off the top of their
heads, it would seem.

If anyone else has any other effective methods of
coming up with a doc plan, please let me know.

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.

Scott

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

Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**New Dates!!** San Francisco (Apr 16-17), San Jose (Mar 29-30)
http://www.weisner.com/training/dreamweaver_help.htm 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.
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.

---

Previous by Author: Re: Framemaker to PDF frustrataions
Next by Author: Re: Big Doc Word
Previous by Thread: How do I develop a doc plan....
Next by Thread: RE: How do I develop a doc plan....

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

---

---

---