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

Daniela Waranie typo3-community at gmx.de
Mon May 4 13:12:18 CEST 2009


Hallo Steffen,

> Ich denke mal, zusätzlich im Wiki zu dokumentieren (und im Manual zu 
> verweisen) schadet sicher nicht.
Sehr gute Idee, dass im offline Dokument (SWX) ein Verweis auf die Wiki
(neuste Dokumentenversion) enthalten sein sollte.

> Ich bin mir aber sehr sicher, dass sich am Prinzip nichts ändert, dass das 
> Manual standardmäßig mit der Extension kommt.
Es ist ja gar nicht schlimm, dass zusammen mit der Extension eine
offline Version (SWX) ausgeliefert wird. An diesem Prinzip möchte ich
auch nichts ändern. Die SWX-Datei, die im TER gelistet ist sollte jedoch
 möglichst aktuell ein - also aus der Wiki generiert werden (z.B. 1x am
Tag).

> Und für FLOW3/TYPO3 5.0 ist die Wahl des Formats übrigens auf DocBook 
> gefallen, wie du im neusten Podcast sehen kannst. Ändert aber am Prinzip der 
> Verbreitung der Doku mit der Extension auch nichts..
Ok, das ist ein funktionierender Ansatz für Entwickler - sehr akademisch
gedacht.
Mit meinem 'Konzept' wollte ich jedoch die 'Hemmschwelle' verringern.
Die im Podcast vorgestellte Lösung baut jedoch weitere 'Hürden' auf, da
folgendes benötigt wird:
- Kenntnisse über das DocBook-Format
- Kenntnisse über einen DocBook-Editor (hier z.B. XMLmind Editor
Personal Edition)
- Kenntnisse über Subversion
- Kenntnisse über einen Subversion-Client

Wenn man nur Entwickler als Authoren 'vor Augen' hat bei der
Konzeptionierung verhindet man ggf. die Teilnahme einige Übersetzer,
Lektoren oder Anwender an dem Dokumentations-Prozess. Ich finde das
schade. Das DocBook-Projekt erhält durch die TYPO3-Community so zwar
einen weiteren Push, jedoch glaube ich, dass TYPO3 so mit 'angezogener
Handbremse' auf dem Sektor 'Dokumentation' weiterfährt.

Klar, ein DocBook kann ich in alle möglichen Formate konvertieren - aber
, dass ist ja der 2te Schritt vor dem ersten. Zunächst muss ich erst was
haben, was es zu konvertieren lohnt - eine gute und aktuelle Dokumentation.

Da vermutlich aber schon einige (vor allem die Entwickler, die bis zum
Hals in Typo3-Code stehen) mit der Dokumentation derart zu frieden sind,
dass diese schon über den 2ten Schritt nachdenken und diesen aktuell
vorantreiben, muss ein Konzept zum Prozess der Dokumentationsänderung
diese Entwicklung berücksichtigen.

Vorstellbar wäre für mich auch eine Web-GUI als 'Editor' zur
SVN-DocBook-Doku, diese müsste aber den User vor dem technischen Teil
(SVN und DocBook-Format) 'schützen'. Gibt es sowas vielleicht?

(
Mit nb_subversion kommt zumindest ein SVN-Client für das TYPO3-Backend
daher. Dass müsste man für eigenloggte Typo3.org-User im Frontend
verfügbar machen und einen DocBook-Online-Editor oben drauf setzen.
)

Lieben Gruß
Daniela Waranie


More information about the TYPO3-german mailing list