Re: If You Were Gonna Teach...

Subject: Re: If You Were Gonna Teach...
From: "Karen E. Black" <kblack_text -at- hotmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 07 Mar 2002 11:35:37 -0500

1. If the material your contributors produce is going to be collected and reformatted by a writer, tell them not to write paragraphs or even complete sentences.

* Bullets points are good
* Much easier to understand
* Keeps them from the hidden pitfalls of grammar

2. Create some doc templates for guides and spend the class teaching them how to use the templates. The more detailed the templates the better. Headings and sub-headings serve to remind them of what they need to include. A whole bunch of "N/A"s under headings is better than missing chunks of detail because a heading was missing.

3. Pizza is OK, sandwiches and fruit/veggie plates are better.

From: Tom Murrell <trmurrell -at- yahoo -dot- com>
But what
I'm really interested in are the four or five things that you would like to see
your contributors stop doing or do better that would improve both document
writing (Requirements, Designs, etc.) and even email communications.

Chat with friends online, try MSN Messenger:

Check it out! Get some cool freebies when you buy RoboHelp! You'll receive
SnagIt screen capture software and a 10% discount voucher for RoboHelp
Consulting. This special offers expires March 29, 2002.

Have you looked at the new content on TECHWR-L lately?
See and check it out.

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 for more resources and info.

Previous by Author: Re: New TECHWR-L Poll Question
Next by Author: Re: Occupational hazard - carpal tunnel
Previous by Thread: Re: If You Were Gonna Teach...
Next by Thread: Re: If you were gonna teach...

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

Sponsored Ads

Sponsored Ads