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:Linda Sherman <linsherm -at- GTE -dot- NET> Date:Wed, 14 Oct 1998 16:03:26 -0400
Kathleen Melly wrote:
> I have to document the classes and methods for a software developers kit
> (sdk) reference manual and a programmers guide...
This has come up before. I don't know if it's in the archives, but you
might want to check.
The consensus, IIRC, was that you should document everything and do it
in some sort of electronic hypertext format--it's too hard to do it in
linear text, especially in languages like C++ where class hierarchies
can get deep and complicated.
L.
--
Linda K. Sherman <linsherm -at- gte -dot- net>
Freelance Writer: Technical - Business - Government
