Technical Writers’ Companion

Make reading your documents a positive experience. Write in a way that’s:

▪accurate and objective

▪informative and helpful

▪respectful and friendly

▪positive and reassuring

The key overall principles when writing user assistance are:

▪Keep it simple and stupid

▪Always start with the main point

▪Talk to the reader

▪Be specific

▪Be concise

▪Be consistent

▪Be parallel

▪Be positive

▪Use the present tense

▪Use the active voice

▪Don’t make judgments

▪Don’t say “please”