So ich bin mit der eigentlichen dokumentation fast fertig und arbeite gerade an der dokumentation>/Anleitung< für die administratoren unserer firma.

Es würde einiges an formulierungsarbeit sparen wenn man zb. schreiben kann:

Klicken sie auf .... um blablubber

ist das erlaubt?

oder muss man schreiben

Mit klick auf .... blabla

Personalpronomen in der allgmeinen Projektdokumentation rauslassen.

Natürlich solltest du in einer Benutzerdoku, wie z.B. einer Einweisung in ein Programm die Anrede Sie benutzen um den Kontakt zum Nutzer aufzubauen.

ich denke, dass wenn das bei dir eine Anleitung für die Admins werden soll, brauchst Du da gar nicht ausführlich sein: z.B.: Start -> Programme -> Verwaltung -> ..... ->...

Stop mal!

Ihr schreibt eine Dokumentation dessen, was ihr im Projekt gemacht habt.

Also keine Installationsanleitung (klick hier, klick da), kein "Mein schönstes Erlebnis"-Schulaufsatz.

Soll heissen, in der Doku ist es wichtig, zu welchem Zweck welches Programm / welches Werkzeug benutzt wird. Unwichtig erachte ich, dort den gesamten Vorgang Klick für Klick darzustellen.

BSP: das Anlegen eines Benutzers auf einem Windows-Server kann man in einer Romanfüllenden (eher einschläfernden) Art und Weise beschreiben, indem man wirklich jeden Klick beschreibt, oder man sagt: "Im Modul Active Directory Benutzer und Computer wird ein User mit den Einstellungen X, Y und Z und der Gruppenzugehörigkeit Blahblubb angelegt." Vorteil: man muss sich auf das wesentliche konzentrieren, statt der einen Seite Roman in der Doku sind 2 bis 3 Zeilen verbraucht.

Nochmal: wichtig ist, darzustellen, warum etwas gemacht wird, mit welcher Zielsetzung und welchen Voraussetzungen, nicht aber eine Installtionsanleitung für Dummies.

P.S.: Die Doku, die mein Azubi schreibt, habe ich am Freitag mal gelesen. Danach war sie fast 2 Seiten kürzer und mein Azubi froh.

@Chief Wiggum:

Ich verstehe es so, dass wir hier von einer Benutzereinweisung reden, so wie ich es oben erwähnt habe.

Meine allg. Doku ist so aufgebaut wie du es auch schon in Auszügen dargstellt hast.

Zudem habe ich eine Kurzeinweisung für die Mitarbeiter. Hier ist die "Sie"-Form in Benutzung.

Dafür ist sie auch geeignet.

Und nun weiter und nicht stop

das gleiche gilt in etwa für mich.

hatte ja auch in der frage stehen das ich die Doku UND eine anleitung mache.

danke auch für die antworten

BSP: das Anlegen eines Benutzers auf einem Windows-Server kann man in einer Romanfüllenden (eher einschläfernden) Art und Weise beschreiben, indem man wirklich jeden Klick beschreibt, oder man sagt: "Im Modul Active Directory Benutzer und Computer wird ein User mit den Einstellungen X, Y und Z und der Gruppenzugehörigkeit Blahblubb angelegt." Vorteil: man muss sich auf das wesentliche konzentrieren, statt der einen Seite Roman in der Doku sind 2 bis 3 Zeilen verbraucht.

Nochmal: wichtig ist, darzustellen, warum etwas gemacht wird, mit welcher Zielsetzung und welchen Voraussetzungen, nicht aber eine Installtionsanleitung für Dummies.

Da, muss ich dir Recht geben, nur ich hab das Problem das ich in meinem P.Antrag unter der " Geplante Dokumentation zur Projekt Arbeit" z.B

- Installation Windows Server2003,

- Installation Exchange..

- Installtion .....

- Installtion bla bla#

eingetragen hab, der Antrag wurde auch so angenommen!

Also , schreibe ich nur von den Vorteilen, fragen die Prüfer sich "Wo sind die Angaben zur Installation?", schreibe ich nur von der Installation bzw. konfiguration fragen sich die Prüfer " Warum und weshalb hatt er das so gemacht und nicht anderes?" Also , echt schwer denn richtigen Mix dahin zukriegen!!

Cool , das du dich als Ausbilder/Chef dich um deinen Azubi kümmert, meiner ist den ganzen Tag auf Achse!

Ich denke bevor ich grob die einzelne Installations bzw. konfigurationsvorgänge beschreibe , die Vorteile kurz erklären. z. b. Vorteile von globalen Gruppen, etc. und dann erklären wie und welche User ich in die globale Gruppe einbinde und auf die Rechtevergabe eingehen.....