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.
Re: Have to know Programming to be able to write about it? -- NO
Subject:Re: Have to know Programming to be able to write about it? -- NO From:kcronin -at- daleen -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 26 Feb 2003 08:25:06 -0700
First and foremost: the more you know, the better.
To respond to this, I want to ask: when we talk about "writing about
programming," does that mean we are teaching somebody to program? Or that
we are teaching a *programmer* to do something?
If you're teaching somebody how to program in, say, C++, you'd *better* be
a C++ programmer. I would assume any O'Reilly book intended to teach me a
programming language was written by a programmer. If it wasn't, I don't
want it. And I would NEVER attempt to write a book intended to teach
somebody a programming language.
But I myself have had to write API docs - manuals meant to guide
experienced programmers in developing product-specific applications. I
felt extremely underqualified, and spent a lot of money on books about
programming to try to get a better grasp of the subject, in addition to
MANY hours interviewing programmers. I initially protested the assignment,
but was given no options. It was a do-it-or-be-fired assignment.
I was not thrilled with the finished product, but apparently it satisfied
the company - an updated version of it is still in use almost 4 years
later, I've been told. I think a programmer could have done an even better
job. But I did my best, and it sufficed.
So I think it depends on what you mean by "writing about programming." I
think most tech writers CAN write about just about any product or
product-related topic, with enough research. But I think when it comes to
the core technologies used in those products, more in-depth knowledge is
essential. I can write a manual for a database-driven application that was
developed in VB and uses an Oracle database. But I'm not ready to write a
book on how to program in Visual Basic, nor on how to become an Oracle
DBA. Does that make sense?
Keith Cronin
________________________
But remember, I am well within bounds to disagree with your idea(s). And
disagreement is not synonymous with misunderstanding.
- Andrew Plato
LAST CHANCE for this steal of a deal! Purchase RoboHelp X3 by February 28
and receive $100 mail-in rebate and FREE WebHelp Merge Module ($339 value)!
RoboHelp, the Industry Standard in Help Authoring, has won over 55 industry
awards. For more information please visit: http://www.ehelp.com/techwr-l2.
"RoboHelp X3 is simply remarkable." - George Bell, Techno-Vision Systems
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.