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/07/10 14:03] d.golovko [Beispiele besonders gelungener Projektdokus vergangener Semester:] |
orga:projektdoku [2021/08/03 14:53] (aktuell) d.golovko [Methoden/Umsetzung:] |
||
|---|---|---|---|
| Zeile 10: | Zeile 10: | ||
| ===== 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 39: | 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 45: | 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 ==== | ||
| Zeile 61: | 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 wie in Abb. {{ref>mosfet}} (s. den Wiki-Quelltext, wie der Link anstelle der Abbildungsnummer erstellt wurde): \\ | + | * 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): \\ |
| <figure mosfet> | <figure mosfet> | ||
orga/projektdoku.1531224216.txt.gz · Zuletzt geändert: 2018/07/10 14:03 von d.golovko
Seiten-Werkzeuge
