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:Bruce Byfield <bbyfield -at- axionet -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Sun, 24 Dec 2000 16:53:51 -0800
Yanick 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).
>
I've observed that a large chunk of API documentation is still done
in much the same way as in the Seventies. In particular, it is often
done as a summary that assumes a great deal of pre-existing
knowledge in the users. While this assumption of knowledge may sound
reasonable, not every programmer remembers every detail of every
aspect, so more explanation would probably be very welcome.
Also, as I like to say, just because someone can lift 500 pounds
doesn't mean that they want to do so a dozen times a day. In other
words, your users may not need more details, but giving some will
make their lives easier, especially when they're tired and have
already put in a long day.
Finally, the layout of API documentation seems stuck with man pages
as the standard. A careful use of tables alone can improve the
documentation beyond belief.
If you're pushing a deadline, or going through the material for the
first time, you may not want to consider these matters. However,
they are overdue for consideration by everyone.
--
Bruce Byfield, Outlaw Communications
Contributing Editor, Maximum Linux
604.421.7189 bbyfield -at- axionet -dot- com
"Thank you very much, thank you very much
That's the nicest thing that anyone's ever done for me,
It may sound double-Dutch, but my delight is such
I feel as though a losing war's been won for me.
And if I had a flare gun, I would fire it
Just to add a kind of celebratory touch,
But since I left my flare gun at home, I simply have to say:
Thank you very, very, very much!"
- "Scrooge!"
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
