Hallo alle miteinander,
ich bin gerade dabei, mein erstes Javascript Tutorial zu schreiben. Was haltet Ihr davon? Es wäre schön, jetzt schon ein erstes Feedback von Euch zu bekommen.
Malleus\' Javascript Tutorials: Das Wörterlabyrinth
Danke
Frank
xafford 
malleus „Mein erstes Javascript Tutorial: Eure Meinung ist gefragt“
Schön aufgemacht und übersichtlich f_ormatiert. Allerdings habe ich 2 Kritikpunkte grundlegender Art:
1. finde ich deine Beispiele oftmals nciht ganz nachvollziehbar
2. finde ich das Beispiel zu komplex für ein Tutorial, es wirkt eher wie eine Dokumantation, als wie ein Tut.
malleus xafford „Antwort“
Hallo "xafford",
ich bin für jede konstruktive Kritik zu haben. Nur so habe eine Chance, etwas besser zu machen.
zu 1.) welche Beispiele kannst Du nicht nachvollziehen?
zu 2.) Ich will keine 08/15 Tutorials schreiben, die gibt's wie Sand am Meer. Du hast schon recht, es ist mehr eine Dokumentation, aber es hat für mich aber mehr das Charakter eine Tutorials: Wie tue ich etwas? Also hier: Wie programmiere ich ein Wörterlabyrinth? Vielleicht sollte ich den Titel ändern.
Tschau und Danke
Frank
xafford malleus „Antwort“
Okay, konkret fangen wir mal beim ersten Punkt an, dem Entfernen der Semikolon bei Try-Catch-Blöcken (setzt die überhaupt jemand von sich aus?):
Du hast in den unteren Gegenüberstellungen eine Vorher-Nahher-Situation dargestellt (siehe Verkürzung von Argumenten), bei diesem Beispiel aber zwei Fäle des "Vorher" dargestellt. Dies ist nicht stringent (nicht schlimm, aber eben nicht stringent).
Dann das Beispiel der verkürzten Funktionsargumente (hier sind die Semikolon übrigens da ;o)), die Argumente sind verkürzt, die Funktionsnamen nicht.
Btw gibt es Plugins, die dies automatisch effektiver machen (1st Page 2000, source compressor), aber dies nur am Rande.
Ich muß gestehen, daß ich nicht weiter die Beispiele analysiert habe, aber das mit dem "nicht nachvollziehbar" bezog sich nicht auf den Inhalt, sondern den Aufbau, wie gesagt, einmal Vorher-Nachher Gegenüberstellung, einmal Fallbeispiele.
Was Dokumentation-Tutorial angeht, so bin ich anderer Meinung als Du. Ein Tutorial soll normalerweise allgemeine Grundlagen einer Sprache erklären, die Beispiele sollen recht allgemeine Anwendungen darstellen und es soll übertragbar sein. Auf Grundlagen gehst Du jedoch nur am Rande ein, Du verwendest z.B. teilweise OOP (so weit man bei JS daon reden kann) gehst aber (zumindest so weit ich gesehen habe) nicht explizit darauf ein. Insofern ist es als Ttorial nur von Nutzen, wenn jemand eine sehr ähnliche Anwendung programmieren wollte. Das soll keine Kritik in der Form sein, daß dein "Tutorial" schlecht oder unnütz sei, nur ist es eben an sich kein Tutorial im Wortsinne.
Ansonsten aber gute Arbeit.
Btw.: Was in meinen Augen noch fehlt ist ein Überblick über den Gesamtcode, oder habe ich den Lin dazu übersehen?
malleus xafford „Antwort“
Hallo xafford,
okay, hier sind meine Antworten ;-)
zu 1 :Entfernen der Semikolon bei Try-Catch-Blöcken:
Der von mir eingesetzte Komptimierer ESC setzt das ";". Nicht ich! Ich muß nur diesen Bug des Komprimierers beheben.
zu 2 : lange Funktionsnamen:
Diese werden von mir später auf einen 2-Zeichen Alias komprimiert.
zu 3: 1st Page 2000:
Werde ich testen, obwohl ich sagen muß, daß ich mit meiner erzielten Kompression sehr zufrieden bin.
zu 4: Dokumentation/Tutorial:
Das ganze ist wie gesagt Ansichtssache, aber hab' noch etwas Nachsicht mit mir: Es ist die Version 0.3, da ist noch viel Zeit um auf Grundlagen einzugehen bzw. den Inhalt zu verändern. Aus diesem Grunde habe ich ja diesen Thread eingestellt. Ich will wissen, was ich verbessern kann. Anhand Deiner konstruktiven Kritik hab' ich jetzt ein paar Anhaltspunkte.
zu 5: Quellcode:
Es gibt oben unter dem Titel ein "Download"-Link. Vielleicht sollte ich den "Text" etwas verbessern.
Nochmals Danke für Deine Mühe!
Tschau
Frank
malleus Nachtrag zu: „Antwort“
Nachtrag zur Komprimierung:
Hallo xafford,
ich hab' mir gerade den "1st Page 2000" und speziell den "Source Compressor" angeschaut. Nun ja, er ist vielleicht bei reinen HTML-Seiten ganz gut, aber bei Javascript-Files ist er eher schlecht. Wenn ich nichts falsch gemacht habe, schrumpft er "word.js" von ca. 10k auf 7.3k. Ich komme mit meiner Methode auf 3.4K. Wenn ich mich nicht täusche, führt er keine automatische Variablen-Substitution durch.
oder hab' ich was falsch gemacht?
Tschau
Frank
Borlander malleus „Mein erstes Javascript Tutorial: Eure Meinung ist gefragt“
Bevor ich loslege: Ich hab das ganze nur überflogen und nicht bis ins letzte Deteil gelesen - das Layout macht wie bereits von xaf geschrieben einen sauberen Eindruck und ist gut lesbar...
Also als Tutorial kann man das auch meiner Meinung nach nicht mehr bezeichnen, dafür wird zu wenig auf die Grundlagen der Sprache JS eingegangen...
Die Strukturierung halte ich allerdings für unglücklich:
Komprimierung ist ein Thema (nice to have) das wenn überhaupt erst ganz am Ende behandelt werden sollte - gleich am Anfang wirkt so etwas abschreckend, wenn Du es am Ende als optional anbietest kann selbst entscheiden ob er dort noch weiterliest.
Die vielen Einschübe halte ich für die Übersichtlichkeit auch nicht umbedingt dienlich, ebenso das abwechselnde palzieren von Code-Blöcken auf der linken und rechten Seite (bei denen sich mir auch die bedeutung der verschiedenen Farben nicht erschlossen hat)...
Denk mal drüber nach ob Du das ganze nicht auf mehrere Seiten nach Abschnitten + Unterabschnitten getrennt verteilen willst...
Gruß
Borlander
malleus Borlander „Antwort“
Hallo Borlander,
Danke für Deine konstruktive Krititk:
Meiner Meinung nach, ist ein Tutorial immer so etwas wie "Wie tue ich irgendetwas?
Bei mir sollte es dann vielleicht heißen: Wie programmiere ich ein Wörterlabyrinth mit Javascript? Daher denke ich schon, daß es noch als Tutorial bezeichnet werden kann. Grundlegende Tutorials zu Javascript gibt's wie Sand am mehr. Ich will die Fortgeschrittenen ansprechen.
Zur Komprimierung: Da der Quellcode stark auf spätere Komprimierung zugeschnitten ist, halte ich immer noch eine "kleine" Erklärung vor dem eigentlichen Quellcode wichtig. Ich denke aber drüber nach!
Farben:
Grün - HTML-Code
Beige - Wörterlabyrinth-Code
Rot - Standardfunktionen, die auch in anderen Spielen eingesetzt werden können
Blau - Beispiele, sonstige Erklärungen, die eigentlich nichts mit dem Wörterlabyrinth zu tun haben.
Ich werde wohl eine Erklärung dafür einfügen müssen. Auch über die Einteilung werden ich noch 'mal nachdenken. Vielleicht biete ich auch zwei Varianten an.
Tscha und nochmals Danke
Frank
