Automatically generating documentation is a dream come true for developers looking to focus on the code instead of copywriting. It’s also a dream for end users, who get documentation that’s up-to-date and reliable.
Posts Tagged: docs
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
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
“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
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