HACKER Q&A
📣 ibn-python

What are examples of good dev docs?


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

  👤 ldng Accepted Answer ✓
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
What sort of API is it? Web-based (as in REST or GraphQL)? Or software libraries? Curious the language, in that case...
👤 michannne
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.