Reference

Guidelines for writing great documentation

The following resources help you understand the standard conventions and best practices for writing technical documentation. These guidelines will help ensure that the feature document you submit is clear, accurate, easy to understand, and requires minimal editing before the content is used in the product

Fundamentals of technical writing

• A Beginner's Guide to Writing Documentation
• Documentation Principles
• Essentials of Technical Writing
• Creating Better Documentation
• Writing for an International Audience

Writing mechanics

• Markdown-material syntax
• Cheat sheet
• Spelling, Punctuation, and Grammar
• Using Commas: [Part One] and [Part Two]
• Hyphens and Dashes
• Commonly Confused Words
• Writing Tips

Additional reading material

• How users read on the web