Projektdokumentation im Robotiklabor MINTgrün

Die Projektdokumentation soll die Ergebnisse eurer Arbeit zusammenfassen und nach außen präsentieren. Sie soll so geschrieben sein, dass ein technisch interessierter Außenstehender ohne Wissen über eurer Projekt verstehen kann, was ihr gemacht habt und alle nötigen Informationen hat, um euer Projekt nachzubauen oder weiter zu entwickeln.

Sie bildet 20% der Endnote.

Die Projektdokumentation orientiert sich grob an einer wissenschaftlichen Arbeit mit Einleitung, Methodenteil, Ergebnissen und Fazit. Zur besseren Übersichtlichkeit sollte die Seite durch Überschriften gegliedert werden. Die folgenden Inhalte gehören rein:

• Kurze Beschreibung der Aufgabenstellung, die der Roboter hat bzw. löst (ca. 1/2 „Bildschirmseite“)
• u.U. Hinweise und Links auf schon existierende ähnliche Arbeiten

• Aus welchen Baugruppen besteht der Roboter?
• Welche Aufgaben waren zu lösen (ganz knapp)
• Welche Aufgaben wurden bewusst ausgeklammert?
• Idealerweise Skizzen/Fotos des Gesamtsystems mit Beschriftung der Teile

Hier geht ihr ins Detail. Jeder wichtige Bestandteil eurer Lösung (z.B. „Aufbau der Karosserie“, „Messen von Umweltparameter X“, „Erkennung von Y“, „Berechnung von Z“, „Ansteuerung von A“, „Algorithmus zur Bewegung zum Punkt B“ ) bekommt einen eigenen Abschnitt.

Dabei sollte kein für die Funktion wesentlicher Teil komplett unerwähnt bleiben. Erklärt insbeondere diejenigen Teile ausführlich, in die ihr besonders viel Hirnschmalz gesteckt habt, oder zu denen es aussagekräftige Messdaten gibt.

• Welche besonderen technischen, mathematischen oder programmiererischen Anforderungen standen bei der Arbeit im Vordergrund und wie wurden sie gelöst?
• Sprache: Technisch detailliert, präzise und eindeutig, aber knapp formuliert.
• Abbildungen: Oft sagt eine Skizze oder ein Schaltplan mehr als tausend Worte! Sie sollte im aber einen Bezug zum Text haben und aus sich heraus verständlich sein.
• Hierher gehören auch Grafiken mit Ergebnissen von Probemessungen, mathematische Herleitungen oder bemaßte Pläne des Aufbaus.
• S. auch diesen Wiki-Artikel zur Darstellung eurer Messdaten.

Hierher gehört…

• Eine Liste der verwendeten Bauteile. Eine Zeichnung mit dem open-source Programm Fritzing kann hilfreich sein. (Kostenlos für Windows fritzing.zip, für Linux: sudo apt-get install fritzing)
• Eine Pinbelegungstabelle (Was ist an wo am Arduino/Teensy/Raspberry Pi angeschlossen) - sie hilft sehr bei Debugging und Weiterentwicklung

• Endstand des Projekts: Was leistet die entwickelte Lösung und woran scheitert sie?
• Falls die Qualität des Ergebnisses in Zahlen zu messen ist, gehören diese oder ein Diagramm damit hierhin.
• Wo bestehen Verbesserungs- oder Erweiterungsmöglichkeiten? (Ausblick)

Eine Sammlung des Kompletten Programmcodes und evtl. Rohdaten gehören zu eurer Dokumentation. Wenn ihr wollt, könnt ihr dafür eine gesonderte Seite, so dass sie verfügbar sind, ohne den Lesefluss allzu sehr zu stören.

Hier solltet Ihr eine lauffähige Version eures Codes inkl. aller verwendeten Libraries als .zip-Datei zum Download anbieten.

• Es geht nicht darum, jemanden zu beeindrucken, sondern etwas möglichst verständlich und präzise zu erklären. Am besten gelingt das mit einer knappen, präzisen, aber freundlichen Sprache ohne allzuviele Floskeln.
• Falls Ihr irgendetwas gemessen oder berechnet habt, gehört das in die Dokumentation
• Falls Ihr Informationen verwendet, die ihr nicht selbst durch Experimente oder Nachdenken gefunden habt, sollten diese mit einer Quelle belegt werden. Die Quellen könnt ihr auch als Links im Wiki-Text angeben, z.B. so: TU Berlin (Wiki-Syntax: [[https://www.tu-berlin.de | TU Berlin]]).
• Fachwörter, die ihr benutzt, solltet Ihr auch verstanden haben. Im Zweifelsfall besser nachschlagen, als Unsinn zu schreiben.
• Skizzen dürfen bei uns durchaus auch handgezeichnet sein. Sie sehen am besten aus, wenn sie auf weißem Papier gezeichnet sind und nach dem Scannen der Weißpunkt so gesetzt wird, dass der Hintergrund reinweiß ist, z.B. so mit GIMP. GIMP ist ein open-source Bildverarbeitungsprogramm, welches auch sonst bei der Vorbereitung der Abbildung für die Dokumentation nützlich sein kann.
• Alle Abbildungen und Diagramme sollten nummeriert und mit einer kurzen Bildunterschrift versehen sein, die die wesentlichen Aussagen und Inhalte der Grafik knapp erklärt, z.B. so wie in Abb. 1 (s. den Wiki-Quelltext, wie der Link an der Stelle der Abbildungsnummer erstellt wurde):
  

Abbildung 1: Arduino-MOSFET-Schalter für induktive Lasten

• Das Gleiche gilt für Tabellen – sie bekommen eine eigene Nummerierung.
• Bitte verteilt eure Dokumentation nicht auf zu viele Unterseiten, sie ist dann schwer zu lesen.

• Wir wollen von euch eine Wiki-Seite! Also keine PDFs, Papierausdrucke oder Word-Dateien!

• soccerbot: Gute Schwerpunktsetzung und Erklärungen anhand von Formeln und die vielen Abbildungen.
• malokal: Sehr schöne Bilder, sehr Umfangreich, es fehlt jedoch eine quantitative Schätzung des sich ansammelnden Lokalisiserungsfehlers
• beerbot:Großer Detailumfang, viele guten Abbildungen. Der Aufbau ist in der Grundstruktur gut. Der Endstand ist ehrlich dargestellt, eine tiefere Analyse der Fehlerursachen fehlt aber.
• Halli Galli: Gute Abbildungen, aber eine Diskussion der Ergebnisse und Probleme hätte ausführlicher sein sollen.
• CATcher: Gute schematische Abbildungen, ausführliche Diskussion der Ergebnisse.