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.
Hallnan, Barbara (CICG Development) wrote:
>
> I've written doc for C APIs before, but this is my first C++ doc. [snipped]
Your ideas sound pretty good. Speaking as a long-suffering C++
programmer, however, I'd like to make a couple suggestions.
First, consider making your Programmer's Reference an electronic rather
than paper document and use hyperlinks to show inheritance and "friend"
relationships. It's generally agreed among experienced C++ programmers
that, when it's done right, this is much easier to use than any
paper-based reference. I know of very few class libraries or C++ APIs
that are documented thoroughly on paper any more--it just creates a
bulky, expensive document that's no fun to use.
Second, if you want programmers to start using the API immediately, one
working sample program is worth a million words of text. This would
probably have to come from your programming department unless you're a
programmer also.
L.
--
Linda K. Sherman <linsherm -at- gte -dot- net>
Freelance Writer: Technical - Business - Government
