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.
[Someone wrote:]
> ...I would suggest that you work hard on the TOC, meaning, spend
> a minimum of 1-2 months on finalizing this....
I hope you are kidding!
Spend about 1-2 HOURS on a TOC, and then go talk to the folks that are going to use youur Developer's Guide. Say something like, "Hey, what are the pain points in using the XYZ System?"
After talking to half a dozen folks, you will learn what chapters need to be in there based on how they will use the doc, and that will help you structure the docs alot better.
Also, what kind of system might help to define the structure. Do you need to provide config info for system admins? How many different audiences are there? You might break it out into several books, like:
XYZ API Reference
Administering XYZ
Using XYZ
Getting Started with XYZ
HTH,
Matthew J. Horn
Sr. Technical Writer
< m a c r o m e d i a >
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Order RoboHelp X3 in December and receive $100 mail in rebate, FREE WebHelp
Merge Module and the new RoboPDF - add powerful PDF output functionality
to RoboHelp X3. Order online today at http://www.ehelp.com/techwr-l
Check out SnagIt - The Screen Capture Standard!
Download a free 30-day trial from http://www.techsmith.com/rdr/txt/twr
Find out what all the other tech writers, including Dan, already know!
---
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.
