Frage zur Realisierung

[knolte]

Hallo zusammen,

ich sitzte momentan vor meiner fast fertigen Doku.

Nun hab ich mir mal einige Beispieldokumentationen angeschaut und bin ins grübeln geraten.

In meinem Projekt musste ich eine Netzwerkkomponente konfigurieren (Concentrator).

Nun zu meiner Frage:

Muss man in der Doku angeben, was man wie und wo eingestellt hat?

Also z.B.

Unter preferences->Ethernet->Interface wurde die Option XY aktiviert damit ...

Ebenfalls wurde unter Usermanagement->Users der User XY angelegt und mit den Rechten 123456 versehen.

Oder reicht es wenn man grob erklärt hat was man gemacht hat bzw. was nötig war? Ich hab hier im Forum schon oft gelesen, dass man keine Anleitung in die Doku reinpacken soll.

Ich hoffe ihr versteht was ich meine und könnt mir weiterhelfen!

[jonny030]

Hi,

ich habe meine Installations- & Konfigurationseinstellungen begründet und Sreenshots in den Anhang gelegt.

Firmeninternes habe ich allerdings aus Datenschutzgründen geschwärzt.

[Bounder]

Teilweise habe ich schon IPs, Domainnamen, etc. angegeben.

Einfach um zu zeigen, dass das ganze stimmt.

Ich bin auch noch am überlegen wie tief man das ganze Dokumentieren sollte.

[Stoertebecker]

Ich denke, dass in der Doku selbst keine Schritt für Schritt-Anleitung stehen sollte, schliesslich hat man diese Doku für Fachleute geschrieben !

Alle genaueren Beschreibungen und Einstellungen sind für den Anhang bzw. für die Kundendoku. So habe ich es zumindest gemacht.

In der Projektdoku. habe ich alles grob beschrieben und die Grundlegenden Dinge erklärt.Die Ausführlichen Sachen wie z.B. IP-Adressen oder bestimmte Einstellungen, und die Gründe für die Einstellungen oder IP-Adressen habe ich in den Anhang bzw. in die Kunden dokumentation gepackt!

ich hoffe selber, dass es richtig ist und war, aber andernfalls würde ja die Dokumentation, in vielen Fällen, auch viel zu umfangreich!