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

[p80286]

Zitat von Satyr:

Das Produkt, der Kern bleibt Delphi. Und das ist manchen (mit z.B.) noch immer wichtig, trotz der Emba-Geschäftspolitik. Manche trennen wohl "mein Delphi" und den derzeitigen Lizenzinhaber - der eh öfter mal wechselt.

Interessante Idee, da scheint etwas dran zu sein.

Aber bleibt die Frage "wer entscheidet, koordiniert....". Genügend KnowHow ist hier vorhanden, aber wer entscheidet und vor allem hat die Zeit dafür?

Oft krankt die aktuelle Hilfe ja daran, daß sie nicht falsch aber unvollständig ist. In vielen Fällen fehlt wofür etwas gut ist. Und wenn wir ehrlich sind, verweisen wir oft genug auf die OH, weil mit der nötigen Erfahrung weiß man was gemeint ist, aber steht da auch was gemeint ist?

Wie also wollen wir das konkret angehen?

Gruß
K-H

[Nersgatt]

Ich kenne mich mit den Hilfe-Formaten nicht so wirklich aus.
Gibt es (technisch) die Möglichkeit, eine vorhandene Hilfe-Installation zu patchen?

Ich stelle mir das so vor:
Die Community, oder wer auch immer sich berufen fühlt, ergänzt die Hilfe, bzw. erstellt die fehlenden Seiten
Diese Verbesserung installiert man über die vorhandene Hilfe-Installation und erhält so eine Installation, die vollständiger/besser ist, als die mitgelieferte.
Die Ergänzungen der Hilfe werden unter eine Lizenz erstellt, die es Emba erlauben würde, sie in ihr eigenes Produkt zu integrieren.

Was man meiner Meinung nach bräuchte:
- Eine Infrastruktur, um die Erweiterungen zu sammeln
- einen Maintainer, der die Dinge sammelt, evtl sichtet (da ließen sich vielleicht weitere Helfer finden) und der daraus dann ein Setup erstellt.

[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)