Cachewolf-Dokumentation

[rstweb]

Neben der eigentlichen Software wird auch an einer Dokumentation für Cachewolf gearbeitet. Verfügbar ist die Dokumentation zusammen mit den Nightly-Builds: http://cachewolf.de.ms/
Wer daran mitarbeiten möchte, kann dies gern tun. Wie man sich daran wagt, das steht alles im Thread Bitte an alle: Dokumentation fertig machen. Eine aktuelle Liste mit noch zu erledigenden Arbeiten an der Doku ist im SVN verfügbar. Die Versionsgeschichte kann ebenfalls im SVN eingesehen werden.

Dieser Thread ist dazu gedacht, um Probleme, Kritiken, Verbesserungsvorschläge und Änderungen zu sammeln. Wenn jemand bestimmte Bereiche der Dokumentation zur Pflege übernimmt, dann wird dies hier auch bekannt gegeben.

Viele Grüße

rstweb

 

[klausundelke]

Vielleicht wäre es gut, wenn die Dokumentation wie in Wikipedia ohne großen
Aufwand für jeden zu ändern wäre. Viele schreckt der Installationsaufwand und das
einarbeiten in den Editor vermutlich ab.
Gibt es da nicht irgend welche Möglichkeiten ähnlich wie Wikipedia?
Das würde sicher helfen, die Doku möglichst aktuell zu halten.

 

[pfeffer]

Es gibt den docbookwiki. Er kann in unserem Format (docbook) speichern und die Änderungen sogar automatisch ins SVN schreiben. Außerdem unterstützt er sogar Übersetzungen.

Es müsste ihn nur jemand installieren und öffentlich zugänglich machen.

Gruß,
Pfeffer.

 

[rstweb]

Vielleicht wäre es gut, wenn die Dokumentation wie in Wikipedia ohne großen
Aufwand für jeden zu ändern wäre. Viele schreckt der Installationsaufwand und das
einarbeiten in den Editor vermutlich ab.
Gibt es da nicht irgend welche Möglichkeiten ähnlich wie Wikipedia?
Das würde sicher helfen, die Doku möglichst aktuell zu halten.

Ich habe mir auch schon darüber Gedanken gemacht, da ich mit der derzeitigen Variante auch nicht 100%-ig zufrieden bin.
Ein Wiki halte ich nicht für sinnvoll. Zum Einen habe ich damit auch so meine lieben Probleme (und würde ein Wiki entsprechend nicht unbedingt als einfacher zu bedienen bezeichnen) und zum Anderen sollte die Doku als eigenständige Datei (als PDF oder HTML mit ggfs Bildern als zusätzliche Dateien) dem Cachewolf-Paket hinzugefügt werden können. Mit DocBook wird derzeit ein offener Standard verwendet, für den es einige Parser gibt.
Wenn jemand Probleme mit dem Umgang mit den DocBook-Editoren hat, dann kann er mir gern den Text, den er ändern würde, anderweitig zukommen lassen (als doc, rtf, txt, odt, ...) und ich würde den Text dann einpflegen.

 

[rstweb]

Es gibt den docbookwiki. Er kann in unserem Format (docbook) speichern und die Änderungen sogar automatisch ins SVN schreiben. Außerdem unterstützt er sogar Übersetzungen.

Das klingt interessant. Ich werde ihn mal testen, wenn ich dann zu Hause bin. Damit könnte man zumindest zweigleisig fahren.

 

[Wutschkow]

Also mich würde ein Wiki auch eher dazu motivieren, hier und da mal Texte zu überarbeiten und zu ergänzen oder eben auch mal etwas neues hinzuzufügen. Von daher fände ich es gut, wenn diese Möglichkeit entstehen würde.

Wenn es ein öffentliches Wiki gibt, dann ist es meines Erachtens nach auch nicht notwendig, Cachewolf eine umfangreiche Dokumentation beizufügen. Die kann dann ja jederzeit über das Wiki abgerufen werden.