[linux-l] Warum gibt es keine einheitliche Dokumentation? (war: dwww)

Peter Ross Peter.Ross at alumni.tu-berlin.de
Di Dez 26 06:25:50 CET 2006


Hi Volker,

On Tue, 26 Dec 2006, Volker Grabsch wrote:

> Plaintext
> ---------
> Man soll die wichtigsten Hinweise auch ohne Manpage-Reader
> oder ähnlichem lesen können. Gut so. 

Warum?

man(1) ist eine Standardsoftware, die bei jedem Unix/Linux dabei ist, und 
bei mir z.B. gigantische 32k gross ist (BTW "cat $manpage | nroff - man | 
less" tut's auch;-).

Es laeuft in jedem Terminal und ist nicht schwieriger zu bedienen als ein 
less oder aehnliches,

es unterteilt die Dokumentation gleichfoermig in Kapitel (auch ein gutes 
Grundgeruest, um nichts zu vergessen), die Markierung ist simpel, und es 
ist mit Standardtools durchsuchbar, man kann es "von oben nach unten" 
lesen, und weiss dann Bescheid (bei Menusystemen ist es leicht, einen 
Hinweis, den man dringend braucht, zu uebersehen, weil er irgendwo vier 
Submenus tief versteckt ist).

Es hat eigentlich auch schon Links (alles, was mit blabla(x) drinsteht, 
besonders unter SEE ALSO).

Desweiteren macht die geeignete Angabe des Manpath es einfach, deutsche 
(z.B.;-) Doku als Default anzubieten und im Falle des Fehlens auf englisch 
zurueckzufallen..

Es ist auch ohne den ganzen Wust, den Du weiter anfuehrst, jederzeit und 
ueberall lesbar.

Auch auf meinem 75MHz-Pentium mit 32MB RAM und 360MB-HD, den ich gerade 
entstaubt habe, meine Tochter muss gerade meinen Schlepptop haben,

aber - wichtiger bis firmenlebenswichtig - eben auch, wenn ich mal mit 
Nokia-Communicator+putty in der S-Bahn einen Server beatmen muss.

Kurz gesagt - man(1) wurde nicht von Dummies erfunden und hat sich 
hervorragend bewaehrt.

Fuer umfassende Doku ist es das geeigneteste System, es laesst sich auch 
leicht "aufbohren", um ein paar <HTML>-Klammern - meinetwegen ach XML - 
verpasst zu bekommen, und schon hast Du die gleiche Doku im Webbrowser - 
inklusive der Links. (siehe z.B. die CGI-Web-Manpages unter 
www.freebsd.org)

Wenn Du es jetzt schaffst, die HowTos oder Handbuecher (die wirklich 
schwer in Manpages zu bringen sind) mit ordentlichen Hinweisen auf die 
Manpages zu verheiraten, hast Du alles unter der Haube.

Ganz ehrlich - in den letzten Jahren haben viele Koeche mit 
Verbesserungen den Schlamassel der Unuebersichtlichkeit herbeigefuehrt, 
und angesichts weniger Vorteile, die oft nur in bestimmten Situationen 
greifen und in anderen eher hinderlich sind, ist das kaum 
nachzuvollziehen. Die Flexibilitaet von man(1) ist wirklich kaum zu 
schlagen..

Daher wuerde ich einfach sagen - schreibt ordentliche Manpages und nutzt 
man (oder halt ein CGI-Skript, ums im Browser darzustellen).

Und fuer den Rest, der da nicht reinpasst, schreibt Handbuecher oder 
HowTos - und sorgt dafuer, dass man alles von index.html erreichen und mit 
search.cgi finden kann.

Und wenn Du was auf Deiner Webseite, oder in 'nem Wiki schreibst - machs 
auffindbar, nicht weit von Google entfernt.

So und nun genug gelabert, ich muss der Laptop-DVD-Benutzerin "parental 
guidance" angedeihen lassen;-)

Gruss
Peter


Mehr Informationen über die Mailingliste linux-l