Technical Writing: 10 Mistakes you don't wanna make
secretGeek .:dotnuts about dotnet:.
home .: about .: sign up .: sitemap .: secretGeek RSS

Technical Writing: 10 Mistakes you don't wanna make

These are not the most common mistakes -- but they may be the nastiest.

  1. Avoid personal pronouns, and reminiscence:
  2. Avoid stale or dated metaphors:
  3. Beware of similes:
  4. Avoid Florid Speech:
  5. Avoid religious topics:
  6. Don't assume your reader to be technically ignorant:
  7. Avoid offensive pronouns:
  8. Avoid Personalization (anthropomorphism) :
  9. Cut overlarge words; break over-long sentences:
  10. Avoid the "not un-" construct (this example courtesy of Orwell) :

Actually, I quite like a few of those... Particular metphors and similes...


Add or view comments about this page

Articles

4 Types of Person (a guide to stupidity) 4 Types of Person (a guide to stupidity)
baby steps in microsoft robotics studio... baby steps in microsoft robotics studio...
Hang in there, little buddy Hang in there, little buddy
Worst. Bug. Ever. Worst. Bug. Ever.
IT Industry Revolutionised By Labour Saving Device IT Industry Revolutionised By Labour Saving Device
An Open, Federated Award Ceremony An Open, Federated Award Ceremony
3 differences between 'Small Business' and 'Enterprise' 3 differences between 'Small Business' and 'Enterprise'
How important is the problem of whether or not P=NP? How important is the problem of whether or not P=NP?
TimeSnapper hits the local press... and more on Iceland TimeSnapper hits the local press... and more on Iceland
MVC Zen Garden MVC Zen Garden
Is Corporate IT a form of emotional abuse? Is Corporate IT a form of emotional abuse?
Java Powered Internet? WTF? Java Powered Internet? WTF?
Life is Upstream Life is Upstream
TimeSnapper 3.3, and News From Iceland TimeSnapper 3.3, and News From Iceland
Growing Up Geek (A Hanselmeme) Growing Up Geek (A Hanselmeme)
Is that all you've got!? Is that all you've got!?
TimeSnapper 3.2: What are you afraid of? TimeSnapper 3.2: What are you afraid of?
Babbage and Boole! Babbage and Boole!
Downloadable Slide-decks: Downloadable Slide-decks: "Build your own Tiny Software Company"/"F# eye for the C# guy"
Simple Trouble Shooting Application Now Fixes Everything Simple Trouble Shooting Application Now Fixes Everything
a simple checklist for trouble-shooting regular problems a simple checklist for trouble-shooting regular problems
secretGeek at Tech-Ed: secretGeek at Tech-Ed: "How to build your own Tiny Software Company"
Bambrick versus Hanselman: Bring it! Bambrick versus Hanselman: Bring it!

Archives .: secretGeek :: Complete Archives
TimeSnapper -- Automated Screenshot Journal TimeSnapper.com    
Version 3.3: true productivity boost

Next Action NextAction
Managing the top of your mind

World's Simplest Code Generator (html edition) World's Simplest Code Generator
25 steps for building a Micro-ISV 25 steps for building a Micro-ISV
3 minute guides -- babysteps in new technologies: powershell, JSON, watir, F# 3 Minute Guide Series
Top 10 SecretGeek articles Top 10 SecretGeek articles
ShinyPower (help with Powershell) ShinyPower
Now at CodePlex

Gradient Maker -- a tool for making background images that blend from one colour to another. Forget photoshop, this is the bomb. Gradient Maker


[powered by Google] 


How to be depressed How to be depressed
You are not inadequate.



Recommended Reading

The Best Software Writing I
The Business Of Software (Eric Sink)

Recommended blogs

Jeff Atwood
Reginald Braithwaite
Joseph Cooney
Phil Haack
Scott Hanselman
Julia Lerman
Joel Pobar
Eric Sink
Joel Spolsky
Des Traynor

Aggregated Links

programming.reddit.com
dzone
dot net kicks

Human Link Machines

interesting finds
a continuous learner's weblog
arjan's world
n links today
new and notable
morning coffee
learning .net
weekly link post
(my del.icio.us account)

LinkedIn profile
home .: about .: sign up .: sitemap .: secretGeek RSS .: © Leon Bambrick 2003 .: privacy

home .: about .: sign up .: sitemap .: RSS .: © Leon Bambrick 2003 .: privacy