How to Create Documentation that Engineers Love

I've learned a few best practices on writing documentation during my time at Netflix, Uber and Microsoft that I wanted to share in my latest article. If you are an engineer that's curious about how they can better structure their documentation pages, you might want to check it out:

https://devtoolmarketing.com/how-to-write-documentation-that-engineers-love/

Here's a summary -

Great documentation starts with a great structure. A complete documentation site should have the following categories:

• Product Overview
• Getting Started Guide
• Use Case Guides
• Reference Material
• Troubleshooting Guide

This top level categorization allows engineers to quickly find what they need and get back to work.

If you want to learn more about each of the categories, you can read more about it in my article.