Re: HELP! Software Jockeys vs. Real Tech Writers

Subject: Re: HELP! Software Jockeys vs. Real Tech Writers
From: Mark Wilden <Mark -at- MWILDEN -dot- COM>
Date: Sat, 27 Sep 1997 20:23:22 -0700

> From: Matt Ion <soundy -at- rogers -dot- wave -dot- ca>
>
> My first thought is to teach them through example. Get copies of the
> best, most well-produced documentation you can find, and of the worst,
> most hideous, painful, confusing documentation you can (a really thin
> motherboard manual poorly translated from an Asian language will serve
> well, in my experience). Explain to them the the good manual had actual
> TECHNICAL WRITERS working on it. The bad one didn't.

That sounds like a great idea.

> An even better example of the second would something with good pictures,
> nice graphic layout, but really crappy, confusing writing. You could
> then readily point out the difference between a manual done by someone
> who knows word processing, and someone who is a real TECH WRITER.

That, however, sounds dangerous. :) They're likely just to look at the
pretty pictures and not even take the time to evaluate the writing.

TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html


Previous by Author: Re: File ownership
Next by Author: Re: display/appear
Previous by Thread: Re: newbie help on pagemaker to html pc/mac
Next by Thread: HELP! Software Jockeys vs. Real Tech Writers


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


Sponsored Ads