Abschlussprojekt- Kundendokumentation bei internen Projekt notwendig?

[DaMi]

Hallo zusammen,

ich mache mir gerade wie viele hier im Forum Gedanken über die Projektdokumentation.

Ich werde eine "kleine" Webanwendung für meinen Ausbildungsbetrieb mit 3 Mitarbeitern entwickeln. Diese Anwendung wird zur Projektverwaltung verwendet werden ( Zeitaufwand, Tätigkeit, usw.).

Ist in meinem Fall eine Kundendokumentation notwendig, da die Benutzer selbst Fachleute sind und die technische Dokumentation ausreichen würde. (?)

Vielen Dank im Voraus. ;-)

[Albi]

Das würde mich auch interessieren, da ich auch ein Projekt das nur intern verwendet wird machen werde.

[mfk'); DROP TABLE Users;--]

Wenn das, was du in deinem Projekt machst, eine Anwenderschnittstelle hat, dann brauchst du eine Anwenderdokumentation, damit der Anwender weiß, wie er das Ding zu bedienen hat.

Ob der Anwender ein Kunde ist, oder das Ding nur intern verwendet wird, ist dabei doch völlig egal.

[Albi]

Ah super danke für die Info Da ich gerade dabei bin meinen Projektantrag zusammenzuschreiben ist die Info natürlich sehr nützlich bevor ich ihn abschicke

[DaMi]

@mfk Hab vielen dank. Dann werde ich später eine Anwenderdokumentation erstellen und diese per Anhang hinzufügen. :-)

[DaMi]

Ich hätte noch eine Frage. Ich habe mir gerade einen groben Überblick von den benötigten Funktionen/Methoden gemacht und es sind ca. 25 Stück. Einen Teil in den Klassen und der Rest in der index.php. Muss ich nun alle in der Dokumentation beschreiben? Da reichen ja 10 Seiten niemals aus. MfG DaMi

[arlegermi]

Einen Anwender werden deine Klassen & Methoden nicht interessieren.

In die Projektdokumentation für die IHK gehören die auch nicht (alle) rein. Such dir ein paar aussagekräftige Stellen raus, die du als gelungen empfindest und an denen man vllt. die Struktur absehen kann und setz die in den Anhang. In einigen wenigen Fällen kannst du Auszüge (!) auch direkt in der Dokumentation bringen, wenn es wirklich relevant und anschaulich ist.

[Albi]

Einen Anwender werden deine Klassen & Methoden nicht interessieren.

In die Projektdokumentation für die IHK gehören die auch nicht (alle) rein. Such dir ein paar aussagekräftige Stellen raus, die du als gelungen empfindest und an denen man vllt. die Struktur absehen kann und setz die in den Anhang. In einigen wenigen Fällen kannst du Auszüge (!) auch direkt in der Dokumentation bringen, wenn es wirklich relevant und anschaulich ist.

Ah ok das hatte mich auch noch interessiert

[arlegermi]

Ich habe gerade nochmal in meine eigene Dokumentation geguckt: In der eigentlichen Doku habe ich 3 Methodenauszüge (zusammen ca. eine 3/4 Seite) und im Anhang dann ~10 Methoden, an denen man exemplarisch das Projekt veranschaulichen konnte (das sind ~ 7 Seiten).

[DaMi]

Super, danke für die schnelle Antwort und Hilfe. Ich werde es dann auch so machen, eine wichtige Methode von einer Klasse genauer in der Doku beschreiben und noch 1-2 Funktionen von der Index.php. Dazu einen Quellcodeausschnitt in den Anhang hinzufügen. Das müsste dann passen. :-)