Benutzeranleitung in die Projektdokumentation?

[ACH0815]

Hallo zusammen, 

mein Abschlussprojekt dreht sich insbesondere um die Neueinführung eines Passwort-Managers in eine Infrastruktur.

Das Hauptaugenmerk liegt darin den Anwendern in Form einer "Bedienungsanleitung" den Umgang zu erleichtern und ein Bewusstsein für Sicherheit zu erzeugen.

Meine Frage ist nun ob ich diese Anleitung einfach komplett in die Dokumentation mit aufnehmen soll?

Es würde die Doku zwar um ein paar Seiten erweitern.. oder wäre es für aus Sicht eines Prüfers besser nur den Aufbau dieser zu beschreiben, mit ein paar Ausschnitten als Screenshots?

Ich danke schonmal für die Antwort(en).

 

MfG 

Bearbeitet 21. Mai 2019 von ACH0815
Tippfehler

[Listener]

In die Projektdokumentation nicht, du beschreibst quasi die Kundendokumentation, die einzeln anzufertigen ist. 

[Undercover]

Wie lang ist denn deine Benutzerdokumentation? Und welche Angaben mach deine IHK bezüglich der Seitenzahl? 

[charmanta]

eine Anwenderdoku gehört zum Projekt und in den Anhang

Sie wird ( öffentlich auch auf den Bewertungsbögen einsehbar ) bei den mir bekannten Kammern mit bis zu 5 Punkten von 100 bewertet

[ACH0815]

Hallo zusammen,

erst mal vielen Dank für Eure weiteren Antworten und Infos!

 

vor 8 Stunden schrieb Julia on Rails:

Wie lang ist denn deine Benutzerdokumentation? Und welche Angaben mach deine IHK bezüglich der Seitenzahl? 

Benutzerdoku ist mit Deckblatt und Inhaltsangabe ungefähr 10 Seiten lang.
Ich bin bei der IHK München und da konnte ich leider weder auf meiner Einladung, noch auf deren Seite eine max. Seitenanzahl finden. Nach kurzer Recherche scheint es nicht nur mir so zu gehen. Gehe jetzt mal davon aus dass das anscheinend den Prüflingen selbst überlassen ist.

Btw ist der Kollege der vor zwei Jahren seinen Abschluss gemacht hat auf 36 Seiten mit Screenshots usw. gekommen. Das wäre jetzt auch meine persönliche Grenze gewesen.

vor 5 Stunden schrieb charmanta:

eine Anwenderdoku gehört zum Projekt und in den Anhang

Sie wird ( öffentlich auch auf den Bewertungsbögen einsehbar ) bei den mir bekannten Kammern mit bis zu 5 Punkten von 100 bewertet

Okay, vielen Dank für den Hinweis!

Dann werde ich diese einfach die PDF-Datei mit der Doku anhängen. Wie mir scheint ist es in dem Onlineportal leider nur möglich eine Datei als Dokumentation hochzuladen. ?

[Undercover]

Dadurch, dass die Doku relativ lang ist, würden Ausschnitte vielleicht reichen. Grade Deckblatt und Inhaltsverzeichnis sind ja für die Prüfer nicht wichtig. Wenn du keine Seitenbegrenzung hast, kannst du sie komplett reinnehmen, ansonsten ist es "Platzverschwendung". Aber zumindest Ausschnitte sollten auf jeden Fall rein, wie @charmanta schon gesagt hat.

Und mit Anhang ist der Anhang gemeint, der noch zur Doku gehört und keine extra Datei oder so. Wenn das ganze in einem Dokument ist, kannst du den Anhang nämlich beschriften, darauf verweisen, er wird im Inhaltsverzeichnis hinzugefügt etc.