Die Dokumentation muss besser werden. Wie können WIR helfen?

[Satyr]

Zitat von Daniel:

Wenn es das Ziel sein soll, dass die erarbeiteten Inhalte in das DocWiki gelangen, dann müssen wir uns von Anfang an auf eine inhaltliche und sprachliche Form (auch auf Deutsch) verständigen, die das überhaupt zulässt. Wobei ich mir aktuell noch nicht im Klaren bin, wie eine technische Realisierung überhaupt aussehen könnte. Lediglich ein Wiki auf einen Webspace zu klatschen scheint mir noch nicht genug an Integration und Unterstützung.

Wäre es theoretisch möglich das jemand ein kleines Plugin für Delphi bastelt, das von dort aus mit diesem Wiki kommunizieren kann? Also eine Art zweite, integrierte, Hilfe?
Ich frage weil ich mit sowas keine Erfahrung habe aber weiß wie gut sich GExperts & Co. integrieren können.

[Nersgatt]

Zitat von Daniel:

Wenn es das Ziel sein soll, dass die erarbeiteten Inhalte in das DocWiki gelangen, dann müssen wir uns von Anfang an auf eine inhaltliche und sprachliche Form (auch auf Deutsch) verständigen, die das überhaupt zulässt.

Auch muss vorher geklärt werden, unter welcher Lizenz Beiträge in dem Wiki stünden, damit das rechtlich überhaupt übernommen werden darf.

[Daniel]

Zitat von Nersgatt:

Auch muss vorher geklärt werden, unter welcher Lizenz Beiträge in dem Wiki stünden, damit das rechtlich überhaupt übernommen werden darf.

Das ist ein guter Hinweis - das gesamte Projekt müsste so gestaltet sein, dass alle Inhalte mit dem (einzigen) Ziel eingestellt werden, am Ende in der offiziellen Hilfe zu landen. Alles andere ergäbe keinen Sinn. Aber natürlich muss das vorher so kommuniziert werden, dass dies jedem Beteiligten klar ist.

[Nersgatt]

Zitat von Daniel:

Zitat von Nersgatt:

Auch muss vorher geklärt werden, unter welcher Lizenz Beiträge in dem Wiki stünden, damit das rechtlich überhaupt übernommen werden darf.

Das ist ein guter Hinweis - das gesamte Projekt müsste so gestaltet sein, dass alle Inhalte mit dem (einzigen) Ziel eingestellt werden, am Ende in der offiziellen Hilfe zu landen. Alles andere ergäbe keinen Sinn. Aber natürlich muss das vorher so kommuniziert werden, dass dies jedem Beteiligten klar ist.

Genau so!

[Perlsau]

Zitat von Daniel:

Das ist ein guter Hinweis - das gesamte Projekt müsste so gestaltet sein, dass alle Inhalte mit dem (einzigen) Ziel eingestellt werden, am Ende in der offiziellen Hilfe zu landen. Alles andere ergäbe keinen Sinn.

Zwar kann ich mich jetzt wirklich nicht als Embarcardero-Insider bezeichnen, doch habe ich im Lauf der Jahre den Eindruck gewonnen, daß Embarcardero nicht unbedingt daran interessiert ist, von außen kommende Verbesserungen ihrer Produkte integrieren zu wollen. Das beste Beispiel ist wohl das Fixpack, das weiterhin von Herrn Hausladen aktuell gehalten wird, weil die Entwickler bei Emba die darin enthaltenen Verbesserungen offenbar nicht in ihr Produkt einzubauen bereit sind. Die sparen sich Arbeitszeit und lassen den guten Mann weiterhin umsonst ausbessern, was eigentlich ihre Aufgabe wäre.

Dasselbe könnte auch mit Ergänzungen der Online-Hilfe geschehen. Daher könnte es schon Sinn machen, das genannte Ziel nicht dermaßen einzuschränken, sondern auch die Möglichkeit offen zu lassen, eine Ersatz-Online-Hilfe zu entwickeln, die man anstelle der offiziellen OH einbinden kann. Auch da müßte man natürlich auch erst Emba um Erlaubnis bitten, da ja auch unter Emba-Copyright stehende Inhalte übernommen werden müßten.

[Daniel]

Ziel eines solchen Projektes müsste es sein, die eingestellten Inhalte der Community verfügbar zu machen. Sei es über die offizielle Hilfe doer auf anderen Kanälen.
Es darf dabei keine Einschränkungen bzgl. der Verwendbarkeit der Inhalte (kommerziell / nicht-kommerziell etc.) geben, das würde das Projekt ad absurdum führen.

[Perlsau]

Sehe ich auch so: keine Einschränkungen hinsichtlich der Verwendbarkeit.

[stahli]

Ich sehe hier auch ein rein pragmatisches Problem.

Ich könnte mir vorstellen, dass es (erst mal nur in der DP) gar nicht viele Leute gibt, die Informationen zu VCL- und FMX-Funktionen oder zu neuen Spachkonstrukten (Generics, annonyme Methoden usw) bzw. systemnahmen Aufrufen auf unterschiedlichen Plattformen verfassen können (mind. deutsch und englisch).
Man müsste dann ja u.U. noch viele Hintergrundinformationen über die technischen Aspekte und die Überlegungen des Herstellers haben.

Wenn ich zurück denke, wie oft hier über die Speicherverwaltung unter ARM usw. spekuliert wurde kann ich mir nicht vorstellen, wer hier entsprechende Hilfetexte verfassen soll.

Und selbst wenn es einige Leute gesichert tun könnten müssten die ja noch genug Zeit dafür übrig haben. In der DP müssten sie ihre Hilfestellungen sicherlich reduzieren.

Ich habe auf keinen Fall etwas gegen das Vorhaben, zweifle aber etwas an der nachhaltigen Umsetzbarkeit.

[jaenicke]

Ich denke es fehlen auch genug Informationen bei Basics. Da steht oft einfach nur da was das für eine Eigenschaft ist. Das war bei der alten Hilfe von Delphi 7 und früher auch oft nicht anders.

Das reicht aber oft nicht ohne z.B. in den VCL-Quelltext zu schauen. Da sollte es oft noch deutlich mehr an hilfreichen Tipps und Beispielen geben.

Neue Features zu dokumentieren, die noch niemand kennt, ist eine ganz andere Baustelle, die denke ich durch ein solches Projekt weder abgedeckt werden kann noch soll.
(Generics, anonyme Methoden usw. zähle ich da allerdings nicht dazu, die sind doch schon recht gut bekannt.)

Ein Problem ist aber in der Tat die Sprache. Ich kann zwar z.B. recht gut Englisch, aber ob meine Texte qualitativ ausreichen um in eine solche Dokumentation zu kommen, wäre ich mir nicht so sicher. Und so geht es vermutlich vielen hier.

[Stevie]

Meiner Meinung nach, müsste man es international aufziehen (außer man will nur eine Verbesserung für die deutsche Hilfe), denn dann vervielfacht sich der Pool an Resourcen (natürlich auch ein wenig die Koordination).

Ich denke auch, man sollte trennen zwischen "bestehende Einträge sichten und Fehler korrigieren" und "komplett fehlende Einträge schreiben". Ich kann mir vorstellen, dass der erste Punkt problemloser gehen wird, gerade was die Integration in die offizielle Hilfe angeht.

Da ich aber nicht weiß, woran es liegt, dass für viele Features die Einträge komplett fehlen (vermutlich der typische Fall von "wurde einfach gecoded aber keiner hats mal dokumentiert" - dann schreibt sich das nicht von selber, kenn ich selber *g*).