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:"walden miller" <wmiller -at- vidiom -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 29 May 2001 15:25:33 -0600
I have been writing API docs for about 15 years or so.
Here are some of the topics that I have been interested in over the years:
1. Organizational techniques for API manual sets (overview of different
techniques)
2. Walking the fine line between talking down to a programmer and being
complete
3. Source code example or Intellectual Property, which is it
4. Creating tutorials or creating walk-throughs--what's the difference
(i.e., will a programmer ever really create code for the sake of learning a
product)
5. How to document a set of API libraries that always requires previous
knowledge of the other libraries. Solving Chicken and Egg theory.
If I think of others, I will add them to the list.
*** 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.
