"An editor is someone who separates the wheat from the chaff - and then prints the chaff." Ronald D. Fuchs
Technical Writer Checklist
Use the following tips when you prepare technical documents. - Write for an intended audience.
- Use strong verbs.
- Avoid
jargon.
- Use design by incorporating labels and lists to increase reading ease.
- Use
ample white space.
- Explain your visuals.
- Use shorter sentences
for more technical information.
- Reduce passive voice.
Check out some of my favorite web sites for help with writing or practical tips to improve presentation skills.
Grammar and Writing: http: owl.english.purdue.edu
www.bbc.co.uk/skillwise/
Clever Quotes: www.brainyquotes.com
Communication/Email Tips: www.championshipcommunication.com
www.tips@peggyduncan.com
www.syntaxtraining.com
Advanced PowerPoint: www.thinkoutsidetheslide.com
Speaking Tips and Resources: www.wisconsinspeakers.com
Great Clipart and Photos: www.istock.com
|
Use
Gender Neutral Terms
Pay attention to gender when you write. It is risky business to make
judgments about gender. Rethink some of these outdated gender biased terms and replace them with the neutral form.
| Not Neutral | Neutral | | workman | worker | | repairman | service technician | | man-made | synthetic | | salesman | sales representative | | policeman | police officer | | gunman | shooter | | chairman | chair, chairperson, leader |
|