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.
From the point of view of a developer working on a new
project, it would be the requirements/specification for
the project. From the point of view of a developer
working with a new tool, i.e., an SDK, it would be the
user/API doc for the tool. So the answer would depend
on whether you're being considered for a job documenting
tools being *used* by the company's developers or tools
being *written* by them for someone else to use.
Gene Kim-Eng
------- Original Message -------
On
Fri, 15 Aug 2003 13:41:26 -0400 Bonnie Granat?wrote:
I had a telephone interview with a major corporation for a technical editing
job yesterday. One of the questions I was asked was, "What is the single most
important documentation for a software developer?" I answered that I didn't
know, but thought it might well be the documentation for the APIs or for the
operating system.
I don't think the question was vital to the interview, but I'm not sure. The
job was one for which the hiring manager thought I might be qualified. It was
not a job to which I had directly applied, and the job *is* for technical
