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:Chris Gooch <chris -dot- gooch -at- lightworkdesign -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 27 Feb 2003 16:19:37 -0000
Beth wrote:
+++
The expert is often the worst person to write about their subject,
because they no longer see it with the naivete of the new user.
Hence the manuals that leave out crucial steps because "tsk, everyone
_knows_ you're supposed to do X before Y".
+++
My view is that the ability to know your subject, _whilst at
the same time remembering that your reader does not know
so much about the subject yet_, is precisely the skill of
a good writer -- being able to put yourself in your reader's
shoes. I don't see this as an argument for "benign ignorance",
just the opposite. You need two sound sets of knowledge:
the subject at hand, and the audience's background and aims.
I've had discussions on this subject in the past, and I can't
help wondering if the different views people take come down
to the old "two cultures" of science and non-science/art.
Some people I know, for example, would hold that, say,
knowing in detail how a rainbow is formed would somehow
detract from being able to appreciate it simply for its
inherent beauty; whereas I would think that such
knowledge could only enhance your experience, certainly
not detract from it.
Interestingly, knowledge of computer programming gives you
a firm background in knowing when it useful to treat things
as a black box, and when it isn't.
As to the whether you need to know programming question
itself; it depends. To document end-user software, no, you
need to know how to use end-user software (and what your
reader will need to know about it). To document a programming
language or API, yes (and also what your reader will need to
know about it).
But then, I'm an ex software engineer who documents an API...
That's my 2 pence used up I guess...
Christopher Gooch, Technical Author
LightWork Design, Sheffield, UK.
chris -dot- gooch -at- lightworkdesign -dot- com www.lightworkdesign.com
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.
