Twilio, Stripe, Parse, Sendgrid, Mailgun are examples of companies with good documentation.
Generally, I like to see a high-level overview of the API, authentication scheme, endpoints, sample request and response, error code explanations, and sample code coverage in multiple languages. I wrote a blog post on this topic:
Much obliged for that. We still have a lot of work still here at Twilio to do around our documentation - appreciate the vote of confidence. Some of the stuff the DevX team is working on right now has me really excited.
Hope you'll share what you think when we release it.
Comments
Twilio, Stripe, Parse, Sendgrid, Mailgun are examples of companies with good documentation.
Generally, I like to see a high-level overview of the API, authentication scheme, endpoints, sample request and response, error code explanations, and sample code coverage in multiple languages. I wrote a blog post on this topic:
http://murtza.org/creating-a-great-developer-experience/
Much obliged for that. We still have a lot of work still here at Twilio to do around our documentation - appreciate the vote of confidence. Some of the stuff the DevX team is working on right now has me really excited.
Hope you'll share what you think when we release it.
I'd add BlockScore to that list:
https://manage.blockscore.com/docs/index