Wie arbeitet ihr Dokumentationen durch ?

[Narretei]

Im Grunde steht meine Frage bereits im Titel.
Hintergrund meiner Frage ist, das ich mich wirklich schwer damit tue rein aus der Dokumentation heraus beispielsweise ein neues Framework zu lernen oder
aus dem Java Source Code direkt abzuleiten und anzuwenden.

Ich habe mich kürzlich mit der Funktionalen Programmierung in Java befasst und versucht erst mit Google auf die jeweiligen Klassen zu stoßen um danach in der Dokumentation im Source Code mir den Rest zu erschließen.

Das hat selbstverständlich kein Stück funktioniert und deswegen meine Frage an euch - Wie macht ihr das ?
Ein befreundeter Programmierer meinte zu mir, mal so mal so.
Mal schaut er in die Online Dokumentation, manchmal einfach nur in den Source Code.

Das Ding ist halt für mich, das ich wenn ich dann mal Sachen im Source Code direkt nachlese, ich danach oftmals mehr Fragen habe als ich Antworten gefunden hab.
Ist dann auf Dauer doch ne wirklich frustrierende Geschichte.

 

[KonradN]

Wenn man ganz neu zu etwas kommt, dann ist mein Ratschlag, immer nach Introductions und Tutorials zu schauen. Damit findet man dann meist einen guten und schnellen ersten Einstieg.

Danach kommt dann ggf. Dokumentation, um sich Dinge im Detail anzusehen und um einzelne Themen zu vertiefen.

In den Source Code zu schauen würde ich eher ablehnen. JavaDoc kann sehr hilfreich sein, aber konkrete Implementationen? Ich wüsste nicht, wann ich das zum Erlernen eines Frameworks gebraucht hätte. (Oder meint Source Code den Code von Beispielen? Das wäre etwas anderes...)

Ich selbst finde aber, dass nichts über gute Bücher geht. Ein gutes Buch gibt halt nicht einen schnellen Einblick in eine Art und Weise, wie etwas schnell gemacht werden kann sondern es wird (hoffentlich) ein Überblick gegeben und verschiedene Wege etwas verglichen. Weiterhin werden Konzepte erläutert ... oft zwar nur kurz, aber das hilft extrem bei dem Verständnis. Das ist vor allem wichtig, wenn man sich das erste Mal mit einer bestimmten Technologie beschäftigt.

Wenn man etwas vergleichbares schon kennt (Also man hat ein Framework schon gut verstanden und will nun ein ähnliches verwenden), dann reicht ggf. auch nur die Dokumentation. Man sieht halt bei Dokumentation halt oft nur einen Aspekt mit vielen Details und hat aber dann die Möglichkeit, das direkt einzuordnen.

(Beispiel Programmiersprachen - als ich mal Dart ausprobieren wollte, habe ich tatsächlich einfach die language specification überflogen. Die Konzepte selbst hinter der Sprache sind halt bekannt und so konnte man die Angaben direkt einordnen.)

Bezüglich praktischem Vorgehen:

- Gewöhn Dir an, eine eigene Dokumentation zu erstellen, die Dir alles kurz und knapp in einer Struktur, die Du brauchst, gibst. Ein Bekannter nutzt dazu MindMaps, ich selbst schreibe einfache Dokumente.

- Gewöhn Dir an, von Anfang an Praxis mit einzubinden. Also nicht nur lesen und aufschreiben. Auch immer gleich machen! Probier alles aus. Spiel mit Code von Tutorials! Man lernt etwas nur über das doing.

- Besorge Dir Unterstützung! Es ist extrem hilfreich, wenn Du jemanden hast, der Fragen beantworten kann. Das kann prinzipiell auch eine KI sein, so es sich um Frameworks oder Technologien handelt, die frei und offen sind und für die es sehr viel gibt. Bei einer KI ist aber wichtig: Überprüfe Aussagen. Das geht recht gut bei Themen der Softwareentwicklung: die KI soll dir auch Code geben, den Du ausprobieren kannst. Oder die KI soll auch Quellen nennen - dann kannst Du die nutzen zur Vertiefung.

Das wäre so meine Sichtweise. Die ist natürlich sehr individuell geprägt:

• Ich bin eine Leseratte, die entsprechend schnell Texte und dessen Bedeutung erfassen kann.
• Ich bin nicht an Lernvideos gewöhnt (Und habe da auch eher schlechte Erfahrungen mit gemacht)
• Ich bin teilweise sehr theoretisch geprägt ... So habe ich auch die Java Language Specification durchgearbeitet um Java final "zu meistern". Das ist aber etwas, das nichts mit "neues Framework zu lernen" zu tun hat.

 

[Narretei]

Ah ok ich bin da sehr ähnlich wie du scheinbar und lese auch lieber Bücher und dachte eigentlich das die Docs genau dazu da sind, um sich eben spezifisch zu belesen aber scheinbar ist dem nicht so (oder doch und ich bin nur zu inkompetent, keine Ahnung in JavaScript waren die Docs meist einfacher verfasst).

Ich komme von JavaScript und habe mich daher erstmal schwer mit OOP getan, hab mir dann das Buch "Java ist auch nur eine Insel" gekauft und bin dadurch recht gut in das allgemeine Konzept von Java und in OOP reingekommen.

Nun habe ich festgestellt das für einige Aspekte dann auch in Java lieber die Funktionale Programmierung genutzt wird (WebFlux) und dachte mir "Ok, kann ja jetzt nicht so schwer sein kenn ich ja bereits aus JavaScript" und einiges konnte ich bereits erlernen.

Lambda-Expressions und die Anwendung des FunctionalInterfaces sowie bereits in Java implementierte Interfaces wie Function und BiFunction etc.

Aber gut scheinbar wirds dann wohl doch wieder umfassende Lektüre werden.
Danke für die Hilfe 🙌

 

[Oneixee5]

Wenn ich entschieden habe ein neues Framework o.ä. zu testen, dann suche ich als erstes nach "Quickstart" oder "Getting Started" und stelle das nach. Wenn das funktioniert, kann ich das schrittweise vertiefen. Meistens kommt ich von selbst zur Konfiguration - Was kann/muss ich für meine Umgebung/Anforderungen alles so einstellen?
Meistens versuche ich nicht alles im Voraus zu verstehen oder zu erlernen. Die Fragen entstehen bei der Nutzung von selbst. Man darf dann bloß nicht irgendwie wursteln, sondern konsequent nachlesen: ... was muss ich jetzt hier machen / wie löst man das am besten ...
Der "Feinschliff" kommt dann bei den Tests der Anwendung. Dabei fällt dann auf, mit welchen Dingen man sich noch beschäftigen muss.
Die ganze Doku auswendig zu lernen hat imho sowieso keinen Sinn. Jede Version bringt irgend etwas neues mit. Der wichtigste Punkt ist, man muss verstehen was man tut. Nicht irgendwie basteln sondern nachlesen was unklar ist. Nicht nach dem Motto: "6 hours of debugging can save you 5 minutes of reading documentation"

 

[White_Fox]

Auch wenn ich weder Informatiker noch Programmierer bin: Ich halte es – leider – auch für den besten Einstieg, erstmal irgendetwas damit zu machen (egal, was es ist).

Dokumentation ist (normalerweise) Dokumentation. Und keine Anleitung. Und auch kein Lehrmaterial. Dokumentation hilft weiter, wenn man eigentlich schon alles Wichtige weiß, und Details nachschlagen will, sie hilft aber nicht wenn man neu anfängt.

Ich habe es gerade mit JavaFX durch. Nach Tutorials vor Jahren irgendwie eine GUI zusammengestöpselt, und vor einigen Monaten das erste Mal eine eigene Componentklasse erstellt (und erst da wirklich was über JavaFX gelernt). Und das alles nur aus Blogartikeln und dergleichen, wo andere Schlaue freundlicherweise ihr Wissen geteilt haben. Sich den Scheiß zusammenzusuchen war absolut nicht einfach und ziemlich langwierig, fand ich jedenfalls. Vielleicht liegt es daran daß ich sonst kaum Softwarehintergrund habe, aber auch Vollblutprogrammierer fangen ja mal irgendwie an.

Und bestehenden Code anzuschauen hat mir exakt gar nichts geholfen. Ich habe mir z.B. die SpreadsheetView-Klasse aus der controlsfx-Bibliothek mal genauer angesehen, die hatte ich vorher verwendet und war damit aber nicht sehr zufrieden. Das Paket besteht aus ca. zwei Handvoll Klassen, die meisten mehrere hundert oder gar tausend Codezeilen groß. Davon lernst du absolut nichts, wenn du nicht ganz weißt nach was du suchst. Wenn du das bereits weißt, dann bist du über das Rooky-Stadium schon hinaus. Nicht, daß die Javadocs der Klassen zu schmal gewesen wären oder so...das ist recht ausführlich und ordentlich gemacht. Aber es hilft einem nur nicht, etwas ähnliches nachbauen zu wollen.

Ich finde aber daß Dokumentation, die einem Neuling keinen Einstieg bietet, einfach Schrott ist. Die Einführung in Konzepte und Abläufe, wie die Entwickler auf die Idee gekommen sind es so umzusetzen wie es ist, gehört da meiner Meinung nach dazu, und zwar direkt an den Anfang. Ein "Hello Framework" nachzutippen und dann schon produktiv werden zu können halte ich eher für bedenklich. Das führt nur dazu daß immer weniger wissen was sie da eigentlich tun.

 

[M.L.]

(WebFlux) ...

Lambda-Expressions

Generell ist Programmierung die Frage, wie sich der Compiler (Interpreter, Transpiler,...) verhält, wenn er im Code auf ein Schlüsselwort trifft. Frameworks erleichtern es hierbei von einer Idee zu einem Ziel zu kommen (wobei es nach den Prioritäten des Frameworks zu recherchieren gilt. Bei WebFlux z.B. die Entwicklung reaktiver Anwendungen für das Web ( Quelle ). Mit internen Änderungen oder Erweiterungen ist bei Frameworks immer zu rechnen )
Auf syntaktischer Ebene kann man recherchieren, wann z.B. anonyme Methoden effektiv Sinn machen.