Introducing Stack Overflow Documentation Beta
blog.stackoverflow.com
Introducing Stack Overflow Documentation Beta
1–10 of 136 posts
Re: Introducing Stack Overflow Documentation Beta
#2So this makes Stack Overflow a library of example code curated by people who already frequent their website. Am I reading that right?
Re: Introducing Stack Overflow Documentation Beta
#3If 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.
Re: Introducing Stack Overflow Documentation Beta
#4Odd.
Couldn't find blog.stackoverflow.com The Q&A site blog.stackoverflow.com doesn't seem to exist…yet.
You can vote for it to be created through our democratic, community-driven process at area51.stackexchange.com, or see a complete directory of all our Q&A sites at stackexchange.com.
Re: Introducing Stack Overflow Documentation Beta
#5Cool new project – I think it might become very helpful one day. Documentation for a lot of open source projects is pretty bad and having to figure out a new contributing workflow every time just to hop in and help a bit is quite problematic. Hopefully, the unified interface SO users are used to will give docs writing a big boost.
That said, I still hope they output some sort of GitHub repo of all the accepted changes to make it a bit less walled-gardeny. A CC license is nice and all, but having the content in a repo as well would put my mind at ease.
Re: Introducing Stack Overflow Documentation Beta
#6So this makes Stack Overflow a library of example code curated by people who already frequent their website. Am I reading that right?
I think this will be separate from Stack Overflow Q&A, if that's what you were aiming at. SO Q&A will still target specific examples. But yes, the new SO Documentation project will be code examples and explanations curated by presumably many existing SO users.
Re: Introducing Stack Overflow Documentation Beta
#7Cool new project – I think it might become very helpful one day. Documentation for a lot of open source projects is pretty bad and having to figure out a new contributing workflow every time just to hop in and help a bit is quite problematic. Hopefully, the unified interface SO users are used to will give docs writing a big boost. That said, I still hope they output some sort of GitHub repo of all the accepted change…
We have plans to eventually add Documentation to the data dump we already produce of the Q&A content (and hook it into the API, etc.)
If for some reason Documentation doesn't really take off or work and we end up scrapping the project, we'll produce a final dump of all content at that point.
Re: Introducing Stack Overflow Documentation Beta
#8Great idea I especially appreciate the fact that its done by example. A couple of things that bothered me are:
1. The UI needs some refinement. I was looking to find a topic to post about and from my 10 minute browse I realised that if I was meant to find information in this documentation it's really hard to find what you are looking for. After you drill down to a tag it feels "unstructured". Readthedocs layout feels more user-friendly.
2. To future proof the documentation examples should come with a version number they apply to. For example there is PayPal and DropBox API examples which in a few months might no longer be valid.
Re: Introducing Stack Overflow Documentation Beta
#9This 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.
Re: Introducing Stack Overflow Documentation Beta
#10If anyone is wondering how this looks and is impatient to read the blog post, here's an example Documentation page for Java Streams - http://stackoverflow.com/documentation/java/88/streams#t=201...