Verbesserung Dokumentation/Wiki (WAS: Make...)

[hum4n0id3]

Sehe ich genauso. English ist in der IT nun mal Standard. Ich habe auch schon mal an einem Wiki für eine Linux-Distribution mit gearbeitet und kenne auch etwa die Arbeit die dahinter steckt.

Ich würde eher etwas kleines und auf das Forum zugeschnittenes machen. Das PHP.de-Forum hat hier etwas tolles gemacht.
https://php-de.github.io/

Delphi-Treff hat auch eine nette Tutorial Sammlung. https://www.delphi-treff.de/tutorials/g ... tutorials/
https://www.delphi-treff.de/object-pascal/

Das andere wird meiner Meinung nach scheitern.

[pluto]

Das andere wird meiner Meinung nach scheitern.

ja, an der Pflege der Inhalte. Im Lazarus-Wiki sind zum Teil alte Beiträge, die dringend ein Update haben sollten.

Ich bin der Meinung, wir sollten uns was kleines vornehmen z.b. eine art Blog über Lazarus bzw. Eine Tutorial Serie zu verschiedene Themen:
- Multimedia mit vlclib, bass oder was auch immer
- Grafik mit der BGRA LIb
- Internet mit Synapse, LNET und co
- Datenbanken

und soweiter.

Mein Problem ist dabei immer, welche Sprache ich wählen soll. z.b. Anfänger/Fortgeschrittene? Was setzte ich voraus.
Welches Vorwissen ist nötig. Tutorials können durchaus aufeinander aufbauen.

[Socke]

Im Lazarus-Wiki sind zum Teil alte Beiträge, die dringend ein Update haben sollten.

Welche Artikel sind das denn?

[TSchnuckenbock]

Vorweg: Von automatischer Übersetzung halte ich nicht viel. Ich nutze DeepL beispielsweise, wenn ich Themen im internationalen Lazarus-Forum verfolge. Ich weiß, ich bin bequem. Ich habe dann immer auf einem Bildschirm DeepL und haue mit Copy-Paste die Beiträge da rein. Bei missglückten Übersetzungen brauch ich dann nur auf dem anderen Bildschirm mir den Original-Text zu schauen.

Ich habe mich meine ganz Schulzeit möglichst um Englisch gedrückt. Am Ende meines Studiums bekam ich dann vom Prof. einige Fachartikel kopiert, die ich in meinen Diplomarbeit einarbeiten sollte. Über 10 Artikel in Englisch und einer in Deutsch. Toll, aber hilft ja nichts. Am Ende hatte ich so um die 30 Fachartikel gelesen und eingearbeitet und auf Deutsch war nur dieser eine vom Anfang. Man kommt in der Programmierung einfach nicht umhin, sich mit Englisch auseinander zusetzen.

Was die Wikis/Tutorials anbelangt: Welche Zielgruppe will man erreichen? Eher die Anfänger, die Hilfe für den Einstieg brauchen oder eher die Fortgeschrittenen, die eine Nachschlagewerk für z.B. irgendwelche Komponenten benötigen?

Schaut man im Internet nach, so findet man eigentlich so einiges auf Deutsch für Lazarus/FreePascal. Einiges/vieles ist leider unvollständig.
af0815 hatte da ja auch schonmal was gemacht. Delphi-Treff fiel mir auch ein, daß ich da in der Vergangenheit mal reingeschaut habe.

Ich könnte mir vorstellen, daß eine Beispiel-Suite ganz hilfreich sein könnte. Ich speichere mir z.B. die Beispiele/Examples von wp immer ab und probiere die auch meist kurz aus. Lazarus liefert ja auch viele Examples gleich mit. Da könnte man mal ein deutsches Inhaltsverzeichnis für erstellen und eventuell auch das ein oder andere Beispiel Schritt-für-Schritt erläutern.

[pluto]

Welche Artikel sind das denn?

https://wiki.lazarus.freepascal.org/Exe ... rograms/de
AProcess.CommandLine ist veraltet und auch die art und weise wie die Parameter übergeben werden.
"ppc386 -h"

Oh, die Englische Version ist da wesentlich umfangreicher als die Deutsche Version.
Damit ist die Deutsche Version überflüssig. Eigentlich.

Ich habe jetzt leider keine Liste angelegt, werde ich aber machen.

[Socke]

https://wiki.lazarus.freepascal.org/Exe ... rograms/de
AProcess.CommandLine ist veraltet und auch die art und weise wie die Parameter übergeben werden.
"ppc386 -h"

Zumindest solche Kleinigkeiten lassen sich doch in unter 5 Minuten beheben. Den ganzen Artikel mit der deutschen Version abzugleichen ist ein wenig mehr Aufwand.

[kupferstecher]

Was die Wikis/Tutorials anbelangt: Welche Zielgruppe will man erreichen? Eher die Anfänger, die Hilfe für den Einstieg brauchen oder eher die Fortgeschrittenen, die eine Nachschlagewerk für z.B. irgendwelche Komponenten benötigen?

Letzteres halte ich nicht für notwendig, die englische Doku ist da gut und ausreichend, gerade was Komponenten anbelangt geht es ja auch viel um Code, der sowieso nicht übersetzt wird (außer in Maschinenbefehle ). Außerdem könnten wir das wohl sowieso nicht leisten.

An einem guten Einsteigertutorial hapert es momentan, sowohl für FreePascal, als auch Lazarus. Für FreePascal könnte man zweigleisig fahren, ein Tutorial für Programmieranfänger und ein dichter gepacktes für Umsteiger und Wiedereinsteiger. Eine Kurzübersicht zum Nachschlagen wäre auch nicht schlecht. Beim Lazarustutorial würde ich dann Programmierkenntnisse voraussetzen. Die Einstiegstutorials wären m.E. mal das absolute Mindestmaß, auch wenn alle, die hier mitdiskutieren längst über dem Stadium drüber raus sind um noch davon zu profitieren. Die Einstiegstutorials sind dann das Fundament für weitere Tutorials und Artikel. Das können dann Speziellere sein, wie die Embedded-Programmierung, Raspi-Programmierung, OOP-Techniken, Multithreading, Komponentenübersichten usw.

Gerade eine Vernetzung der vorhandenen Doku hielte ich da für hilfreich. Z.B. eine Komponentenübersicht mit Kurzbeschreibung, wo dann englische Wikiartikel und die LCL-Doku verlinkt ist.
Dass der Programmierer einen Ausgangspunkt in seiner Recherche hat und nicht bei jeder Unklarheit erstmal den Internetsuche starten muss. Um dann in den ersten Treffern auf Delphi-Dokumentation zu stoßen.

[charlytango]

Tut mir leid, aber das hören hier die meisten nicht gern: Wer programmieren will, muss einen Mindestumfang der englischen Sprache beherrschen. Das ist nun mal so.

Das mag so sein, dass es so ist, aber das hilft jetzt nicht weiter. Für Englisch gibt es schon mehr als genug. Für deutsch noch nicht.
Damit erreichen wir auch nicht mehr Entwickler die halt kein Englisch können warum auch immer.

Klar hat @wp_xyz recht. Ohne Englisch tut man sich in der EDV schwer. Und mit Englisch brauche ich in Wahrheit keine lokalen Sprachen. Trotzdem lese ich Deutsch schneller und flüssiger auch wenn ich Englisch ganz annehmbar beherrsche.

Aber was ist das Ziel der ganzen Aktion? Eine saubere deutsche Doku? Dann braucht es diese Diskussion nicht.
Wenn wir mehr Benutzer anziehen wollen muss es den jeweiligen Personen so leicht wie möglich gemacht werden sich in Lazarus zu verlieben.

Und nochmal: JA ein beliebiges hin und her übersetzen KANN zu Müll führen. Genau deswegen wäre ja eine kluge Strategie nötig und das Hirnschmalz aller Beteiligten um das zu vermeiden.

Die Qualität von DeepL haben einige hier ja schon bestätigt.

Die Frage ist ja auch wie das Ergebnis aller Überlegungen präsentiert/veröffentlicht werden soll. Eigenes Wiki des lazarusforums? Eigenes CMS? Handgestrickte Webseite ?
Ohne Redaktion und mehrstufiger Freischaltung samt Sprachunterstützung sehe ich wenig Land.

[Socke]

An einem guten Einsteigertutorial hapert es momentan, sowohl für FreePascal, als auch Lazarus. Für FreePascal könnte man zweigleisig fahren, ein Tutorial für Programmieranfänger und ein dichter gepacktes für Umsteiger und Wiedereinsteiger. Eine Kurzübersicht zum Nachschlagen wäre auch nicht schlecht. Beim Lazarustutorial würde ich dann Programmierkenntnisse voraussetzen.

Einem Einsteiger zu sagen "Arbeite die Free Pascal-Tutorials durch, bevor du dich mit der IDE beschäftigst" halte ich für wenig elegant. Die Tutuorials sollten schon zeigen, wie man mit Lazarus seine ersten Programme erzeugt.
Ob man hier direkt mit grafischen Anwendungen oder erstmal die Theorie in Kommandozeilenprogrammen abhandelt ist diskussionsfähig. Unter Linux ist aber auch das immer wieder ein Kampf!

[Nimral]

Im Lazarus-Wiki sind zum Teil alte Beiträge, die dringend ein Update haben sollten.

Welche Artikel sind das denn?

Wie viele Beispiele magst Du haben?

Ich denke, ich hatte heute ein Dutzend Beispiele, sie haben mich keine Ahnung wie viele Stunden Arbeit und Frust gekostet. Ich zähle inzwischen nicht mehr mit, sonst würde ich mal wieder ernsthaft drüber nachdenken, endgültig ins feindliche Lager zu wechseln. Ich war jetzt ein halbes Jahr auf c#, und hätte an der Doku wenig zu mäkeln.

Ich brrauche gerade eine Socket-Lösung. Nun, eine Socket-Library zu haben könnte man als absolutes Basic bezeichnen, dementsprechend würde man auch eine sorgfältig ausgearbeitete Doku mit Beispielen erwarten. Also, guckst Du hier:

https://wiki.lazarus.freepascal.org/fcl-async

Da gibt es nur ein paar dürre Sätze. Und es dauert genau drei Zeilen bis man sich das erste Mal am Kopf kratzt: das ist also eine "plattformübergreifende Unix-only Library". Aha. Check mit Lazarus unter Windows scheint dem Nebensatz Recht zu geben: es gibt kein Package fcl-async im Packet Manager oder sonstwo, oder ich habs nicht gefunden. Schade dass die Liste der Packages so überhaupt keine Spalte für die unterstützten Umgebungen kennt. Also weiter im Wiki, als nächstes wird angepriesen: lNet. Gibts im Repository wohl gar nicht, externer Link verweist auf Subversion, der ist retired und verweist auf https://github.com/almindor/lnet, da gibt es in der Tat ein Package, und (jubel) ein Verzeichnis doc, und darin einen offenbar automatisch erzeugten, unbrauchbaren Datenfetzen. Also los, Examples umackern und sehen, ob man damit irgendwie zurecht kommt. Und die Uhr tickt.

(Irgendwer kommt jetzt sicher auch noch mit Synapse ums Eck .... und da ist es erstens genauso, und die Uhr tickt und tickt.)

Genau das ist gemeint mit "Einsteigerfeindlich". Es ist nicht das eine große Problem, es sind die vielen, vielen kleinen Nadelstiche die einem den Nerv töten. Klar, jedes für sich wäre vielleicht in 5 Minuten zu beheben, wäre da einer am Schreiben der sich sicher ist, dass das was er hinzufügt dann auch unter allen Lazarussen auf allen Plattformen läuft, und nicht nur unter den beiden die jeder hat (Windows und Linux). In Summe sind das Tage und Wochen.

Armin.

[TSchnuckenbock]

Mir fällt gerade ein, daß ich vor vielen Jahren mal ein Delphi-Tutorial nachvollzogen hatte, in dem man mit Delphi einen Editor-Programm erstellte, so mit Menü, ggf Toolbar (oder das als Steigerung des Schwierigkeitsgrades...extended!), Text-Datei speichern und öffnen und so weiter. Da war schon ziemlich viel drin.

Man könnte ja mal gucken, was diesbezüglich im Netz kursiert und das dann umtoasten auf Lazarus.

Als Basis könnte man ein Mini-Wiki machen mit Datentypen, Schleifen, Verzweigungen usw.

Was ich bei Praktikanten immer wieder sehen konnte wo die Verständnis-Probleme hatten und wobei ich mir anfangs einen abgebrochen hatte, war das Verständnis beim Erzeugen einer Instanz einer Klasse. In dem Zusammenhang kann man dann auch gleich erklären, daß man die Instanz üblicherweise auch wieder freigeben muß....dann landet man bei try...finally.

[Winni]

Hi!

Meinst Du das:

https://doc.lagout.org/programmation/De ... Delphi.pdf

Copyright 2000-2002 Borland

Da musst Du schon sehr sehr viel umschnitzen, bis das nicht mehr auffällt.

Winni

[Winni]

Was ich bei Praktikanten immer wieder sehen konnte wo die Verständnis-Probleme hatten und wobei ich mir anfangs einen abgebrochen hatte, war das Verständnis beim Erzeugen einer Instanz einer Klasse.

Hi!

Ist doch gan einfach:

Eine Klasse ist das Auto im Katalog.
Eine Instanz ist das Auto, in dem Du sitzt.

Winni

[TSchnuckenbock]

Hi!

Meinst Du das:

https://doc.lagout.org/programmation/De ... Delphi.pdf

Copyright 2000-2002 Borland

Da musst Du schon sehr sehr viel umschnitzen, bis das nicht mehr auffällt.

Winni

Jo, das könnte es gewesen sein. Die Zeit kommt auch hin...muß so um 2003 gewesen sein.
Man muß es ja nicht 1:1 übersetzen. Neue/andere Screenshots wären auch notwendig.
Bildbetrachter wäre auch mal eine spontane Idee.

Was mir grad so einfällt: Ich versuche seit Jahren für die hauseigene Software bei meinem Arbeitgeber eine Anleitung zu schreiben. Ich hatte mich damals für DocBook entschieden und laß das dann nach HTML übersetzen. Man glaubt als Entwickler gar nicht, wie aufwändig es ist, eine umfangreiche "Hilfe" für (die eigene) Software zu schreiben. Gute Texte finden, passende Screenshots usw......da geht Zeit flöten wie irre. Es dauert auch immer seine Zeit, bis man wieder im Fluß ist, also mal so eben 30 Minuten Hilfe schreiben, da kommt bei mir nicht viel raus.

Eine Klasse ist das Auto im Katalog.
Eine Instanz ist das Auto, in dem Du sitzt.

Kein schlechtes Beispiel. Es muß klick machen, danach hat man es dann.
Ich habe es dann immer versucht zu erklären, indem ich die Klasse als "Vorlage"/"Schablone" bezeichnet habe.
Mein Lehrmeister ist damals an mir fast verzweifelt.

[hum4n0id3]

Gute Texte finden, passende Screenshots usw......da geht Zeit flöten wie irre. Es dauert auch immer seine Zeit, bis man wieder im Fluß ist, also mal so eben 30 Minuten Hilfe schreiben, da kommt bei mir nicht viel raus.

Ganz genau. Das merkt jeder schnell der anfängt sich damit zu befassen.