Re: Starting an API Doc Project

[Goober Writer <gooberwriter -at- yahoo -dot- com>]

> I'd like to know what you think 
> are the top 5-10 steps for getting started on an API
> documentation project. 

1. Know your shtuff.
2. Know the architecture.
3. Know the purpose and goal of the product.
4. Work with development leads to work out an
accommodating workflow.
5. Document your process before starting so you can
visually map out your workflow and note snags before
diving in.

> Any additional tips or caveats you can share are
> most appreciated.

COMMUNICATE!!!! Don't sit on what you're doing or on
issues you've found. Be open, honest, and direct about
your approach, intent, progress, and issues.

=====
Goober Writer
(because life is too short to be inept)

"As soon as you hear the phrase "studies show",
immediately put a hand on your wallet and cover your groin."
      -- Geoff Hart

__________________________________
Do you Yahoo!?
Protect your identity with Yahoo! Mail AddressGuard
http://antispam.yahoo.com/whatsnewfree

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

ROBOHELP FOR FRAMEMAKER TRIAL NOW AVAILABLE!

RoboHelp for FrameMaker is a NEW online publishing tool for FrameMaker that
lets you easily single-source content to online Help, intranet, and Web.  
The interface is designed for FrameMaker users, so there is little or no
learning curve and no macro language required! Call 800-718-4407 for 
competitive pricing or download a trial at: http://www.ehelp.com/techwr-l4

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