Principles of effective technical writing

Effective technical writing is guided by a number of principles, often called the "Cs" of technical writing.

1. Clarity. The message should be easy to understand and have only one meaning. Use simple words, short sentences, defined terms and logical order.
2. Conciseness. Say what is needed in the fewest words. Remove repetition, wordy phrases and unnecessary details.
3. Accuracy. Facts, figures, units, names and calculations must be correct and checked, because errors in technical work can be costly or dangerous.
4. Completeness. Give all the information the reader needs: what, who, when, where, why and how, so that they can act without asking further questions.
5. Coherence. Ideas should be connected logically, with clear paragraphs, transitions and headings, so the document flows smoothly.
6. Correctness. Use correct grammar, spelling, punctuation and format. Mistakes reduce the writer's credibility.
7. Consistency. Keep the same terms, units, style, headings and formats throughout the document.
8. Concreteness. Use specific facts, numbers and examples instead of vague statements.
9. Courtesy. Use a polite, respectful tone with the reader's point of view in mind ("you-attitude").
10. Objectivity. Present facts without bias and avoid emotional or exaggerated language.
11. Audience and purpose awareness. Decide who will read the document and why, and select content, level and tone accordingly.
12. Effective design and visuals. Use headings, lists, tables, graphs and white space to make the document easy to read.

Together these principles make technical documents usable, reliable and professional.