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: What are "advanced" API topics? From:Kathleen Melly <kmelly -at- gensym -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 30 May 2001 09:07:38 -0400
I've documented a few APIs, starting from just the facts (signature
description) to concepts and how to information.
The tools to automate the process are complex. I worked with a programmer
turned writer who developed a system using JavaDoc that will probably die
with him. I also developed a system using SoDA that could easily be carried
on without me, but was very labor intensive (just what you don't want). So
tools, tools, tools.
Adding to the tools dilemma is documenting more than one language. I found
it hard maintaining an API in two languages, I couldn't imagine trying to do
so in four.
The other thing I would say is example code, including everything pointed
out by people in previous responses. Who does it, engineering or
documentation? How do you maintain them? How many? I found that providing
step by step instructions without sample code was pretty much useless.
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
Sponsored by Information Mapping, Inc., a professional services firm
specializing in Knowledge Management and e-content solutions. See http://www.infomap.com or 800-463-6627 for more about our solutions.
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.