Re: Interesting site for software tech writers

Subject: Re: Interesting site for software tech writers
From: Goober Writer <gooberwriter -at- yahoo -dot- com>
To: "Guy K. Haas" <guy -at- hiskeyboard -dot- com>, TECHWR-L <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 9 Jan 2004 07:15:01 -0800 (PST)

> He advises the engineer-spec-writer to write
> informally and use humor.

Everything with a grain of salt...

> Humor may hold the attention of the reader, but is
> usually frowned upon
> in the documents TWs produce. Humor, if it does
> make it into a
> published manual, does not internationalize well.

Well, specs are usually seen as internal documents.

> What does YOUR organization say about humor?

I don't use it. It's not appropriate for the types of
applications I and my team document. But, if I was
writing video game manuals, humor would be in there
based on the type of game I'm documenting. (FWIW,
Simpsons Hit & Run is a fantastic game with a quick
and helpful manual, unlike other games that add too
much story and other crap in the manuals).

> Would it be easier or harder for you, as a writer,
> to translate from
> specs to manuals if the specs were written as Joel
> suggests?

Definitely harder. That's a fact, and I have my hand
over my crotch to prove it! ;)

=====
Goober Writer
(because life is too short to be inept)

"As soon as you hear the phrase "studies show",
immediately put a hand on your wallet and cover your groin."
-- Geoff Hart

We can't all be as creative with sigs as krautgrrl. ;-)

__________________________________
Do you Yahoo!?
Yahoo! Hotjobs: Enter the "Signing Bonus" Sweepstakes
http://hotjobs.sweepstakes.yahoo.com/signingbonus




References:
Re: Interesting site for software tech writers: From: Guy K. Haas

Previous by Author: RE: You know you're an incurable tech writer when...
Next by Author: Re: Giving TW help: Are we training our replacements?
Previous by Thread: Re: Interesting site for software tech writers
Next by Thread: Re: Interesting site for software tech writers


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


Sponsored Ads