ChewyF5

Hi,

und gleich die nächste Frage.

Wenn ich ein System,Programm usw... geschrieben hab, dann möchte ( muss) ich dieses System ja dokumentieren damit es hinterher jeder, der daran weiterarbeiten möchte (soll) versteht was ich da zusammengecodet hab.

Gibt es irgendwo eine Internetseite bzw eine Richtline wie mann/frau so etwas erstellt.

Hat jemand mit so etwas Erfahrung oder eine Vorlage ?

PS.: ich meine damit keine Dokumentation durch Inline-Doku, das die da sein muss ist mir schon klar

__________________
ChewyF5

-- A strange game. The only winning move is not to play --
WAR GAMES 1983

Mister Ad

Corvin

http://www.phpdoc.org/

ChewyF5

@corvin

Das Prog ist schön und gut, aber es macht auch nur Codedokumenation.
Aber danke erstmal für den tip.

Ich brauche aber eine richtig gehende Systemdokumentation
Mit als sonem Scheiss wie Systemrequirements , Verwendungszweck usw......

__________________
ChewyF5

-- A strange game. The only winning move is not to play --
WAR GAMES 1983

Corvin

Ein Tool um ein Benutzerhandbuch zu erstellen?

ChewyF5

@corvin

Weniger, ich hab hier ein paar punkte von meinem Prof aus der UNI bekommen, aber selbst der denkt nicht an alles.

Zur Zeit schreib ich meine Doku in Micro...-Wort und das ist auch gut so.

Mal eine kleine Zusammenstellung was mir mein prof. geschickt hat.
- Systemaufbau ( modular , OO, ...)
- Systemvoraussetzungen
- Schnittstellen zum System
- Ablaufdiagramme
- ER-Diagramme
- Tabellenaufbau
- Backup and Security
- Abkürzungsverzeichnis

Das man ein DAU-Buch ähh Benutzerhandbuch schreibt ist schon klar und das man dem Admin auch was in die Hand geben sollte ebenfalls.

Von daher hat irgendjemand sowas schon mal gemacht oder hat ne vorlage oder ein paar punkte die ich vergessen hab.

Aussdem freut sich der chef wenn er noch einen Ordner im Schrank stehen hat, wo er sehen kann, was der Informatiker da gemacht hat.
Und für den Fall, das andere an dem System weiterentwickeln sollen, hab die etwas woran sie sich festhalten können wenn sie die 10.000 Zeilen code sehen...

OK, 10.000 ist übertrieben aber wo sie sehen können was wo passiert und an welchen stellen sie ansetzen müssen um das System zu erweitern

__________________
ChewyF5

-- A strange game. The only winning move is not to play --
WAR GAMES 1983

imported_Ben

Selbst schreiben?

__________________
Webentwickler-Blog - Buchbesprechung PHP Design Patterns - SQL-Antipatterns

ChewyF5

Das hatte ich sowieso vor es geht um eine Vorlage oder

ob jemand sagt:" ... muss unbedingt da rein, weil..."

halt ob jemand erfahrung mit sowas hat

wenn ich mit meiner doku fertig bin, werde ich die mal posten damit sie vielleicht mal jemand weiterverwenden kann.

__________________
ChewyF5

-- A strange game. The only winning move is not to play --
WAR GAMES 1983

ChewyF5

Hallo,
so nun bin ich endlich mit meiner Doku fertig.
Ich hab hier einen keinen Überblick über mein Projekt und die Arbeitsschritte

Vor dem Projekt
Pflichtenheft ( Was kann, darf und soll das Programm tun )
Zielbestimmung ( was soll das werden )
Produkteinsatz ( wo soll das programm eingesetzt werden )
Produktübersicht ( woraus besteht das Produkt )
Produktfunktionen ( was soll man damit machen können )
Produktdaten ( was soll das Produkt verarbeiten )
Qualitätsanforderungen ( soll das Produkt erweiterbar sein ... )
Benutzeroberfläche ( soll das ding so aussehen wie z.B. Windoof ? )
Nicht funktionale Anforderungen ( was ist zu beachten in hinblick auf die Zielgruppe )
Technische Produktumgebung ( wo soll das Produkt drauf laufen )
Gliederung in Teilprodukte ( SInd das unterschiedliche Komponenten die zu unterschiedlichen Zeiten Released werden ? )
Ergänzungen ( irgendwas, was einem noch einfällt )

(ist ne menge schreibkram aber hinterher meckert der Kunde nicht das er dir was gesagt hat was nun doch nicht drin ist)

Nun Programmieren ! ( mein liebster Teil )


Dann Abschlussdokumentation (wieder ne menge schreibkram aber es erspart einem ein paar genervte Nachmittage "das geht nicht .. " "gucken sie da, da stehts" )
Teil 1 Entwicklerdokumentation
Einleitung
Systemvoraussetzungen
Abgrenzungen
Systemaufbau
Schnittstellen
Datenstruktur
Sicherung
Wiederherstellung
Installation
Glossar
Entwicklungshistorie

Teil 2 Administrationsdokumentation
Installation
... ( man führe einen admin durch das produkt und zeigt ihm in bildern was er den zu tun und zu lassen hat )
Ergänzendes

Teil 3 Anwenderdokumentation
Wie soll der Anwender das System bedienen

Ich hoffe ich kann einigen die Arbeit etwas erleichtern.
Ich hab mal mit meinem prof gesprochen und der meinte, jetzt wäre alles drin ... wollen mal sehen.

Und solltet ihr 10 Jahre später in verlegenheit kommen diese Produkt weiterzuentwickeln habt ihr weniger Probleme euch da wieder reinzufinden

__________________
ChewyF5

-- A strange game. The only winning move is not to play --
WAR GAMES 1983