Dokumentation, Anhang, Grafiken?

[Rhuen]

Hy,

ich hab irgendwie gerade nen Knoten im Hirn.

Ich bin an der Dokumentation dran, jetzt bin ich aber verwirrt was die Punkte Grafiken und Anhang angeht.

Kann ich in meiner Doku einfach Grafiken einfügen?z.b. jetzt für Netzwerk veranschaulichung oder müssen die in den anhang?

Oder sollen nur alle grafiken die man einfügt nochmal in den anhang?

Denn ich habe hier eine pdf die den Aufbau einer Dokumentation durchkaut, und da gibts am ende den punkt:

Anhang u.a. den unterpunkt Grafiken, Protokolle, Tabellen.

Das hat mich jetzt alles bisschen verwirrt.

Bin leider der einzige und erste FISI von daher kann mir das hier auch keiner sagen .

Ich würde da jetzt meine Dokumentation schreiben, screenshots bzw. bilder und grafiken einfügen mit bezeichnungen wie Abb. 1 Abb. 2 etc. und beim anhang die alle nochmal auflisten?

mfg

[Deadlift]

Welche IHK haste denn?

München sagt dazu klar: was sind die Anforderungen ihres Betriebs => so machen

Generell würde ich in ner Doku keine Bilder oder Code irgendwo redundant haben.

Das zeigt nur dass du es nicht strukturieren konntest.

Du kannst 2 Sachen machen...

Entweder packst du (wenn nicht allzu groß) die Bilder direkt in den Fließtext, ist ab und an ne gern gesehene Abwechslung zum vielen Text.

Oder

Du haust große Bilder direkt in den Anhang und verweist in deiner Dokumentation darauf dass der dargestellte Sachverhalt im Anhang in nem Bild deutlicher zu erkennen ist.

Was aber ned geht ist beispielsweise zu einem Punkt nichts da steht ausser:

siehe Anhang 7.7. Bild Toll Netzwerkdiagramm

Ich hab meine ganzen Bilder nur im Anhang weil sie einfach zu groß für die Doku gewesen wären und verweise an den respektiven Stellen auf die Anhänge.

(Ein Flussdiagramm und ein DB Schema)

Dann kann man sichs ansehen um es genauer zu sehen, muss aber nicht und versteht den Zusammenhang trotzdem.

[Rhuen]

Ok, thx.

Habe auch ne Fertige Projektdokumentation im Netz gefunden, die hilft mir da schon sehr weiter.

Da wurden im Anhang nur sehr große Grafiken (wie erwähnt) angehängt, und im Fließtext dann immer kleine aussagekräftige.

Genau das wollte ich damit nur wissen .

Dachte schon das die ganze Doku nur aus Text besteht und dann im Anhang nach und nach die Bilder rein, das wäre ja mehr als unübersichtlich .

Wenn man was fertiges hat, kann man sich wenigstens auch ein gesamtbild der Optik machen wie man es evt. vom "Design" übernehmen kann oder wie man es aufteilt.

Ist ja schwierig ein Fertiges zu finden, wohl in der gefahr das man nur kopiert oder alles gleich macht.

[Deadlift]

Ist ja schwierig ein Fertiges zu finden, wohl in der gefahr das man nur kopiert oder alles gleich macht.

Dafür gibts mehrere Gründe.

Glaub irgendwo hast du rechtlich 10 Jahre bis dus hochladen darfst, andererseits sinds teils Themen die die Betriebe ned gern im Netz sehen würden etc.

Frag ma in deiner Berufsschule nach, die Lehrer ham meist immer positiv und negativ Beispiele auf Lager an alten Dokus.

(wobei das wird nu etwas spät sein)

Im Endeffekt ist selber machen und nen fertigen Kaufmann (ja auch ich als FiAw habs nen Kaufmann gegelesen lassen) zeigen, die ham meist Layoutkniffe auf Lager.

[Rhuen]

Selber machen tu ich das, aber son fertiges hilft da doch sehr das man sich etwas inspirieren kann wie es aussehn sollte.

Wie mit ner neuen webseite, wenn man keine ahnung hat, surft man rum, schaut sich verschiedene an und wird dann inspiriert zu neuen ideen.

Für in der schule nachfragen ists jetzt wirklich zu spät ^^.

Habe durch das ganze lernen etc. ganz verschwitzt das der Termin so langsamm abläuft für die abgabe.

Habe mir aber schon lange gedanken gemacht was ich schreiben würde, von daher kann ich das meiste frei hand runter rattern.