Eric Caron
Nov 23, 2015 · 1 min read

James Yu, a co-founder of Parse, said:

Documentation is a layered beast.

Truer words are rarely spoken. And writing blog posts about how to write API documentation is almost as old as the idea of RESTful APIs (one we particularly appreciate is Braintree’s story.) While we’re very big fans of Swagger, sometimes interacting with an API isn’t enough to understand an API — so we have spent the last couple of months thinking about how to make our API documentation more successful.

Then we found Slate and fell in love. And if you’re looking at a solution that’s embraced by NASA, IBM and Mozilla, then you’ve probably found something pretty special.

We’re not done migrating all of our documentation to Slate, but that’s part of the fun. Last month, Mailjet talked about open sourcing their API documentation and we think that’s absolutely brilliant. So we’re open sourcing ours!

If you’d like to see the work in process, we have it up at https://bestbuyapis.github.io/api-documentation/. And if you’d like to get involved (or just watch us get it finished), you can follow along at https://github.com/BestBuyAPIs/api-documentation.

Isn’t open source awesome?

Best Buy Developers

Thoughts,musings and cool information about the Best Buy APIs program

Thanks to Leah DeBruycker and Best Buy APIs

Eric Caron

Written by

Best Buy Developers

Thoughts,musings and cool information about the Best Buy APIs program

Welcome to a place where words matter. On Medium, smart voices and original ideas take center stage - with no ads in sight. Watch
Follow all the topics you care about, and we’ll deliver the best stories for you to your homepage and inbox. Explore
Get unlimited access to the best stories on Medium — and support writers while you’re at it. Just $5/month. Upgrade