Quelltext der Seite Erwartungen an die Dokumentation von Projekten

[[Kategorie:HowTo]]
Autoren: [[Benutzer:Ulrich_Schneider| Prof. Schneider]], [[Benutzer:Prof._Mirek_Göbel|Prof. Göbel]]

== Einleitung ==
Dieser Artikel soll Ihnen bei der Anfertigung von Wiki Artikeln für Ihre Projekte helfen. Im Laufe Ihres Studiums werden Sie einige Projekte durchführen, aber es ist äußerst wichtig, auch Ihre Erkenntnisse nachhaltig zu dokumentieren, damit andere Ihre Schritte verstehen, diese nachvollziehen können und am besten Ihr Projekt nachbauen können! Dokumentieren Sie fortlaufend während des Projektes im Wiki ("frontloading").

== Planung eines Projektes ==
Im Verlauf des Studiums sollen Sie lernen eigenverantwortlich zu handeln und stukturiert vorzugehen. Hierbei ist es sinnvoll, sich an gängigen Prozessmodellen zu orientieren und einen Projektplan aufzustellen.

=== Prozessmodelle ===
Nutzen Sie für die Entwicklung ein klassisches Prozessmodell. Wir empfehlen:
* [https://de.wikipedia.org/wiki/V-Modell V-Modell] (für Mechatronikprojekte)
* [https://www.heise.de/developer/artikel/Software-Kanban-im-Einsatz-1235465.html?seite=all Kanban] (für Mechatronikprojekte)
* [https://www.heise.de/developer/artikel/Kriterien-fuer-eine-Entscheidung-fuer-Scrum-oder-Kanban-1071172.html?seite=all SCRUM] (für SW-Projekte).

=== Projektplan ===
Beginnen Sie frühzeitig (1. Semesterwoche) mit der Projektplanung. Nutzen Sie die Methoden, die Sie im Studium gelernt haben. Ein Gantt-Chart kann helfen Abhängigkeiten (Vorgänger, Nachfolger) zu visualisieren. Planen Sie in Arbeitsstunden und gleichen Sie die Workload mit dem Modulhandbuch ab. Verfolgen Sie den Projektfortschritt. Läuft nicht alles nach Plan, erwähnen Sie dies in '''Lessons Learned'''. Bei Fragen melden Sie sich bei Ihrem Projekt-Betreuer*in!

=== Lessons Learned ===
Nicht immer läuft alles perfekt. Fassen Sie Ihre wichtigsten Erkenntnisse kurz zusammen und machen Sie diese im nächsten Projekt besser.

== Fachlicher Inhalt ==
Gehen Sie hier systematisch nach Ihrem Prozessmodell vor, hier z. B. nach V-Modell:
# Anforderungsdefinition
# Funktionaler System-/Softwareentwurf (lösungsneutral)
# Technischer System-/Softwarentwurf (spezifisch)
# Komponentenspezifikation
# Entwicklung/Programmierung
# Komponententest
# Integrationstest
# Systemtest
# Abnahmetest/Präsentation

== Qualität der Dokumentation ==
Lesen Sie bitte zuerst den Artikel [[Erwartungen_an_Pr%C3%A4sentation_und_Dokumentation|Erwartungen an Präsentation und Dokumentation]] und befolgen Sie die dort anschaulich beschriebenen Hinweise. Schauen Sie sich auch die Artikel anderer Studierenden an. Sie können sie auch gern die Quelltextseiten ansehen und die Formatierung übernehmen.

=== Anforderungsanalyse ===
Erstellen Sie sich ein Lasten-/Pflichtenheft, in dem Sie die Anforderungen an Ihr Projekt beschreiben. Geben Sie diesen fortlaufende Nummern (z.B. Req.001).

=== Planung und Durchführung ===

=== Hardware (Systemarchitektur, -entwurf) ===
Beinhaltet Ihr Projekt die Erstellung von Hardware, beachten Sie die nachfolgenden Punkte.
* Hinterlegen Sie Datenblätter für Ihre wichtigsten Bauteile
* Nutzen Sie NI Multisim für die Schaltungsimulation, hinterlegen Sie die Projektdatei und die Simulationsergebnisse.
* Testen Sie Ihren Aufbau auf einem Steckbrett. Dokumentieren Sie das Zwischenergebnis.
* Führen Sie das Leiterplattenlayout mit NI Ultiboard durch, hinterlegen Sie die Projektdatei und das Leiterplattenlayout als Gerber- sowie PDF-Datei.
* Testen Sie die Leiterplatte vor und nach der Bestückung und dokumentieren Sie die Testergebnisse.


=== Software (Softwarearchitektur, -entwurf) ===
Beinhaltet Ihr Projekt die Erstellung von Software, beachten Sie die nachfolgenden Punkte.
* Verwenden Sie [[Einführung_in_MATLAB#Header|Header]] und Kommentare, damit andere Ihren Quelltext verstehen. Beschriften Sie in Simulink beispielsweise die Signalleitungen.
* Ist die Funktion nicht selbsterklärend, nutzen Sie einen Programmablaufplan (PAP) zur Visualisierung der Funktion. Achten Sie darauf, dass das PAP zu Ihrer Implementierung der Software passt.
* Testen Sie Ihre Software anhand der Requirements und dokumentieren Sie Tests und Testergebnisse.


=== Test ===
Testen Sie, ob alle Anforderungen erfüllt sind. Nehmen Sie dabei Bezug auf die Anforderungen (z.B. Req.001). Dokumentieren Sie die Testergebnisse.

'''Statische Tests:'''
* Statische Codeanalyse (z.B. mit Polyspace)
* Code Review

'''Dynamische Tests:'''
* Modultests
* Integrationstests
* Systemtests
* Abnahmetest

== Erlaubte Software-Werkzeuge ==
Nutzen Sie aus Gründen der Nachhaltigkeit ausschließlich die hier aufgeführte Software. Sollten Sie weitere benötigen, sprechen Sie diese bitte vorher mit uns ab!
* Schaltungssimulation: NI Multisim
* Leiterplattenlayout: NI Ultiboard
* Modellbasierte Entwicklung: Matlab/Simulink
* Arduino-Programmierung: Matlab/Simulink
* NXT/EV3 Programmierung: Matlab/Simulink
* CAD: Solid Works
* Statische Codeanalyse: Polyspace
* Dynamische Codeanalyse: Cantata
* Programmablaufpläne: [https://www.heise.de/download/product/papdesigner-51889 PAP-Designer]
* Projektplanung: [https://www.heise.de/download/product/ganttproject-25167 Gantt Project]

== Nachhaltiges Arbeiten in SVN ==
* [[Software_Versionsverwaltung_mit_SVN|SVN]] ist die Versionsverwaltung der HSHL. Was Sie dort speichern ist für Ihre Teammitglieder nutzbar und auf dem Server vor Verlust gesichert.
* Die '''verbindlichen Regeln''' für den umgang mit SVN finden Sie im Artikel [[Software_Versionsverwaltung_mit_SVN|Software Versionsverwaltung mit SVN]].
* Verlinken Sie Ihr Repositorium im Wiki-Artikel, so dass Ihr Ergebnis auffindbar ist.

== Hilfestellung ==
* Sprechen Sie Ihre Vorgehensweise mit Ihrer/Ihrem Betreuer*in ab.
* Sollten Probleme entstehen, sprechen Sie diese frühzeitig mit dem/der Beteuer*in ab. Vielleicht muss ggf. die Aufgabenstellung angepasst werden.