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: Tech writers and engineers From:Iliana Kostova <i_kostadinova -at- prosyst -dot- bg> To:techwr-l Date:Fri, 27 Feb 2004 17:09:33 +0200
Thanks for the support, Dan.
Actually, I think that knowing how to code depends on what you are
documenting. At my company, we produce middleware software mainly for
developers, and technical writers are in charge of writing the code
examples, included in the user documentation (but developers are in duty
to check their correctness). As you can see, knowing how to code is a
must here, although not at developer level.
In general I'm not interested so much in where CONSTANT_A is supposed to
stay within the implementation (usually hidden from the user) and what
technique will avoid creating too much temp objects, but how the user
can gain access to the API and make use of it. Sometimes this is
discussed at iteration meetings, sometimes it's not. But considering
your arguments, I think I should attend them as much as possible.
