Ask HN: What are examples of good dev docs?

3 points by ibn-python 5 years ago | 5 comments

Have an opportunity to provide input on my company's api documentation. What are some of your favorite examples of docs done well?

ldng 5 years ago |

Django is, IMHO, one of the best in both its content and structure.

Here is an enlightning talk about the structure : https://www.youtube.com/watch?v=azf6yzuJt54

jdbowman 5 years ago |

What sort of API is it? Web-based (as in REST or GraphQL)? Or software libraries? Curious the language, in that case...

ibn-python 5 years ago | |

REST

jdbowman 5 years ago | | |

A few that impress me: - Github: https://docs.github.com/en/rest/guides/getting-started-with-... - Twilio: https://www.twilio.com/docs/usage/api - Stripe: https://stripe.com/docs/api

You may also appreciate reading Swagger's tips: https://swagger.io/blog/api-documentation/best-practices-in-... and reading up on Swagger in general.

michannne 5 years ago |

Tensorflow. Also the MSDN, specifically for .NET. I think having relevant examples explaining the impact of the arguments is more important than a dry explanation of the function itself.