Personal tools
You are here: Home Studium und Lehre Hinweise und Vorlagen Richtlinien für Software- und Laborpraktika
Document Actions

Richtlinien für Software- und Laborpraktika

Anmerkungen zur Durchführung und zu den erwarteten Ergebnissen von Software- und Laborpraktika

Ablauf

Bei einer ersten Besprechung des Themas mit den Studenten wird eine bestimmte Problemstellung umrissen, z. B. die Verwaltung von Übungsaufgaben. Dabei werden bereits die Möglichkeiten der Informationstechnik zur Lösung des Problems berücksichtigt.

Daraufhin erstellen die Studenten eine erste schriftliche Ausarbeitung der Aufgabenstellung. Diese besteht aus einer Beschreibung des Problems und des Lösungsansatzes. Die ausgearbeitete Aufgabenstellung sollte nicht länger als eine Seite und noch sehr abstrakt sein. D. h. es geht hierbei noch nicht um konkrete Implementierungsvorschläge, sondern vielmehr um das Verständnis des Problems. Die Ausarbeitung wird diskutiert und bei Bedarf iterativ angepasst.

Im nächsten Schritt ist ein Fachkonzept zu erstellen. Das Fachkonzept ist ein Modell, das die beteiligten Akteure und Abläufe (Prozesse) in geeigneter Weise und unter Verwendung der fachlichen Terminologie beschreibt. Es dient als Ausgangspunkt für das DV-Konzept und die anschließende Implementierung.

In der nachfolgenden Phase, der Phase des DV-Konzeptes, wird das erstellte Modell in die Kategorien der DV-Umsetzung übertragen. Hierzu ist zunächst herauszufinden, welche Technologien zur Umsetzung geeignet erscheinen. Gibt es mehrere Möglichkeiten, müssen diese anhand geeigneter Kriterien (die sich im wesentlichen aus dem Fachkonzept und der Verfügbarkeit von Werkzeugen ergeben) evaluiert und eine Entscheidung für eine Alternative getroffen werden.

Das im Fachkonzept beschriebene Modell wird dann auf die Möglichkeiten der ausgewählten Technologien und Werkzeuge (z. B. Datenbanksysteme, Netzwerkarchitekturen oder Programmiersprachen) abgebildet. Diese Abbildung gewährleistet, dass Änderungen am DV-Konzept keine Auswirkungen auf das Fachkonzept haben. Diese lose Verbindung soll aber nicht bedeuten, dass das DV-Konzept isoliert entwickelt werden kann.

Im Rahmen der technischen Implementierung wird nun das DV-Konzept auf konkrete hardware- und softwaretechnische Strukturen übertragen.

Implementierung

  • Interaktion, um Probleme frühzeitig zu erkennen
  • Programmierwerkzeuge (Editoren, make usw.)
  • Versionsverwaltung
  • Bugtracking
  • "Packaging"
  • i18n

Dokumentation

  • Aufgabenstellung (DIN A4)
  • Konzeptbeschreibung (Fach- und DV-Konzept)
  • Quelltextdokumentation (API)
  • Benutzerhandbuch
  • Vorlage verwenden

Coding style guide

Bei der Gestaltung von Quelltext sollte man sich grundsätzlich an den jeweiligen sprachspezifischen Konventionen orientieren. Für Python z. B. sind das PEP 8 und PEP 257.

  • Encoding-Angabe, CVS-Id und kurze Beschreibung des Inhalts im "Dateikopf"
  • Einrückungen mit Leerzeichen
  • Methodendokumentation im Doc-String (beispielsweise Python: pythondoc-konform, structured text; Java: javadoc-konform)
  • max. 80 Zeichen Quelltext pro Zeile
  • empfohlene Code-Formatierung der einzelnen Programmiersprachen verwenden

Powered by Plone, the Open Source Content Management System