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:How do I develop a doc plan.... From:Johanna <chazjo -at- magma -dot- ca> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 13 Mar 2001 14:34:03 -0500
...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.
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.
