Erwartungen an die Dokumentation von Projekten: Unterschied zwischen den Versionen

Version vom 13. März 2018, 15:54 Uhr

Einleitung

Dieser Artikel soll Ihnen bei der Anfertigung von Wiki Artikeln helfen. Im Laufe Ihres Studiums werden Sie einige Projekte durchführen, aber es ist äußerst Wichtig auch Ihre Erkenntnisse auch nachhaltig zu dokumentieren, damit andere Ihre Schritte verstehen und diese nachvollziehen können.

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

Projektplan

Lessons Learned

Fachlicher Inhalt

Qualität der Dokumentation

Lesen Sie bitte zuerst den Artikel 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.

Software

Beinhaltet Ihr Projekt die Erstellung von Software, beachten Sie die nachfolgenden Punkte.

Verwenden Sie 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.

Nachhaltiges Arbeiten in SVN

SVN ist die Versionsverwaltung der HSHL. Was Sie dort speichern ist für Ihre Teammitglieder nutzbar und auf dem Server vor Verlust gesichert.

Nutzen Sie dies und arbeiten Sie nachhaltig in SVN. Spätestens an jedem Arbeitstag sollten Sie die Daten auf dem Server sichern, wenn nicht sogar nach jeder wichtigen Änderung.
Schreiben Sie zu jedem commit einen sprechenden Log-Kommentar als Erläuterung Ihrer Änderungen.
Verlinken Sie ihr Repositorium im Wiki Artikel, so dass Ihr Ergebnis auffindbar ist.
Sichern Sie nur wichtige Dateien in SVN (auf keinen Fall Kompilat oder Backup-Sicherheitskopien).
Sichern Sie nur getesteten Quellcode in SVN, welcher Über Header und Kommentare verfügt.

@@ Zeile 18: / Zeile 18: @@
 == 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.
+=== Software ===
+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.
 == Nachhaltiges Arbeiten in SVN ==