Vorlage für die Projektdokumentation

Vorlage für die Projektdokumentation

Um unseren Auszubildenden die Arbeit zu erleichtern, habe ich eine LaTeX-Vorlage für die Projektdokumentation erstellt. Damit auch ihr etwas davon habt, könnt ihr sie hier herunterladen. Auch wenn ihr nicht mit LaTeX arbeitet, ist die PDF-Datei sicher interessant für euch, da eine Gliederung inkl. Beispielinhalten gezeigt wird.

Wenn du stattdessen lieber mit Microsoft Word* oder LibreOffice arbeiten möchtest, gibt es unter

   dieperfekteprojektdokumentation.de

die komplette Vorlage für Word ab Version 2007 bzw. LibreOffice ab Version 5.1.5 zum Download.

Microsoft Word-/LibreOffice-Vorlage für die Projektdokumentation der IT-Berufe

Die Vorlage umfasst neben dem Layout und den obligatorischen Elementen wie Deckblatt, Verzeichnissen und Literaturangaben insbesondere eine Vorstrukturierung der üblicherweise geforderten Inhalte einer Dokumentation zur betrieblichen Projektarbeit inklusive einiger Beispiele für wichtige Inhalte wie z.B. Kostenkalkulation und Amortisationsrechnung. Obwohl viele Inhalte der Vorlage speziell auf Anwendungsentwickler zugeschnitten sind, dürfte die Vorlage auch für die anderen IT-Berufe (Fachinformatiker Systemintegration, IT-Kaufleute usw.) interessant sein, da die Vorgaben hinsichtlich der Projektarbeit größtenteils übereinstimmen (siehe auch die u.a. Links).

Vielen Dank an dieser Stelle an Dirk Grashorn für die zur Verfügung gestellten Inhaltsbeispiele (Grafiken, Listings usw.) und die ALTE OLDENBURGER für die Erlaubnis, die Vorlage zu veröffentlichen.

Als Literatur für die konkreten Inhalte der Projektdokumentation und auch als Vorbereitung auf die anderen praktischen Teile der Abschlussprüfung bei der IHK, empfehle ich „Clevere Tipps für die Projektarbeit – IT-Berufe: Abschlussprüfung Teil A*“ von Anselm Rohrer und Ramona Sedlacek. Die beiden Autoren geben einen guten Überblick und viele praktische Tipps für die Abschlussprüfung und ich habe ihre Anregungen auch in meine Vorlage einfließen lassen.

Clevere Tipps für die Projektarbeit*

Wer mit LaTeX noch nicht so viel anfangen kann, dem sei LaTeX – kurz & gut* empfohlen:

Matthias Kalle Dalheimer - LaTeX - kurz & gut*

Wenn euch die Vorlage hilft, würde ich mich über Feedback in den Kommentaren oder per Kontaktformular freuen.

Inhalte

Im Detail finden sich im fertigen Dokument:

  • Hinweise zu den geforderten Inhalten mit Quellenangaben
  • Deckblatt
  • Inhaltsverzeichnis
  • Abbildungs- und Tabellenverzeichnis
  • Abkürzungsverzeichnis/Glossar
  • vorstrukturierte Kapitel für den eigentlichen Inhalt mit Stichpunkten und Beispielen (Zeitplanung, Stundensatzrechnung, Use Case-/Klassendiagramm, ERM, Mockups u.a.)
  • Literaturverzeichnis
  • Eidesstattliche Erklärung
  • Anhang

Lizenz

Creative Commons Lizenzvertrag
LaTeX-Vorlage zur Projektdokumentation für Fachinformatiker Anwendungsentwicklung von Stefan Macke ist lizenziert unter einer Creative Commons Namensnennung – Weitergabe unter gleichen Bedingungen 4.0 International Lizenz.

Die Namensnennung mit Verlinkung auf diese Seite (http://fiae.link/LaTeXVorlageFIAE) muss dabei nicht lesbar im fertigen PDF erfolgen, sondern lediglich im LaTeX-Quelltext.

Download

Ergänzende Inhalte

Echte Beispiele für mit 100% bewertete Projektdokumentationen auf Basis dieser Vorlage:

  • Deckblatt der Projektdokumentation von Gerda Feldhaus
  • Deckblatt der Projektdokumentation von Markus Amshove

Checkliste (mit über 100 Punkten) für die Projektdokumentation

Anwendungsentwickler-Newsletter

Als Dankeschön bekommst du meine
Checklisten für Projektantrag, Projektdokumentation und Projektpräsentation
mit über 100 Punkten zur Prüfung auf mögliche Fehler.

Einführung in LaTeX

Meine Video-Serie zur Einführung in LaTeX. Das erste Video kannst du dir direkt hier anschauen:

Podcast: Häufige Fehler in der Projektdokumentation

In Podcast-Episode 9: Die 17 häufigsten Fehler in der Projektdokumentation stelle ich häufige Fehler in der Projektdokumentation vor.

Weitere Infos zur Projektdokumentation

Du suchst noch mehr Tipps rund um die Projektdokumentation? Dann schau doch mal in diese Artikel- und Podcast-Kategorie: Alle Artikel rund um die Projektdokumentation.

Kennst du schon meine Microsoft Word-/LibreOffice-Vorlage für die Projektdokumentation? Unter dieperfekteprojektdokumentation.de kannst du sie herunterladen.

Und wenn du dich für meinen Newsletter einträgst, kannst du dir jetzt sofort meine Checkliste für die Projektdokumentation herunterladen.

Checkliste für die Projektdokumentation

19 thoughts on “Vorlage für die Projektdokumentation

  1. Hallo,

    ich quäl mich gerade durch meine Projektarbeit (Fachinformatik: Systemintegration). Deine Vorlage hat mir extrem geholfen. Schon allein was man überhaupt schreiben soll, geschweige denn von wie.

    Ich habe noch nie mit LaTeX gearbeitet aber aus neugier mal reingeschaut. Wenn ich versuche mit MikTex und TexMaker deine Vorlage zu übersetzen erhalte ich eine Fehlermeldung. Mich würde intressieren wo da mein Fehler liegt.

    Ich öffne die Projetkdokomentation.tex und starte „Schnelles Übersetzen“. Dann erhalte ich die Fehlermeldung ! LaTeX Error: \chapterpagestyle undefined für Zeile 13 in Allgemein\Seitenstil.tex.

    Da ich wie gesagt keine Ahnung habe, bin ich bisher nicht dahintergekommen, wie ich den Fehler beseitige ohne die Zeile zu löschen.

    Regards

    wKovacs

  2. Hallo wKovacs,

    sorry, die Zeile \renewcommand{\chapterpagestyle}{scrheadings} ist noch aus einer alten Version der Vorlage drin :-/ Lösch sie einfach, dann geht es! Bei nächster Gelegenheit werde ich das im ZIP korrigieren.

    Viele Grüße!
    Stefan

  3. Schöne Vorlage. Allerdings entspricht das Inhaltsverzeichnis nicht der DIN 5008. Demnach verlaufen die Nummerierungen aller Kapitel und Unterkaptel in einer, sowie die Kapitel- und Unterkapitelbezeichnung in einer eigenen Fluchtlinie. 1 Kapitel 1
    1.1 Unterkapitel A
    1.2 Unterkapitel B
    2 Kapitel 2
    Weiß jemand wie man das hinbekommt? die Option tocleft in der scrartcl-Klasse tut es nicht ganz. Wäre für ein Minimalbeispiel und Tipps dankbar.

  4. @Chris:
    Die Einrücktiefe kannst du manuell festlegen, z.B. für Abschnitte:

    \cftsetindents{section}{0.5in}{0.5in}

    Stackexchange hat eine eigene Sub-Community für LaTeX, wo ich auch diese Antwort her habe 🙂

    @Stefan: Den Haken für den Newsletter per Default aktivieren halte ich für hinterhältig, zumal die E-Mail Adresse ein Pflichtfelt für Kommentare ist.

  5. Hallo,

    in der Abkuerzungen.tex gibt es den Befehl \begin{acronym}. Eclipse meckert mir hier an, dass die Umgebung „acronym“ nicht definiert wäre. Ich habe in deiner Vorlage nichts dergleichen gefunden.
    Wo steht das?

    Vielen Dank!

  6. Hallo chena,

    in der aktuellen Version steht in Zeile 40 der Packages.tex dies: \usepackage[printonlyused]{acronym}. Das bindet das Package acronym ein, das die Umgebung definiert.

    Viele Grüße! Stefan

  7. Hallo Stefan,

    bin noch neu im Thema Latex, und möchte aber deine Vorlage gerne für meine Projektdoku nutzen.

    Ich hab mir schon einige deiner Tutorials angesehen, und mich auch auf deiner Seite umgeschaut.
    Mir fehlt hier irgendwie leider eine kleine Einführung, wie man deine Vorlage in ein bzw als Projekt einbindet?!

    Ich würde mich freuen, wenn du mir da mal auf die Sprünge helfen könntest.

    Gruss

    Thorsten

  8. Hallo Stefan,

    erstmal vielen Dank für die tolle Vorlage.
    Ich hätte da mal eine Frage zu den Inhalten, ich habe hier in den verschiedenen als Vorlage eingereichten Projektdokumentationen immer ein paar ähnliche, wenn nicht sogar fast identische Absätze gesehen, z.B.:

    „Die folgende Projektdokumentation schildert den Ablauf des IHK-Abschlussprojektes, welches der Autor im Rahmen seiner Umschulung zum Fachinformatiker Fachrichtung Anwendungsentwicklung durchgeführt hat.“

    „Für die Umsetzung des Projektes standen dem Autor 70 Stunden zur Verfügung. Diese wurden vor Projektbeginn auf verschiedene Phasen verteilt, die während der Softwareentwicklung durchlaufen werden. Eine grobe Zeitplanung sowie die Hauptphasen lassen sich der Tabelle Zeitplanung entnehmen. Außerdem wurden die einzelnen Hauptphasen noch in kleinere Unterphasen zerlegt. Eine detaillierte Übersicht dieser Phasen befindet sich im Anhang Zeitplanung.

    „In der Übersicht, welche sich im Anhang Verwendete Ressourcen befindet, sind alle Ressourcen aufgelistet, die für das Projekt eingesetzt wurden. Damit sind sowohl Hard- und Softwareressourcen als auch das Personal gemeint. Bei der Auswahl der verwendeten Software wurde darauf geachtet, dass diese kostenfrei z.B. als Open Source zur Verfügung steht oder die Firma bereits Lizenzen für diese besitzt. Dadurch konnten anfallende Projektkosten so gering wie gehalten werden.“

    Kann ich die so bzw. leicht abgeändert in meiner Dokumentation nutzen? Wenn ja, muss ich diese Absätze in der Dokumentation als ‚Zitate aus Ihrer Latex Vorlage‘ kennzeichnen?
    Mein Projekt-/ Praktikumsleiter meint nämlich es keine gute Idee sei einfach aus der Vorlage Texte zu nehmen.

    Jetzt bin ich verunsichert.

  9. Hallo Steffen,

    da gebe ich deinem Praktikumsleiter recht: Du solltest keine Inhalte aus „fremden“ Dokumentationen ohne Hinweis übernehmen. Das kann zum Punktabzug führen oder schlimmstenfalls zum Nichtbestehen der Prüfung. Siehe auch hier: Verwendung von fremden Vorlagen für die Projektdokumentation.

    Die Inhalte, die du ansprichst, sind Formulierungen, die bei uns im Unternehmen verwendet werden. Daher haben beide Azubis den Text übernommen. Ich würde dir jedoch dringend empfehlen, die Inhalte selbst zu formulieren. Oder du findest ähnliche Texte, die bei dir im Unternehmen verwendet werden. In letzterem Fall würde ich jedoch sogar zu einer Kenntlichmachung der übernommenen Text raten.

    Viele Grüße!
    Stefan

  10. Dabei ging es um den
    Download des kompletten LaTeX-Quelltextes (inkl. Projektdateien für TeXlipse)

    funktioniert aber wieder.

    Danke

  11. Hallo Stefan,

    zunächst einmal herzlichen Dank für die exzellente LaTeX-Vorlage und dafür, dass Du diese kostenfrei zur Verfügung stellst!

    Zu dieser hätte ich einige Fragen.
    Die Vorgabe der IHK lautet Schriftgröße 11, Zeilenabstand: 1,3-fach.

    Nun bin ich mir nicht sicher, ob Deine Vorlage diese Spezifika erfüllt. In der Seitenstil.tex findet sich unter „Allgemeines“:
    \onehalfspacing % Zeilenabstand 1,5 Zeilen

    welches ich zu

    \renewcommand{\baselinestretch}{1.3}

    geändert habe. Nach fehlerfreiem kompilieren konnte ich in der fertigen .pdf-Datei allerdings keinen Unterschied zu dem Kompilat aus Deiner Vorlage erkennen.

    Eine andere Lösung zum Zeilenabstand habe ich hier gefunden
    http://mrunix.de/forums/showthread.php?65697-Kleiner-Zeilenabstand-%281-3-fach%29-mit-onehalfspacing
    und es mit

    \usepackage{setspace}

    \setstretch{1,2381}

    (Vorschlag aus dem letzten Forumseintrag ganz unten)

    probiert und auch fehlerfrei kompilieren können. Allerdings kann ich in der fertigen .pdf-Datei auch hier keinen Unterschied zu dem Kompilat aus Deiner Vorlage erkennen.

    Wie kann ich den Zeilenabstand auf 1,3-fach in Deiner Vorlage ändern?

    Zudem habe ich ebenfalls in der Seitenstil.tex ganz oben unter:
    \geometry{a4paper,left=20mm,right=20mm,top=25mm,bottom=35mm}

    versucht die Schriftgröße zu ändern indem ich:

    \geometry{a4paper,11pt,left=20mm,right=20mm,top=25mm,bottom=35mm}

    eingegeben und fehlerlos kompiliert habe.
    Beim genauen Betrachten der fertigen .pdf-Dateien kann ich allerdings auch hier keinen Unterschied mit geänderten Parametern zu dem Kompilat Deiner Vorlage feststellen.

    Wie kann ich die Schriftgröße auf 11 ändern?

    Die IHK sagt in dem Schreiben, welches diese Vorgaben enthält leider auch nicht, ob es 11pt, 11em, 11mm oder 11in sein sollen. Ich gehe mal davon aus, dass es 11pt sein sollen.

    Welchen Formatvorgaben entspricht Deine Vorlage eigentlich? Wäre nett, wenn Du dies noch zum Download der Vorlage dazu schreiben könntest.

    Vielen Dank im Voraus und viele Grüße!

    Martin

  12. Hallo Martin,

    die Vorlage folgt keiner Formatvorgabe, da eh jede IHK ihr eigenes Süppchen kocht. Und hunderprozentig vergleichbar mit z.B. Microsoft Word wird das LaTeX-Dokument nie sein, da LaTeX den Text teilweise ganz anders (aber natürlich besser 😉 ) setzt und dadurch Platz spart. Ich habe mal einen Vergleich gemacht und bin bei gleicher Schriftgröße und 15 Seiten Text auf über eine Seite weniger im Vergleich zu Word gekommen.

    Die Schriftgröße kannst du in Projektdokumentation.tex mit \documentclass[11pt] anpassen. Den Zeilenabstand müsste ich jetzt auch googlen. Den musste ich bislang noch nie ändern 🙂

    Wenn du eine Lösung hast, schreib gerne einen Kommentar!

    Viele Grüße!
    Stefan

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.

To create code blocks or other preformatted text, indent by four spaces:

    This will be displayed in a monospaced font. The first four 
    spaces will be stripped off, but all other whitespace
    will be preserved.
    
    Markdown is turned off in code blocks:
     [This is not a link](http://example.com)

To create not a block, but an inline code span, use backticks:

Here is some inline `code`.

For more help see http://daringfireball.net/projects/markdown/syntax