Re: Writing clearly

[Tony Chung <tonyc -at- tonychung -dot- ca>]

Hints for your guide:

1. Use controlled vocabulary. Avoid using the same word differently.

2. Write to a Grade 8 reading level. Short sentences, bullet points,
and serial commas aid information processing.

3. Demonstrate the difference between Concept, Reference, and Task
topic. Explain what goes where, and when.

4. Avoid semicolons, or use them properly.

5. Know the difference between verbs in participle form and gerunds nouns.

6. Start task sentences with a verb.

7. Use one verb instead of two: Decide—Don't make a decision.

8. Know the difference between em dashes—which suggest interruption,
and en dashes that denote a range between numbers like 20 – 40.

9. "Leave my like alone": Listen to the song on
http://www.patpattison.com/patssongs/

and finally, (but not completely),

10. Always refer to a product by its proper name. That is, don't refer
to the 'Windoze' operating system unless you wish to be subjected to
ridicule (especially on this list—although
http://www.techwr-l.com/archives/0912/techwhirl-0912-00098.html may
have been a one-off occurrence.)

Cheers,

-Tony
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Gain access to everything you need to create and publish documentation, 
manuals, and other information through multiple channels. Choose 
authoring (and import) as well as virtually any output you may need. 
http://www.doctohelp.com/


 - Use this space to communicate with TECHWR-L readers - 
   - Contact admin -at- techwr-l -dot- com for more information - 


---
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. 

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat