Hallo Wilko!
Wilko Fokken schrieb am Sonntag, 24. August 2003:
> On Sat, Aug 23, 2003 at 03:11:20PM +0200, Wilhelm Wienemann wrote:
>> Wilko Fokken schrieb am Samstag, 23. August 2003:
>>
>>>> Am Wed, 20 Aug 2003 12:10:23 +0200 schrieb Stiglbauer Andreas:
^^^^^^^^^^^^^^^^^^^^^^^^^^
>>>>> Die untenstehende Mail brachte das Fa� zum �berlaufen und veranla�t
>>>>> mich, meinen Unmut �ber den Diskussionsstil in dieser Liste zu
>>>>> �u�ern.
>>
>> Glaube mir, das haben schon mehrere mit unterschiedlichen Ans�tzen
>> versucht. Es m�ndet nahezu immer und gnadenlos in einen Endlosthread.
>>
> meinen Senf habe ich in dieser Liste, zu diesem Thread zwar auch
> beigetragen, aber den oben erw�hnten nicht, auf denselben habe ich
> vielmehr geantwortet; tut aber nichts, Deinen Beitrag fand ich gut.
Den Verfasser des obigen Beitrags habe ich ja, wie sich das geh�rt,
zitiert. Nat�rlich hast Du Recht, ich habe wieder mal die Quadratur
des Kreises versucht, die von Dir angesprochene Passage h�tte ich
*gesondert* dem urspr�nglichen Verfasser 'ins Buch' schreiben sollen. ;-)
[...]
> Dennoch glaube ich, da� kurze, treffende Beispielsausschnitte mit
> typischen Anwendungsbedingungen den Dokumentationsaufwand nur wenig
> erh�hen, dagegen die Lernkurve des Anwenders betr�chtlich optimieren
> w�rden. Nach meiner vagen Erinnerung hatte HP um 1990 die manpages
> seines HPUX vielfach mit kleinen Anwendungsbeispielen erg�nzt, und
> nicht nur die Anwender, auch Administratoren pflegten den Aufruf der
> manpages mit der Taste fortzusetzen, die gleich zur letzten Seite
> f�hrte, wo sich die besagten Anwendungsbeispiele fanden.
HPUX ist eines der Unixe, die ich bisher noch nicht nutzen durfte.
Nach meinem bisherigen Kenntnisstand ist Hewlett-Packard mit dem
von Dir zitierten Weg der Abfassung von manpages aber einen Sonderweg
gegangen.
Bisher habe ich die manpages, �hnlich wie Bernd Brodesser es in einem
seiner Beitr�ge zu diesem Thread schon geschildert hat, als
Schnell�bersicht verstanden, die die Befehlsoptionen und Parameter klar
gliedert auflistet und kurz, aber pr�gnant beschreibt. Einzelne, wenige
manpages folgen aber Deiner Empfehlung wie z.B. 'figlet', 'procmail',
'cdrecord', 'mkisofs' etc.; insgesamt ist das aber eher die Ausnahme.
> Die Erkenntnis: "Ein Bild sagt mehr als tausend Worte" m�chte ich
> erg�nzen mit: "Ein Beispiel sagt mehr als hundert Definitionen".
> Vor allem versteht man noch unbekannte Definitionen viel leichter, wenn
> man zuvor einen Einstieg in die Programmfunktionen durch kleine Beispiele
> gefunden hat.
Das ist aber gerade das schwierige Unterfangen. Die m�glichen Parameter
und Optionen sind selbst bei kleinsten Programmen so vielf�ltig und
oft kontr�r zueinander, dass es den Rahmen einer manpage formal
allzuleicht sprengen w�rde. Einzelne manpages (z.B. bash, csh, vi etc.)
sind trotz strenger Orientierung an die formale Struktur bereits so
aufgebl�ht, dass man sich oftmals �berhaupt nicht traut, diese zu
benutzen. Wenn dann noch eine Vielzahl von Beispielen dokumentiert w�re,
dann w�re die urspr�ngliche Handhabung sicher nicht mehr gew�hrleistet.
IMHO gibts dazu weiterf�hrende und geeignetere Dokumentationen.
Auch die bekannten Buchautoren, die es gewagt haben, sich diesem Thema
zu n�hern, sind sehr schnell mit ihren Versuchen auf einzelne pr�gnante
Beispiele ausgewichen, da sie festgestellt haben, dass eine l�ckenlose
Darlegung aller Nutzungs- und Kombinationsvarianten sehr schnell ein
ganzes B�cherregal f�llen w�rde.
> Zum Schlu� bitte ich noch um Hinweise, wie man sich �u�ern soll, wenn
> man glaubt, selbst eine Probleml�sung gefunden zu haben, die andere
> interessieren k�nnte.
Auch wenn es manchmal lange dauert und vielleicht auch erst �ber gewisse
Umwege unter Beweis gestellt wird, so kann man doch res�mieren, dass
Qualit�t sich immer behaupten wird. Das haben nicht nur Dokumentationen,
Diskussionen und Betriebssysteme gemeinsam. :-))
Wenn Du eine Dokumentationsidee hast, die sich als p�dagogisch bessere
darstellt, lasse Dich nicht aufhalten und diese in Form von HOWTOs, FAQs
oder auch manpages - m�glichst unter GPL - oder gar in einem Buch zu
ver�ffentlichen.
Manche Autoren guter Dokumentationen wie z.B. Peter H. Ganten, Frank
Ronneburg, Michael Kofler, Jochen Hein, John Goerzen, Ossama Othman,
Michael Bramer, Sebastian Hetze, Dirk Hohndel, Martin M�ller, Olaf Kirch
und viele andere haben das - jeder auf seine Weise - treffend unter
Beweis gestellt.
> In dieser Liste scheint mir die ungefragte Ver�ffentlichung einer
> Probleml�sung noch nicht vorgekommen zu sein.
Sorry, dem muss ich widersprechen. Bereits in meinen vorausgegangenen
Beitrag habe ich zum Ausdruck gebracht, dass ich aus mannigfachen
Diskussionen - auch wenn ich daran nicht unmittelbar beteiligt war -
wertvolle Tipps und Hinweise, ja auch viele Probleml�sungen f�r mich
entlehnen und entnehmen konnte. Den unz�hligen und den inzwischen
teilweise auch unbekannten Verfassern in dieser und anderen Mailinglisten
sowie Newsgroups sei an dieser Stelle herzlich gedankt!
Dir und allen Mitlesern der Mailingliste einen sch�nen Sonntag!
Gr��e - Wilhelm
--
(�> Wilhelm Wienemann <[EMAIL PROTECTED]> -�) -�)
//\ Gr��e vom NiederRhein, der Region mit R(h)einKultur /\\ /\\
V_/_ _\_V _\_V
--
Haeufig gestellte Fragen und Antworten (FAQ):
http://www.de.debian.org/debian-user-german-FAQ/
Zum AUSTRAGEN schicken Sie eine Mail an [EMAIL PROTECTED]
mit dem Subject "unsubscribe". Probleme? Mail an [EMAIL PROTECTED] (engl)
