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

Für Dinge zum Forum, Kritik, Verbesserungsvorschläge, Umfragen und ähnliches.
Antworten
pluto
Lazarusforum e. V.
Beiträge: 7178
Registriert: So 19. Nov 2006, 12:06
OS, Lazarus, FPC: Linux Mint 19.3
CPU-Target: AMD
Wohnort: Oldenburg(Oldenburg)

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

Beitrag von pluto »

Nimral hat geschrieben: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.
Für uns mag es leicht sein, für andere nicht.

Ein Beispiel:
Ich habe gestern wieder mal eine HTML Seite verarbeiten wollen um nicht länger auf ein Python Script angewiesen zu sein.
Habe ich auch geschafft. Leider ohne XPAHT. Dazu habe ich bisher nur wenig bis gar nichts brauchbares finden können.
Das sind z.b. in Python Standard Libs.....

Das Problem: Ich wollte mir eine Grafik von der Seite runterladen, der Dateiname der Grafik ändert sich jeden Tag.

Gut meine Lösung gefällt mir jetzt auch besser, davon mal abgesehen.

Ein Anfänger wäre wohl dran verzweifelt.
MFG
Michael Springwald

Nimral
Beiträge: 390
Registriert: Mi 10. Jun 2015, 11:33

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

Beitrag von Nimral »

Mein Ansatz wäre, dass Einsteiger wie ich, die im Zuge ihres Einlernprozesses sowieso endlos Testcode-Projekte bauen, diesen, sobald er läuft, und wenn sie das Gefühl haben dass es noch nix Vernünftiges gibt, veröffentlichen für die, welche (hoffentlich) noch nach ihnen kommen. Oder dass sie sich an bestehendem Sample-Code entlanghangeln und am Ende dort Kommentare oder Ergänzungen machen wo sie auf Probleme gestoßen sind.

Die Profis wären gefordert die Samples kurz durchzusehen, ob da nicht irgendwelche Bärenfallen lauern die bei Testcode vielleicht gar nicht auffallen, und nochmal Andere wären gefordert ihn auf den Plattformen zu testen die der Autor nicht zur Verfügung hat.

So könnte ein Schuh draus werden. Ich denke, ich wäre derzeit auf einem guten Weg, das für Socketkommunikation zu machen.

Armin.
Zuletzt geändert von Nimral am Di 30. Nov 2021, 23:17, insgesamt 1-mal geändert.

Benutzeravatar
kupferstecher
Beiträge: 418
Registriert: Do 17. Nov 2016, 11:52

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

Beitrag von kupferstecher »

TSchnuckenbock hat geschrieben:
Di 30. Nov 2021, 17:23
Winni hat geschrieben:
Di 30. Nov 2021, 16:53
Meinst Du das:
https://doc.lagout.org/programmation/De ... Delphi.pdf
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.
Ist ja witzig, genau sowas hab ich vor 2 Wochen fürs englische Wiki angefangen zu schreiben. Als Lazarustutorial Teil 2. Ist noch nicht 100% fertig aber m.E. schon recht ansehnlich. Angehängt das Formular, es sind Dialoge drin, Filehandling, StringList, TPanel, Anchoring, Initialisierung in der FormCreate, IntToStr...
Wg. dem Tutorial selbst wollte ich einen eigenen Thread im englischen Forum aufmachen...

Edit: Mit dem Anhang funktioniert was nicht...
EasyEditor02.png
EasyEditor02.png (2.81 KiB) 1479 mal betrachtet
Zuletzt geändert von kupferstecher am Di 30. Nov 2021, 17:56, insgesamt 1-mal geändert.

hum4n0id3
Beiträge: 301
Registriert: So 5. Mai 2019, 15:23

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

Beitrag von hum4n0id3 »

YouTube-Kanal aufmachen und dann Lernvideos produziern :wink:

hum4n0id3
Beiträge: 301
Registriert: So 5. Mai 2019, 15:23

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

Beitrag von hum4n0id3 »

kupferstecher hat geschrieben:
Di 30. Nov 2021, 17:51
Edit: Mit dem Anhang funktioniert was nicht...

EasyEditor02.png
Na klar. Vorher war dein Bild, Grün und Streifig, jetzt Blau und Streifig.

Benutzeravatar
kupferstecher
Beiträge: 418
Registriert: Do 17. Nov 2016, 11:52

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

Beitrag von kupferstecher »

hum4n0id3 hat geschrieben:
Di 30. Nov 2021, 17:59
Na klar. Vorher war dein Bild, Grün und Streifig, jetzt Blau und Streifig.
Ja, habs neu gespeichert, weils hier grün und streifig rausgekommen ist. Beim Upload 38k, nach der Vorschau dann nur noch 2,8k (und grün und streifig)... Scheint was kaputt zu sein.

Benutzeravatar
fliegermichl
Lazarusforum e. V.
Beiträge: 1432
Registriert: Do 9. Jun 2011, 09:42
OS, Lazarus, FPC: Lazarus Fixes FPC Stable
CPU-Target: 32/64Bit
Wohnort: Echzell

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

Beitrag von fliegermichl »

Winni hat geschrieben:
Di 30. Nov 2021, 16:57

Eine Klasse ist das Auto im Katalog.
Eine Instanz ist das Auto, in dem Du sitzt.
Jooaaahh Neee nicht so ganz.

Die Klasse ist der Bauplan und die Instanz ist das nach dem Bauplan gebaute Haus. Ich glaube, daß trifft es besser.

hum4n0id3
Beiträge: 301
Registriert: So 5. Mai 2019, 15:23

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

Beitrag von hum4n0id3 »

fliegermichl hat geschrieben:
Di 30. Nov 2021, 19:36
Winni hat geschrieben:
Di 30. Nov 2021, 16:57

Eine Klasse ist das Auto im Katalog.
Eine Instanz ist das Auto, in dem Du sitzt.
Jooaaahh Neee nicht so ganz.

Die Klasse ist der Bauplan und die Instanz ist das nach dem Bauplan gebaute Haus. Ich glaube, daß trifft es besser.
Eine Klasse in obigen Fall wär ein Bauplan für das Auto. Die Instanz ist das nach dem Bauplan gebaute Auto. Um mal bei Auto zu bleiben :)

Benutzeravatar
m.fuchs
Lazarusforum e. V.
Beiträge: 2636
Registriert: Fr 22. Sep 2006, 19:32
OS, Lazarus, FPC: Winux (Lazarus 2.0.10, FPC 3.2.0)
CPU-Target: x86, x64, arm
Wohnort: Berlin
Kontaktdaten:

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

Beitrag von m.fuchs »

Es kommt jetzt hier zu dem klassischen Problem - aus einem Brainstorming wird eine Diskussion über Detailfragen.

Bevor es zu sehr ins Klein-Klein abdriftet noch meine Meinung zur Diskussion:
  1. Man kann erwarten dass für tiefgreifende Dinge die Entwickler auch eine englische Dokumentation lesen können. Es muss nicht alles auf Deutsch vorhanden sein.
  2. Für den Einstieg, für Schüler, etc. wäre ein deutschsprachiges Werk aber eine gute Sache.
  3. Eine veraltet Dokumentation ist schlimmer als gar keine Dokumentation. Sie suggeriert Sicherheit die nicht vorhanden ist und lässt den Nutzer verzweifeln, weil Dinge nicht so sind wie sie dort beschrieben sind.
  4. Automatisierte Übersetzungen sind ein Anfang, mit dem man per manuellen Feinschliff ein vernünftiges Ergebnis bekommt.
  5. Es ist immer gut das Wiki zu erweitern, auch in englisch. Mehr Beispiele, mehr Beschreibungen bieten auch mehr Hilfe.
  6. Wenn finanzielle Unterstützung notwendig ist, wird sich auch Geld finden. Der Verein kann dabei helfen. Voraussetzung ist ein vernünftiges Konzept was passieren soll.
  7. Dafür ist es aber auch notwendig dass sich jemand den Hut aufsetzen möchte, um die Diskussion in Gang zu bringen. Für die beiden anderen Projekte (Weiterbildungs-Portal und News-Portal) hab ich das jetzt erst einmal gemacht. Für eine Analyse und Ideen wie man Wiki und Doku verbessert fehlt mir momentan die Zeit. Aber grundsätzlich bin ich gerne dabei.
Software, Bibliotheken, Vorträge und mehr: https://www.ypa-software.de

Nimral
Beiträge: 390
Registriert: Mi 10. Jun 2015, 11:33

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

Beitrag von Nimral »

m.fuchs hat geschrieben:
Di 30. Nov 2021, 23:26
Es kommt jetzt hier zu dem klassischen Problem - aus einem Brainstorming wird eine Diskussion über Detailfragen.
Der Ordungsruf war überfällig :-)

Ich hätte die Zeit, bzw. kann ich sie mir nehmen, aber mir fehlen noch große Teile des tieferen Know-Hows sowie die komplette Entwicklungshistorie von Lazarus/FPC seit dem Millennium. Den Hut aufsetzen kann ich m.E. fachlich nicht stemmen, ein guter Capo muss auch im Zweifelsfall ein Machtwort sprechen können, ich würde dabei vermutlich fachlich überfordert sein. Frisch sind allerdings die Erinnerungen an die Leiden die man als Einsteiger durchmachen muss bis man endlich halbwegs Boden unter die Füße bekommt. Wer auch immer sich den Hut aufsetzt, bekommt in mir einen sowohl willigen als auch billigen Wasserträger mit Option auf mehr, sobald ich soweit bin.

pluto
Lazarusforum e. V.
Beiträge: 7178
Registriert: So 19. Nov 2006, 12:06
OS, Lazarus, FPC: Linux Mint 19.3
CPU-Target: AMD
Wohnort: Oldenburg(Oldenburg)

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

Beitrag von pluto »

m.fuchs hat geschrieben:Man kann erwarten dass für tiefgreifende Dinge die Entwickler auch eine englische Dokumentation lesen können. Es muss nicht alles auf Deutsch vorhanden sein.
Dann können wir es gleich lassen. Fürs Englische findet sich bereits alles. Fürs Deutsche noch nicht.

Das bringt es nicht. Wir sollten erst mal den Anfang schaffen und zwar in der Deutschen Sprache. Schließlich ist das Forum ja auch komplett in Deutsch oder gibt es ein unter Forums für Englisch?
m.fuchs hat geschrieben:Eine veraltet Dokumentation ist schlimmer als gar keine Dokumentation. Sie suggeriert Sicherheit die nicht vorhanden ist und lässt den Nutzer verzweifeln, weil Dinge nicht so sind wie sie dort beschrieben sind.
Dieser Ansicht teile ich nicht und sie ist schädlich !

Denn, ein Anfänger oder auch jemand der Erfahrung hat wird davon enttäuscht sein und woanders hin gehen.
Wo es Aktuellere Infos gibt.

Denn eine veraltete Doku, bringt Fehler und die Sachen Funktionieren dann vielleicht zum Teil nicht mehr.
Dann kann man sich lieber den Soruce-Code direkt anschauen.
MFG
Michael Springwald

Benutzeravatar
six1
Beiträge: 782
Registriert: Do 1. Jul 2010, 19:01

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

Beitrag von six1 »

Ja, ich teile die Meinung, dass es hauptsächlich "Anfänger" im Pascal Universum betrifft.

Ging mir selbst nie anders... zu Delphi Hochzeiten war ich manchmal der Verzweiflung nahe.
Trotz mehrerer Fachbücher und drei Schinken von Andreas Kosch, konnte ich es manchmal nicht lösen.
Gut war aber, dass ich Andreas Kosch über Foren erreichen konnte und er mich auf den richtigen Weg brachte!

Es ist schön, wenn man nach ein paar Eingaben und wenigen Klicks eine gute Hilfe findet, wichtiger ist für mich im Laufe der Zeit allerdings das Forum geworden (als nicht mehr ganz "Anfänger").

Ich finde zu meinen Suchthemen eher Delphi Antworten, bin aber in der Lage das an Lazarus/fpc anzupassen.

Suberes Basic-Wiki ist gut, Forum ist bei tiefer gehenden Dingen besser; mal abgesehen von Specs und RFC's. Aber wer damit arbeitet, ist eh' ein Überlebenskünstler und fuchst sich schon durch :lol:
Gruß, Michael

Benutzeravatar
af0815
Lazarusforum e. V.
Beiträge: 6198
Registriert: So 7. Jan 2007, 10:20
OS, Lazarus, FPC: FPC fixes Lazarus fixes per fpcupdeluxe (win,linux,raspi)
CPU-Target: 32Bit (64Bit)
Wohnort: Burgenland
Kontaktdaten:

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

Beitrag von af0815 »

Ich weis nicht, ob jemand schon mal hineingeschaut hat

https://lazarusforum.de/viewforum.php?f=22 Unterstützung Lazarusproject
https://lazarusforum.de/viewtopic.php?f=22&t=244 (speziell Übersetzung des Lazarus-Wiki, begonnen 2006 diskutiert bis 2010)

https://lazarusforum.de/viewforum.php?f=27 Unterstützung Lazarusprojekt (Gruppenforum - ev. braucht man da Mitgliedschaft)

Die Themen sind in etwa gleich, nur die Personen haben bis auf wenige Ausnahmen gewechselt :-)
Blöd kann man ruhig sein, nur zu Helfen muss man sich wissen (oder nachsehen in LazInfos/LazSnippets).

Benutzeravatar
m.fuchs
Lazarusforum e. V.
Beiträge: 2636
Registriert: Fr 22. Sep 2006, 19:32
OS, Lazarus, FPC: Winux (Lazarus 2.0.10, FPC 3.2.0)
CPU-Target: x86, x64, arm
Wohnort: Berlin
Kontaktdaten:

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

Beitrag von m.fuchs »

pluto hat geschrieben:
Mi 1. Dez 2021, 00:47
m.fuchs hat geschrieben:Eine veraltet Dokumentation ist schlimmer als gar keine Dokumentation. Sie suggeriert Sicherheit die nicht vorhanden ist und lässt den Nutzer verzweifeln, weil Dinge nicht so sind wie sie dort beschrieben sind.
Dieser Ansicht teile ich nicht und sie ist schädlich !
Denn, ein Anfänger oder auch jemand der Erfahrung hat wird davon enttäuscht sein und woanders hin gehen.
Wo es Aktuellere Infos gibt.
Dann stell dir mal die Enttäuschung vor, wenn man nach Dokumentation vorgeht und es funktioniert nicht.
Und dann nach Tagen fragst man dann im Forum nach und bekommt als Antwort: "Das stimmt nicht mehr, schau mal auf die englische Seite und folge den Anweisungen".
Dann doch lieber gleich feststellen dass es nur eine englische - aber dafür funktionierende - Doku gibt.
Software, Bibliotheken, Vorträge und mehr: https://www.ypa-software.de

charlytango
Beiträge: 843
Registriert: Sa 12. Sep 2015, 12:10
OS, Lazarus, FPC: Laz stable (2.2.6, 3.x)
CPU-Target: Win 32/64, Linux64
Wohnort: Wien

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

Beitrag von charlytango »

af0815 hat geschrieben:
Mi 1. Dez 2021, 08:02
Ich weis nicht, ob jemand schon mal hineingeschaut hat

https://lazarusforum.de/viewforum.php?f=22 Unterstützung Lazarusproject
https://lazarusforum.de/viewtopic.php?f=22&t=244 (speziell Übersetzung des Lazarus-Wiki, begonnen 2006 diskutiert bis 2010)

https://lazarusforum.de/viewforum.php?f=27 Unterstützung Lazarusprojekt (Gruppenforum - ev. braucht man da Mitgliedschaft)

Die Themen sind in etwa gleich, nur die Personen haben bis auf wenige Ausnahmen gewechselt :-)
hab die Links mal überflogen.... anscheinend ist es damals gescheitert weil sie einerseits keine Rechte für das Wiki hatten um Änderungen vorzunehmen. Andererseits haben sie sich (wie wir gerade) in klein-klein-Diskussionen verloren ohne einen Masterplan zu haben.

Mein Vorschlag:
  • Grob das Ziel definieren und wie es in etwa umgesetzt werden soll. Maximal 5 Sätze.
  • Jemand finden der die Koordination macht.
  • Und mit diesem in einem nächsten Schritt etwaige Themen und Details ausmachen.
sonst drehen wir uns nur im Kreis mit gleichem Ergebnis wie 2010.

Antworten