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.
> Rajeev Jain wrote:
> Do we have any API writers subscribed to this list? If yes, I
> would like them to share their experiences with developers,
> management, tools used, and also about their contribution in
> the content (of API Guides and Programmers Manuals).
That's a pretty broad request. Can you perhaps narrow it a bit? In the
meantime, I'll respond with an equally broad answer. :)
Developers: I work with them on figuring out what stuff does.
Managers: I work with them on figuring when stuff is done and by whom.
Tools Used: To create or edit API doc, I use TextPad or whatever text
editor. We edit the class files and embed API comments in there. We then
use a local ant build to test our changes (make sure we didn't break it,
basically) and another internal tool to generate JavaDoc-like output for
the class libraries.
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.