Programmdokumentation schreiben

Es gibt 3 Antworten in diesem Thema. Der letzte Beitrag () ist von gfcwfzkm.

    Programmdokumentation schreiben

    Hallo,

    ich möchte mein Programm ausführlich Dokumentieren, jedoch weiss ich nicht, wie ich sowas am Besten angehen soll.
    Soll man da Auch Flussdiagramme verwenden? (Habe Microsoft Visio) Oder direkt ein eigenes Word-Dokument?

    Gibt es gewisse "Richtlinien" beim dokumentieren, woran man sich halten könnte?

    mfg

    gfc

    Pinki ich glaube er meint eine ausführliche Dokumentation als Hilfe. So hatte ich es jetzt verstanden.
    Falls ich es missverstanden habe, ist Pinki Lösung die dem MS Visio vorzuziehen.


    Ich hatte das mal für ein Programm in HTML gemacht und diese dann einfach als Frame in einer "Hilfe" Form angezeigt.
    Der Vorteil war, du musst nicht ewig formatieren und Links erstellen, da in HTML recht einfach Text mit Bilder zu Erläuterung
    und die dazugehörigen Sprungpunkte (Anker) gesetzt werden können.
    Und man hat gleich die Doku für die Webseite fertig, sofern nötig.

    Oh, danke =)

    vorallem das "Generieren von Nicer-Dokumentation" gefällt mir, jedoch habe ich da ein Problem.

    Und zwar kann ich die Dateien nicht in \Examples\Sandcastle\ kopieren. Es verlangt das Admin-PW (Das ich habe) aber wenn ich es eingegeben habe, sieht man den Ladebalken vom kopiervorgang, aber danach sind die Dateien trotzdem nicht da :(

    Ich probier es mal per CMD (Kann es ja als Admin ausführen) aber kenne nicht den Befehl, um z.B. alle Dateien mit dem Namen "TelnetDemo" zu kopieren

    :(

    gfc

    EDIT://
    Meine das Dokumentieren vom Quellcode (damit auch andere sich darin zurechtfinden). Die "Bedienungsanleitung" mach ich auf Papier ;D

    Doppeledit ://
    Irgendwie geht es nicht. Das Programm stürzt immer ab. Ich habe es mit: "build_Sandcastle.bat prototype TelnetDemo" ausgeführt.

    Dieser Beitrag wurde bereits 1 mal editiert, zuletzt von „gfcwfzkm“ ()

Facebook
Telefonspende