Hacker News Reader

Comment by skybrian | Hacker News Reader

Buried in there is an announcement [1] that they're going to start accepting documentation and particularly examples of API usage, not just Q&A.

It seems like a good place to put stuff that isn't a question.

[1] http://meta.stackoverflow.com/questions/303865/warlords-of-d...

View on HN

That's smart. Programmers do a lot of searching for examples, there was a recent Google study on the topic. [1]

One of my personal favorites lately has been bropages [2] - it's a crowdsourced set of usage examples for Unix command-line tools. Instead of wading through fifty pages of obtuse manpages or googling for usage, you just use "bro [command]" and you get some working examples.

[1] https://research.google.com/pubs/pub43835.html

[2] http://bropages.org/

I have always been a huge fan of http://Readme.io I wish StackOverflow would integrate with some of these existing platforms instead of creating a new one. One of the biggest problems I have with documentation is fragmentation across platforms. I fear StackOverflow adding another platform will add to the fragmentation problem.

As always, there's an XKCD about it :)

https://xkcd.com/927/

There's also "howdoi," [0] which searches stack overflow. For example:

$ howdoi turn dictionary into json python

>>> json.dumps(your_data, ensure_ascii=False)

[0] https://github.com/gleitz/howdoi

+1 for bro, it's super handy. I'm not affiliated with it but I use it all the time.

http://sourcegraph.com/ is doing something similar.

That is awesome. I was getting tired of solving problems in Nim for the first time, but felt that SO was too question-y to place them, so I created my own little thing, which of course gets a little Google traffic, but nobody really interacts with:

http://nim.community/

Just allowing documentation right on SO is way better.

Something like https://devdocs.io/ with UGC would be great.

Reply on news.ycombinator.com