Ifyou write API documentation and need to learn some examples, here, I gather some great ones.

GitHub API Documentation

Github’s docs are minimalistic, the team isn’t trying to put too much information on one page. They provide a simple menu at the top-right with links to reference material, guides, and libraries, and then it’s down to well-ordered articles. Moreover, to make documentation more vivid, they add some jokes.

They also have a version selector to provide you with the relevant information.

Stripe API Reference

The Stripe team did their best — documentation features a sleek and great two-panel design, with explanations written in plain English on the left and handy code snippets on the right. So, you can read a code and explanation without scrolling constantly that makes reading effective.

Moreover, all the information you need to get started, presented cleanly and sensibly.

Dropbox API Documentation

The specificity of this API documentation is that you can choose a necessary language and get relevant information. The Dropbox documentation is great thanks for its simplicity- they don’t bombard you with the wall of information, you can get just what you want.

Twitter API Documentation

Twilio Docs

The Twilio Docs use the same, two-panel style as the Stripe API Reference. However, Twilio’s API documentation feels a little easier to read since they use well-chosen fonts and bright, contrasting links. Code is highlighted on the other panel with a dark background, so it’s easier to distinguish text and code. It makes topics more obvious.


 

 

 

Written by
Ann Green
Content Manager at ClickHelp. In my blog, I write about technical writing.

 

 

 

 

 

 

 

 

 

 

 

Show Buttons
Hide Buttons

Si continuas utilizando este sitio aceptas el uso de cookies. más información

Los ajustes de cookies de esta web están configurados para "permitir cookies" y así ofrecerte la mejor experiencia de navegación posible. Si sigues utilizando esta web sin cambiar tus ajustes de cookies o haces clic en "Aceptar" estarás dando tu consentimiento a esto.

Cerrar