Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Beide Seiten der vorigen Revision Vorhergehende Überarbeitung Nächste Überarbeitung | Vorhergehende Überarbeitung Nächste Überarbeitung Beide Seiten der Revision | ||
job:fiae [2015-01-10 20:58] stefan |
job:fiae [2015-01-17 07:40] stefan [Projektdokumentation] |
||
---|---|---|---|
Zeile 8: | Zeile 8: | ||
===== Projektdokumentation ===== | ===== Projektdokumentation ===== | ||
- | ==== Vorlage ==== | + | Hier habe ich meine erwarteten Inhalte der Projektdokumentation zusammengefasst: [[http://fachinformatiker-anwendungsentwicklung.net/2015/01/17/inhalte-der-projektdokumentation/|Inhalte der Projektdokumentation]] |
- | Unter http://f.macke.it/LaTeXVorlageFIAE kann man sich meine LaTeX-Vorlage für die Dokumentation zur betrieblichen Projektarbeit mit einer Vorstrukturierung und vielen Beispielinhalten herunterladen. | + | |
- | ==== Anmerkungen ==== | ||
- | * //kursive// Punkte sind optional bzw. nur bei Bedarf zu erstellen | ||
- | * die Reihenfolge der Punkte ist nicht fix, es können auch mehrere Punkte zusammengefasst werden | ||
- | * eine "sehr gute" Dokumentation... | ||
- | * erfüllt alle unten angegebenen Punkte perfekt | ||
- | * geht aber auch noch darüber hinaus, enthält also ein besonders umfangreiches Projekt mit viel Eigenleistung und außergewöhnlichem Inhalt | ||
- | * ist fehlerfrei hinsichtlich Rechtschreibung/Grammatik/Layout/Verzeichnissen/Verweisen/Literaturangaben etc. | ||
* Beispiele für Projektdokumentationen | * Beispiele für Projektdokumentationen | ||
* [[http://www.pruefungsausschuss.de/ProjektDokus.shtml]] | * [[http://www.pruefungsausschuss.de/ProjektDokus.shtml]] | ||
- | * [[http://www.it-themenportal.de/suicidal/dl_engine/index.php?subcat=7]] | ||
* Bewertungsbögen zur Dokumentation | * Bewertungsbögen zur Dokumentation | ||
* {{:fiaebewertungdokuihkkoeln.pdf|Bewertungsbogen der IHK Köln}} | * {{:fiaebewertungdokuihkkoeln.pdf|Bewertungsbogen der IHK Köln}} | ||
Zeile 27: | Zeile 18: | ||
* {{:ka_merkblattprojektarbeit.pdf|Merkblatt für die Projektarbeit der IHK Oldenburg}} ([[http://ihk-oldenburg.de/download/ka_merkblattprojektarbeit.pdf|online]]) | * {{:ka_merkblattprojektarbeit.pdf|Merkblatt für die Projektarbeit der IHK Oldenburg}} ([[http://ihk-oldenburg.de/download/ka_merkblattprojektarbeit.pdf|online]]) | ||
- | ==== Inhalte ==== | + | ==== Vorlage ==== |
- | * //Formblatt der entsprechenden IHK// | + | Unter http://f.macke.it/LaTeXVorlageFIAE kann man sich meine LaTeX-Vorlage für die Dokumentation zur betrieblichen Projektarbeit mit einer Vorstrukturierung und vielen Beispielinhalten herunterladen. |
- | * Deckblatt mit Informationen zum Projekt | + | |
- | * Titel des Projekts | + | |
- | * Name, Kontaktdaten, Geburtsdatum, Ausbildungsberuf des Auszubildenden | + | |
- | * Name, Kontaktdaten des Ausbildungsbetriebs | + | |
- | * Verzeichnisse (Inhalt, Abbildungen, Tabellen, Abkürzungen, Quellen (!), Anhang, //Listings//) | + | |
- | * Einleitung | + | |
- | * Projektumfeld: Ausbildungsbetrieb, Auftraggeber/Kunde etc. | + | |
- | * Projektziel: Was soll erreicht werden? Worum geht es eigentlich? | + | |
- | * Projektbegründung: Warum ist das Projekt sinnvoll? Was ist die Motivation hinter dem Projekt? | + | |
- | * Projektschnittstellen: Mit welchen anderen Systemen interagiert die Anwendung? Wer sind die Benutzer der Anwendung? | + | |
- | * //Projektabgrenzung//: Was ist explizit nicht Teil des Projekts (insb. bei Teilprojekten) | + | |
- | * Projektplanung | + | |
- | * Projektphasen mit detaillierter Zeitplanung: Beschreibung/Begründung des gewählten Vorgehensmodells | + | |
- | * Ressourcenplanung: Was wird an Ressourcen benötigt (z.B. Hardware, IDE, Betriebssystem)? Gibt es Einschränkungen? | + | |
- | * Kostenplanung/-kalkulation: Was kostet das Projekt? Mögliche Kosten: Entwicklung, Einführung/Schulung, Wartung | + | |
- | * //Make-or-buy-Entscheidung// | + | |
- | * Amortisationsrechnung: Ab wann rentiert sich das Projekt? Mögliche Einsparungen: Lizenzen, Arbeitszeitersparnis, Usability, Korrektheit. Break-Even-Punkt grafisch verdeutlichen (Graphen mit Schnittpunkten) | + | |
- | * nicht-monetärer Nutzen/Nutzwertanalyse: z.B. Vorher-/Nachher-Vergleich anhand eines Wirtschaftlichkeitskoeffizienten | + | |
- | * wichtig: immer den Maßstab für die Gewichtung (warum sind die Kriterien unterschiedlich wichtig?) und die Bewertung (z.B. Punkte von 1 bis 5: was bedeutet das?) angeben | + | |
- | * //Pflichtenheft// erstellen | + | |
- | * Beschreibung des Programms, Ziel der Entwicklung | + | |
- | * Funktionen des Programms: Muss/Soll/Wunsch, Benutzerrollen | + | |
- | * Umgebung: Zielplattform (Programmiersprache, DB, Client, Server, Software, Hardware), Benutzer/Zielgruppen | + | |
- | * Datenstruktur: z.B. ERM, Tabellenmodell, textuelle Beschreibung der Entitäten/Attribute | + | |
- | * Programmlogik: z.B. Flusspläne, UML-Diagramme | + | |
- | * Benutzeroberfläche: Gestaltung, Menüführung | + | |
- | * Qualitätsmerkmale: z.B. Anforderungen hinsichtlich Performance, Usability, Effizienz etc. (ISO 9126) | + | |
- | * Tests: Testszenarien, Benutzer-/Entwicklertests | + | |
- | * Projektdurchführung: Was wurde genau während des Projekts durch den Auszubildenden gemacht? Wie ist er vorgegangen? Hat er z.B. bestimmte Vorgehensmodelle verwendet? | + | |
- | * Ist-Analyse: Wie ist die bisherige Situation (z.B. bestehende Programme, Wünsche der Mitarbeiter)? Was gilt es zu erstellen/verbessern? Ggfs. Erstellen eines Lastenhefts. | + | |
- | * Design/Entwurf | + | |
- | * Funktionen des Programms: z.B. mit Use-Case-/Aktivitätsdiagramm, EPK | + | |
- | * Datenbank (ERM, Tabellenmodell) bzw. wenn keine DB verwendet Darstellung der eingesetzten Datenstrukturen (z.B. XML, CSV o.ä.) | + | |
- | * Geschäftslogik: z.B. Komponenten-/Klassen-/Sequenz-/Datenflussdiagramm, Architekturplanung, EPK | + | |
- | * Benutzerschnittstelle: z.B. GUI, Webinterface, Entwurf/Gestaltung der Oberflächen/Masken, Corporate Identity, Einbindung in andere Anwendungen | + | |
- | * Implementierung/Realisierung: z.B. DB anlegen, Programmierung (interessante Funktionen, Quelltextbeispiele), Screenshots der Oberfläche | + | |
- | * Test/Qualitätssicherung: z.B. Test-Reports, Unit-Tests, Code-Reviews | + | |
- | * Dokumentation: Projektdokumentation, Entwickler- (z.B. JavaDoc) und Benutzerdokumentation ("Handbuch") | + | |
- | * Einführung: z.B. Installation, Benutzerschulung | + | |
- | * Retrospektive: Wie ist das Projekt rückblickend zu bewerten? | + | |
- | * //Begründung von Änderungen zum Projektantrag// | + | |
- | * Soll-/Ist-Vergleich: Wurde das Ziel erreicht? Wurden die Kosten/Zeiten eingehalten? | + | |
- | * Ausblick: Erweiterungsmöglichkeiten, Anschlussprojekte, Akzeptanz der Benutzer | + | |
- | * Fazit | + | |
- | * Erklärung des Auszubildenden | + | |
- | * //Anhänge// | + | |
- | * Lasten-/Pflichtenheft | + | |
- | * Datenbankentwurf | + | |
- | * UML-Diagramme, EPKs, Flusspläne, PAPs | + | |
- | * Entwürfe/Screenshots der Oberflächen | + | |
- | * Dokumentation (Entwickler/Benutzer) | + | |
- | * Glossar | + | |
- | * Quelltexte | + | |
==== Bewertung ==== | ==== Bewertung ==== |