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.
>>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?
Absolutely everything. Since this is an SDK, it is vital that everything be
documented. As a developer, I hate to see things mentioned somewhere but
not documented. It is like buying a car and having no references in the
owner's manual to a row of buttons on the dash. Your SDK needs an owner's
manual, too.
Your readers are developers and need as much info as possible. As far as
internal classes and methods are concerned, document them as well.
