Wie umfangreich soll die Anwenderdokumentation sein?

[DerFlauschige]

Servus miteinander, kurze Frage:

wie viel Inhalt soll bei einem Admin-Handbuch enthalten sein? 
Hab als Projekt ein Monitoringsystem aufgesetzt, jetzt ist die Frage: 
Muss ich erklären, wie der Server aufgesetzt wurde / wie z.B. die HTTPS / PostFix-Konfiguration unter Linux dazu aussieht, oder reicht es 
wenn man erklärt, wie der Anwender einfache Tätigkeiten wie das erstellen neuer Hosts und Regeln im Monitoring-System durchführen kann? 
Hab das Handbuch bis jetzt auf den kleineren Umfang beschränkt und überleg jetzt ob der Rest noch reinsoll - eigentlich ist das ja alles in der Projektdokumentation beschrieben, heißt das könnte ich da einfach rauskopieren? 

Bin da grad etwas verloren, schonmal Danke für eure Antworten!

[DerFlauschige]

Sollte dazu noch anmerken, das zum aktuellen Zeitpunkt auch keine weitere Dokumentation betrieblich nötig ist - ich bleib in meinem Betrieb und werde das Monitoring-Systeme weiterhin betreuen. Außerdem handelt es sich um ein Firmen-internes Projekt.

[cortez]

vor 18 Stunden schrieb DaRauscher:

wie viel Inhalt soll bei einem Admin-Handbuch enthalten sein? 

so viel Inhalt, dass jemand der neu ins Unternehmen kommt, das Programm nach dem durchlesen ohne Probleme administrieren kann. 

vor 18 Stunden schrieb DaRauscher:

ich bleib in meinem Betrieb und werde das Monitoring-Systeme weiterhin betreuen. Außerdem handelt es sich um ein Firmen-internes Projekt.

Na und? Müssen deine Kollegen immer auf dich warten wenn etwas geändert werden soll? Soll niemand sonst etwas an dem System machen? Was passiert wenn du mal länger ausfällst oder du doch den Betrieb wechselst? 

[DerFlauschige]

vor 8 Minuten schrieb cortez:

Na und? Müssen deine Kollegen immer auf dich warten wenn etwas geändert werden soll? Soll niemand sonst etwas an dem System machen? Was passiert wenn du mal länger ausfällst oder du doch den Betrieb wechselst? 

Ist mir klar, nur die Frage ist ob das bis 31.5 fertig sein muss und mitgesendet, damit nach dem Gusto der Prüfer abgearbeitet werden muss, oder ob ich das im Anhang weglassen kann und dann entspannt ohne ewige Formalien für meine Kollegen erstellen kann 

[cortez]

Es sollte zu deinem Antrag passen. Hast du in deinem Antrage erwähnt, dass du eine Admindoku erstellst, würde ich sie der vollständigkeitshalber anhängen.  

Zur Form der Doku:

Ich weiß nicht wie ihr intern die Sachen dokumentiert, jedoch sollte immer ein gewisses Maß an Form vorhanden sein. 

[DerFlauschige]

vor 2 Stunden schrieb cortez:

Es sollte zu deinem Antrag passen. Hast du in deinem Antrage erwähnt, dass du eine Admindoku erstellst, würde ich sie der vollständigkeitshalber anhängen.  

Zur Form der Doku:

Ich weiß nicht wie ihr intern die Sachen dokumentiert, jedoch sollte immer ein gewisses Maß an Form vorhanden sein. 

Ok, da hab ich drin Interne Dokumentation. Denke da werd ich jetzt einfach das Adminhandbuch, also für mich die Basic-Einweisung für die Kollegen, mitschicken. 

Naja, es macht trozdem (finde ich) einen unterschied, ob du eine Doku erstellt die einfach den Zweck erfüllen soll, das deine Kollegen verstehen wie das System funktioniert (also Zweckorientiert), oder ob du ein extra rausgeputztes und Argumentativ sicheres Dokument erstellst welches zu 100% die Wünsche der Prüfer erfüllt.

- Edit - 
Die Einstellung liegt aber wahrscheinlich an meiner Denkweise, hab hald beim schreiben von allen Dokumenten immer im Hinterkopf einen extra fiesen Prüfer, der versucht mich an jeder Kleinigkeit aufzuhängen  

Bearbeitet 25. Mai 2021 von DaRauscher

[cortez]

vor 4 Stunden schrieb DaRauscher:

...ob du ein extra rausgeputztes und Argumentativ sicheres Dokument erstellst welches zu 100% die Wünsche der Prüfer erfüllt.

Bei deiner Doku geht es in erster Linie, um das WARUM. Warum entscheidest du dich so, wie du dich entschieden hast? Warum hast du dich entschieden das Problem zu lösen? Warum hast du die alternativen nicht genommen?

Bei einer Anwender/ Admindoku steht das WIE im Vordergrund. Wie verwendet man die Software, um die Software optimal zu nutzen? Du hast die Software eingeführt, also bist du der Experte im Unternehmen, wenn es um diese Software geht. Bei einer Admindoku hast du es einfacher, denn deiner Zielgruppe sind schon Leute die Erfahrung mit IT haben und mehr Grundwissen voraus setzen kannst.

Ich bin kein Prüfer, vielleicht kann hier @charmanta etwas mehr zusagen.  Ich hatte mich nur in einen Prüfer hin versetzt und mir gedacht was würde ich haben wollen. Mein Ziel war den text gut lesbar zu machen, also den Text strukturiert und gegliedert. Hin und wieder wenn es gepasst hat einen Absatz eingefügt. Keine ausschweifenden Sätze über mehrere Zeilen, sondern direkt auf den Punkt kommen. 

Resultat waren für mich 85 Punkte. Von den fehlenden gingen einige auf inhaltliche Schwächen. 

vor 4 Stunden schrieb DaRauscher:

... allen Dokumenten immer im Hinterkopf einen extra fiesen Prüfer, der versucht mich an jeder Kleinigkeit aufzuhängen  

Was würde es denen nutzen dich reinzureiten? Die Prüfer sind eigentlich immer auf der Prüflinge.