Verbesserung der Dokumentation der Winst-Script-Funktionen

Antworten
Benutzeravatar
Neptunium
Beiträge: 224
Registriert: 03 Jul 2008, 12:08
Wohnort: Marburg - Germany

Verbesserung der Dokumentation der Winst-Script-Funktionen

Beitrag von Neptunium »

Hallo liebe uiBler,

ich suche immer in den Handbüchern von Opsi und Winst nach Hinweisen, in welchem Kontext eine Befehl oder Konfigurationsparameter erlaubt ist und sehr häufig muß ich dann schlicht zu trial&error greifen. Ich würde mir für Opsi eine Doku wünschen, die ähnlich strukturiert und informativ ist wie die vom Apache Webserver ( => http://httpd.apache.org/docs/2.2/de/mod/directives.html). Ein gutes Beispiel wäre z.B. die Redirect Directive (http://httpd.apache.org/docs/2.2/de/mod ... l#redirect):
  • Beschreibung
  • Syntax
  • Kontext (Aktionen, Subsektionen, Includes, Winbatch, ...)
  • Status
  • Auflistung und Beschreibung aller Optionen
  • Beispiele
Das zu erstellen ist sicherlich nix, was man mal grad eben in freien 5 Minuten macht, aber vielleicht ergibt es sich ja irgendwann irgendwie, wenn dieser Vorschlag überzeugt. ;)

Gruß

Dirk
Benutzeravatar
r.roeder
uib-Team
Beiträge: 540
Registriert: 02 Jul 2008, 10:08

Re: Verbesserung der Dokumentation der Winst-Script-Funktionen

Beitrag von r.roeder »

Hallo,

die Anregungen zur Gliederung zur Doku sind bedenkenswert. So ungefähr deckt die Winst-Doku ja die aufgeführten Punkte ab. Im "ungefähr" steckt natürlich das Problem. Aber z.B. alle Optionen nicht nur aufzulisten - was in der Regel geschieht -, sondern auch in allen Varianten ganz vollständig zu beschreiben und mit Beispielen zu unterfüttern, würde den Umfang der Doku schnell verdoppeln. Und eigentlich wäre ein komplettes "Refactoring" für die in zehn Jahren gewachsene winst-Doku angesagt (auch schon, um weitere Übersetzungen zu erleichtern). Kurzfristig ist der Aufwand hierfür nicht zu stemmen.

Wir planen stattdessen fürs erste, eine umfangreiche Test- und Beispielsammlung, die wir als eine Art Unit-Text entwickelt haben, zur Verfügung zu stellen. Vielleicht hilft dies dann bei etlichen Fragen weiter. Für knifflige Spezialprobleme gibt es ja immer auch noch den Support, den auch die beste Doku nicht ersetzen kann :)

Grüße!

Rupert Röder
opsi support - uib gmbh
For productive opsi installations we recommend maintainance + support contracts which are the base of opsi development.


Wondering who's using opsi? Have a look at the opsi map: http://opsi.org/opsi-map/.
Antworten