Posts of interest to engineering managers.
The quality of API documentation is a key differentiator for API providers, and directly impacts both API adoption and satisfaction. To be competitive, your API documentation has to be really good. But what does that really mean? This post explains.
Why You Need One, and What It Is: The Ideal API Reference Read More »
Whether you’re playing poker or creating developer documentation, it’s always better to have an ideal hand. In poker, the ideal hand is a royal flush. In developer documentation, there’s also an ideal hand.
Poker and Developer Docs Read More »
Use this article as a checklist when creating documentation for software developers, and support every crucial stage of the developer experience.
The Ideal Documentation Suite for Software Developers Read More »
When interviewing technical writers, make sure you’re evaluating how well they’ll write at least as much, if not more, than the tool you want them to use.
It’s Not About the Tool Read More »
Expert Support has been a part of the SVELC for many years. This group regularly convenes dozens of local innovation leaders who understand that engineering leadership is a strategic competency.
Agile Improves Predictability: February Meeting of SV-ELC Read More »
Technical documents have a purpose. If you don’t understand the purpose of a document before you start writing it, you may deliver the wrong document. A document specification (doc spec) should define your document before you have a chance to get into trouble.
Quick and Easy Document Specifications Read More »
You have a new software tool project, and you know the finished product is going to need good documentation. What does that mean, and what’s it going to take? When should you get started working on the documentation, and how much of your team’s time will be taken up by it?
How to Work with a Tech Writer for the Best Results Read More »