Golden Rules for Technical Documentation

3-13-2013 11-06-54 AM

We have been working on some thoughts about what, how and why we are writing a document. We have come up with few golden rules, which help technical writers to deliver an informative and well-scripted document.

Always keep in mind technical writers Write to inform, not to impress!

Following are some of the golden rules, which each tech writer should follow:

Rule 1: Be Clear

Be clear in your content and think about the real objective of your content. Avoid using phrases and clichés that do not mean anything. Avoid proprietary words that may puzzle the audience and the end-users.

Rule 2: Be Brief

Try to avoid the stuffing contents such as welcome message or overly long instructional text for online forms. Cut your text in half and shorten paragraphs.

Rule 3: Be Creative

Try to be innovative, use a diverse way of representing message, other than paragraphs or texts. Instead of boring paragraphs of text and titles, use billboards, charts, and infographics. These might encourage users to stick with your document.

Step 4: Be Compelling

Know your audience, be excited, be confident, and be bold. Use words that resonate with your audience.

Rule 5: Mind Your Grammar and Spellings

Spellings and grammar distracts users from the message in the content. Always try to implement one idea per paragraph.

Rule 6: Use Templates

Usage of templates enables easier content development, easier gathering of content and makes content consistent.

Pay for quality documentation and your users will be happy. Carefully consider the document formatting, spelling and grammar.

logo_bw

  1. No trackbacks yet.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

%d bloggers like this: