Side note, how do I volunteer or work part time writing technical documentation? I feel like my writing skills and my ability to make code understandable and explicit to other readers would be a perfecy use for producing great documentation.
Ask HN: What is the best API documentation you have ever seen?
11–20 of 64 posts
Re: Ask HN: What is the best API documentation you have ever seen?
#12Re: Ask HN: What is the best API documentation you have ever seen?
#13Side note, how do I volunteer or work part time writing technical documentation? I feel like my writing skills and my ability to make code understandable and explicit to other readers would be a perfecy use for producing great documentation.
You can always pick a few projects on GitHub that have a less than ideal readme or set of docs and submit a bunch of PRs at once, I've done that before as a quick way to make myself feel like I'm contributing to the community whenever I don't have the motivation to push through on my own projects.
Re: Ask HN: What is the best API documentation you have ever seen?
#14Re: Ask HN: What is the best API documentation you have ever seen?
#15Re: Ask HN: What is the best API documentation you have ever seen?
#16What are people's thoughts on Swagger?
Some of the worst docs I've ever seen used swagger. Some of the best I've seen used swagger, so the tool doesn't make the docs IMO.
I'd rather you email me a .txt file that's well organized and complete (including a damned baseURL, you heathens) than pretty swagger docs without substance.
Re: Ask HN: What is the best API documentation you have ever seen?
#17[1] Auth0 - https://auth0.com/docs/api/authentication