Five API Documentation Mistakes That Drive Developers Crazy (And How to Fix Them)
Good documentation lowers the barrier to adoption. Bad docs send developers straight to a competitor. Here are the five mistakes I see most often.
Read more →Technical writing insights, API documentation deep dives, and practical advice for writers working at the intersection of language and technology. · RSS Feed
Good documentation lowers the barrier to adoption. Bad docs send developers straight to a competitor. Here are the five mistakes I see most often.
Read more →
The challenge of working with engineers isn't a knowledge gap problem. It's a communication problem. And communication problems are fixable.
Read more →
Docs-as-code isn't a specific tool — it's a philosophy about how documentation should live and move through an organization. Here's what it means in practice.
Read more →
AI APIs are a different animal. The usual documentation playbook gets you 60% of the way there. Here's what to do about the other 40%.
Read more →
After decades of technical writing, I'm bringing my thoughts on API documentation, AI tools, and the craft of technical communication to haletha.com.
Read more →