Anforderungen an eine Dokumentation

T

Tim_Tux

Mitglied
Hallo,

ich möchte/muss eine saubere Dokumentation entwerfen. Es ist nicht ganz einfach die richtige Forenkategorie zu finden, aber ich denke, dass Programm und Dokumentation einhergehen und ich hier nicht so falsch bin.

Bislang habe ich immer intuitiv losgeschrieben und hatte nie Vorlagen an der Hand. Nun stellt sich mir aber doch die Frage, ob es nicht bestimmte Normen für das Anfertigen von Dokumentationen (Zielgruppe: Admins, die die Software später installieren und konfigurieren) gibt.

Wenn jemand Tipps oder einen Pointer dazu parat hätte, wäre ich sehr dankbar.

Gruß und Dank
 
Dokumentation

Hallo

Das Einzige, was mir im Moment dazu einfält, sind Kompltte Formatierungen

siehe dazu man und die Linux HowTo (die haben eine eigene documentclass, wenn ich mich recht erinnere.)

Also die Form ist teilweise vorgegeben, aber der Aufbau, Gliederung ist völlig dir überlassen.

mfg
schwedenmann
 
Interessant, dass es da keine Norm zu geben scheint. Man könnte sicherlich einiges an Geschimpfe über schlechte Dokus eliminieren, wenn es da klare Richtlinien gäbe.

Ich danke Euch erstmal für die Tipps. Eine sinnvolle Gliederung wird mir schon einfallen.
 
MEld dich bei ISO und RFC und wie sie alle heissen
 
Formatierung, Standards, bla bla bla - gibts irgendwo - schau dir halt mal UML an.

Das wichtige ist imho die Verständlichkeit und Nachvollziehbarkeit. Bei uns machen wir das immer so: Wenn eine Doku fertig ist, lassen wir damit einen Unbeteiligten, kein Informtaiker (z.B.: Sekretärin, Putzfrau, Buchalter/in) damit arbeiten. Und jede noch zu kleine und unbedeutende Frage wird beantwortet und in die Doku aufgenommen.

Ein Doku ist dann richtig gut, wenn jeder (egal welcher Background) damit das Programm anwenden, installieren,... kann.

Für die technischen Specs gibts eh Standards wie UML.
 
Ich wette das es da auch von den einzelnen Distributionen Standarts gibts, z.B. sehen sich alle man Pages sehr ähnlich.
 
Anmelden, um zu antworten.

Neueste Themen

Zurück
Oben