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: Documenting an API From:Hal Wrobel <hwrobel -at- toptier -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Sun, 24 Dec 2000 07:48:46 -0800
Yanick LeClerc wrote:
Can anyone suggest guidelines for what a good API document should include
(aside from the input and output of each function with code examples).
The best advice I can offer is to talk to those for whom the API
documentation is to be written. If you're writing for a company that employs
consultants or implemention staff who visit customer sites to facilitate
installation and customization, they are the best, and perhaps the most
accessible, people for answering your questions. They are the ones who will
need the explanations you write.
I'm sure that at the very least, besides explanations of programming objects
and input and output arguments, you will need syntax examples and actual
representative samples, from a realistic context, of how the APIs can be
used. Usually the ones needing your documentation like a good sample from
which they can copy and paste, making the appropriate corrections, so good
relevant samples are important.
Hal Wrobel
Technical Documentation
TopTier Israel mailto:hwrobel -at- toptier -dot- com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY. http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Take XML and Tech Writing courses online! Our instructor-led courses
(4-6 hrs/wk) give you "hands on" experience at your convenience. STC members
get 20% off! http://www.online-learning.com/index.html.
---
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.
