Live data from Hacker News

Introducing Stack Overflow Documentation Beta

blog.stackoverflow.com

121–130 of 136 posts

Re: Introducing Stack Overflow Documentation Beta

#121
post #118

It would be nice if there is SO for business. Lots of companies have terrible internal documentation, Q/A tools.

Odoo Q&A is an open source clone of stackoverflow: https://www.odoo.com/page/community-builder It has three mode: forum, Q&A (clone of SO), share links (like HN)

Very cool. Would be great if three functionality can be supported: transient chat, persistent Q/A and persistent documentation. The same for Stack Overflow. They may make a big profit if business start to use it.

Re: Introducing Stack Overflow Documentation Beta

#122

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…

The Stack Overflow Documentation content can be 'upstreamed' if it's worth doing so:

- [Upstreaming content on Stack Overflow Documentation - Meta Stack Overflow](http://meta.stackoverflow.com/questions/328438/upstreaming-c...)

And the point of the whole feature is to document things without good canonical (or non-canonical) documentation:

- [Creating a topic which already has good official documentation - Meta Stack Overflow](http://meta.stackoverflow.com/questions/328569/creating-a-to...)

Re: Introducing Stack Overflow Documentation Beta

#123
post #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?

Yes and yes. They just ignored my contributions.

Re: Introducing Stack Overflow Documentation Beta

#124
post #89
post #72

I really don't want people to start using something like this instead of improving the official documentation. I hate the fact it probably cannot be helped. To "do the same thing for docs that we did for Q&A"? Yeah, except there just was no sane platform for Q&A before. And for docs there is, you know… the docs!

"The docs" are remarkably inconsistent between projects. "The docs" for C# really don't need any help, "the docs" (by which I mean the AFAIK unofficial cppreference.com) for C++ are fine. But even major languages like Python don't have the greatest documentation, never mind the thousands of libraries out there that have wildly disperate levels of official "docs".

Even then, often docs just cover the API and functions and fail to give an idea of "how can I use this?"

Re: Introducing Stack Overflow Documentation Beta

#125
post #63
post #41

Earlier quoted context omitted.

The UI needs some big improvements indeed. I toyed around with the site and although I could find my way around when just clicking through some topics, I am still confused as to what the structure of the site is (other than a list of topics, with a list of examples, not hierarchically structured or Q&A style or anything else that would make sense). I'm not sure I could find anything on here if I didn't get there via…

personally, google is how I always end up on stack overflow, so I'd imagine the same will be true for this product.

19 out of 20 times, true. However I totally get how SO is structured and contributing answers to people's question is something everyone gets. And if I want to find other questions (like for marking a duplicate, or researching a topic) I can use the search and tag system easily. Somehow the structure of this documentation area is not very clear to me.

Re: Introducing Stack Overflow Documentation Beta

#126
Didn't see the word "test" in the article (except once talking about beta testing S.O.'s new product). And the word "test" isn't in these comments either, so...

Will updated examples be run through a program testing them in some way? If not a full run within a playground-style environment, then through a type checker?

And will the examples be tagged with version numbers? Some programming languages are notorious for changing syntax and/or semantics between minor versions.

Re: Introducing Stack Overflow Documentation Beta

#127

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 thought Google = Documentation for a long time.

Now I need to resist the urge to just Google the question, I need to exert effort to find the documentation and make it handy.

Re: Introducing Stack Overflow Documentation Beta

#128
post #88

Earlier quoted context omitted.

So the answer is to not use links at all?

Put the content AND the link, instead of just the link. This way, if the link changes the info will stay in SO.

But that violates DRY principle tho

Re: Introducing Stack Overflow Documentation Beta

#129

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…

The Stack Overflow Documentation content can be 'upstreamed' if it's worth doing so: - [Upstreaming content on Stack Overflow Documentation - Meta Stack Overflow]( http://meta.stackoverflow.com/questions/328438/upstreaming-c... ) And the point of the whole feature is to document things without good canonical (or non-canonical) documentation: - [Creating a topic which already has good official documentation - Meta Sta…

Doesn't your first link explain why it generally can't be upstreamed, except if the project coincidentally also uses CC BY-SA 3.0, or a user makes a point explicitly granting a more compatible license?
Post reply on HN