Martin Wodrich ([EMAIL PROTECTED]) schreibt:

> Joachim Merkel <[EMAIL PROTECTED]> schrieb am 02.11.05 um 03:56:

>> Ich meinte eigentlich nur, dass man den erreichten Stand etwa
>> an den Anforderungen bemessen kann. Dementsprechend waere auch
>> eine Dokumentation nur von voruebergehender Aktualitaet.

> ??? Was willst du mir damit sagen ???

Eine aktuelle Dokumentation sollte zumindest die Arbeit und die
Projektgestaltung durch die Beteiligte reflektieren. Weitere
geplante Umbauten sind teilweise schon eingebaut und sind
in der Dokumentation ebenfalls zu berücksichtigen.

Weitere Dokumentationen sind teilweise bei MH in Arbeit, wie
zum UUZ und der UKA_PPP Client-Anbindung. Die Arbeit macht man
sich dann wohl doppelt. Ein weiterer Bewertungsmaßstab ergibt
sich auch anhand der Todo- und Bugliste.


>>> Und die Unterstuetzung bei der Doku ist praktisch nicht vorhanden.
>>> Es ist daher auch schon ein Problem ueberhaupt zu wissen, wo
>>> jemand der CrossPoint nicht kennt, Probleme haette.
>> Die Zielgruppe ist nicht genau erfassbar, aber ich verfolge
>> einige laufende Dokumentationsprojekte im Netz und meine es
>> reicht oder muss reichen, zunaechst mal Gliederungshilfen fuer
>> XP-Dokumentationen zu geben.

> Was erreicht man damit? Dann hat man eine Gliederunshilfe und
> eventuell danach eine Doku die man nur als Grossbaustelle
> ansehen kann. Es muss eben doch schon sichergestellt werden, das
> auch etwas getan wird.

Wenn ich mal die Struktur nehme, die die XP-Doku hat, dann ist
es eine Übersicht des gesamten Themenkreises, eine Auffächerung
des Programms nach Anwendungszwecken und eine Vielzahl technischer
Funktionsbeschreibungen und einige nette Formulierungen machen
das ganze genießbarer.

Dein Vorschlag war wohl, zu bestimmen, auf welche speziellen
Anforderungen man eingehen muß, ohne dieselbe Ausführlichkeit
bei allen Themen durchhalten und sich auf die notwendigsten
Aktualisierungen zu beschränken. 

Ich meine, ohne eine halbwegs vollständige Themenliste aus der
Snapshot.Txt zu filtern, um zu einer Gliederung zu kommen und
um Themen genauer zu bestimmen und ebensowenig ohne die
sorgfältige Bearbeitung von Teilbereichen besteht das Problem
arbeitsaufwendiges Flickwerk produzieren, es bleibt also bei
der älteren Großbaustelle.

Ohne auch, daß diejenigen Beiträge erbringen, die darin einen
praktischen Nutzen sehen, die sich interessieren und ihre Erfahrungen
anderen mitteilen, bleiben die meisten Dokumentationen zu Programmen
solcher Projekte wie FreeXP weiter liegen. Eine Ausnahme sind die
Projekte, die "hype" sind oder sich einzelne Maintainer aufrauchen.

Ich kann mir auch vorstellen, daß Anwender mit einer unfertigen
Dokumentation leben, wenn ich zugleich sehe, das alles Sinnvolle
getan wurde, das weiterhin noch zu verbessern.

>> Um den erreichten Stand ordentlich den Anwendern zur Verfuegung
>> leiste ich gern einen Beitrag, aber eine laengere und intensive
>> Bearbeitung einer Dokumentation wuerde den dafuer von mir
>> veranschlagten Aufwand bei weitem ueberschreiten, davon abgesehen
>> ist bei mir mit Fido und Windows-Clients 'eh nicht weit her.

> Nunja, FIDO hat sich eigentlich eh nichts wirklich wessendliches
> getan, dafuer allerdings um so mehr im Bereich der Schnittstelle
> fuer externe RFC-Clients (RFC/Client). Dies muessen nicht nur
> Windows- Programme sein. Sondern das ist eben eine allgemeine
> Schnittstelle.

Ich habe noch in Erinnerung, daß der Fidoteil komplett veraltet
sei. Und zur Clientschnittstelle könnte man schon sehr viel
schreiben. Der entscheidende Punkt ist ja Themen inhaltlich
vollständig und zugleich in möglichst knappen Worten zu beschreiben.
Das macht gerade die Arbeit aus.

>> Eine befriedigende Dokumentation zu erstellen wird sicher
>> lange dauern, aber die Entscheidung darueber wie es angefasst wird,
>> liegt allein bei Dir nach dem Stand der Dinge.

> Nun, am liebsten waere mir jemand der sehr gut ist im Dokuschreiben
> und vorallem den Rueckstand erst einmal aufholen koennte.
> Danach kann man wirklich weitersehen, wie man die Doku weiter
> verbessern kann.

So wie es aussieht, wird sich niemand darum reißen, eine
neutral verfaßte und komplette Dokumentation zu erstellen.
Nach meiner Erfahrung braucht man auch eine innere Distanz bei
solchen umfangreichen Dokumentationsprojekten.
Das letzte Projekt in der Art war das Buch von den Foebud-Leuten,
die haben etwa ein halbes Jahr dran gesessen. 
Inzwischen sind fast 10 Jahre vergangen und die Doku ist nicht
wirklich neu konzipiert worden. O'Reilly wird kein Buch darüber
verlegen, also gibts keine schnelle und komfortable Lösung.
Darüberhinaus ist die vorhandene Dokumentation ein Verkaufsargument
gewesen, das trägt heute auch nicht mehr. Ebenfalls fehlen
wirklich neue Anreize.

>>> Das duerfte aber wohl eher fuer jede halbwegs stabile Version
>>> mehr oder weniger gelten.
>> Das muss aber erstmal erreicht werden.

> Die 3.40 war dies eigentlich mehr oder weniger schon mindestens
> seit sie FreeXP heisst.

Für mich hätte die auch mehr oder weniger gereicht. Einige wichtige
Sachen sind danach repariert worden, das wichtigste in Bezug auf
Stabilität wahrscheinlich für Anwender unter Windows.

-- 
Salut
 _)oachim

------------------------------------------------------------------------
FreeXP Entwickler-Mailingliste
Dev-List@freexp.de
http://www.freexp.de/cgi-bin/mailman/listinfo/dev-list

Antwort per Email an