Technical Writing

Technical Writing Principles

Clarity

• Use Simple Language: Write at an 8th-grade reading level for general audiences
• Avoid Jargon: Define technical terms or use simpler alternatives
• Be Concise: Remove unnecessary words and filler content
• Use Active Voice: Active voice is clearer and more direct than passive voice
• One Idea per Sentence: Keep sentences focused and easy to understand

Accuracy

• Verify Facts: Double-check all technical information, code examples, and data
• Test Instructions: Follow documented steps to ensure they work
• Cite Sources: Attribute information to reliable sources
• Update Regularly: Keep documentation current with software changes
• Peer Review: Have subject matter experts review technical content

Completeness