Documentation will set you free – this is a mantra often delivered by experienced developers, and it bears repeating whenever the value of documentation is discussed. Simply put, documentation is perhaps one of the most important elements of effective API developer communication, second only to active demonstrations, tutorials, and other interactive systems. Read more
Posts Tagged: documentation
One of the hardest things to do as an API provider is to work within the enterprise environment. This is due, in large part, to the very nature of enterprise structures – often slow to adopt new technologies, fundamentally distrustful of external solutions, and far more insular than most modern corporations would like to admit. Read more
We’ve been in the API game for a little while now, and we’ve seen our fair share of compelling developer communities being cultivated. On the flipside, we’ve also seen some epic fails. At our 2016 Platform Summit, Shayne Parmelee, developer experience lead at Shopify, talked about some of his own successes (and failures) during his time with the company. Read more
On the one hand, having proper API documentation can be a sign of early success for an API provider, allowing new users to effectively understand the functionalities and caveats behind an API solution.
On the other hand, extensive documentation could indicate an overly complex solution with far too many variables to navigate. Read more
The API lifecycle is a topic of much discussion — and rightfully so. The API space is agile, ever changing, and its participants must continually meet the shifting kaleidoscope of user needs and demands. Read more