Re: The Technical Writing Field

Subject: Re: The Technical Writing Field
From: "Simon North" <north -at- synopsys -dot- COM>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 28 Jun 2001 13:13:47 +0200


> Must be able to interpret technical information and write clear
> documentation (does this mean strictly technical manuals and books and
> such, or does the term go beyond that definition?)

At its worst, it means that you'll be given copies of the engineering
specifications and be expected to write the documentation from
that. IMNSHO, a good tech writer should be able to glean a lot of
useful information from specs, especially in the software industry.

> Experience developing and managing documentation repositories (I have
> no idea ...)

At its simplest, a 'documentation repository' is just a glorified
revision control system/database. It's a pretty vague term though
as it could mean anything from a sophisticated system where
paragraphs, or even single sentences, are stored and then retrieved
to construct composite documentation, to a basic check in/check
out document management system.

> and web development is a plus (are technical writers also
> web designers?).

I think most of us are, or have been involved with some form of 'web
development' in the sense of producing "content", and I'd guess
that this would be considered to be a pretty normal task for a tech
writer these days.

I think fewer of us have done "real" web development in the sense
of code development. I know quite a few tech writers who can hack
code, but not many who could really handle the task of coding for a
web site. Though, to be honest, I've met a lot of "web developers"
who don't have clue either. I'd say this kind of skill would be a nice
bonus, but isn't what you'd call a "mainstream" tech writer's job.

Even fewer of us have real experience of designing, building and
running web sites. Others may disagree, of course, but I really
think this lies outside the scope of a 'normal' tech writer. This isn't
to say it doesn't happen though; there are some smaller
companies with smaller webs sites that can be, and are, totally
controlled by the tech writer (been there, done that).

Simon North


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

*** 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 Cub Lea, specialist in low-cost outsourced development
and documentation. Overload and time-sensitive jobs at exceptional
rates. Unique free gifts for all visitors to http://www.cublea.com

---
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.


References:
The Technical Writing Field: From: george . m . hook

Previous by Author: Re: No Notepad
Next by Author: Re: Contracting: project duration estimation
Previous by Thread: The Technical Writing Field
Next by Thread: Re: The Technical Writing Field


What this post helpful? Share it with friends and colleagues:


Sponsored Ads