Find out how your API docs rank, and get tips on how to improve!

Get Started
Created with Sketch. README TECH.
Created with Sketch.
%

Get your own free report! Find out how your API docs rank, and get tips on how to improve:

Rate My Docs
...
Average score
...
People have taken this
...
Your score

Learn more about your results

Code Samples

The first thing people look for on a page are examples. Don't lie... you do too! Nobody wants to assemble a code snippet from metadata. It's error-prone and tedious. When you give a customer just descriptions of how to use your API, it puts the burden on them to have to construct a code sample. Give your users something to copy and paste, and they'll love you for it!

Created with Sketch.
ReadMe can generate code snippets for you in a dozen languages! Don't worry about tediously writing and updating hundreds of code snippets, because we'll take care of it for you. Learn more

API SDK

Having an SDK simplifies things for your users. Rather than teaching them what headers to send, how to URL encode query params, and ways to base64 an API key to use as auth, you can do the heavy lifting and hide away the complexity. You can still expose the URLs and documentation to anyone daring enough to use it, but SDKs make your API easy for anyone to use.

Try It Now

Show, don't tell! By letting people play around with your API right in the documentation, they'll understand exactly how to use your API and have the confidence to make calls on their own. Rather than reading details on how your API works, they can see it in actions, and quickly understand what data goes and and what data comes out.

Created with Sketch.
If you describe your API in ReadMe, your users will get a module where they can try out their own queries. Once they're happy, they can copy an auto-generated code snippet in their language! Learn more

API Keys Inline

Your docs should know who your users are. Don't hide your API keys away in a dashboard. Nobody wants to go hunting around for authentication details.

Created with Sketch.
Readme makes it easy to include API keys and other variables right in the documentation. Your users won't need to go hunting anymore. Learn more

Separate Guides and Reference Docs

Reference docs are great, but they don't paint the full picture. They're like handing someone a dictionary and telling them to learn a language. Users should spend most of their time reading through topical guides and examples, with the reference guides being the last place the user goes.

Created with Sketch.
On ReadMe, there's a separate section for all the types of documentation you have! Learn more

Support Forums

Support forums are the wild-west of documentation! They let you document hundreds of edge cases without distracting people in the regular docs. Make your support public and searchable, and users will solve their problems quickly!

Created with Sketch.
Our support forums are hosted the same place as you docs, so they're integrated with search and your users. Learn more

Changelog

If your API changes, make sure you document it clearly in a place where people can follow along.

Created with Sketch.
ReadMe has a blog feature that makes it easy to post announcements and changelogs. Learn more

Docs for old version

Not everyone is using the most recent version of your API or code library! You should keep old versions of your docs online somewhere.

Created with Sketch.
With ReadMe, you can keep old versions of your docs available for anyone on a previous version of your API. Learn more

Custom branding

An API is the best bizdev hire you can make, so it should feel like your brand. Make sure your docs deliver a consistent look and feel.

Created with Sketch.
ReadMe is flexible! You can make it seamlessly look just like the rest of your site. Learn more

Auto-Generated From Code

It's so easy for your documentation to get out of sync. The best way to keep it in sync is to generate documentation directly from the code, making it almost impossible for it to fall behind.

Created with Sketch.
With ReadMe, you can auto-generate docs right from your API. It can be added to your build script each time you deploy. Learn more

API Specification Format

Having one source of truth for your API documentation helps reduce bugs! With a Swagger (or similar) file, you can design your API, mock responses, generate docs, run tests, and more. Having a common language for describing APIs will make tooling much easier to use, and will change how we make and consume APIs.

Created with Sketch.
ReadMe supports Swagger, making it easy to create beautiful docs in minutes. Learn more

Do you have code samples?
Created with Sketch.
Do you have an API SDK?
Created with Sketch.
Can users play around with your API right in your documentation?
Created with Sketch.
Do you show your user's API keys in the documentation?
Created with Sketch.
Do you have separate sections for guides and reference docs?
Created with Sketch.
Which of the following do you have?
Created with Sketch.
Next
Is your API documentation generated from your code?
Created with Sketch.
Do you use an API specification format?
Created with Sketch.
What's the URL for your docs?
Created with Sketch.
What's your email address?
Created with Sketch.

Want to get your results and learn more about how to improve your docs?

Next