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.
turnleftatnowhere is looking for help about API documentation: <<They've
been in business more than four years and never had a tech writer until I
was hired - the developers did all the documentation.>>
Then the developers are probably a good starting point for finding out
what's needed. They use this kind of documentation every day in their work,
so who (other than your actual customers) would be better to tell you how to
do it right? Talk to them to find out their requirements, and use that as a
good starting point for your work. Among other things, they'll come to learn
that you actually care about their needs and will be working to make their
lives easier, and that's a great way to start building a successful
long-term relationship with them.
<<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?>>
I'd recommend having a look at http://www.gordonandgordon.com/api_workshop_details.html
Haven't taken the course or read the book myself, but I've taken other of
their courses and enjoyed and benefited from them, and I've heard good
things about the API course. (Disclaimer: Gordon and Manny are old buds of
mine. I think I'm being objective, but obviously can't swear to that.)
--Geoff Hart, geoff-h -at- mtl -dot- feric -dot- ca
(try ghart -at- videotron -dot- ca if you get no response)
Forest Engineering Research Institute of Canada
580 boul. St-Jean
Pointe-Claire, Que., H9R 3J9 Canada
"I have always wished that my computer would be as easy to use as my
telephone. My wish has come true. I no longer know how to use my
telephone."--Bjarne Stroustrup (originator of C++ programming language)
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.
