Re: Wie dokumentiert ihr? Suche eleganten Weg für Dokumentation.
On Mon, 14 Nov 2005 20:24:39 +0100, Thorsten Haude
<debian@thorstenhau.de> wrote:
>* Marc Haber wrote (2005-11-14 08:18):
>><debian@thorstenhau.de> wrote:
>>>* Georg Lohrer wrote (2005-11-13 18:56):
>>>>ich meine damit nicht offizielle Dokumentationen, wie sie in bestimmten
>>>>Projekten gefordert sind. Da ist man zumeist festgelegt. Es geht mir vielmehr
>>>>umd die eigenen kleine Projekte, die hints und tips, die sich mit der Zeit
>>>>ansammeln und die, besonders unter Linux notwendigen, HOWTO's aus eigener
>>>>Erfahrung.
>>>
>>>Kommentare in Quell- oder Konfigurationsdateien.
>>
>>Taugt nicht für Systeme, die über ein Webinterface konfiguriert werden
>
>Warum das nicht?
Weil diese Webinterfaces üblicherweise Kommentare ignorieren, nicht an
den User des Webinterfaces weitergeben, und schlimmstenfalls bei
Veränderungen an den Konfigdateien die Kommentare einfach plattmachen.
>>oder deren Konfigurationsdatei keine Kommentare kennt
>
>Ich würde sagen: Solche Systeme taugen nichts.
Cisco IOS und kompatible (Foundry, zebra, quagga, Teile von hp). Taugt
zwar nicht so wirklich was, ist aber trotzdem weltweit weit verbreitet
im Einsatz. Wenn ich mir das so angucke, ist mir noch kein Switch über
den Weg gelaufen, der Kommentare in der Konfiguration erlaubt.
>>sowie ebenfalls nicht für Dokumentation, die zur Weitergabe an Kunden
>>gedacht ist.
>
>Das ist jetzt aber schon etwas außerhalb der Fragestellung. Profis
>sollten schon selbst die eine oder andere Idee haben.
Die eine oder andere Idee hat man durchaus selbst, wenn auch die
meisten "Profis" ihre Dokumentation ganz professionell als .doc mit
voller Bearbeitungshistorie abliefern, aus der man klar erkennen kann,
für welche anderen Kunden dieser "Profi" bereits ähnliche Projekte
gemacht hat, von wo die Dokumentation überall zusammenkopiert ist.
Professionelles Arbeiten ist aber auch, dass man sich von Kollegen und
Konkurrenten inspirieren lässt.
Grüße
Marc, der seine Doku in Dokuwiki pflegt, mit offline-doku statisch
exportiert und dem Kunden das entstehende HTML gibt.
--
-------------------------------------- !! No courtesy copies, please !! -----
Marc Haber | " Questions are the | Mailadresse im Header
Mannheim, Germany | Beginning of Wisdom " | http://www.zugschlus.de/
Nordisch by Nature | Lt. Worf, TNG "Rightful Heir" | Fon: *49 621 72739834
Reply to: