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

[jaenicke]

Ich denke mal etwas anderes als ein Wiki macht für so ein Projekt keinen Sinn. Insbesondere müsste es eins sein, dass zu den einzelnen Seiten eine direkte Diskussion erlaubt, das gibt es ja als fertige Lösung.

Und dann gibt es drei teilweise schon diskutierte Möglichkeiten, letztere fände ich nicht schlecht, insbesondere wenn die anderen nicht so ohne weiteres gehen:

• Entweder mit Unterstützung durch Embarcadero und direkte Integration in die Hilfe
• Wie genannt eine nachträgliche Injektion der Seiten, was über die Registrierung der benutzten Hilfe gehen könnte
• Oder einfach eine Integration hier in die Delphi-Referenz der DP, sofern Daniel das unterstützen würde

[Uwe Raabe]

Zitat von jaenicke:

Insbesondere müsste es eins sein, dass zu den einzelnen Seiten eine direkte Diskussion erlaubt

Das ist mit dem Delphi DocWiki aber bereits möglich.

Ich kann aber auch nachvollziehen, daß Embarcadero keine direkten Änderungen der Hilfs-Inhalte erlaubt.

[mquadrat]

Meine bescheidene Meinung:

- Entfernen der offline-Delphi-Hilfe
- Im DocWiki Nutzerkommentare erlauben (siehe z.B. PHP.net)
- Bei F1 direktes Öffnen des Hilfe-Themas im DocWiki

Ergebnis:

- Dokumentation kann laufend verändert werden
- Nutzerkommentare helfen einem ggf. über Stolpersteine hinweg, die in der Doku nicht erwähnt werden

Ich arbeitete mit mehreren Sprachen und die Variante von PHP funktioniert gut, MSDN ist auch halbwegs brauchbar (wobei sich Google da logischerweise gerne im Versionsdschungel verrennt). Java finde ich persönlich so ziemlich die schlechteste Doku, die es gibt. Dort ist zwar alles, wirklich alles dokumentiert, aber helfen tut es oft nicht :p

[Medium]

Als jemand, der öfter auch direkt beim Kunden (d.h. in Fertigungshallen fern ab jeglichem Internetzugangs) programmiert: Strikt gegen eine reine Online-Lösung! Wenn dann so, dass man ein Offlinesystem hat, dass sich regelmäßig und wenn möglich mit einer online DB synchronisiert. Bei Online-Only bekomme ich immer leicht agressive Neuronenkrämpfe.

[jaenicke]

Zitat von Uwe Raabe:

Ich kann aber auch nachvollziehen, daß Embarcadero keine direkten Änderungen der Hilfs-Inhalte erlaubt.

Wobei es bei Wikipedia ja auch so ist, dass zuerst ein Review stattfinden kann bevor neue Seiten und Änderungen freigeschaltet werden.

Das Problem ist nur, dass dann jemand die Änderungen auch prüfen muss.

[Nersgatt]

Mir würde auch eine (optionale) Offline-Lösung mehr gefallen, als eine reine Onlinelösung.
Wobei das Wiki, was Sebastian ansprach, ja ein Sammelbecken/Zentralpunkt sein kann, woraus dann eine Offlinemöglichkeit generiert wird.

[mkinzler]

Die Bereitstellung eines Wikis wäre kein Problem. Es ist nur die Frage, ob EMBT uns erlaubt Ihren Content (Inhalt Hilfe/Onlinedoku) dort einzufügen (um ihn dort Korrekturen/Ergänzungen zu erlauben)

[Satyr]

Ich habe mal irgendwo hier im Forum gelesen das es hier Leute mit Kontakt zu Emba gibt. Hat man da schon mal versucht Emba anzusprechen? Vielleicht haben die auch Ideen wie eine Art Zusammenarbeit in dem Bereich aussehen könnte.

[Daniel]

Meiner Ansicht nach können wir nur "ergänzend" arbeiten - wir können nicht einfach ein eigenes Wiki aufziehen, dessen Basis die Delphi-Hilfe darstellt.

Entweder geht man gleich in das Original-Wiki, dann muss man seine Inhalte jedoch in brauchbarem Englisch beisteuern oder wir basteln und selbst etwas, mit dem wir in der DP arbeiten können und dies als Teil der Referenz verwenden. Von hier aus ist der Weg in das offizielle Wiki nicht ausgeschlossen: Ich habe passende Kontakte in die Staaten und könnte auf diesem Weg auch versuchen, ausgewählte Inhalte von uns zu denen transferieren zu lassen.

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.

Der Ansatz, lokal in der DP zu beginnen, hätte den Charme, dass Erfolge unmittelbar sicht- und greifbar werden, wenn die Inhalte in die Online-Referenz integriert werden.

[bernau]

Ja, hier lesen Leute von Emba mit. Deshalb finde ich es auch gut, daß "Der schöne Günther" diesen Thread eröffnet hat.