Screenshots in ProjektDoku?

[pfc]

Hallo zusammen,

ich habe als FiSi ein Abschlussprojekt gewählt, in dem viel Konfigurationsaufwand von Netzwerkkomponenten erforderlich ist.

zB via Browser auf Systeme zu greifen, oder mit Console / telnet IP-Adressen vergeben oder Routen eintragen.

Jetzt bin ich am dokumentieren, und überlege mir, dass man solche Einstellungen am besten mit Screenshots verdeutliche kann, was ich eigentlich zu welchem Zeitpunkt gemacht habe.

Nun meine Frage, sind Screenshots in Abschluss-Dokumentationen gerne gesehen oder verpöhnt? Natürlich muss auch der Text stimmen, etc, aber im Moment habe ich bereits 4 oder 5 Screens. in der Doku.

Viele Beispiel Dokus die ich gesehen, habe kommen fast komplett ohne Screenshots aus, höchstens mal im Anhang.

Was würdet Ihr sagen?

gruß,

pfc

[dieterds]

Also die werden dir nicht wegen ein paar Screenshots den Kopf abreißen. Es dürfen in der eigentlichen Doku (10 Seiten) halt nicht zu viele Screenshots sein, da die Umschreibung zum besseren Verständnis des Projektes ja in den Anhang gesteckt werden sollen.

Max 1-4 Screenshots in Doku die zusammen höchst 1 Seite einnehmen.

Rest in Anhang. (Natürlich in der Doku auch auf den Anhang verweisen).

[ollo]

Würde auch sagen, dass Screenshots nichts in der eigentlichen Doku zu tun haben.

ich schreibe gerade auch meine Doku und ich habe ohne Screenshoots schon 13 Seiten (incl. Inhalts- und Anlagenverzeichnis) dazu kommen noch 15 Anlagen.

Aber nun mal ehrlich? Wie lange braucht ihr dafür, um die Doku zu schreiben? Ich bin mittlerweile um alle richtig schön zu machen, bei über 30 Stunden.

[Däni]

Hi,

also ich habe in meiner Doku im Hauptteil schon 11 Screenshots, in der Anlage dann nochmal drei. Thema war Evaluierung eines RIS Servers und die Screenshots stammen eigentlich alle von der Konfiguration des Servers. Ingesamt bringts meine Doku auf 29 Seiten, wobei davon 13 Seiten Anhang sind.

Übringens wurde die Doku mit 99 % bewertet :OD , also können ein paar mehr Screenshots wohl nicht so schlecht sein !

Viel Spaß, Daniela

[pfc]

Hi Daniela,

hey danke für den post.

Ich gehe auch stark davon aus, dass Projekte, in denen nun mal in der Realisierung viel konfiguriert werden muss etc., nicht abgewertet werden, wenn man Screenshots einsetzt, wenn es nötig ist. Die Rahmenbedingungen müssen natürlich auch stimmen, aber immer nur "es wurde dies und das getan, dies und das angelegt" kann nicht sein. Es sollte bildlich und natürlich Textlich veranschaulicht werden...

Gruß,

pfc

[CyberDemon]

Screenshots gehören i.d.R. in den Anhang. In der Dokumentation verweist man dann an den jeweiligen Stellen darauf hin.

Wenn man doch Grafiken in die Doku packt, sollte man darauf achten, dass die Bildchen nicht als Formatfüller fungieren. Das soll heissen, dass man bei reinem Text nur 7 Seiten hat, durch einfügen von Grafiken aber auf 15 Seiten kommt. Das könnte Punktabzüge zur Folge haben.

In meiner Doku hatte ich nur ein Tortendiagramm in der Doku, weil mein Prüfer es haben wollte. Alle anderen waren im Anhang.

[Däni]

Also ich habs genau entgegengesetzt gelernt, angewendet und bin damit immer gut gefahren (und grad jetzt im Controlling schreib ich mehr Konzepte, Berichte usw. denn je). Mir wurde beigebracht, dass es wichtig ist, den Text durch Grafiken aufzulockern. Der Leser kann sich nur schwer auf längere Texte konzentrieren, wenn sie nicht durch Grafiken aufgelockert werden. Natürlich sollen diese Grafiken nicht wahllos reingesetzt werden sondern am besten unter einem Absatz das eben gelesene nochmal verdeutlichen und unterstreichen.

Wäre mal interressant was die Prüfer hier so dazu sagen !

[christinaz]

dass es wichtig ist, den Text durch Grafiken aufzulockern. Der Leser kann sich nur schwer auf längere Texte konzentrieren, wenn sie nicht durch Grafiken aufgelockert werden.

Genau so wurde mir des auch beigebracht, hab zwar bisher auch noch keine grafiken in meiner doku untergebracht, aber bilder sagen meist mehr aus, als ellenlange erklärungen und sind auch leichter zu verstehen

[MBaeuml]

Bei Grafiken (Diagramme) ja, aber er meinte Screenshots und die kann man eigentlich nur erkennen wen sie relativ groß sind (meist ist die Schrift bei 1024x768 Auflösungen zu klein). Deshalb würde ich die nach wie vor in den Anhang setzten und darauf verweisen. So ein Screenshot muss um gut lesbar zu sein ca. eine halbe Seite einnehmen, das wird dann schnell als "aufblähen der Doku" abgestempelt. Entweder nur den entsprechenden Auschnitt den ihr behandelt, also z.B. nur das Eigenschaften-Fenster der IP Einstellungen anstatt den ganzen Desktop oder wirklich in den Anhang.

ach ja wie ihr hier seht hatte ich zwar keine Screenshots, dafür aber einige Tabellen in der Doku. Die großen waren aber auch im Anhang. Diagramm für die Kosten hatte ich dann in der Präsentation, kann aber auch sehr gut in die Doku.

[Däni]

Natürlich packt man nicht den Screenshot des ganzen Desktops mit rein sondern nur den Ausschnitt, der wirklich interressant ist ! Nicht das da Missverständnisse aufkommen...