Ask HN: What are examples of good dev docs?

3 pointsby ibn-pythonover 4 years ago

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

3 comments

ldngover 4 years ago

Django is, IMHO, one of the best in both its content and structure.<p>Here is an enlightning talk about the structure : <a href="https://www.youtube.com/watch?v=azf6yzuJt54" rel="nofollow">https://www.youtube.com/watch?v=azf6yzuJt54</a>

jdbowmanover 4 years ago

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

评论 #24335533 未加载

michannneover 4 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.