Anforderungen an eine Dokumentation

Dieses Thema im Forum "Programmieren allgemein" wurde erstellt von Tim_Tux, 21.04.2008.

  1. #1 Tim_Tux, 21.04.2008
    Tim_Tux

    Tim_Tux Mitglied

    Dabei seit:
    03.06.2006
    Beiträge:
    35
    Zustimmungen:
    0
    Ort:
    München
    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
     
  2. Anzeige

    Schau dir mal diese Kategorie an. Dort findest du bestimmt etwas.
    Registrieren bzw. einloggen, um diese und auch andere Anzeigen zu deaktivieren
  3. #2 BloodyMary, 21.04.2008
    BloodyMary

    BloodyMary Pornophon

    Dabei seit:
    15.03.2005
    Beiträge:
    615
    Zustimmungen:
    1
    Ort:
    Bayern
  4. #3 schwedenmann, 21.04.2008
    schwedenmann

    schwedenmann Foren Gott

    Dabei seit:
    18.11.2003
    Beiträge:
    2.635
    Zustimmungen:
    2
    Ort:
    Wegberg
    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
     
  5. #4 Tim_Tux, 21.04.2008
    Tim_Tux

    Tim_Tux Mitglied

    Dabei seit:
    03.06.2006
    Beiträge:
    35
    Zustimmungen:
    0
    Ort:
    München
    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.
     
  6. #5 BloodyMary, 21.04.2008
    BloodyMary

    BloodyMary Pornophon

    Dabei seit:
    15.03.2005
    Beiträge:
    615
    Zustimmungen:
    1
    Ort:
    Bayern
    MEld dich bei ISO und RFC und wie sie alle heissen
     
  7. Anzeige

    Vielleicht findest du HIER Antworten.
    Registrieren bzw. einloggen, um diese und auch andere Anzeigen zu deaktivieren
  8. cremi

    cremi Dude

    Dabei seit:
    15.02.2004
    Beiträge:
    329
    Zustimmungen:
    0
    Ort:
    AUT/Ktn
    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.
     
  9. #7 BloodyMary, 22.04.2008
    BloodyMary

    BloodyMary Pornophon

    Dabei seit:
    15.03.2005
    Beiträge:
    615
    Zustimmungen:
    1
    Ort:
    Bayern
    Ich wette das es da auch von den einzelnen Distributionen Standarts gibts, z.B. sehen sich alle man Pages sehr ähnlich.
     
Thema:

Anforderungen an eine Dokumentation

Die Seite wird geladen...

Anforderungen an eine Dokumentation - Ähnliche Themen

  1. Starbound laggt - Systemanforderungen ?

    Starbound laggt - Systemanforderungen ?: Hallo, ich versuche Starbound unter Linux zu spielen und das Spiel laggt extrem. Ich frage mich, ob es am Laptop liegt: Es ist ein HP Compaq...
  2. Systemanforderungen testen

    Systemanforderungen testen: Im Voraus: Bin noch Anfänger. Wenn ich jetzt mein erste Programm fertig habe, wie kann ich dann Systemanforderungen testen? Weil ich gerne...
  3. Linux erfüllt Anforderungen für IPv6

    Linux erfüllt Anforderungen für IPv6: Eine Arbeitsgruppe der Linux Foundation hat die behördlichen Anforderungen an IPv6-Implementierungen analysiert und die bestehenden Lücken...
  4. openSuSE 10.3 Systemanforderungen

    openSuSE 10.3 Systemanforderungen: Weiß jemand schon die Systemanforderungen von SuSE 10.3? auch die von der "Vollversion"? (also nicht die alpha) Grüße kimi
  5. Kolab Erfahrungen? Anforderungen, Komponenten?

    Kolab Erfahrungen? Anforderungen, Komponenten?: Hallo liebes Board! Ich weiss so einen Thread gibt es schon, und der ist sogar auch von mir, aber er ist auch schon was alt. Seit dem sind...