Projektlabor Robotik MINTgrün

Diese Seite ist nicht editierbar. Sie können den Quelltext sehen, jedoch nicht verändern. Kontaktieren Sie den Administrator, wenn Sie glauben, dass hier ein Fehler vorliegt.
====== Dokumentation schreiben ======

===== Allgemeines =====
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.

\\
===== Gliederung und Inhalte: =====

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:

==== Themenbeschreibung/Einleitung ====
  * Kurze Beschreibung der Aufgabenstellung, die ihr in eurem Projekt löst
  * u.U. Hinweise und Links auf schon existierende ähnliche Arbeiten, bzw. eure Inspirations-Quelle

\\
==== Methoden/Umsetzung: ====
=== Überblick über das Gesamtsystem ===

    * Aus welchen Baugruppen besteht das System?
    * Welche Aufgaben waren zu lösen (ganz knapp)
    * Welche Aufgaben wurden bewusst ausgeklammert?
    * Evtl. ein Übersichts-Foto

=== Einzelne Abschnitte zur Beschreibung von Details der einzelnen Systembestandteile ===
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 insbesondere diejenigen Teile ausführlich, in die ihr besonders viel Hirnschmalz gesteckt habt.
    

  * Welche besonderen technischen, mathematischen oder programmiertechnischen 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 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.

=== Technische Daten, Bauteile, Pins, etc.===
Hierher gehört...
  * Eine Liste der verwendeten Bauteile. Eine Zeichnung mit dem open-source Programm [[http://fritzing.org/home/ | Fritzing]] kann hilfreich sein. 
  * Eine Pinbelegungstabelle (Was ist an wo am Arduino/Teensy/Raspberry Pi angeschlossen) - sie hilft sehr bei Debugging und Weiterentwicklung
  * Technische-Skizzen/Fotos des Systems
      * mit Beschriftung der Teile (Mechanik)
  * Schaltplan des Systems (Elektrik).
      * Ein richtiger Schaltplan wäre schön, es reicht jedoch auch die Steckplatinen-Ansicht von Fritzing

\\
==== Ergebnis und Diskussion ====
  * Endstand des Projekts: Was leistet die entwickelte Lösung und woran scheitert sie?
  * Wo bestehen Verbesserungs- oder Erweiterungsmöglichkeiten? (Ausblick)


==== Code und Rohdaten ====
Eine Sammlung des kompletten Programmcodes und evtl. Rohdaten gehören zu eurer Dokumentation. Wenn ihr wollt, könnt ihr dafür eine gesonderte Seite anlegen, 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.**


\\
\\
===== Stil und Formales =====
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 allzu viele 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: [[https://www.tu-berlin.de | 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 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. [[techniken:grafikgimp#hintergrund_einer_zeichnung_weiss_machen_mit_gimp| so mit GIMP]]. [[https://www.gimp.org/ | 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 mit einer erklärenden, kurzen Bildunterschrift versehen sein. z.B. so wie in z.B. in der Abbildung unten.
  * Bitte verteilt eure Dokumentation nicht auf zu viele Unterseiten, sie ist dann schwer zu lesen.

**Bitte schreibt eine Wiki-Seite! Also keine PDFs, Papierausdrucke oder Word-Dateien!** Die drei letzgenannten lassen sich nämlich nicht gut im Webbrowser lesen.

<figure mosfet>
{{:techniken:mosfet_schalter_strombegrenzer_pulldown_induktiv.jpg?400|}}
<caption>Arduino-MOSFET-Schalter für induktive Lasten </caption>
</figure>


\\
\\
===== Quellenverweis ====
Große Teile dieser Seite wurden von der [[orga:projektdoku]]-Seite des Robotik-Labors übernommen. Der Inhalt wurde dabei an die Gegebenheiten des Mechatronik-Labors angepasst.
Projektlabor Robotik MINTgrün

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Seiten-Werkzeuge
