Gliederung im Anhang

[Ente19]

Ich bin gerade mal angefangen das Pflichtenheft welches fertig ist in den Anhang zu stellen. Bin zwar noch nicht fertig, aber den Anhang schon zu füllen ist ja nicht falsch. Dann vergess ich das nachher auch nicht

Jetzt ist ein Pflichtenheft normalerweise ja ein eigenständiges Dokument, wie bring ich das nun in den Anhang. Bei vielen Dokumentationen ist der Anhang in dem selben Design wie die übrige Dokumentation und hat somit die selben Kopf- und Fußzeilen. Auch die Seitenzahl ist ja weiterlaufend.

Das eigentliche Problem ist nun aber das mein Pflichtenheft ja auch eine Nummerierung und Absätze hat, genau wie der Anhang.

1 Beschreibung des Projektes

.

.

6 Anhang

6.1 Pflichtenheft

Hinzu kommt das ich im Text selber immer die Nummern der Überschriften Linksbündig habe und dann den Text sowie die Überschriten auf einer Flucht, gelöst mittels eines Tabluators. Wenn ich aber nun zu Punkt 6.1 kommt und das Pflichtenheft im selben Stil einbinde, dann sieht das total dumm aus.

Jemand eine Idee?

Meine IHK sagt allerdings das jedes Blatt dem Prüfling und der Dokumentation zu zuordnen sein müssen, was die Fortführung der Kopf- und Fußzeilen eigentlich zur Pflicht macht. (IHK Duisburg)

[timmi-bonn]

Original geschrieben von Ente19

[...] Wenn ich aber nun zu Punkt 6.1 kommt und das Pflichtenheft im selben Stil einbinde, dann sieht das total dumm aus.

Jemand eine Idee?

Seitenzahlen im Footer des Anhanges mit einem Großbuchstaben (A-1, D-22 ...) gemaß Anhangs-Teil deklarieren?

Farbiges Papier?

Ein nicht zu übersehendes (Farbe, Form, Größe) Trennblatt zwischen Doku und Anhang?

Der Kreativität sind keine Grenzen gesetzt.

[Ente19]

Ja schon klar, dann ist jedem Klar das man sich im Anhang befindet. Doch den Zusammenhang mit den Zahlen aus der Inhaltsangabe und die Überschriften sind dann immernoch nicht geklärt.

Selbst wenn ich in der Inhaltsangabe das ebenfalls so deklariere...

Anhang

A1 Pflichetenheft

A2 ...

dann muß ich die Überschrift ja immernoch auf dem jeweiligen Blatt drübersetzen. Und das mit der Fluchtliene und der eigenen Nummerierung innerhalb des Pflichtenheftes ist dann doch auch noch nicht gelöst.

[just_me]

Basierend auf dem Umstand, dass es sich um losgelöste Dokumente handelt, ist es weder möglich noch nötig, ihre äußere Form derjenigen der Dokumentation anzupassen.

Trenne die Anhänge deutlich vom Dokument, und "lege die anzuhängenden Dokumente einfach bei".

Die Gliederung des Anhangs muss sich jedoch in die des Dokuments einfügen, da sie Bestandteil des Dokuments ist. Mein Vorschlag: Produziere Trennseiten: Überschrift, und ein paar erklärende Worte, falls das angehängte Dokument nicht selbsterklärend ist.

Ebenso muss die Seitennumerierung durchgehend sein. Zwar könntest du im Anhang mit einer neuen Numerierung beginnen, etwa A-1, A-2, A-3 oder A1-1, A1-2, A2-1, etc., aber selbst dann musst du eine durchgehend konsistente Lösung finden.

Wenn zusätzliche Restriktionen (Kopf- und/oder Fußzeilen) bestehen, gelten diese natürlich primär.

[Ente19]

Mit anderen Worten erstelle ich eine Art Deckblatt die den Anhang einleitet, und ein Blatt mir der Nummerierung

6.1 Pflichtenheft

hier dann ein paar zeilen zu dem Pflichtenheft oder zu andren Teilen die im Anhang dann kommen werden.

und dann einfach das eigenständige Dokument im Design wie es von der Firma immer erstellt wird anfügen.

Was mach ich dann wenn ich die Doku BInden lassen will, wirkt das dann nicht wie ein Stilbruch beim lesen?

[just_me]

... wirkt das dann nicht wie ein Stilbruch beim lesen?

Es handelt sich um eigenständige Dokumente, die partiell oder vollständig beigelegt werden. Diese eigenständigen Dokumente besitzen auch einen eigenen "Stil".

Würdest du sie - und sei es auch nur stilistisch - anpassen, wäre es gleichbedeutend mit einer Änderung des Dokumentes. Wenn dieses Dokument nicht von dir verfasst wurde, hast du kein Recht, dieses zu verändern (UrhG). Wenn dieses Dokument von dir verfasst wurde, besteht keine Notwendigkeit es zu ändern, da es lediglich zusätzliche, erläuternde Informationen birgt.

(Im Übrigen wäre es schon rein logisch Wahnsinn, jedesmal alle Dokumente aneinander anzupassen. Bei einer vollständigen Dokumentation hast du schnell hunderte Seiten dutzender verschiedener Dokumente. Das würde schnell dazu führen, dass du daraus zehntausende Seiten "Dokumentation" produzierst, die unglaublich redundant wäre ...)

6.1 Pflichtenheft

Natürlich bleibt die Gliederung dir überlassen, aber "üblicherweise buchstabiert" man Anhänge, etwa "Anhang A - Pflichtenheft", "Anhang B - CodeSnippets", etc.; oder man gibt ihnen römische Zahlen, etwa "Anhang I - Pflichtenheft", "Anhang II - CodeSnippets".

Das sorgt dafür, dass der Anhang auch optisch sauber vom Dokument getrennt wird --- denn letztlich ist er "nur Anhang" (in des Wortes wahrstem Sinne).

Wird ein Anhang untergliedert - was sich insbesondere bei Auszügen aus Dokumenten oder Code anbietet - beginnt eine neue Numerierung. Beispiel: "Anhang II - CodeSnippets", "1. Redundanzcheck", "1.1 automatische Prüfung", "1.2 semiautomatische Prüfung". Hier folgt zunächst eine kurze Erläuterung, wenn es notwendig ist (Insbesondere bei Quellcode gern gesehen, weil es die Zeit zum Einlesen merklich reduziert.).

Im Text kannst du dann so darauf verweisen "(vergl. Anhang II CodeSnippets:1.1 automatische Prüfung)". Ziel ist es, gerade bei umfangreichen oder "zusammengestückelten" Anhängen schnellstmögliche Zugriffe zu gewährleisten.

hier dann ein paar zeilen zu dem Pflichtenheft oder zu andren Teilen die im Anhang dann kommen werden.

Wenn es notwendig oder nützlich ist, ja. Redundante Information "um Platz zu füllen", nein.

... und dann einfach das eigenständige Dokument im Design wie es von der Firma immer erstellt wird anfügen.

Yep.

[Ente19]

Verstehe, aber eine Frage habe ich dann zum Schluss noch. Wenn ich also nun in dem Inhaltverzeichnis die Anlagen aufzähle, und diese weiter Untergliedert werden, ist dies dann auch schon in dem Inhaltsverzeichnis Kenntlich zu machen?

Also um beim Pflichtenheft zu bleiben, wird also die Unterteilung des Pflihtenheftes im Inhaltsverzeichnis unter dem Anhang wiederzufinden sein?

Anhang I - Pflichtenheft

1 Zielbestimmung

1.1 Muss-Ziele

Oder wird diese Unterteilung dann einfach nur in der Anlage und dem Pflichtenheft ersichtlich.

[just_me]

Wenn ich also nun in dem Inhaltverzeichnis die Anlagen aufzähle, und diese weiter Untergliedert werden, ist dies dann auch schon in dem Inhaltsverzeichnis Kenntlich zu machen?

nope.

Im globalen Inhaltsverzeichnis listest du entweder nur "Anhang ... 60" auf, und überlässt es den Leuten, zu erraten was drinstehen könnte (Das ist vorteilhaft bei sehr kurzen und überschaubaren Anhängen, oder dann, wenn der Anhang aus nur einem Dokument besteht.), oder du listest die Anhänge einzeln auf, also etwa "Anhang A ... A-1, Anhang B ... A-15".

Wenn du einen sehr umfangreichen Anhang hast, kannst du am Anfang des Anhangs ein zusätzliches Inhaltsverzeichnis einfügen.

Zusätzlich (oder ersatzweise) kannst du in jedem Anhang ein Inhaltsverzeichnis einfügen, wenn dies die Übersicht verbessert.

[just_me]

Also um beim Pflichtenheft zu bleiben, wird also die Unterteilung des Pflihtenheftes im Inhaltsverzeichnis unter dem Anhang wiederzufinden sein?

Vorsicht.

Wenn ich dich richtig verstehe, denkst du daran, 2 Inhaltsverzeichnisse des Pflichtenheftes zu erzeugen? Eines im Anhang, und das zweite als Bestandteil des Pflichtenheftes?

Das Pflichtenheft ist ein einheitliches Dokument. Wenn du es "zersägst", und nur Teile in den Anhang übernimmst, dann ist es durchaus empfehlenswert, eine Gliederungsübersicht im Anhang einzufügen.

Im Fall, dass du das komplette Pflichtenheft anhängst, bringt dieses bereits seine eigene Gliederung mit. Es ist daher nicht mehr nötig, dies zusätzlich im Anhang auszuweisen.