RE: Am I qualified to be a Technical Writer based on my knowledge ?

Subject: RE: Am I qualified to be a Technical Writer based on my knowledge ?
From: Logan Jackman <techscrivener -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 27 Feb 2003 15:45:01 -0800 (PST)


Obviously, "writing about software" comprises many
types of documentation. Some documentation requires
great knowledge; other documentation requires not so
much.

For example, if you are documenting how the Subaru
Telescope in Hawaii functions, you will need a great
deal of knowledge of mirrors, magnetic driving
systems, astronomy, and other disciplines. If,
however, you are creating online help for systems like
the machine that dispenses prepaid theater tickets at
the box office, you don't need a whole lot of prior
knowledge.

One kind of software writing is not "better" than
another, just different.

Of course, a systems developer will know everything
about the system that is being developed. However,
developers often write text that is unclear even to
their close coworkers, although it might contain all
the necessary information. So, sometimes the choice is
whether to have the SMEs write an unintelligible
deliverable that is unusable or to have a tech writer
unfamiliar with that particular technology work
closely with the SMEs.

Logan



__________________________________________________
Do you Yahoo!?
Yahoo! Tax Center - forms, calculators, tips, more
http://taxes.yahoo.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.



Previous by Author: RE: Why they don't ask for candidates by technology skills.
Next by Author: Re: Three error message style ideas Re: Style guide for error messages?
Previous by Thread: RE: Am I qualified to be a Technical Writer based on my knowledge ?
Next by Thread: Re: Am I qualified to be a Technical Writer based on my knowledge?


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


Sponsored Ads