4 ms·
APIs don't live in a vacuum. Sorry, but you can't just ship a service that exposes an API and expect people to use it. It MUST be documented. And no, your auto-
by solatic 3y ago
APIs don't live in a vacuum. Sorry, but you can't just ship a service that exposes an API and expect people to use it. It MUST be documented. And no, your auto-generated Swagger/OpenAPI docs don't cut the mustard.
If, as an executive, you expect the teams you set up to actually be independent, then treat them like Product teams in their own right. Set expectations to write Product-quality documentation, at least as good as what you ship to customers. Hire internal Product managers for those teams, who will learn how internal customers use those APIs and what else they need to solve their problems. Hire internal Marketing to ensure everybody else knows that the APIs exist. Sound ridiculous? What, do you expect your Engineering teams to have these skillsets already? If you don't expect your company's product to succeed without Product and Marketing then why, pray tell, would you expect your internal products to be any different?
- nox101 3y agoWorst docs I've used recently are the chrome extension docs. They're auto generated and practically incomprehensible, to me.