Wie lang muss eine Einleitung für Entwickler sein?

[profo]

Ich kenne von vielen Entwicklern die Eigenart, etwaige Einleitungen etc. einfach zu überspringen. Wenn das dann so auf den Punkt gebracht wird, wie im folgenden Beispiel, finde ich das ziemlich witzig:

What is the the Webmap API?

The Second Life Webmap API allows you to embed Second Life Maps onto your web pages. Enough talk, lets jump into the code.

Geht es noch kürzer?

[Anonymous]

Hmm... steht doch da wofür die api is... alles weitere wäre ja nur noch wie man sie benutzt, und dazu is halt der code nötig... warum also lange mit Texten aufhalten die dann eh keiner liest...

[ole1210]

Diese Eigenart haben nicht nur Entwickler.

Welcher normale User liest sich denn heutzutage noch die Anleitung vom Handy, DVD-Player oder vom neusen CMS durch? Kaum jemand.

Wenn Probleme auftreten, dann wird google oder ein Hilfeforum bemüht.

[Datibesol]

Manche Entwickler übertreiben es aber auch. Es gibt z.T. APIs und Frameworks, die wahrscheinlich super sind - nur benutzt sie niemand weil sie weder dokumentiert noch kommentiert sind.

[raxon]

Deswegen sind ja auch Kommentare im Code seeehr wichtig!

Ich finde diese "Einleitung" ausreichend.