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:RE: Asking for help . . . LOTS From:"Susan W. Gallagher" <sgallagher5 -at- cox -dot- net> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Sun, 19 Oct 2003 08:41:43 -0700
There are a couple of whitepapers on my web site that will help to
get you started. Go to http://members.cox.net/susanwg/ - follow the
Whitepapers link, and read "Oh, oh! The job ad says OO!" and "Yesterday
API was just another acronym; today I have to document one."
Then go to www.bruceeckle.com or one of its mirror sites and download
a free copy of _Thinking_in_Java_ in the format of your choice.
You already have a yahoo account. Find the Nettechwriters group and
subscribe. It's a low traffic list where a bunch of us alpha geeks
hang out. ;-) The group has collected lots of references on its
home page.
And don't be afraid to ask more questions!
HTH!
-Sue Gallagher
turnleftatnowhere -at- yahoo -dot- com wrote:
This is about doing API documentation. Everything I've read on this list
seems to indicate that the process of documenting an API is hellishly
complex and only the very best alpha geeks of the documentation world can
manage it. Late yesterday afternoon the VP gave me the job of documenting
the API for my company's product. He and I are supposed to discuss the
project this afternoon.
<snip>
Can anyone point out one or more Web sites and/or commercially available
books that can tell me everything I need to know about documenting an API,
and/or about using JavaDocs? In considering this question, please remember
I'm 100% totally ignorant. I need something that will do the moral
equivalent of taking me by the hand and walking me through every step in
the process.
<snip>
HAVE YOU SEEN THE LATEST FRAMEMAKER PUBLISHING TOOL?
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 view a live demo at: http://www.ehelp.com/techwr-l3
---
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.
