[linux-l] Private Notizen, Howtos, etc. (was: X-Terminals und deren "Unterschiede"?)

Volker Grabsch vog at notjusthosting.com
So Aug 19 12:24:30 CEST 2007


On Sun, Aug 19, 2007 at 10:00:54AM +0200, Steffen Schulz wrote:
> > > Musst du ja nicht.
> > Hm. Ich müsste vor allem anfangen, mir mal wieder Notizzettel zu machen 
> > (so wie ich es als 12jähriger zu DOS-Zeiten gemacht habe), um mir das 
> > alles zu merken...
> 
> Was es nicht bei google gibt, kann
> man auch in text-dateien schreiben, dann muss man das nicht abtippen.

Nicht schreiben - kopieren!  :-)

Zumindest, wenn die Webseite gut genug ist, dass man die Beispiele
direkt herauskopieren kann und sie bei einem laufen.

Wenn eine Webseite so gut ist, sollte man sie auch in seine Linkliste
aufnehmen. ("Lesezeichen" im Browser, Textdatei mit URLs, ...)

Meist muss man Herauskopierte aber noch verbessern. Zum Beispiel Labertext
entfernen, und stattdessen Kommentare hinein bringen, die einem wirklich
helfen. Und irgendwelche Fehler korrigieren, kaum eine Howto funktioniert
auf Anhieb.

Ich habe es mir angewöhnt, größere Arbeiten auf jeden Fall zu
dokumentieren. Nicht alles haarfein erklären, nur das "Warum" und die
Stolpersteine. Aber ausführlich genug, um es später überwiegend mit
Copy & Paste wiederholen zu können.

Und für solch eine Dokumentation hat die Kommandozeile ihre Stärken.
Statt mühselig zu beschreiben, wie man durch welche Menü hindurch welche
Einstellungen ändert, kopiere ich einfach die Kommando. So, wie ich sie
eingegeben habe, landen sie in der Doku.

An der Kommandozeile führt man einen Dialog, genau wie in einer
Anleitung. Eine GUI ist da anders, deshalb auch schwerer / unangenehmer
zu dokumentieren. Es sei denn, natürlich, die GUI ist selbsterklärend.
Das ist super, dann ist nämlich die GUI gleichzeitig Programm und
Anwender-Doku, so wie es sich gehört.

Aber in dem Moment, wo bei eine GUI nicht mehr klar ist, was man wo
findet bzw. eintragen muss, wird das Doku-Schreiben nervend. Lieber
beschreibe ich 3 Shell-Kommandos als zu erklären, wie man sich durch
eine Webseite / GUI / was auch immer hindurchhangeln muss.

Zumal sich diese Dinge auch nicht richtig automatisieren lassen,
während man bei Kommandozeilen-Aktionen mit Copy & Paste arbeiten
kann, oder sogar die Howto zu einem Shellscript weiterentwickeln kann.

(In Sinne des Literate Programmings habe ich auch schonmal daran
gedacht, eine Howto zu entwickeln, die tatsächlich *gleichzeitig*
auch ein lauffähiges Shellscript ist. Mehrere Proof-Of-Concepts
habe ich schon.)


Gruß,

    Volker

-- 
Volker Grabsch
---<<(())>>---
Administrator
NotJustHosting GbR



Mehr Informationen über die Mailingliste linux-l