Live data from Hacker News

Introducing Stack Overflow Documentation Beta

blog.stackoverflow.com

51–60 of 136 posts

Re: Introducing Stack Overflow Documentation Beta

#51
post #9

This is awesome. I can't count the number of times I've found an Android function that has almost no documentation. I usually post a question and answer on SO if I work out how it works. I only wish it were organised a bit more like normal documentation - i.e. into classes and methods. Might make it easier to find things.

Have you considered/tried adding back to the official documentation in cases like these?

Re: Introducing Stack Overflow Documentation Beta

#52
post #42

This is awful, another trick site that fools people into doing work that they could be getting paid to do, all for the joy of getting some "karma." Well kids, karma ain't gonna pay the rent. If you want to get experience volunteering to write documentation for software, then find the existing official documentation and add to that (or start it, preferably in a repository close to the actual code). Any profits that ge…

> karma ain't gonna pay the rent

My StackOverflow profile helped me get a new job with a good payrise. It's also helped me a better developer.

I'm absolutely ok with them making a profit, and they're a hell of a lot more ethical and useful than what went before them.

Re: Introducing Stack Overflow Documentation Beta

#53
post #42

This is awful, another trick site that fools people into doing work that they could be getting paid to do, all for the joy of getting some "karma." Well kids, karma ain't gonna pay the rent. If you want to get experience volunteering to write documentation for software, then find the existing official documentation and add to that (or start it, preferably in a repository close to the actual code). Any profits that ge…

You're free to not use the site, I guess.

Re: Introducing Stack Overflow Documentation Beta

#54
I like the concept (reminds me of gobyexample.com) but this really isn't documentation. Instead of more code snippets I want high quality annotations (like snippets!) atop official documentation. If more people were driven to canonical docs but with a guiding hand I think we'd see more people actually understanding the code they write.

Re: Introducing Stack Overflow Documentation Beta

#55
post #21

If this gains traction I don't think we'll feel the benefits till a little later down the line. I've contributed a little to the Swift tag but the real advantages come from technologies that don't already have good documentation. I'm considering starting a tag for the enreco HTML -> PDF generator I use quite a lot as the official documentation isn't great.

> enreco HTML -> PDF generator What is that? Googling it only brings up this comment thread.

My bad its Nreco

Re: Introducing Stack Overflow Documentation Beta

#56

What I'm most worried about is the duplication between the canonical documentation of a project and the StackOverflow one. As the author of an open-source project, I try my best to write a great documentation, and I would be a bit annoyed if people started to add examples to StackOverflow just to gain reputation there instead of contributing to the "official" one. Also, SO is ranked way higher than the smaller-projec…

I think they should link back to the official documentation wherever it makes sense. They could even automatically import official docs into their system if the license permits that and a standard tool is used.

They would still outrank your official docs. Just like wikipedia, they add nofollow to their links, meaning the links mean nothing in the eyes of Google.

Instead of having some innovation when it comes to spammers, wikipedia and stack overflow punish the original content creators.

Re: Introducing Stack Overflow Documentation Beta

#57

What I'm most worried about is the duplication between the canonical documentation of a project and the StackOverflow one. As the author of an open-source project, I try my best to write a great documentation, and I would be a bit annoyed if people started to add examples to StackOverflow just to gain reputation there instead of contributing to the "official" one. Also, SO is ranked way higher than the smaller-projec…

Is this really going to be that different from things like the Arch wiki?

Re: Introducing Stack Overflow Documentation Beta

#58

What I'm most worried about is the duplication between the canonical documentation of a project and the StackOverflow one. As the author of an open-source project, I try my best to write a great documentation, and I would be a bit annoyed if people started to add examples to StackOverflow just to gain reputation there instead of contributing to the "official" one. Also, SO is ranked way higher than the smaller-projec…

There's one question I saw on Stack Overflow a while back that irritated me. If you copied and pasted the literal question directly into Google, the top hit was directly to the canonical documentation, where you could just scroll down to the clearly marked heading, and copy and paste the sample code and have it work straight away. When I pointed this out, I was berated for not understanding that Stack Overflow is try…

Did you leave a comment (under the corresponding StackOverflow question/answer) with a link to a correct (from your point of view) example?

The official docs are the reference (and at best some common questions are answered). Stack Overflow is a Q&A site. It doesn't replace the docs; it complements them.

The new "Documentation" section on stackoverflow is just categorized code examples created and ranked by the community. It doesn't replace the docs too. Though It is not clear how the Documentation feature will evolve and whether it will be as useful as the Q&A part.

Re: Introducing Stack Overflow Documentation Beta

#59
post #42

This is awful, another trick site that fools people into doing work that they could be getting paid to do, all for the joy of getting some "karma." Well kids, karma ain't gonna pay the rent. If you want to get experience volunteering to write documentation for software, then find the existing official documentation and add to that (or start it, preferably in a repository close to the actual code). Any profits that ge…

I think you're missing the point. Sure, getting "karma" is a fun aspect of SO, but I think what's beautiful about the site is the "give and take" aspect. Every programmer brings a different set of knowledge to the site, and every programmer also brings a different set of needs. And as long as people are not just using SO as tool for consumption, then the system is mutually beneficial for everyone. So, yes, while answering questions on the site does not pay the bills, what does pay the bills is my full time job as a developer. And I have been greatly helped in that job due to people donating their time, effort, and knowledge into SO. And that is why I don't see it as a waste of time to answer others' questions on the site or contribute to this documentation.

Re: Introducing Stack Overflow Documentation Beta

#60

Earlier quoted context omitted.

To be fair, that best answer is totally editable by any user to be more informative and/or link to the canonical source of information. There are few projects whose docs have such low contribution friction, for better or worse. And unlike project-specific documentation, it comes in one basic format and set of norms. I also don't think there's a problem of spoonfeeding information to developers. If a developer at Comp…

I was just idling in the Documentation chat channel and based on what I was seeing there, it appears links to sources are discouraged on StackOverflow documentation. Presumably, they're aiming to eventually host new content that's better than what's already out there. I think it's a bit silly -- at least make a Sources section where folks can click to view links to existing docs!

Everyone knows that cool urls don't change, but the problem with links is that not all urls are cool urls. Links rot over time.
Post reply on HN