Posts Tagged: documentation

5 Frequent Developer Community Mistakes (And How To Fix Them)

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

The End of API Documentation As We Know It

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

5 Ways the OpenAPI Specification Spurs API Agility

OpenAPI Specification can be used to secure and accelerate the API lifecycle.

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

3 Ways to Organize Your API Developer Docs

Designing and writing good API documentation can be a daunting task, but is critical for any API-driven or B2D (Business 2 Developer) company to ensure developer success. Your documentation is also your company’s marketing asset and may be the first few pages a new prospect visits to assess how difficult your integration is and how the product works. Read more

Standard API Definitions Demystified

As with any industry, the web API space faces different approaches to standardization. Not least of which are the differences between how API providers choose to define their APIs in a machine readable way with API specifications and description languages.

API definitions have emerged as ways to annotate API functionalities, and there are still many out there catering to varying web service architectures. Read more