Re: What do you guys think of STCs new definition for technicalwriter?

["Bill Swallow" <techcommdood -at- gmail -dot- com>]

And if you can't explain it in the simplest of terms then what good is
the definition in the first place?

And to use the "daddy writes books" example, how many books about
careers have you read to your kids over the years? How many books
about scientists, doctors, and other more complex fields? They're not
in depth, they don't use big words, and yet they get the definition
across well to their audience - kids.

I'm not saying let's go out and write a children's book, but if the
definition isn't easy to write in plain common language, then it
doesn't work.

Funny, don't we say the same thing about bad UI design? If it's a pain
to document, then it's likely poorly designed?

On Tue, May 27, 2008 at 1:58 PM, Sean Brierley <sbrierley -at- accu-time -dot- com> wrote:
> To be fair, this needs to be more than "daddy writes books." <grin>
>
> That is, I am fine writing this for a professional audience, but the
> definition itself must itself be a *good* example of technical
> communication.

-- 
Bill Swallow
HATT List Owner
WWP-Users List Owner
Senior Member STC, TechValley Chapter
STC Single-Sourcing SIG Manager
http://techcommdood.blogspot.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or 
printed documentation. Features include support for Windows Vista & 2007 
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot- 

To unsubscribe send a blank email to 
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/ for more resources and info.