Zum Inhalt springen

Gehören Screenshots innerhalb der Projektdokumentation eher in die Doku selbst oder in den Anhang?


Bnce

Empfohlene Beiträge

Hallöchen,

ich bin aktuell noch reichlich mit meiner Projektdokumentation beschäftigt. Da es seitentechnisch aktuell "knapp" wird, frage ich mich, ob man nicht sämtliche Screenshots aus der Durchführungsphase auch einfach in das Abbildungsverzeichnis packen kann? Ich habe nämlich noch genug Inhalt, den ich abtippen kann, diesen muss ich aber aufgrund der ganzen Screenshots stark kürzen und einiges auch leider ganz weglassen.

In einigen älteren Foreneinträgen im Internet habe ich dazu bestätigende Aussagen gelesen, diese waren aber wie bereits erwähnt deutlich älter von 2000-2008.
Unsere IHK vor Ort gibt leider kaum nützliche Infos preis. Wir können da schon froh sein, dass wir wissen, dass in Arial 12 geschrieben werden soll (wenn es nicht so traurig wäre, würde ich tatsächlich lachen)!

 

Hat hier der ein oder andere eventuell eine Antwort oder Einschätzung parat? Wäre sehr dankbar!

Bearbeitet von Bnce
Link zu diesem Kommentar
Auf anderen Seiten teilen

Hallo Bnce,

mein Ausbilder hat es mir wie folgt erklärt: Wenn die Screenshots für das Verständnis wichtig sind, und das darstellen, was du erklärst bzw. versuchst zu erklären, dann kommen sie in den Text. Dabei solltest du nicht übertreiben, sondern die Screenshots so klein wie möglich halten (aber trotzdem leserlich).

Alle Bilder, die zwar schön zum Sehen sind, aber nicht zwingend für das Verständnis benötigt werden, gehören in den Anhang. Beachte bitte, dass dieser auch begrenzt ist! Bei uns ist er auf 15 Seiten begrenzt.

Ich würde sagen, dass es am Ende die gesunde Mischung macht :=)

 

Ein Abbildungsverzeichnis macht sich gut, damit kannst du auch im Text auf Bilder verweisen.

Hier zum nachschauen, er hat auch ein Video zu Querverweisen.


Ich hoffe das hilft dir weiter.

Link zu diesem Kommentar
Auf anderen Seiten teilen

vor 3 Minuten schrieb peshr:

Hallo Bnce,

mein Ausbilder hat es mir wie folgt erklärt: Wenn die Screenshots für das Verständnis wichtig sind, und das darstellen, was du erklärst bzw. versuchst zu erklären, dann kommen sie in den Text. Dabei solltest du nicht übertreiben, sondern die Screenshots so klein wie möglich halten (aber trotzdem leserlich).

Alle Bilder, die zwar schön zum Sehen sind, aber nicht zwingend für das Verständnis benötigt werden, gehören in den Anhang. Beachte bitte, dass dieser auch begrenzt ist! Bei uns ist er auf 15 Seiten begrenzt.

Ich würde sagen, dass es am Ende die gesunde Mischung macht :=)

Ein Abbildungsverzeichnis macht sich gut, damit kannst du auch im Text auf Bilder verweisen.

Hier zum nachschauen, er hat auch ein Video zu Querverweisen.


Ich hoffe das hilft dir weiter.

Vielen Vielen Dank für den Rat, das Video werde ich mir direkt anschauen :)

Link zu diesem Kommentar
Auf anderen Seiten teilen

vor 31 Minuten schrieb Bnce:

ob man nicht sämtliche Screenshots aus der Durchführungsphase auch einfach in das Abbildungsverzeichnis packen kann

alsooo ganz pauschal kann man das nicht sagen. ICH empfehle alle unwichtigen Screenshots und alle, die grösser als  1/3 Seite gross sind in den Anhang zu packen. Das gilt auch für Tabellen und Grafiken.

Alles, was zum Verständnis nötig ist und nicht grösser als 1/3 Seite sollte meiner Meinung nach im Hauptteil bleiben.

Link zu diesem Kommentar
Auf anderen Seiten teilen

Ich sehe das auch so wie meine Vorredner. Aus den Vorgaben der IHK hier vor Ort lese ich, dass die Bilder im Fließtext nicht zur Seitenumfang gehören:

Zitat

Anzahl der Seiten: 10 bis 12 DIN A4 Seiten

Hierbei werden nicht mitgezählt:-

  • Deckblatt-
  • Inhaltsverzeichnis-
  • Anhänge- Quellenangaben-
  • Kundendokumentation- B
  • ildern, Grafiken, Tabellen, Skizzen usw
     

 

Link zu diesem Kommentar
Auf anderen Seiten teilen

vor 2 Stunden schrieb bartali:

Ich sehe das auch so wie meine Vorredner. Aus den Vorgaben der IHK hier vor Ort lese ich, dass die Bilder im Fließtext nicht zur Seitenumfang gehören:

Bitte immer daran denken, dass das je nach IHK unterschiedlich sein kann. Die IHKs haben alle ihre eigenen Anforderungen. Und nur weil eine IHK das so macht, ist das nicht pauschal auch für alle anderen richtig.

Link zu diesem Kommentar
Auf anderen Seiten teilen

Als Beispiel, mein Prüfer sagte mir, dass er es nicht mag, vom Text in ein Verzeichnis zu springen und wieder zurück. Also habe ich alle Grafiken in den Text gepackt und kein Verzeichnis angehängt. Kommt immer auf die IHK und den Prüfer an. 🙂 

Link zu diesem Kommentar
Auf anderen Seiten teilen

vor 37 Minuten schrieb charmanta:

? Woher kennst Du "Deinen" Prüfer ? Normalerweise stellen sich die Prüfer erst bei der Prüfung vor und Du solltest sie alle nicht kennen ?

Wenn du mich meinst, die IHK bei mir legt sehr viel Wert darauf, dass die Prüfer sich bei den Prüflingen melden und dann vor Ort Termine vereinbaren und genau bei so einem Gespräch hat er mir das gesagt. 😄 

Link zu diesem Kommentar
Auf anderen Seiten teilen

vor 4 Minuten schrieb charmanta:

Oha. Ist bei uns gar nicht der Fall. Danke für die Info

Ja, die finden das besser. Da wird dann vor Ort die Firma geprüft, dein Projekt geprüft, der Code geprüft. Glaube damit werden auch ausgedachte Projekte herausgefiltert 😄

Wobei dir der Prüfer hier nicht sagt, dass du was falsch gemacht hast oder so, das bleibt alles auf einem gewissen Level.
 

Link zu diesem Kommentar
Auf anderen Seiten teilen

Dein Kommentar

Du kannst jetzt schreiben und Dich später registrieren. Wenn Du ein Konto hast, melde Dich jetzt an, um unter Deinem Benutzernamen zu schreiben.

Gast
Auf dieses Thema antworten...

×   Du hast formatierten Text eingefügt.   Formatierung wiederherstellen

  Nur 75 Emojis sind erlaubt.

×   Dein Link wurde automatisch eingebettet.   Einbetten rückgängig machen und als Link darstellen

×   Dein vorheriger Inhalt wurde wiederhergestellt.   Editor leeren

×   Du kannst Bilder nicht direkt einfügen. Lade Bilder hoch oder lade sie von einer URL.

Fachinformatiker.de, 2024 by SE Internet Services

fidelogo_small.png

Schicke uns eine Nachricht!

Fachinformatiker.de ist die größte IT-Community
rund um Ausbildung, Job, Weiterbildung für IT-Fachkräfte.

Fachinformatiker.de App

Download on the App Store
Get it on Google Play

Kontakt

Hier werben?
Oder sende eine E-Mail an

Social media u. feeds

Jobboard für Fachinformatiker und IT-Fachkräfte

×
×
  • Neu erstellen...