Screenshots in Dokumentation

[fuppel]

Hallöchen! Ich schreibe grade meine Dokumentation. Sind Screenshots angebracht, oder nicht so?

[claudi]

Screenshots sind nur in den Anlagen angebracht! Normalerweise nicht in dem Projektbericht, nur wenn sie wichtig zur Erklärung sind.

Tipp: Wenn in der Anlage ein Screenshot vorkommt, solltest Du ihn noch erklären!

[Rohde]

Mit Bildern kann sich der Prüfungsausschuß, der Deine Projektdokumentation bewerten soll, ein wesentlich besseres Bild von Deinem Projekt machen. Deshalb solltest Du Screenshots mit einbeziehen. Die Auswahl der Screenshots hängt aber von Deinem Projekt ab. Hast Du z.B. irgendein datenbankbasiertes Informationssystem incl. Benutzeroberfläche entwickelt (das habe ich meinerzeit getan), empfiehlt es sich, Screenshots der Oberfläche in der Dokumentation zu zeigen und dabei dann auf die Aspekte einzugehen, nach denen diese Oberfläche entstanden ist (Stichwort Software-Ergonomie, http://www.sozialnetz-hessen.de/ergo-online/Software/inhalt.htm).

Nicht verwenden solltest Du Screenshots von der Installation eines Programms, in der Art "Weiter", "Pfad auswählen", "Weiter", "Fertigstellen" = 4 Bilder. Wäre ich im Prüfungsausschuß, wäre mir das wohl zu simpel, aber das ist nur meine Meinung.

[ 11. April 2001: Beitrag editiert von: Rohde ]

[ 11. April 2001: Beitrag editiert von: Rohde ]

[fuppel]

Danke für die bisherigen Antworten. Es handelt sich bei den Screenshots um einen Zusatz zur Erklärung, würde ich es in den Anhang packen wäre es doppelt gemoppelt. Es ist auch keine Installationsanweisung sondern eine Erläuterung zur Konfiguration.

Für weitere Meinungen wäre ich dankbar.

[timuwine]

ich habe damals in meiner prüfung kurz die enwicklung umgebung erläutert und eine screenshot implementiert.

zusätlich habe ich die zwei dialoge (oralce forms) als hardcopy am ende präsentiert und erläutert...die dialoge konnte ich nicht in echtzeit vorführen, da die datenbank nicht auf den laptop gepasst hat.

Ich denke screenshots sind ok wenn du ermmessen kannst ob sie einen beitrag zum verständinis leisten und nicht nur schönmalerei sind.

generell sind screenshots ok du solltes dir eben überlegen wann du sie wo SINNVOLL einsetzt.

[Tasjopeia]

@fuppel

also ich würde die screenshots in die doku mitreinnehmen wenn sie wichtig sind um deine vorgehensweise in der doku zu erklären. natürlich solltest du nicht deine ganze doku voll mit screenshots machen, das kommt auch nicht gut.

die andere möglichkeit ist, du machst an der jeweiligen wichtigen stelle einen verweis auf einen screenshot in der anlage.

viel glück

[Chipsy]

Hi,

also ich hatte damals in der Doku direkt auch keine Screenshots im Pflichtenheft dafür um so mehr...

In der Doku soll es ja auch nur um den Ablauf mit Zeitplan, Abweichungen und Probleme und die Qualitätssicherung gehen... Wie das Programm aussieht, was für Klassen Datenbankanbindungen und so weiter man hat steht ja im Pflichtenheft und Lastenheft....

so hatte ich das zumindes gemacht.. und immerhin 99% bekommen...

Chipsy

[Rohde]

Und ich dachte immer, was herauskommen soll und nicht, was herausgekommen ist

Ist aber etwas off-topic.

[JoelH]

es ist also wenig sinnvoll Screenshots direkt in die Doku zu packen, man sollte eher auf den Anhang 'verlinken', sehe ich das richtig ??

Wie sieht es bei der Präsentation aus, eine kleiner 'Snapshotaneinanderreihung' (machs mit Beamer) und dazu dann die Erklärungen der Installationsschritte aus meinem Mund dazu, ist das eine gute Idee ?

[timmi-bonn]

Original geschrieben von JoelH

es ist also wenig sinnvoll Screenshots direkt in die Doku zu packen, man sollte eher auf den Anhang 'verlinken', sehe ich das richtig ??

Wie sieht es bei der Präsentation aus, eine kleiner 'Snapshotaneinanderreihung' (machs mit Beamer) und dazu dann die Erklärungen der Installationsschritte aus meinem Mund dazu, ist das eine gute Idee ?

Hallo JoelH,

wie so meist liegt die Wahrheit im goldenen Mittelweg. Kleinere Grafiken (auch Screenshots) machen im Text durchaus Sinn. "Ein Bild sagt mehr als 1000 Worte". Wenn also die vorgeschriebenen "10 bis 15 Seiten" aus 10 Seiten reinem Text und 5 Seiten Grafiken bestehen, so ist das formal OK. Wenn aber jemand knapp 5 Seiten Text mit 5 ganzseitigen Screenshots auf 10 Seiten "aufbläht", so genügt diese Arbeit nicht der Form.

Also: kleinere Grafiken in den Text; ergänzende, größere Grafiken in den Anhang.

Zur Präsentation: Von einer reinen "Snapshotaneinanderreihung" würde ich dringendst abraten. Eine gute Präsentation hat einen gewissen Aufbau, der übrigens zum Lehrstoff auf der Schule gehört. Halte Dich am besten an das dort gelehrte Schema. Ich selbst bevorzuge den Ablauf: (provokativer) Aufmacher, Begrüßung mit Vorstellung, "Spielregeln", Übersicht über das Gesamt-Thema, Präsentation mit deutlich erkennbarem roten Faden, abschließende Kurz-Zusammenfassung und, falls möglich, eine begründete Bewertung des Ergebnisses. Anschließend Aufforderung zu Fragen und zur Diskussion. Abschließend expliziter Dank an das Auditorium für "die Aufmerksamkeit, die Fragen, das Interesse ...". (Bloß kein simples "Danke!", bei dem keiner weiß, wofür eigentlich.) Kleiner Trick von mir: Den letzten Satz der Präsentation auf Kärtchen schreiben und ablesen! Klingt vielleicht blöd - ist aber sehr hilfreich.

Vor der Präsentation praktisch üben, üben und nochmals üben vor Familie und Freunden.