Fachinformatiker > Dokumentation > Mantel / Vorspann

Mantel und Vorspann

Deckblatt

Die Gestaltung des Deckblattes ist der Phantasie jedes einzelnen überlassen. Es darf auch die firmeneigene Vorlage im Sinne des Corporate Design verwendet werden. Einige Punkte sollten bei der Gestaltung jedoch berücksichtigt werden:

Inhalt

Auf dem Deckblatt müssen folgende Angaben gemacht werden:

  • Projektbezeichnung
  • Titel mit Untertitel
  • Name des Verfassers mit Adresse
  • Personalnummer / Prüflingsnummer (in der Schule ist das die Klasse!)
  • Name des Projektbetreuers
  • Name des Ausbildungsbetriebes mit Adresse
  • Abgabeort und Abgabedatum
  • auf richtige Schreibweise der Namen (Institut, Referenten) achten
  • bei den Referenten den akademischen Titel angeben.

Gestaltung

Die Angaben sollten nun auch noch gestaltet werden:

  • auf den ?Goldenen Schnitt? (1,6:1) achten
  • maximal drei Schriftbilder
  • gut lesbare Schriftart (Arial, Times New Roman)
  • Layout im Corporate Design der Firma
  • keine Seitenzahl auf dem Deckblatt!

Anfertigen eines Inhaltsverzeichnisses

Schwerpunkte bei der Erstellung einer Inhaltsangabe sind die Gliederung und die Wahl der Überschriften. Grundsätzlich soll der Leser einen guten Überblick über die Auseinandersetzung mit dem Thema bekommen und schnell zu einzelnen Bereichen der Arbeit geleitet werden. Die Argumentationskette sollte dem Leser transparent und vor allem nachvollziehbar durch eine aussagekräftige Formulierung der Überschriften dargestellt werden!

Gliederung des Inhaltes

Die Gliederung ist ein verkürztes Spiegelbild der Dokumentation!
Es gibt verschiedene Arten der Gliederung einer Projektarbeit.

  • chronologische Gliederung (nach dem zeitlichen Ablauf des Geschehens) vom
  • historischen Rückblick zur Zukunftsperspektive
  • Gliederung nach Ursache und Wirkung
  • vom Allgemeinen zum Besonderen bzw. vom Globalen zum Detail.
  • Für alle Vorgehensweisen gilt:
  • auf logische Reihenfolge der Gliederungspunkte achten
  • die Darstellung möglichst differenziert gliedern; bei Dokumenten unter zwanzig Seiten sind drei Gliederungsebenen üblich.

In den einzelnen Kapiteln einen einheitlichen Differenzierungsmaßstab anlegen - also vermeiden, dass ein Kapitel sehr fein gegliedert ist während ein anderes, ähnlich komplexes Kapitel nicht oder nur grob strukturiert ist.

Erstellen von Überschriften und Gliederungspunkten

Nachdem eine Arbeitsgliederung erfolgreich umgesetzt wurde und der Text ausreichend überarbeitet vorliegt, empfiehlt sich eine Neufassung der Überschriften. Dazu werden alle vorhandenen Überschriften gelöscht. Die Aussage der Überschrift steckt ja inhaltlich im dazugehörigen Text, sie geht damit nicht wirklich verloren, sondern wirkt quasi aus dem
Hintergrund.
Jetzt müssen neue Überschriften erstellt werden indem die Kernsätze bzw. Kernaussagen aus dem jeweiligen Textabschnitt isoliert werden und als ?neue? Überschrift vorangestellt
werden. Der Effekt zeigt sich sofort im Informationsgehalt der neuen Inhaltsangabe!

Erstellen von Überschriften und Gliederungspunkten

Nachdem eine Arbeitsgliederung erfolgreich umgesetzt wurde und der Text ausreichend überarbeitet vorliegt, empfiehlt sich eine Neufassung der Überschriften. Dazu werden alle vorhandenen Überschriften gelöscht. Die Aussage der Überschrift steckt ja inhaltlich im dazugehörigen Text, sie geht damit nicht wirklich verloren, sondern wirkt quasi aus dem
Hintergrund.
Jetzt müssen neue Überschriften erstellt werden indem die Kernsätze bzw. Kernaussagen aus dem jeweiligen Textabschnitt isoliert werden und als ?neue? Überschrift vorangestellt
werden. Der Effekt zeigt sich sofort im Informationsgehalt der neuen Inhaltsangabe!

Gestaltung des Inhaltsverzeichnisses

Die Gestaltung ist nur das Kleid einer Dokumentation und macht auch nur einen kleinen Teil der Bewertung aus, aber der erste Eindruck prägt sich beim Leser oft sehr tief ein und beeinflusst damit alle anderen Bewertungsgrundlagen! Die Gestaltung ist nicht alles, aber sie erleichtert oder erschwert das Lesen der Dokumentation.

Bei der Gestaltung ist auf folgende Punkte zu achten:

  • Kopf und Fußzeile nicht vergessen! (Name, Projektbezeichnung, Titel, Seitenzahl/Gesamtseitenzahl). Die optische Trennung durch eine Linie wäre schön.
  • maximal drei Gliederungsebenen (siehe auch Formatierung)
  • aussagekräftige Überschriften
  • Überschrift im Text und Gliederungspunkt sind 100% identisch!

Das Inhaltsverzeichnis und Anhänge werden mit römischen Ziffern gezählt, um deutlich zu machen, dass sie nicht zur Projektkernbeschreibung gehören. Außer dem Deck bzw.
Titelblatt sind sämtliche Blätter zu nummerieren:

  • Im Text werden die Seiten mit arabischen Zahlen numeriert.
  • Bei der Gliederung, dem Anhang mit Glossar (Abkürzungsverzeichnis) Abbil-

        dungsverzeichnis und dem Literaturverzeichnis bedient man sich römischer Zahlen,  d.h. das Inhaltsverzeichnis soll selbst im Inhaltsverzeichnis auftauchen.

z.B.:

Seitenzahl

Inhaltsverzeichnis

   ... II/V

Hinweise                                               

     ...1/3

Einleitung                                             

    ... 1/3

Hauptteil                                              

    ... 2/3

Fazit                                                  

    ... 3/3

Anhang                                                 

    ...III/V

Glossar (Abkürzungen und Fachbegriffe)  

    ....IV/V

Quellen und Tabellen           

     ... V/V

Ausbildung gesucht?

Du willst Dein Hobby zum Beruf machen? Dann bewerbe Dich bei uns als Fachinformatiker für Anwendungsentwicklung / Systemintegration.

Mehr: Ausbildung Fachinformatiker

Folgen Sie uns auf:
Werden Sie Fan!
Empfehlen Sie uns: