Technische Dokumentation - Wie?

[Codemaschine]

Hallo!

Ich habe in meinem Projektantrag angegeben, dass ich neben dem dokumentierten Quellcode auch eine Technische Dokumentation erstelle und beifüge.

Nun stellt sich die Frage, wie so eine technische Dokumentation überhaupt aussieht, was da rein gehört und wie man das aufbaut.

Ich wäre dankbar, wenn dazu jemand Infos hätte und evtl. auch einen Link, wo das erklärt ist.

Danke!

Gruss

Codemaschine

[LuckyLuke]

Hey, genau das muss ich heute auch machen...

Wäre super, wenn jemand was dazu schreiben kann!

[LuckyLuke]

Ha, hab grade was dazu gefunden!!!

Gliederung (dieser Doku, die mit 99% bewertet wurde) sieht so aus:

1 Entwicklungsumgebung

1.1 Software

1.2 Hardware

2 Tabellenübersicht / ER-Modell

3 Tabellenstrukturen

4 Quellcode-Dokumentation

4.1 Ordnerstruktur und Dateien

4.2 Dateifunktionen

4.3 Variable Daten

4.4 Programmorganisation

[sockä]

also ich würde da reinschreiben, was alles wichtig ist, damit das produkt auch "läuft" (z.b. bei einem webserver welche änderungen an ner conf-datei gemacht wurden). und ich würde es so schreiben / aufbauen, dass ein admin das versteht und später "nachklicken" kann, so wie ne art anleitung mit beschreibung, was man wieso klickt und warum.

[Codemaschine]

Original geschrieben von sockä

also ich würde da reinschreiben, was alles wichtig ist, damit das produkt auch "läuft" (z.b. bei einem webserver welche änderungen an ner conf-datei gemacht wurden). und ich würde es so schreiben / aufbauen, dass ein admin das versteht und später "nachklicken" kann, so wie ne art anleitung mit beschreibung, was man wieso klickt und warum.

Tja, aber das "klicken" hab' ich schon in der Benutzerdokumentation.

Soll da vielleicht rein, welche Module / Formulare / Funktionen die Software hat?

Oder evtl. auch technische Hintergründe?

Z. B. Datenbankverbindung mit ADO etc.

Ich hab' echt keinen Plan.

Kommt schon! Weiss sonst keiner was dazu?

Danke und Gruss

Codemaschine

[sockä]

die funktionen der software kannste du natürlich in den technische doku schreiben, da das ja eventuell wichtig ist und nicht in den projektbericht gehört. und auch kommentierte quellcodes und alles, wie das "funktioniert". aber nicht dein vorgehen. das gehört unbedingt in den bericht. auch würde ich dir davon abraten, klickanweisungen in den bericht zu packen, da es deinem PA herzlich wenig interessiert, ob man die linke oder rechte maustaste drücken soll. die interessiert dein vorgehen, deine lösungsmöglichkeiten, deine entscheidung und deine planung etc. klickanweisungen sind für den admin später wichtig.

[Codemaschine]

Ich habe mir jetzt nochmal ausführlich Gedanken über die technische Doku gemacht.

Wer benötigt eine derartige Doku?

1. Die Programmierabteilung für evtl. Wartungsarbeiten

2. Der Support um Kunden bei Problemen zur Seite zu stehen.

Was muss also rein?

1. Für die Programmierabteilung:

Eine Beschreibung der Formulare, Module, Funktionen (incl. Übergabeparameter und Rückgabewerte).

2. Für den Support:

Allgemeine Informationen zur Applikation (sehr kurz gehalten)

3. Für Programmierung UND Support:

Programmablaufpläne, Screenshots

Was hat das zur Folge?

In meiner Projektdokumentation fallen sämtliche Screenshots und Prügrammablaufpläne raus. Ich verweise hierzu auf die technische Dokumentation. In der Projektdokumentatin beschreibe ich also nur die Mittel und Wege, die zur Lösungsfindung führten. Einzig Codeausschnitte (von den wichtigsten Programmteilen) dienen der Veranschaulichung.

Tja, was haltet Ihr davon?

Gruss

Codemaschine

[Codemaschine]

Sorry, muss das nochmal hochschieben.

Keiner eine Meinung dazu?

Gruss

Codemaschine