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 Classes and Methods/Functions From:John Gilger <JohnG -at- MIKOHN -dot- COM> Date:Wed, 14 Oct 1998 09:06:47 -0700
To document less than ALL of the classes and methods in your software
developers kit would be a major disservice to your customers. This reference
manual and programmers guide should completely cover everything in the SDK.
Otherwise, why waste your effort developing a useless document? Also, don't
make rash assumptions about what your customers "need to know."
John
=======================
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?
