Benutzer-Werkzeuge
doku2020
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen gezeigt.
| Beide Seiten der vorigen Revision Vorhergehende Überarbeitung Nächste Überarbeitung | Vorhergehende Überarbeitung | ||
|
doku2020 [2020/07/14 13:26] d.golovko [Allgemeines] |
doku2020 [2020/07/31 10:57] (aktuell) d.golovko [Stil und Formales] |
||
|---|---|---|---|
| Zeile 5: | Zeile 5: | ||
| Für die Projektdokumentation bekommt ihr maximal 20 Punkte. Insgesamt gibt es im Kurs 100 Punkte, ihr braucht 50%, um zu bestehen. Die Lehrveranstaltung wird im Sommersemester 2020 nicht benotet. | Für die Projektdokumentation bekommt ihr maximal 20 Punkte. Insgesamt gibt es im Kurs 100 Punkte, ihr braucht 50%, um zu bestehen. Die Lehrveranstaltung wird im Sommersemester 2020 nicht benotet. | ||
| + | |||
| + | Macht bitte eine neue Seite für eure Projektdokumentation. Sie gehört nicht auf eure Projektplanung-Seite. | ||
| + | |||
| + | Ihr habt bis zum 26.07. Zeit, die erste Version eurer Doku vorzubereiten. Dann wird Darya sie lesen und euch in ca. 2 Tagen in Wiki Kommentare geben. Ihr bekommt dazu eine ISIS-Nachricht. Danach habt ihr bis zum 09.08. Zeit, die Endversion der Doku vorzubereiten. Falls ihr mehr Zeit braucht (z.B. wegen Prüfungen), schreibt Darya eine E-Mail. | ||
| \\ | \\ | ||
| Zeile 18: | Zeile 22: | ||
| * u.U. Hinweise und Links auf schon existierende ähnliche Arbeiten bzw. Projekte aus den alten Semestern | * u.U. Hinweise und Links auf schon existierende ähnliche Arbeiten bzw. Projekte aus den alten Semestern | ||
| - | ==== Methoden/Umsetzung: ==== | + | ==== Umsetzung / Funktionalität: ==== |
| === Überblick über das Gesamtsystem === | === Überblick über das Gesamtsystem === | ||
| Zeile 26: | Zeile 30: | ||
| === Einzelne Abschnitte zur Beschreibung von Details der einzelnen Systembestandteile === | === Einzelne Abschnitte zur Beschreibung von Details der einzelnen Systembestandteile === | ||
| - | Hier geht ihr ins Detail. Jeder wichtige Bestandteil eurer Lösung (z.B. "GUI", "Erkennung von X im Bild", "Berechnung von Y", "Modell für die Simulation von Z, "Anwendung des Algorithmus ABC" ) bekommt einen eigenen Abschnitt. | + | Hier geht ihr ins Detail. Jeder wichtige Bestandteil eurer Lösung (z.B. "GUI", "Erkennung von X", "Berechnung von Y", "Modell für die Simulation von Z, "Anwendung des Algorithmus ABC" ) 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. | + | 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 interessante Zwischenergebnisse (z.B. Bilder) gibt. |
| | | ||
| Zeile 35: | Zeile 39: | ||
| * Abbildungen: Oft sagt eine Skizze oder eine Zeichnung mehr als tausend Worte! Sie sollte im aber einen Bezug zum Text haben und aus sich heraus verständlich sein. | * Abbildungen: Oft sagt eine Skizze oder eine Zeichnung 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, die die Zwischenergebnisse darstellen, die in eurem Projekt entstanden sind. | * Hierher gehören auch Grafiken, die die Zwischenergebnisse darstellen, die in eurem Projekt entstanden sind. | ||
| - | === Technische Daten, Bauteile, Pins, etc.=== | + | |
| - | Hierher gehört... | + | |
| ==== Ergebnis und Diskussion ==== | ==== Ergebnis und Diskussion ==== | ||
| * 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 hierhin. |
| * Ausblick: Wo bestehen Verbesserungs- oder Erweiterungsmöglichkeiten? Wie könnte man das Projekt weiter entwickeln (z.B. in den nachfolgenden Semestern)? | * Ausblick: Wo bestehen Verbesserungs- oder Erweiterungsmöglichkeiten? Wie könnte man das Projekt weiter entwickeln (z.B. in den nachfolgenden Semestern)? | ||
| Zeile 54: | Zeile 57: | ||
| * 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. | ||
| * Falls Ihr irgendetwas gemessen oder berechnet habt, gehört das in die Dokumentation | * 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]]%%''). | + | * Falls Ihr Informationen verwendet, die ihr nicht selbst durch das Ausprobieren 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]]%%''). Das bezieht sich natürlich auch auf Bilder, die ihr nicht selbst erstellt habt. Da das Urheberrecht ein komplexes Thema ist, ist es besser, die entsprechenden Seiten oder Videos zu verlinken, als die dort stehenden Bilder/Videos zu kopieren. |
| * 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. | ||
| Zeile 65: | Zeile 68: | ||
| * Das Gleiche gilt für Tabellen -- sie bekommen eine eigene Nummerierung. | * 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. | + | * Bitte verteilt eure Dokumentation nicht auf viele Unterseiten, sie ist dann schwer zu lesen. |
| * **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!** | ||
| + | |||
| + | * Eure Wiki-Seite wird spätestens zum Anfang des nächsten Semesters öffentlich geschaltet werden, und zwar unter dem Punkt "Projekten aus den vergangenen Semestern" in Wiki. Das bedeutet, falls ihr Bilder von euch selbst erzeugt habt und nicht wollt, dass diese öffentlich werden, schreibt Darya eine E-Mail. Falls ihr wollt, dass eure Namen auf der Projekt-Doku-Seite auftauchen, so schreibt diese dort. | ||
| + | * Falls ihr Fragen zur Wiki-Formatierung habt, helfen wir euch gerne. Schreibt eine E-Mail an Darya. | ||
| \\ | \\ | ||
doku2020.1594726002.txt.gz · Zuletzt geändert: 2020/07/14 13:26 von d.golovko
Seiten-Werkzeuge
