Bilder/Screenshorts in Doku?

[piti66]

Hey Leute,

wollt mal fragen ob es angebracht ist bei der Installation von Software oder der Parametrierung von Hardware einige Bilder zu machen und diese dann an den bestimmten Stellen in der Doku anzuzeigen?

mfg

[perdian]

wollt mal fragen ob es angebracht ist bei der Installation von Software oder der Parametrierung von Hardware einige Bilder zu machen und diese dann an den bestimmten Stellen in der Doku anzuzeigen?

An bestimmten Stellen kann es sinnvol sein. Aber weniger ist hier mehr. In einer Doku will niemand eine Screenshot-Galerie sehen, a la

"Als nächsten Schritt gibt der User das Zielverzeichnis ein"

[bILD]

"Nun muss die Installationsart (short/medium/extended) gewählt werden"

[bILD]

...

Das ganze soll eine Dokumentation und kein Bilderbuch für DAUs werden. Wenn du allerdings an einer Stelle kurz beschreibst "Der User erhält somit eine übersichtliche Maske, auf der alle Optionen direkt dargestellt werden", dann kann en Screenshot sehr gut dazu beitragen, dass geschriebene zu unterstreichen und zu visualisieren.

Also generell: Screenshot möglich, aber die Placierung sollte gut überlegt werden.

[BadDog]

Hey Leute,

wollt mal fragen ob es angebracht ist bei der Installation von Software oder der Parametrierung von Hardware einige Bilder zu machen und diese dann an den bestimmten Stellen in der Doku anzuzeigen?

mfg

Nun ja - ich würde sagen, es kommt darauf an, wie du die erstellten Screenshots verwenden möchtest. Ich kenne Leute, deren Doku bestand aus einer Art "Installationsanleitung" ..... und das war dann das Anfang vom Ende für die Bewertung in diesem Prüfungsabschnitt.

Gegen sinnvoll eingesetzte Screenshots hat sicherlich niemand etwas einzuwenden - aber "Klick-Anleitungen = Doku" ist sicherlich der falsche Weg.

Gruss

BadDog

[as-sassin]

Ich finde ein paar Bilder, Screenshots oder Diagramme lockern den Text auf. Ob ich in der Doku ein bild hatte, weiß ich gar nicht mehr :confused: - aber im Anhang hatte ich einige.

Natürlich müssen sie informativ, halbwegs hübsch anzusehen und vor allem sinnvoll sein.

Zu groß sollten sie auch nicht sein, aber natürlich gut zu erkennen ...

Viel Erfolg

as-sassin

[allesweg]

Neuralgische Punkte kann man, falls es die Verständlichkeit erhöht, durch Bilder ergänzen. Aber bitte achte dabei auf die Vorgaben deiner IHK - manche IHK akzeptiert Bilder im Text Doku, andere IHKen bestehen auf Bilder im Anhang (somit zählen diese Seiten dann meist nicht zum Umfang und können nicht zum Platz schinden missbraucht werden).

Viel Erfolg

[mKipke]

"Ein Bild sagt mehr als tausend Worte" - gerade, wenn du Topologien, zeitliche Abläufe oder Strukturen beschreiben möchtest (was wohl in jeder Projektdoku irgendwo der Fall sein wird), solltest du immer mit Grafiken arbeiten.

Ausserem sollten zumindest in einem Programmierprojekt alle relevanten Masken dargestellt sein. Du willst ja auch zeigen, das du was gemacht hast.

Bedinungsanleitungen sollten generell nur dann in die Doku, wenn du dies im Projektantrag auch so geschrieben hast. Diese gehört dann aber in den Anhang.

[timmi-bonn]

wollt mal fragen ob es angebracht ist bei der Installation von Software oder der Parametrierung von Hardware einige Bilder zu machen und diese dann an den bestimmten Stellen in der Doku anzuzeigen?

Daw wo es Sinn macht; will heissen, dort wo "ein Bild mehr aussagt als 1000 Worte", da eindeutig ja. Aber bitte nicht jede Eingabe mit einem kompletten Screenshot dokumentieren! Denn da hat ein Screenshot keinerlei Vorteil gegenüber der reinen Textzeile in der Doku.

Btw., ich ziehe bei Dokus alle Bilder (und Tabellen) ab 1/4 Seite Grösse von der Gesamtseitenzahl ab, und danach erst prüfe ich, ob diese korrigierte Endsumme der Seitenzahl (immer noch) innerhalb der vorgeschriebenen Grenzen (hier 10 - 15) liegt.

Also: Ein Bild oder eine Grafik immer (nur) da, wo sie "mehr aussagt als 1000 Worte". Das ist im Prinzip das selbe, wie die so beliebten - aber völlig überflüssigen bis sogar falschen - Folienübergäünge bei PPT-Präsentationen.

gruss, timmi