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.
> I agree that being a technically savvy tech writer IS
> helpful, but it is certainly not required. The whole
> idea of being a tech writer, IMHO, is that you don't
> HAVE to know all that technical stuff. You know enough
> to get the gist of things, ask intelligent questions,
> and figure it out.
One of the most common criticisms I hear about the "content-centric"
documentation theories is:
"How can I be an expert in all possible areas? That's impossible." or "How can
a class teach all possible technologies to students. Thats impossible."
My answer has always been, you don't have to know all technologies. You merely
need intellectual tools to handle complex information. Tools that most (if not
all) tech writing programs in universities do not teach.
The problem isn't knowing all technologies. Its knowing how to approach complex
systems intelligently. How to analyze information, ask questions, discover
patterns, and explain complexity. So many tech writing programs focus on the
"language" element of tech writing. While language is an integral part, you
can't use language effectively until your mind understands.
Consider the example:
"Make sure to reinitialize the fang housing before the ramistat gorhunkinator
is fully dexterous."
That sure sounds impressive, but its meaningless. We know that merely because I
used words that are clearly nonsense.
Language is merely a media. A way to communicate. Good documentation does more
than merely communicate. It communicates the correct information. If you don't
know what to write, having the ability to write effectively does you no good.
Too many writing programs are dominated by people fascinated with language who
have minimal interest in information. This creates a skewed view of what tech
writers do. They come out of these programs thinking that mere mastery of
language will enable them to write documentation. These people often lack the
basic skills of technical analysis.
I agree, with Chris' idea of throwing people into something and letting them
flounder as an excellent method to teach. In my experience, people in confusion
do one of two things:
1. Attack the problem intellectually.
2. Attack the problem emotionally.
The first group are destined for great technical writing. They use their minds
rather then their hearts to guide them through the chaos. This usually results
in some kind of categorization and deconstruction of the components.
The second group cannot separate the information from their need to express
themselves. To them, the act of expressing an idea is personal not
intellectual. They need the attention or satisfaction of seeing their ideas be
accepted. These people want somebody else to do the "hard thinking." They want
to focus on the "gray" areas where creative expression is allowed. These people
generally make terrible technical writers as the process of writing is far too
personal for them.
> I don't quite agree. But then again, I don't know the
> big picture goals of this course. I think most
> technical knowledge is learned on the job. But I say
> that because that's how I learned mine.
While it is true that the "true" content knowledge will be learned on the job,
the tools necessary to adequately acquire that knowledge are often lacking.
For example, there are numerous writers out there who do not comprehend basic
logic. If A and B, then C kind of stuff. To me, anybody who wants to work in a
technical field should be forced to take a basic logic course. Most technology
boils down to simple logic arguments.
The process of "asking intelligent questions" is knowing how to analyze
information. There are far to many writers who avoid the icky and often
mentally taxing aspect of figuring out technology in favor of obsessing over
language and perceived problems with "readability."
Andrew Plato
__________________________________________________
Do You Yahoo!?
Yahoo! Auctions - buy the things you want at great prices http://auctions.yahoo.com/
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
Sponsored by Information Mapping, Inc., a professional services firm
specializing in Knowledge Management and e-content solutions. See http://www.infomap.com or 800-463-6627 for more about our solutions.
---
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.
