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: Help on Procedure Writing From:TJ Alias <tom_the_techwriter -at- yahoo -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 6 Dec 2001 07:55:13 -0800 (PST)
Anila, et al.:
Technical writing isn't as simple as some of the
people on the list seem to be indicating. I can't
imagine trying to condense my education and experience
into a single e-mail message. I spent almost 2 of my
4 years in college learning the specific skills that I
use as a technical communicator. But it sounds like
you aren't asking for a single set of tips and
tricks...more like a starting place. Here are a
couple:
I would first go to the web site of a college or
university that offers a degree in technical
communication (off the top of my head: U of Minn,
Mich. Tech., Texas Tech, RPI) and find their course
guides or listings for a course that claims to be
teaching what you want to know. Find the list of
required texts for the course and order them from one
of the many online sources for books. I have a book
called Procedure Writing (which was one of my college
texts), but it is now fairly obsolete, so I suggest
that you find out what they're using now.
Next, if this assignment is a one-time kind of thing,
get the job done and move on; but if this is your new
job and you will be doing it full-time, I'd seriously
consider enrolling in at least a certificate course in
technical writing (there are many out there, including
some taught online, such as at the U of Minn.), if not
a degree program. With your background, you would
probably be admitted to a Master's degree program at
most of the schools that offer it.
Finally, don't worry about the software tools--they
are secondary to what's really important, which is
what you are asking about, the core writing and
communicating. Simply owning/knowing a particular
tool is only enough skill to make you dangerous. If
you want to be effective, learn the discipline of
technical communication. You'll learn the tools on the
job.
Good Luck!
TJ
>>>Message to which I am Responding>>>
Hi everyone
I am new to the field of Tech Writing. A graduate in
English literature, I have no background whatsoever in
tech writing or in any of the tools/technologies I see
mentioned in most of the messages posted here --
except for MS Word, MS Excel and to a certain extent
Framemaker.
I am in need of information on the following topics:
Writing User Manuals
Writing Online Help
By this I mean the the language, style and format to
be used in this kind of procedure writing. My company
does not require me to work with the different help
technologies as of yet. At present I am concerned
basically with the language part of it.
Please do let me know where to go for this kind of
information.
Thank you
Anila Alias
__________________________________________________
Do You Yahoo!?
Send your FREE holiday greetings online! http://greetings.yahoo.com
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of
your book. What are you waiting for? http://www.iuniverse.com/media/techwr
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
---
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.