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:API documentation From:Dave SCOTT <dscott -at- IBM -dot- NET> Date:Tue, 22 Jun 1999 06:01:43 -0700
This may seem like a silly question, but how proficient in a programming
language (say, C++) should an employer expect of a tech writer who
produces API docs? And on the flip side, how proficient -should- you be?
I've written software in several languages, including C, but not C++, and
there is a substantial difference. I may have an opportunity
to document a C++ API, but am nervous about what the potential employer
may be expecting.
