Stack Overflow begint met 'Documentation'-kanaal

Stack Overflow heeft een nieuwe manier van documenteren uit closed beta gehaald. De dienst draagt de naam 'Documentation'. Documentation is breder opgezet dan de normale vraag-en-antwoord-topics en voorbeelden voeren de boventoon.

Gebruikers van Stack Overflow Documentation kunnen met stemmen de kwaliteit van voorbeelden beoordelen en zelf voorbeelden en documentatie toevoegen. De opbouw van Documentation bestaat uit voorbeelden, parameters, syntax en opmerkingen. De documentatie wordt via tags gegroepeerd, net als de vraag-en-antwoordsectie.

Naast het stemmen en het toevoegen van eigen content, is het ook mogelijk om commentaar en feedback te geven op bestaande onderwerpen of voorbeelden. In tegenstelling tot het vragenonderdeel waar Stack Overflow bekend mee geworden is onder ontwikkelaars, is Documentation breed opgezet en bedoeld als algemeen naslagwerk waarbij niet ingegaan wordt op specifieke problemen, maar op hele verzamelingen van problematiek.

Ook wordt in het eerste topic van een tag een lijst van versies bijgehouden. Die versies kunnen aan hele topics toegevoegd worden, maar ook aan individuele secties binnen de documentatie van een tag. Ook heeft Stack Overflow een manier toegevoegd om te zorgen dat er geen kapotte links meer staan binnen topics. Elke link krijgt een timestamp zodat oudere versies altijd terug te vinden zijn.

Stack Overflow zegt al samen te werken met Microsoft, PayPal, Dropbox, Xamarin, Twilio, PubNub, Twitch en Meteor voor het opzetten van documentatie, samen met de Stack Overflow-community. De voornaamste hulp die de bedrijven nu geven, lijkt te liggen op het vlak van verbeteren of beoordelen van door de community gemaakte documentatie.

Aan bijdragers in de komende vier weken deelt Stack Overflow 'Documentation Pioneer Badges' uit en bestaat de mogelijkheid een van de 100 Stack Overflow-T-shirts te winnen.

Reacties (86)

[PvdVen777]

Wellicht kan iemand het unieke van dit principe beter uitlichten, want wanneer ik het verhaal lees dan klink mij dit in de oren als een 'wikipedia' oplossing.

Neemt niet weg dat goeie en gestructureerde informatie altijd van harte welkom is.

[nulkelvin]

Het is natuurlijk niet een uniek principe.
Wat stack zo goed maakt is focus op het concept en goede moderation.

Stack is gericht op: er moet een vraag zijn die te beantwoorden is. Feitelijk te beantwoorden.

Dit is heel goed voor vragen zoals: Hoe maak ik een index op een tabel in sql server.

Dit concept werkt echter niet goed voor vragen zoals: wat is de beste manier om mijn sql queries sneller te maken.

Het laatste type vragen zal veel meningen als antwoord bevatten, en dat werkt niet goed voor een Q&A format. Vragen zoals die worden dan ook weggemodereerd.

Blijft staan dat antwoorden op zulke vragen en meningen natuurlijk wel heel waardevol kunnen zijn. Documents probeert dit gat te vullen.

[Accretion]

Ik denk niet dat meningen binnen "documentation" op prijs gesteld worden.

Q&A werkt bij specifieke vragen, vaak bij een direct probleem.

Documentation gaat meer in de richting van algemene documentatie/tutorials (hoop ik).

Als ik op Q&A vraag;
"Hoe start ik met ontwikkelen voor microcontrollers"
Wordt de vraag waarschijnlijk heel snel al gesloten; "te breed" en " geen specifiek probleem".

Op documentation, kan men heel algemene dingen "documenteren" zonder dat deze vraag-specifiek zijn.

Wellicht wat richting wikipedia, maar technischer en vooral toegepaster.

Ik ben eerlijk gezegd ook wel een beetje klaar met alle slechte instructies, waardeloze voorbeelden of blogs van Jan en alleman, waar men niet op kan reageren of foute content kan aanpassen.

[icepickle]

Ja correct, documentation is vooral voor algemene documentatie en heel veel voorbeelden.

Het is best interressant te zien was ze al bereikt hebben tijdens de closed beta

[paltenburg]

klink mij dit in de oren als een 'wikipedia' oplossing.

Ja zoiets is de bedoeling ook.. nou, 's toch goed?
Voor wikipedia zelf gaat dit natuurlijk te specifiek, maar een wiki-achtig ding is het zeker.

[PvdVen777]

Niets mis mee inderdaad, maar bij mij ontsond een twijfel of ik iets nieuws over het hoofd zag.
Prima initiatief verder.

[ByteBusters]

Lijkt ook wel wat op http://www.codeproject.com

[PerfectionVR]

Ik gebruik stack overflow al sinds 2009 en heb het veel zien veranderen. Het blijft een beetje de holy grail voor programmeurs. Het is de holy grail voor fatsoenlijke vragen en gelukkig is het vrijwel troll vrij en is het meeste on-topic.

[418O2]

True. Ik vraag me af of non-devs beseffen hoe verschrikkelijk belangrijk die site is Niet dat het er toe doet, maar toch.

[DeDirecteur]

Stack Overflow is zo'n beetje de enige site waarvoor ik bereid ben te betalen.

[Lordfox73]

Eh, nee. Ik snap niets van wat er op die site staat. Dus hoe belangrijk kan het zijn? Wat je niet begrijpt moet je negeren.

[jordees]

Stack heeft me al meermaals geholpen met vraagstukken betreffende problemen en fouten die ik tegen ben gekomen tijdens het programmeren. Tevens een goede vraagbaak voor Linux gerelateerde vragen/problemen.

Zeer goede community!

[Kafka]

Echt leren doe je niet maar meer een quick solution voor een probleem.

[marteo]

Dat is volgens mij afhankelijk hoe je er zelf mee omgaat. Zelf probeer ik antwoorden te zoeken die ook uitleggen wat er gebeurd, want ik wil weten wat de oplossing biedt. En als ik zelf een keer een antwoord geef dan probeer ik ook uit te leggen wat het stukje code doet wat ik -als voorbeeld- toevoeg.

[RoestVrijStaal]

Ik hoop dat wat er op "Documentation" komt ook gecheckt wordt dat de "veldwerkers" de documentatie snappen i.p.v. enkel academici die met moeilijke woorden en wiskundige formules alles maar moeten bewijzen.

[MadEgg]

Ik, als veldwerkende academicus, kan dat laatste juist waarderen. Een oplossing, maar goed onderbouwd en met achtergrondinformatie is veel waardevoller dan de quick and dirty hack. Beiden kunnen best naast elkaar bestaan en dat zie je vaak ook terug op StackOverflow. Het ene antwoord is doodsimpel, doeltreffend (maar o zo lelijk), het andere antwoord is schermvullend met de juiste achtergrondinformatie, links en ontwerpkeuzes, met als conclusie een mogelijke oplossingsrichting. Heerlijk!

[RoestVrijStaal]

Het hangt natuurlijk van het type probleem af.

Als veldwerker sta ik niet te wachten om een wall of text door te lezen terwijl het met een paar zinnen qua achtergrondinformatie veel simpeler af kan. Het gaat mij niet om de quickfixes, maar afgebakende achtergrondinformatie zonder de hele geschiedenis van de onderwerpen van het probleem.

Daarom hoop ik ook dat "Documentation" een richtlijn instelt tot taalgebruik en afbakening van achtergrond informatie.

[Reactie gewijzigd door RoestVrijStaal op 22 juli 2024 16:39]

[MadEgg]

Daar draagt structuur goed aan bij. Als er goede paragrafen en kopjes gebruikt worden kun je desgewenst eenvoudig wat minder relevante stukken overslaan en eruit halen wat je wilt. Een beetje doorscrollen is geen probleem toch?

Ik zie graag dat er toegezien wordt op kwaliteit van informatie en van structuur, maar dat er achtergrondinformatie beperkt zou worden kan ik niet waarderen. Het kan altijd achter een uitklapbare paragraaf, met 'voor de geinteresseerden' staan natuurlijk.

Wat mij betreft: hoe meer info hoe beter, als het maar goed gestructureerd is. Op WIkipedia wijk ik ook vaak uit naar de Engelstalige omdat die vaak veel meer achtergrondinformatie bevatten terwijl de Nederlandstalige wikipedia-pagina's veel te to-the-point zijn en daarmee, in mijn ogen, relevante en interessante achtergrondinformatie missen.

[kidde]

Academici schrijven de summary meestal bovenaan in hun publicaties toch? Lijkt me de oplossing, dan kunnen mensen die snel hun werk moeten afmaken gelijk aan de slag zonder veel lezen en zoeken, en geïnteresseerden lezers door.

Als ik haast heb is het soms vervelend dat het antwoord pas na 80% in het artikel staat. Haast lijkt me juist een reden dat mensen SO gebruiken, hadden ze meer tijd deden ze een cursus, lazen ze het boek/publicatie of lurkten op IRC over dat onderwerp.

[YopY]

Het is belangrijker om snel goede informatie te kunnen vinden dan om alles te proberen onthouden. Het kunnen inschatten of een aangeboden oplossing goed is, is belangrijker dan zelf een oplossing kunnen bedenken.

[Kafka]

Klopt. Als je een tijdje niet meer programmeert dan gaan je kennis en vaardigheden in een rap tempo achteruit. Dan zijn deze sites een uitkomst.

[pietje63]

Toch worden de "quick en dirty" oplossingen die sommige gebruikers adviseren vaak gemint, en verbeterd met de robuustere oplossingen. Daarmee leer je het ook beter.

[BitJager]

Ik kan het alleen maar toejuichen. Stackoverflow is echt wel één van de beste in zijn soort! Meer van dat aub!

[Verwijderd]

Fantastisch initiatief. Ik ga dit zeker in de gaten houden en waar mogelijk ook hier en daar wat aan bijdragen.

[Cornelisjuh]

Zonder enige twijfel, zonder Stack Overflow had ik lang niet het niveau in webdevelopment gehaald waar ik nu zit.

[AWiersma]

Dit is zeker een mooie toevoeging aangezien nu ook de basics voldoende aandacht krijgen. Voor beginners was de QA variant van Stackoverflow niet altijd de meest toegankelijke plek.

De eerste artikelen die ik heb gelezen op het documentatie kanaal laten echt stap voor stap zien hoe je bepaalde features gebruikt dus wat mij betreft ook heel geschikt voor beginners.

[hdz200]

StackOverflow werkt super voor zowel korte Q&A's als vragen die iets uitgebreider beantwoord moeten worden. Maar soms wil je echt iets meer diepgang zoals wat de Pro's en Con's zijn van een bepaalde toepassing van een techniek, wat eventueel de alternatieven zijn etc.

Soms ben je gewoon op zoek naar een degelijke, uitgebreide antwoord. Dat soort antwoorden kun je dus verwachten in "Documentation". Ik ben enthousiast!

[jj71]

Ik beantwoord zelf ook al jarenlang vragen op StackOverflow, maar eigenlijk snap ik niet waarom het zo populair is. Misschien omdat het snel vraag-en-antwoord is en omdat veel mensen op zoek zijn naar snelle, makkelijke antwoorden die ze kunnen copy-&-pasten?

SO is zeker niet vriendelijk voor beginners, als je een "domme" of beginnersvraag stelt dan is de kans groot dat je wordt neergesabeld. (Ja, ikzelf erger me er ook regelmatig aan als er weer eens iemand komt met "I wrote a program. It didn't work. How to I solve the problem?" zonder uit te leggen wat voor programma hij heeft geschreven en wat hij bedoelt met "it didn't work").

Het format is beperkt: stel een vraag, krijg antwoorden. Weinig ruimte voor discussie, zoals in een traditioneel forum.

Ik ben wel benieuwd naar wat het nieuwe Documentation concept gaat toevoegen.

[MSalters]

Dat er weinig tot geen ruimte voor discussie is, is met opzet. 't Is zelfs een expliciete SO close-reason, en met opzet. Niet elke site wil alles doen. Voor traditionele discusssies kun je in de DevSchuur terecht.

[ATS]

Waar ik een beetje bang voor ben is een verdere verplintering van communities. Documentatie hoort voor mij echt bij een project zelf, en niet los ervan. Ik zou het eeuwig zonde vinden als mensen nu enorm veel werk gaan steken in het schrijven van documentatie die er of grotendeels al is, of bij het project zelf verbeterd had kunnen worden door daar direct aan bij te dragen.

Begrijp me niet verkeerd: de Q&A is fantastisch.