🚀 go-pugleaf

RetroBBS NetNews Server

Inspired by RockSolid Light RIP Retro Guy

Article View: misc.writing
Article #1495

Re: Tech Writing Courses - what's in them?

#1495
From: Henrik M�rtensson
Date: Fri, 31 Jan 1997 00:00
79 lines
3170 bytes


Robert Chao wrote:

> Some people have suggested that I take a tech writing course.
My question is,
> what does one learn in a tech writing course besides:
> 1) how to write well in general, which I already know;

You would learn how to write good technical documentation, which
is very different from writing well in general. To be more
specific, the course might teach:

* structure and layout
* use of headings
* style
* graphic presentation techniques
* markup strategies
* project management

just to name a few topics. There are many, many others, and a
single course would not cover them all.


> 2) how to use an advanced word processor like FrameMaker ?

Depending on what kind of course you take, they might teach you
about other document production systems, SGML, information
retrieval systems, archiving systems, etc.

> Also, what is the starting salary for a tech writer for a
mid-size company?
> I have heard it is about $35,000/year. I work as a word
processor and make
> about $31,000/year. This is because I work for a huge
accounting company. I
> have two college degrees and word processing is boring.

Gee, I have MS Word, WordPerfect, and a bunch of other word
processors, but none of them has even a single college degree.
:-)

Your guess about pay rates is better than mine. I live on another
continent, so what I make wouldn't be applicable. Besides, pay
rates vary widely (at least where I live). If you are any good at
DTD design, writing retrieval engines for SGML databases, and
stuff like that, you could get a lot more than the average
technical writer.

> If you took a good tech writing course, what books would be
used?

I do not know, but I do know a few books I would read if I wanted
to learn the ropes on my own:

Effective Writing, by C. Turk and J. Kirkman, ISBN 0-419-14660-1
This one requires some stamina to get through, but contains a lot
of good advice.

How to Write Usable User Documentation, E. H. Weiss, ISBN
0-89774-639-2
This one is good, despite the mistake in the Fog index formula on
page 151. It may get you into trouble though, because most
technical writers haven't heard of the ideas presented in the
book. Try to use them, and you might be considered a bit outr�.

The Elements of Style, W. Strunk and E.B. White, ISBN
0-205-19158-4
You probably know about this one already. If you don't have it,
get it, read it, sleep with it under your pillow. When you wake,
read it again. (It is only 85 pages.)

Those three are a start.


I hope this tells you what you want to know.

/Henrik
Technical Details
Message-ID: <01bc0fc0$326134a0$337af482@NONE.nic.swip.net>
Path: arc1-ca.pugleaf.net!unknown!not-for-mail
References: <rchaoE4v1E3.3r4@netcom.com>

Show Full Headers
Complete Article Headers
X-Google-Language: ENGLISH,ASCII
X-Google-Thread: 101fb9,bb628c45f21b628
X-Google-Attributes: gid101fb9,public
X-Google-Thread: fee76,bb628c45f21b628
X-Google-Attributes: gidfee76,public
From: "Henrik M�rtensson" <henrik.martensson@swipnet.se>
Subject: Re: Tech Writing Courses - what's in them?
Date: 1997/01/31
Message-ID: <01bc0fc0$326134a0$337af482@NONE.nic.swip.net>
X-Deja-AN: 213544235
references: <rchaoE4v1E3.3r4@netcom.com>
organization: HM MediaTech
newsgroups: misc.writing,ba.jobs.misc
nntp-posting-user: s-221879