[TYPO3-german] Typo3.org: Dokumentation nur auf Englisch

Daniela Waranie typo3-community at gmx.de
Wed Apr 29 12:47:56 CEST 2009


Hallo Georg,

> weil wenn wer mal was ergänzen will, geht das nur wenn das
> Ausgangsmaterial zugänglich ist. Das PDF kannst du halt nicht
> bearbeiten. 
In erster Linie ist die Dokumentation zum lesen da, und nicht zum
editieren, meine ich. Die Mehrheit liest diese "nur", daher halte ich
PDF als geeigneter.

> Und als Autor müsst ich dann ja bei PDF immer 2 Versionen
> haben, das Ausgangsgfile und das PDF.
Ich setze einfach mal voraus, dass diese Änderung es wert ist, sie mit
der Community zu teilen. Wer die Dokumentation editieren möchte, tut
dieses aus einem gegebenen Anlass - meist weil er einen Fehler gefunden
hat, übersetzen will oder eine schönere Formulierung hat. Eine locale
Kopie zu editieren und diese Änderung damit "für sich zu behalten"
möchte ich nicht gerne  unterstützen (gedankliche Grundhaltung) - somit
würde ich SXW zukünftig zu gunsten einer Wiki "Stiefmüssterlich" behandeln.

Lokal geänderte Dokumentationen (SXW) später online zu bringen, ggf. mit
hohem Aufwand in konkurierende Versionen zu integrieren, halte ich für
einen schlechten Prozess. Hier sollte grundsätzlich die Änderung am
Dokument via z.B. wiki erfolgen.

Ob die Dateiformate, wie PDF und SXW on-the-fly bei jeder Änderung in
der Wiki erstellt werden sollten oder nur in Abständen von Stunden,
Tagen oder Wochen oder OnDemand ist eine Frage der Auslastung 'unsere
Community Systeme'. Ich würde jedoch die PDF-Generierung grundsätzlich
täglich erzeugen (ähnlich wie bei NightlyBuilds) und SXW OnDemand (SXW
Dateien cachen, nur erneut erzeugen, wenn es eine Änderung in der Wiki
gab). SXW ist somit nur noch für die "ich behalte meine Änderungen vor
mich"-Leute interessant und hierauf sollte m.E. nach kein Fokus liegen.
Leider war/ist es m.E. jedoch heute auf Grund eines fehlenden, besseren
Dokumentations-Änderungs-Prozesses so, dass der Fokus auf Änderung via
SXW liegt.

Zusätzliche zu den 'NightlyBulid'-Docs (NBD) könnte es in größteren
abständen   Review-Versionen veröffentlicht werden, quasi als
Stable-Release, die zwangsläufig eine Momentaufnahme sind. Ob ein
solcher Review-Prozess jedoch SEPARAT notwendig ist bezweifel ich
jedoch, da jeder Leser potenziell auch ein Reviewer ist und das NBD
somit immer den "besten Wissensstand" repräsentiert. Das Wiki-System
bietet bei Inhalten, die von Vandalismus gefährdet sind geeignete
Schutzmaßnahmen / Prozesse - das dieses gut funktioniert zeigt
Wikipedia. Nicht vergessen dürfen wir dass jede Dokumentation (genau wir
Code) stehts Fehler beinhalten wird, solange bis die Fehler entdeckt und
beseitigt wurden.

--Ende Plädoyer für Dokumentationsänderung via Wiki--
Ich hoffe die meisten sehen das genauso.

Lieben Gruß
Daniela Waranie









More information about the TYPO3-german mailing list