RE: Technical Writers Needed for API Doc: Really?

["walden miller" <wmiller -at- vidiom -dot- com>]

andrew wrote:

<snip>

However, for the most part I would consider an API manual mostly reference
material.


I agree with andrew in the sense that programmer's use API manuals as
reference.  Consequently, they need to be highly organized and very
complete.  They are not terse man pages heavily cross-referenced to crucial
information.

I agree with others that the API reference manual is only one in a set of
manuals that cover the API. My sets include a tutorial, a programmer's
guide, and any tool manuals that are bundled with the API.

wm



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you 
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of 
your book. What are you waiting for? http://www.iuniverse.com/media/techwr

Have you looked at the new content on TECHWR-L lately?
See http://www.raycomm.com/techwhirl/ and check it out.

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