Wie erstelle ich eine Dokumentation?



  • Hallo!

    Für die Berufsschule sollten wir ein Programm schreiben das wie eine Arbeit gewertet wird, dass Programm an sich ist zu 98% fertig nur müssen wir auch eine Dokumentation dazu machen aber uns wurde nie gesagt wie das geht, nur was in unserem Falle rein muss:

    - Bedienung
    - Anforderungen
    - Mögliche Erweiterungen
    - Fehlerreferenz
    - Name, Ansprechpartner
    - Beschreibung

    Sprich es wird eine Produktdokumentation und keine Prozessdoku. Das Problem ist nur das ich absolut nicht weiß wie das geht, hat hier jemand evt. eine Referenz parat? Bei der Prozessdoku könnte ich wenigstens in der MSDN schauen wie die das machen.



  • Im Grunde schreibt ihr einen ganz normalen Bericht. Die Themen sind ja schon mal vorgegeben.

    Bei den Anforderungen schreibt ihr auf, das die Applikation das und dies erfüllen muß. Z.B. das sie unter Windows laufen muß, da der Kunde nur Windows-Rechner hat. Oder das es eine besondere Architektur geben muß, z.B. einen Client und einen Datenbank-Server, und das mehrere User auf dem Server arbeiten müssen. Wenn bekannt ist, wieviel User es geben wird, muß das System so aufgebaut werden, das ein vernünftiges Arbeiten möglich ist.

    Das schreibt ihr ganz normal, als Bericht. Kleine Illustrationen können das ganze auflockern.

    Da gibts eigentlich nichts spezielles zu beachten.



  • Danke schon mal!
    Falls noch jemand ein Bsp hat nur her damit 🙂


Anmelden zum Antworten