Benutzer-Werkzeuge
orga:projektdoku
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen gezeigt.
| Beide Seiten der vorigen Revision Vorhergehende Überarbeitung Nächste Überarbeitung | Vorhergehende Überarbeitung | ||
|
orga:projektdoku [2018/02/07 12:04] d.golovko [Code und Rohdaten] |
orga:projektdoku [2021/08/03 14:53] (aktuell) d.golovko [Methoden/Umsetzung:] |
||
|---|---|---|---|
| Zeile 6: | Zeile 6: | ||
| Sie bildet 20% der Endnote. | Sie bildet 20% der Endnote. | ||
| + | \\ | ||
| + | \\ | ||
| ===== Gliederung und Inhalte: ===== | ===== Gliederung und Inhalte: ===== | ||
| - | Die Projektdokumentation orientiert sich grob an einer wissenschaftlichen Arbeit mit Zusammenfassung, Einleitung, Methodenteil, Ergebnissen und Fazit. | + | 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. | Zur besseren Übersichtlichkeit sollte die Seite durch Überschriften gegliedert werden. | ||
| Die folgenden Inhalte gehören rein: | Die folgenden Inhalte gehören rein: | ||
| Zeile 37: | Zeile 39: | ||
| === Technische Daten, Bauteile, Pins, etc.=== | === Technische Daten, Bauteile, Pins, etc.=== | ||
| Hierher gehört... | Hierher gehört... | ||
| - | * Eine Liste der verwendeten Bauteile. Eine Zeichnung mit dem open-source Programm [[http://fritzing.org/home/ | Fritzing]] kann hilfreich sein. | + | * Eine Liste der verwendeten Bauteile. Eine Zeichnung mit dem open-source Programm [[http://fritzing.org/home/ | Fritzing]] kann hilfreich sein. (Kostenlos für Windows {{:orga: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 | * Eine Pinbelegungstabelle (Was ist an wo am Arduino/Teensy/Raspberry Pi angeschlossen) - sie hilft sehr bei Debugging und Weiterentwicklung | ||
| Zeile 43: | Zeile 45: | ||
| * Endstand des Projekts: Was leistet die entwickelte Lösung und woran scheitert sie? | * 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. | * 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? | + | * Wo bestehen Verbesserungs- oder Erweiterungsmöglichkeiten? (Ausblick) |
| - | ===== Code und Rohdaten ===== | + | ==== 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, so dass sie verfügbar sind, ohne den Lesefluss allzu sehr zu stören. | 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. | ||
| Zeile 51: | Zeile 53: | ||
| + | \\ | ||
| + | \\ | ||
| ===== Stil und Formales ===== | ===== 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 allzuviele Floskeln. | * 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. | ||
| Zeile 58: | Zeile 61: | ||
| * Fachwörter, die ihr benutzt, solltet Ihr auch verstanden haben. Im Zweifelsfall besser nachschlagen, als Unsinn zu schreiben. | * 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. [[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. | * 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. [[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 nummeriert und mit einer kurzen Bildunterschrift versehen sein, die die wesentlichen Aussagen und Inhalte der Grafik knapp erklärt, z.B. so: \\ | + | * 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. {{ref>mosfet}} (s. den Wiki-Quelltext, wie der Link an der Stelle der Abbildungsnummer erstellt wurde): \\ |
| - | {{:techniken:mosfet_schalter_strombegrenzer_pulldown_induktiv.jpg?400|}}\\ | + | |
| - | **Abb. 1:** Arduino-MOSFET-Schalter für induktive Lasten | + | <figure mosfet> |
| + | {{:techniken:mosfet_schalter_strombegrenzer_pulldown_induktiv.jpg?400|}} | ||
| + | <caption>Arduino-MOSFET-Schalter für induktive Lasten </caption> | ||
| + | </figure> | ||
| * Das Gleiche gilt für Tabellen -- sie bekommen eine eigene Nummerierung. | * Das Gleiche gilt für Tabellen -- sie bekommen eine eigene Nummerierung. | ||
| Zeile 67: | Zeile 73: | ||
| * **Wir wollen von euch eine Wiki-Seite! Also keine PDFs, Papierausdrucke oder Word-Dateien!** | * **Wir wollen von euch eine Wiki-Seite! Also keine PDFs, Papierausdrucke oder Word-Dateien!** | ||
| + | \\ | ||
| + | \\ | ||
| ===== Beispiele besonders gelungener Projektdokus vergangener Semester: ===== | ===== Beispiele besonders gelungener Projektdokus vergangener Semester: ===== | ||
| * [[projektews1415:soccerbot|soccerbot: Gute Schwerpunktsetzung und Erklärungen anhand von Formeln und die vielen Abbildungen.]] | * [[projektews1415:soccerbot|soccerbot: Gute Schwerpunktsetzung und Erklärungen anhand von Formeln und die vielen Abbildungen.]] | ||
| * [[projektews1415:malokal|malokal: Sehr schöne Bilder, sehr Umfangreich, es fehlt jedoch eine quantitative Schätzung des sich ansammelnden Lokalisiserungsfehlers]] | * [[projektews1415:malokal|malokal: Sehr schöne Bilder, sehr Umfangreich, es fehlt jedoch eine quantitative Schätzung des sich ansammelnden Lokalisiserungsfehlers]] | ||
| * [[projekte2014:beerbot:dokumentation|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.]] | * [[projekte2014:beerbot:dokumentation|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.]] | ||
| + | * [[projektewise1718:haligalipublic:start|Halli Galli: Gute Abbildungen, aber eine Diskussion der Ergebnisse und Probleme hätte ausführlicher sein sollen.]] | ||
| + | * [[projektewise1718:catcherpublic:start|CATcher: Gute schematische Abbildungen, ausführliche Diskussion der Ergebnisse.]] | ||
orga/projektdoku.1518001478.txt.gz · Zuletzt geändert: 2018/02/07 12:04 von d.golovko
Seiten-Werkzeuge
