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:Documenting Classes and Methods/Functions From:Kathleen Melly <kmelly -at- HI -dot- COM> Date:Wed, 14 Oct 1998 11:48:26 -0400
Hello;
I have to document the classes and methods for a software developers kit
(sdk) reference manual and a programmers guide. Does anyone have advice on
determining which classes and methods to document? The classes/methods that
are available to the developer (versus those that are internal) are listed
in the functional spec. However, the list is very long. Should I be
documenting all of the classes/methods available to the developer or is
there some rule of thumb I should be using to discriminate between those
that they need and those that they do not need to know about?
Any advice or references to material on documenting program languages would
be appreciated.
Kathy Melly
Hitachi
781-890-0444 X233
kmelly -at- hi -dot- com
