Stack Overflow startet Crowdsourcing-getriebenes Dokumentationsangebot für Entwickler

Der Betreiber einer weltweit wichtigsten Websites für Entwickler will künftig nicht mehr nur für Fragen und Antworten da sein, sondern auch das Thema der technischen Dokumentationen angehen.

Mehr: Stack Overflow startet Crowdsourcing-getriebenes Dokumentationsangebot für Entwickler | heise online

Das wurde ja auf Meta teilweise kontrovers diskutiert, ich bin mir auch noch nicht sicher, was ich davon halten soll. Auf der einen Seite ist Dokumentation ein schwieriges Thema, weil sie an Open Source Projekten oft fehlt - aber dann hindert mich nichts dran, die Ärmel hochzukrempeln und am Projekt / der Doku mitzuarbeiten. Dafür bekomme ich natürlich keine wertlosen Internetpunkte auf irgendeinem Profil, und auch keine goldenen, bronzefarbenen oder silbernen Plättchen neben meinem Gesicht. Langfristig könnte es dazu führen, dass a) die Doku zwischen Projekt und SO auseinanderläuft, b) weniger Personen dokumentationsbezogene Contributions am Projekt tätigen, weil sie lieber auf Stackoverflow etwas beitragen.

Ja, ich sehe das auch mit einer gewissen Skepsis. Man muss wohl schon noch ein bißchen warten, bis sich das einpendelt und festrüttelt. Aber einige der dort diskutierten Punkte SIND ein echtes Problem. Z.B. sowas wie Plagiate. Aber nicht zuletzt auch die Überschneidung zwischen dem QA- und dem Doku-Teil. Bisher gab es oft keine verünftige Doku, und selbst bei der besten Doku haperte es meistens an Beispielen - und DAS ist ja etwas, worauf bei SO-Documentation besonderer Wert gelegt werden soll. Nun ist es aber so, dass wenn man
“How to do X in Z?”
in Google eintippt, man praktisch IMMER bei einem passenden Stackoverflow-Post landet, wo genau diese Frage beantwortet ist - und MEISTENS mit einem Beispiel-Code-Snippet (!). Man könnte tausende von Antworten aus Stackoverflow 1:1 in die Documentation kopieren.

Und ein massivSTes Problem ist: Das machen einige :frowning: Ich sehe deswegen in Addressing Documentation #RepGateApocalypse - Meta Stack Overflow ein echtes Problem Man mag von diesen Rep-Punkten und Badges halten, was man will, aber sie haben trotzdem eine gewisse Aussagekraft. (Über die man lange diskutieren und streiten kann, aber … Reputation+Badges SIND “wichtig”, und durch Ausnutzen der Doku-Rep wird ihre Bedeutung verwässert).

Wenn ich mir das hier ansehe: All clojure Topics - Stack Overflow oder All Java Language Topics - Stack Overflow

Dann hat das doch mit Dokumentation nichts zu tun, das sind How-Tos, bzw. abgespeckete Tutorials. Mich stört es jetzt schon, dass man im Netz erst mal zwei bis drei Suchmaschienenseiten billige Tutorials überblättern muss, bevor man an eine ordentliche Doku kommt…

Nun, einerseits hat Stackoverflow so viel Struktur, Vernetzung, Impact und Community(!), dass die dort erstellte Documentation zumindest potentiell “besser” ist, als andere. Wenn ich nach einer Problemlösung suche, und dann die Wahl habe, zwischen irgendeinem obskuren Blogeintrag und einer Stackoverflow-Antwort mit 300 Upvotes, dann bewirken letztere ein gewisses (!) Vertrauen. Und How-Tos ist glaube ich auch genau eines der Ziele. Dokumentation wie https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Document.html ist zwar wichtig, aber in anderer Hinsicht ein Witz: Man kann nicht diese Doku lesen, und sich daraus erschließen, dass man

DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
DocumentBuilder db = dbf.newDocumentBuilder();
Document d = db.parse(xml);

braucht, um XML zu lesen. Und rate, wo ich diese 3 Zeilen jetzt auf die schnelle her hatte :wink:

Insofern könnte da schon was gutes (wichtiges) rauskommen, aber im Moment geht ziemlich viel drunter und drüber, und die Richtung scheint noch nicht ganz die richtige zu sein. Der schon fast (negativ!?) berühmte Eintrag
Arrays - Java Language - Stack Overflow
im Vergleich zu
https://docs.oracle.com/javase/tutorial/java/nutsandbolts/arrays.html
zeigt, dass die Vorstellungen von den passenden Inhalten wohl noch konvergieren müssen…

Es gibt ein Update: Documentation Update, August 4th - Meta Stack Overflow
Zumindest wird dran gearbeitet.

Also wenn mir damals jemand das Konzept von Wikipedia vorgestellt hätte - Was zum Teufel rede ich da!? - Wenn mir heute noch jemand das Konzept von Wikipedia erklärt, dann würde ich ihn direkt als Verrückt abstempeln.
Das es trotzdem geklappt hat muss man Niemandem mehr beweisen.

Von daher glaube ich hat das ganz große Zukunft und der Fachbereich, von allen die so etwas machen würden, stimmt auch.

Nebenbei wollten ““wir”” in diesem Forum nicht auch so etwas aufziehen?

Ich hoffe nur das zentralisiert das ganze nicht zu sehr. Ich mag es 10 verschiedene Blogs und damit 10 verschiedene Möglichkeiten in ihren Details zu lesen.
Stack Overflow kann schon manchmal sehr schwarz/weiß sein.

Nun, die Abgrenzung zu einem Wiki ist ja auch etwas, was auf Meta diskutiert wird. Leider ist unser Wiki nicht so aktiv. Das ALLERmeiste davon stammt von Lex, und er macht immer mal wieder updates, aber eine echte, aktive Community dafür hatte sich nie entwickelt - dabei IST da schon sehr viel Wissen angesammelt (ich kenne zumindest nichts vergleichbares). Stackoverflow hat die Community und Infrastruktur, und ich denke, es besteht noch Hoffnung, dass sich das ganze “einpendelt” durch die bereitgestellten Mechanismen (Themen-Anfragen, Bewertungen, Reviews…).

[ot]
Das mit den 10 verschiedenen Möglichkeiten kann ich gerade so GAR nicht nachvollziehen. Ich wollte in JavaScript einen Namespace mit mehreren “Klassen” mit (größtenteils privaten) Methoden erstellen. Und was man dazu im Internet findet ist, gelinde gesagt, ein chaotischer Haufen zusammengewürfelter Müll. Jeder stellt andere, abstrus wirkende Konzepte in den Raum. Eine klare “SO macht man’s richtig!”-Seite ist schon manchmal nicht verkehrt.
[/ot]

Das kommt natürlich auf das Thema an. Im Internet habe ich jetzt vor kurzem gesucht wie man am besten eine Kollisionsberechnung gegen eine Objektgitter macht.
Auf Stack Overflow als “einzig richtige” Antwort die Bruteforcemethode.

Auf anderen Blogs teilweise andere Ansätze mit unterschiedlichen Vor- und Nachteilen.

Je komplexer ein Thema wird desto gewichtiger werden die Vor und Nachteile.
Solange das ganze bei Arrays bleibt…

Die Kunst oder auch das Handwerkszeug eines jeden Informatikers besteht darin, ein Problem nach seinen wesentlichen Bestandteilen zu reduzieren… Jeder Informatiker weiß das.

Induktion Reduktion Abstraktion Konkretision müssen im Einklang sein…

Ja, es ist ganz nett, über Arrays, aber JavaDoc ist auch nicht schlecht. Ich hab schon (unter Pseudonym) hier im Wiki geschrieben, was, wegen der abgehobenen Sprache, nicht so Anklang fand, aber dennoch gefällts mir hier.^^

Sehr zwiespältiges Thema. Ja fast schon Philosophischen Ausmasses, was den überhaupt “richtig” ist und wer entscheidet was “richtig” ist.
Ist eine Demokratische Abstimmung hilfreich Fragen zu entscheiden bei denen es eine klare “richtige” Antwort gibt?

Vielfalt ist wunderbar. Aber es gibt auch den krassen Gegenentwurf

“Why Google Stores Billions of Lines of Code in a Single Repository”

Entweder es passt “universell” oder es ist nicht gut genug. So einfach wie genial umgeht man damit eine Vielzahl von Problemenkategorien.

Wenn man Dokumentation braucht um eine API zu verwenden, dann kann es auch sein, dass die API nicht endanwenderfreundlich genug ist. Eine DefaultMethode in Document parseXml(InputStream is) hätte es wohl auch getan.

Es gibt mal wieder ein update: Documentation Update, August 29th - Meta Stack Overflow
Scheint als würden sie das (nun ja auch als Wort gebannte) “rep-whoring” einzudämmen versuchen…