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

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

[Der schöne Günther]

Oh, es geht weiter. Schön dass es sich nach der Internet-Kneipenschlägerei wieder beruhigt hat-

Die Verwertungsrechte der Nutzerbeiträge sind ja jetzt schon jetzt im DocWiki geklärt:

Zitat:

Bitte beachte, dass alle Beiträge zu RAD Studio API Documentation von anderen Mitwirkenden bearbeitet, geändert oder gelöscht werden können. Reiche hier keine Texte ein, falls du nicht willst, dass diese ohne Einschränkung geändert werden können.

Du bestätigst hiermit auch, dass du diese Texte selbst geschrieben hast oder diese von einer gemeinfreien Quelle kopiert hast (weitere Einzelheiten unter RAD Studio API Documentation:Urheberrechte). ÜBERTRAGE OHNE GENEHMIGUNG KEINE URHEBERRECHTLICH GESCHÜTZTEN INHALTE!

Mein großes Fragezeichen (das habe ich anfangs nicht bedacht) ist die Sprache:
Bislang liegt die Dokumentation entweder nicht oder gleich in allen vier Sprachen vor (EN, DE, FR, JA). Ich habe keinen Ansatz wie man verfahren könnte, dass sich das nicht ändert. Embarcadero wird (verständlicherweise) vermeiden wollen, dass sich verschiedene Sprachversionen inhaltlich nicht exakt gleichen.


Auch: Es gibt ja im Endeffekt eine Vielzahl an RAD Studio DocWikis: XE3, XE4, XE5, ...
Wie löst Embarcadero das technisch? Würde es ausreichen, den XE4-Artikel zu TIntegerHelper zu ändern damit sich das auf XE4-XE6 auswirkt?

Zitat von sh17:

<OT>Ist Furtbichler jetzt raus aus dem Rennen (der DP) </OP>

Finde ich wirklich enttäuschend. Fachlich konnte ich bei ihm trotz oft krassen Formulierungen nur staunen, aber so tumb und provokant eine verbale Messerstecherei anzuzetteln und dann mit fliegenden Schößen zu verschwinden? Ich behalte ihn trotzdem als eine Art Reich-Ranicki des Software Engineering in Erinnerung.

[bernau]

Wie mquadrat schon schrieb: Die Nutzerkommentare im PHP.net sind echt ne feine Sache. Würde schon was bringen, wenn man so was in das DocWiki von Emba bringen konnte. Anhand der Nutzerkommentare kann man auch sehr gut die Dringlichkeit sehen.

[Stevie]

Zitat von Smut:

Unabhängig meiner persönlichen Meinung zu dem Thema im Ganzen:
Die Doku muss in (allen?) den 4 Sprachen konsistent sein... man stelle sich vor, was sonst passieren würde. DE + English gut, FR fehlanzeige

Meine Meinung: wenn nur Englisch vorhanden ist, ist das besser, als wenn gar nix vorhanden ist.
Auch wenn man des englischen nicht mächtig ist, können die diversen Übersetzungstools gute Arbeit leisten, damit man versteht, was gemeint ist (ziehe MSDN, wo viele Einträge maschinell übersetzt sind)

Zitat von Smut:

aus welchem Film hab ich das

Die Unbestechlichen