Re: Wie dokumentiert ihr? Suche eleganten Weg für Dokumentation.
Zitat von Thorsten Haude <debian@thorstenhau.de>:
> Das ist jetzt aber schon etwas außerhalb der Fragestellung. Profis
> sollten schon selbst die eine oder andere Idee haben.
yep, haben sie. Aber das Bessere ist wie immer der Feind des Bestehenden.
Deshalb auch meine ursprüngliche Frage: "Wie dokumentiert Ihr?"
Ein gutes Beispiel ist mein WLAN-Router. Da gab es einige Ecken und Kanten, bis
das Ding tatsächlich lief. Da gibt's keine Möglichkeit irgendwelche
Konfig-Dateien aufzupeppen. Alles läuft über das WebInterface.
Also habe ich das ganze Prozedere in einem Wiki protokolliert und schlußendlich
dokumentiert. Das ist zwar zum schnellen Nachschlagen gut geeignet, aber mit
der Zeit gibt's einige Anwendungen, die mich nach einer eleganteren Art der
Dokumentation Ausschau halten ließen. Zum Beispiel wird in einem Forum
nachgefragt wie die WLAN-Einstellungen von diesem WLAN-Router sein müssen.
Ich will gerne helfen, aber jetzt wird's sperrig. Die Dokumentation im Wiki
sieht zwar gut aus, aber für den Export taugt sie nicht viel. Auch die
druckfreundliche Anzeige bringt nur etwas Verbesserung. Es bleibt, daß
praktisch alle Formatierungsdetails und Auszeichnungen beim Übertragen in den
Mail-Text verloren gehen. Eine pdf-Datei schaffte Abhilfe. Aber in einem Forum
ist das nicht so glücklich. Die pure Wiki-Syntax kann ich aber auch nicht ins
Forum stellen.
Andererseits bin ich nicht professioneller Foren-Supporter, so daß ich nicht
ewig Zeit habe auf Fragen zu antworten.
Also wäre ein Ausgangsformat für Dokumentationen, mit dem man bei Bedarf die
unterschiedlichsten Zielformate kreieren kann am schnellsten. Darüberhinaus
sollte es aber auch einfach in der Handhabung -- deshalb mein Einwurf wegen
DocBook -- und einfach zu bedienen und lernen sein.
Und da kamen jetzt schon eine ganze Menge Ideen zusammen.
Ciao, Georg
Reply to: