Posts Tagged: api documentation

5 Examples of Excellent API Documentation (and Why We Think So)

If you’ve been spending much time on the Nordic APIs blog, you’ll know that developer experience is something we’re passionate about. Creating a smooth and enjoyable experience for those implementing your APIs is essential with just how much competition there is nowadays, and API documentation is one of the keys to success. Read more

8 Tiny API Docs Tweaks That Deliver Big On DX

Creating brilliant API documentation can be tricky. It’s something of a balancing act: curating the essential information developers need to get started quickly, while still fleshing out other, more complicated topics in detail. But what if you could improve the developer experience for users across the board with just a few simple tweaks? Read more

How Bad Developer Portals Kill APIs

“Reference docs do not constitute developer portals.”

This was the crux of a talk given by Nordic APIs veteran and Pronovix CEO Kristof Van Tomme at our 2017 Platform Summit. His opinion is that developer portals should function as self-service hubs for APIs, allowing developers to access APIs without having to wait around for access keys or any additional information. Read more

7 Items No API Documentation Can Live Without

Web APIs are highly variable things – they can be custom-built, designed around a single purpose, all-encompassing, and almost everything in between. Shifting requirements dictate what the interface is comprised of. Due to this, it’s hard to find commonalities between APIs and their user-facing portals. Read more

How to Optimize Developer Experience for Your API

Programming can be tough, especially when you’re starting out with a new language or trying to interact with a new API. It’s as if there are an endless number of strange procedures and functions with names you’ve never heard before, and all warranting special syntax. Read more