Ask HN: What are the best documented developper tools?

#1

Post by hadri » Wed, May 27, 2015, 3:11 AM UTC

My company is in the process of writing developer facing documentation and I am trying to make a list of the best examples to take inspiration from.

Re: Ask HN: What are the best documented developper tools?

#2

Post by kanche » Wed, May 27, 2015, 4:01 AM UTC

If you are talking about company's internal developer facing documentations, they are not going to be on internet.

Some of the best product documentations there are:

https://stripe.com/docs/api

http://www.twilio.com/docs

https://docs.djangoproject.com

https://developers.google.com/maps/documentation/

http://docs.oracle.com/javase/7/docs/api/

https://parse.com/docs/ios/guide

Re: Ask HN: What are the best documented developper tools?

#3

Post by acrooks » Wed, May 27, 2015, 4:40 AM UTC

https://auth0.com/ provides some pretty incredible documentation (they also provide a great product; we use it to support authentication for our suite of corporate/enterprise-facing apps)

Re: Ask HN: What are the best documented developper tools?

#4

Post by codenut » Wed, May 27, 2015, 5:05 AM UTC

http://flask.pocoo.org/docs/0.10/

Re: Ask HN: What are the best documented developper tools?

#5

Post by hadri » Wed, May 27, 2015, 5:19 AM UTC

kanche wrote: post #2

If you are talking about company's internal developer facing documentations, they are not going to be on internet. Some of the best product documentations there are: https://stripe.com/docs/api http://www.twilio.com/docs https://docs.djangoproject.com https://developers.google.com/maps/documentation/ http://docs.oracle.com/javase/7/docs/api/ https://parse.com/docs/ios/guide

That's exactly the kind of list I was looking for. Thank you for understanding despite the lack of explanation.

Re: Ask HN: What are the best documented developper tools?

#6

Post by hadri » Wed, May 27, 2015, 5:22 AM UTC

acrooks wrote: post #3

https://auth0.com/ provides some pretty incredible documentation (they also provide a great product; we use it to support authentication for our suite of corporate/enterprise-facing apps)

The filtering options to get to the version of the doc you need are wonderful. Thanks!

Re: Ask HN: What are the best documented developper tools?

#7

Post by hadri » Wed, May 27, 2015, 5:39 AM UTC

codenut wrote: post #4

http://flask.pocoo.org/docs/0.10/

It's unusually wordy and I think it is great. I can't count how many times I scratched my head trying to figure out what some API calls were meant for and how they were meant to be used.