dedlfix: Schnittstellen

Beitrag lesen

Tach!

[…] sondern vor allem auch, wie es der Leser erwartet, sonst hagelt es wieder Beschwerden, dass man da nichts finde.

Ich würde meinen, der Leser erwartet im Wiki vor allem „formal und technisch korrekte“ Beschreibungen der behandelten Materie. Sicher, aus der Sicht eines kompletten Anfängers macht es keinen Unterschied, woher die Objekte kommen mit denen er arbeiten kann. Aber es sollte ja nicht das Ziel des Wikis sein, ihn in seinem Unwissen auch noch zu bestätigen, indem die tatsächlichen technischen Hintergründe bewusst verschleiert beziehungsweise verwischt werden.

Wenn im Alltag manche Dinge vermischt werden, ohne dass Nachteile entstehen, warum sollte man das dann zwingend getrennt dokumentieren, wenn sich dadurch auch noch Nachteile in der Benutzbarkeit/Auffindbarkeit ergeben? Es geht mir nicht darum, Dinge zu verstecken oder unter den Tisch fallen zu lassen, sondern um eine gute Balance zwischen Notwendigkeit und Benutzbarkeit. Wenn ich mir zum Finden die Trennung bewusst machen muss, sie aber sonst so gut wie nie notwendig ist, dann empfinde ich das als überflüssig und eher störend als gewinnbringend. Das heißt nicht, dass man die Zugehörigkeit verschweigen soll, sondern nur als nebensächlichen Fakt in die Beschreibungsseite aufnimmt.

Jetzt mal nur bezogen auf die Abgrenzung von DOM und HTML stimme ich dir da absolut zu. Dies war für mich auch einer der Hauptgründe, weshalb ich mich in meinem Posting dafür ausgesprochen hatte, bei den Schnittstellen keine separate Rubrik für HTML-APIs einzurichten, sondern die entsprechenden Informationen im Zuge der Erläuterungen zum Document Object Model einzugliedern. Allerdings würde ich es dann halt gerne sehen, wenn in diesen Artikeln zum DOM dann auf die Unterschiede eingegangen wird. Also, um im Beispiel zu bleiben, dass etwa im Artikel zur Schnittstelle Document entsprechend auf HTMLDocument hingewiesen wird, und bei der Auflistung der Eigenschaften und Methoden auf dieser Seite dann ein extra Absatz und eine Überschrift eingefügt wird, so dass dem Leser die Information zumindest nicht vorenthalten wird und er verstehen kann, dass hier formal betrachtet abstrahiert werden müsste.

Genauso meine ich das. Da ist die Trennung eher störend, weil kaum wahrgenommen und unwichtig. Bei den anderen APIs, wie File oder Storage, ist die Trennung geboten, weil sie üblicherweise auch so abgegrenzt wahrgenommen werden und auch die Verwendung der Namen geläufig ist.

Dass komplette Anfänger sich in das Thema einarbeiten und erst eine Übersicht gewinnen müssen, bevor sie etwas finden, ist klar. Aber für den Einstieg sind ja auch Tutorials gedacht und nicht gleich die API-Beschreibungen.

Vermutlich sind wir näher beieinander, als du annimmst. Mir war es nur wichtig, den Aspekt zu betonen, dass der Anwender nicht aus den Augen verloren werden darf und man nicht alles nur aus den Augen des Insiders betrachten sollte.

dedlfix.