Skip to main content

APIs & API Documentation

Whether you're documenting an existing API, or creating documentation for a new API as it's being developed, it can be hard to know how to get started. We're here to help, with insight from our team and industry professionals on the do's, don't's, and must-haves for your documentation.

APIs 101

Get started on your documentation journey with our 101-level guides, explaining everything from the history of APIs to the basics of what API documentation is, why it's important, and how to write it.

What is API Documentation (and Do You Really Need It?)
6 min read

What is API Documentation (and Do You Really Need It?)

Ever tried to put together a complex piece of furniture without the instructions? We all know that’s typically a recipe for disaster. But that’s exactly what some companies expect developers to do, when they have API documentation that’s hard to find, poorly maintained, or difficult to understand…or worse yet, don’t have any API documentation at all 😱 As Ruben Vermeersch…

How to Write API Documentation Everyone Can Read
7 min read

How to Write API Documentation Everyone Can Read

Starting your API documentation can be a daunting task. Whether you’re learning the ropes for the first time, looking for a refresher course, or want to improve your existing docs, we’re here to share our best practices and tips for writing it, along with the pitfalls to avoid. Let’s get started 💪 The goal of API documentation 🌟 Before we…

7 Best Practices for Writing and Updating API Docs
7 min read

7 Best Practices for Writing and Updating API Docs

Developers respect clean, simple code. We have to be experts at finding ways to do more with less. And while that skill set is highly valued in development, it doesn't always transfer over to writing great documentation. API documentation has to be more than the bare necessities of methods and endpoints. It needs examples, summaries, and fleshed out explanations. Unlike…

Behind the Docs

Learn from industry professionals about precisely what goes into API documentation, how to improve your team's documentation workflow, and more.

API Workflow Automation with Josue Negron
11 min read

API Workflow Automation with Josue Negron

From high school entrepreneur to his current position, Josue Negron has been working in tech for most of his life. As a Senior Principal Product Solutions Architect in the R&D organization at OneTrust, his first priority after being hired was to improve their API documentation and developer experience.  Today, he's something of a product manager for their DX, working closely…

Technical Writing for APIs: Q&A with Beth Favini, Director of Product Documentation at Couchbase
6 min read

Technical Writing for APIs: Q&A with Beth Favini, Director of Product Documentation at Couchbase

At ReadMe, we think a lot about creating a great experience for developers building with our customers’ APIs. But we care a lot about the folks responsible for those APIs, too! Behind the scenes of every developer hub, there’s a team of engineers, product managers, and technical writers who make the magic happen ✨ Today, we’re excited to show off…

DriveWealth’s Justin Jenkins on DX & Improving Your Docs
4 min read

DriveWealth’s Justin Jenkins on DX & Improving Your Docs

At ReadMe, we think a lot about creating a great experience for the developers that are building with our customers’ APIs. But we care a lot about the folks responsible for those APIs, too! Behind the scenes of every developer hub, there’s a team of engineers, product managers, and technical writers who make the magic happen ✨ Today, we're talking…