TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: Teaching others how to fish From:Writers Book Mall <steve -at- writersbookmall -dot- com> To:Melissa Nelson <melmis36 -at- hotmail -dot- com>, techwr-l -at- lists -dot- techwr-l -dot- com Date:Fri, 20 Jul 2007 08:09:51 -0700 (PDT)
Here's one I recall: a lot of my programmers, who were
not native English speakers, would ask me to make
updates to the error message table. This was the table
with all messages shown to users on screen and in
reports.
But what they would actually ask is for me to update
the *massage* table. So my tip was to explain the
difference. :)
I selected the tips based on actual problems that
seemed to recur, not general English usage from a
book. If you can tailor your tips, and your examples,
to your audience, that helps. People actually enjoyed
getting these, since they were bite-sized and
relevant.
--- Melissa Nelson <melmis36 -at- hotmail -dot- com> wrote:
> >"One way I've used in the past is to send out a
> short
> >tip every week based on common mistakes. People
> will
> >read a quick tip, especially if you can make it
> >interesting and light in tone."
>
>
> I like this idea, what types of tips do you include?
> Do you have a sample
> that you do not mind sharing?
>
> Melissa
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-