Die Sammlung meiner Anmerkungen und Hinweise zu den Laborberichten im Mastermodul IoT dient dazu zu verdeutlichen, bei welchen Textstellen ich Verbesserungsmöglichkeiten sehe. Die Sammlung mag insbesondere als Hinweisgeber für die Erstellung von Hausarbeiten dienen.
Die Sammlung entstand während des Wintersemesters 2023. Zu jeder ersten Ausfertigung eines Laborberichtes gab es eine kurze Rückmeldung. Die Rückmeldungen sind hier noch einmal zusammengefasst.
Beachten Sie auch meine Schreibregeln.
Stand 11.12.2023
Allgemeine Hinweise zu „Laborberichte schreiben“
Die allgemeinen Hinweise sind eher grundsätzlicher Natur und gehen nicht auf einzelne Formulierungen ein.
a) Jeder Bericht sollte für sich allein lesbar sein, ohne dass ein Leser gezwungen ist zum Verständnis auch einen Vorhergehenden zu lesen.
b) Spendieren Sie dem Leser im Anhang den kompletten Quelltext (noch einmal) zusammenhängend und kopierfreundlich. Dann muss jemand, der das nachbauen will, nicht alles abtippen.
c) Falls zwei Abbildungsunterschriften gleich sind: Das ist eher ungewöhnlich.
d) Schreiben Sie nichts, was Sie nicht verstehen und auch nicht erklären können, sondern recherchieren Sie vorher so lange, bis Sie es in der Tiefe verstanden haben.
e) Bitte spendieren Sie zumindest Ihrer Hausarbeit eine Seitennummerierung …
f) Formal: wenn Sie auf Abb. 2 verweisen, sollte diese auch Abb. 2 heißen. Heißt sie Abbildung 2, so verweisen Sie bitte auf Abbildung 2.
g) Formal: Orthografie und Grammatik werden bei Ausarbeitungen in der Wirtschaftsinformatik mit bewertet.
h) Es gibt keine Zwischenüberschriften? Auch bei einem kurzen Text lohnt es sich, dem Leser durch eine Strukturierung Orientierung zu geben. Ein Bewertungskriterium ist auch: Wie finde ich mich zurecht?
i) Formal: Abbildungen enthalten zwar Abbildungsunterschriften, allerdings stehen sie bezugslos herum und es wird im Text nicht darauf verwiesen. Zudem: Für den Leser istz es angenehm, wenn die Abbildungslegenden schon für sich sprechend sind. Was sieht man? Worauf ist zu achten?
j) Wofür ist Ihr System gut und wie kann ich es benutzen? Die Unterlage sollte diese Frage beantworten.
Im Detail
Die folgenden Anmerkungen beziehen sich jeweils auf einzelne Textstellen in unterschiedlichen Laborberichten.
1.
„Die LEDs werden so angeschlossen, dass ihre Kathode (kurzes Bein) an diese äußere Reihe der Platine angeschlossen wird, während die Anode (längeres Bein) mit den festgelegten Pins des ESP8266 verbunden wird,“
a) Es wäre lesefreundlich, wenn die Anschlüsse hier auch benannt würden – zusätzlich zum Verweis auf den Quelltext.
b) Dass das ohne Vorwiderstände funktioniert, ist eher Zufall – bei anderen Mikrocontrollern funktioniert das nicht. Es könnte ein Satz spendiert werden, warum im speziellen Fall hier die LEDs ohne passende Vorwiderstände nicht sofort durchbrennen.
2.
„Diese können entweder direkt am ESP eingesteckt werden, oder wie in Abbildung 1 zu sehen, auf Höhe der entsprechenden Pins. Beachten Sie, dass die Pluspole der LEDs auf Höhe eines Pins sind, da wir die LEDs über diese Pinbelegung ansteuern werden. Der Pluspol der LEDs sollte an den Pluspol des ESP8266 angeschlossen werden, während der Minuspol an den Minuspol der Steckplatine angeschlossen wird.“
a) Wo hat der ES8266 denn einen Pluspol? Den Anschluss kenne ich gar nicht.
b) Wieso funktioniert das ohne Vorwiderstände? Bei anderen Prozessoren brennen die LED sofort durch …
c) Woran erkennt der geneigte Leser den Pluspol einer LED?
d) An welchen Pins des ESP (Bezeichnung) werden die LED denn nun genau angeschlossen? Eine genaue Benennung im Text würde dem Leser das Nachbauen erleichtern.
3.
„Abbildung 1: Eigene Abbildung“
Das ist ein Bisschen nichtssagend. Eine sprechende Abbildungsunterschrift wäre günstiger.
Allgemein: In wissenschaftlichen Veröffentlichungen ist es oft Usus, die Abbildungslegende schon selbsterklärend auszugestalten, so dass ein Leser schon weiß, um was es sich handelt, ohne den ganzen Text gelesen zu haben. In Publikumszeitschriften lösen die Redakteure das mit sogenanten „Kästen“, in denen sich ein Bild und etwas erklärender Text befindet. Wie so etwas beispielhaft aussehen kann, finden Sie hier: http://bieneviernull.de/wp-content/uploads/2023/10/MesselkenWurmBrell2023Temperaturmessungen-im-BienenstockEntomologie-heute-34-SONDERDRUCK.pdf
4.
„Wie in der Abbildung 1 zu erkennen, wurden die jeweiligen LED mit den Steckplätzen des ESP8266 verbunden.“
Damit ein Leser, der das nachbauen will, nichts falschmacht, wäre eine Benennung der Anschlüsse hilfreich, also was wird mit wem verbunden. Eine kleine Tabelle kann schneller zu erfassen sein als längerer Fließtext.
5.
„Die Zwischenschaltung der Widerstände ist notwendig, da es ansonsten zu einer erhöhten Spannung kommen kann“
Das ist inhaltlich falsch. Die Widerstände begrenzen nicht die Spannung (an welchen Punkten denn?) sondern den Strom durch … (welches Bauteil)
6.
„Hierfür wurde sich am Tutorial, welches auf der Website
cbrell.com verlinkt wurde, orientiert.“
So sollten im Master Quellenangaben nicht mehr aussehen. Geben Sie die Quelle direkt an. Die Website cbrell.com existiert nicht. Ich verbuche das bis hierhin als nicht ausreichend sorgfältig.
7.
(I)„drei LED-Lampen in das
Board eingesteckt und mit Widerständen am Minus-Pol angeschlossen“
LED sind keine Lampen. An Minuspol von was wurden sie angeschlossen? Ich vermute, ein Leser kann mit dieser Ausführung das Projekt nicht nachbauen.
(II)„die rote als auch grüne Lampe“
Eine LED ist keine Lampe.
(III)„Es leuchtet nun immer die Lampe, die über das erste Verzeichnis angesteuert wird“
Eine LED ist keine Lampe, auch wenn sie leuchtet. Ein Glühwürmchen ist auch keine Lampe …
8.
„über jeweils ein Kabel an
die Output Pinslots des Arduinos verbunden“
Was sind Pinslots? Den Begriff habe ich in diesem Umfeld noch nicht kennen gelernt. Wenn Sie die GPIO meinen … an welche wird was angeschlossen? Ich vermute, dass das so ein nachbauwilliger Leser nicht nachbauen kann.
9.
„Das Projekt befasst sich mit der Verwendung der im letzten Projekt erarbeiteten Ampel mit dem ESP8266 D1 Mini, dessen LEDs nun in einem deterministischen Chaos angesteuert werden sollen.“
Ein geneigter Leser ist nun gezwungen, auch den letzten Bericht zu suchen. Es wäre entgegenkommend, wenn es keinen Verweis sondern – ganz kurz und knapp – eine kurze Beschreibung der Ampel gäbe.
10.
„Das Ziel ist es, eine Farbe aus einem Internetverzeichnis auszulesen, die entsprechende LED anzuschalten und abhängig von dieser Farbe eine andere Farbe in ein zweites Verzeichnis zu schreiben.“
Was der Leser nun nicht weiß, ist, dass genau das nun auch ein anderes System tut und das gegenseitige Beschreiben eben das Chaos erzeugt….
In Tabelle 1 wird die Zuordnung zwar erklärt, es wird aber nicht ganz deutlich.
11.
„Die LEDs werden mit ihrer Kathode (kurzes Bein) an dieser äußeren Reihe angeschlossen, während die Anode (langes Bein) mit den definierten Pins des ESP8266 verbunden werden, die im Steuercode für die Farbsignale zuständig sind“
Wie könnte man das so beschreiben, dass es einem Leser leicht fällt, das nachzubauen, ohne suchen und hin und herklicken zu müssen?
Wieso funktioniert das hier ohne dass die LEDs sofort durchbrennen? Beim Arduino ginge das nicht …
12.
„Diese können entweder direkt am ESP eingesteckt werden, oder wie in Abbildung 1 zu sehen, auf Höhe der entsprechenden Pins. Beachten Sie, dass die Pluspole der LEDs auf Höhe eines Pins sind, da wir die LEDs über diese Pinbelegung ansteuern werden. Der Pluspol der LEDs sollte an den Pluspol des ESP8266 angeschlossen werden, während der Minuspol an den Minuspol der Steckplatine angeschlossen wird.“
a) Wo hat der ES8266 denn einen Pluspol? Den Anschluss kenne ich gar nicht.
b) Wieso funktioniert das ohne Vorwiderstände? Bei anderen Prozessoren brennen die LED sofort durch …
c) Woran erkennt der geneigte Leser den Pluspol einer LED?
d) An welchen Pins des ESP (Bezeichnung) werden die LED denn nun genau angeschlossen? Eine genaue Benennung im Text würde dem Leser das Nachbauen erleichtern.
13.
„Durch Veränderung des Jumperkabels soll die Farbwahl (gruen = off oder rot = on) über einen Webserver geändert werden.“
Ok soweit, jedoch: Wird ein Lehrer aufgrund dieses Satzes verstehen, was das System tut und wie das Ganze funktioniert? Ich fürchte, der Lehrer und vermutlich auch seine Schüler werden es eher nicht verstehen. Vielleicht wollen Sie das noch etwas erläutern, eine kleine Skizze ist dabei immer hilfreich.
14.
„Die beiden zuvor durchgeführten Praxisversuche…“.
Inhaltlich stimmt das, aber welche Praxisversuche sind denn genau gemeint? Und in den Referenzen taucht kein Verweis auf die Beschreibung der Praxisversuche auf. Ein Leser hat vermutlich keine Chance, das zu verstehen. Das ist aber der Sinn einer solchen Dokumentation. Eine Dokumentation, wenn sie nicht konsekutiv in einem Schriftenband oder Buch steht, muss für sich alleine lesbar sein.
15.
„Für die Simulation des Buttons wurde ein Aufbau von der Seite draeger-it.blog übernommen. Dabei wird mittels Jumperkabeln ein Kreislauf zwischen dem 3,3V PIN und einem digitalen PIN mit einem Widerstand zwischen geschaltet (vgl. Draeger 2023).“
Das kann man so machen, jedoch ist der Leser nun gezwungen, die Quelle zu lesen, sonst kann er Ihr Projekt nicht nachbauen. Zum Kreislauf: Das ist recht unpräzise, wie schaltet man einen Kreislauf? Was läuft denn hier im Kreis, die Elektronen? Welche Aufgabe hat denn der Widerstand? Und zwischen welchen Anschlüssen ist denn der Schalter – hier Ihr Jumperkabel – geschaltet?
16.
„An die Anode jeder LED wird ein Widerstand mit einem Wert von 330 Ohm – 2000 Ohm, die diese mit der Kathode des Steckboards verbindet.“
Das ist nicht ganz richtig, ein Breadboard (oder deutsch Steckbrett) hat keine Kathode. Der erste Teil des Satzes hat kein Verb, die Form (Grammatik und Rechtschreibung) wird mit bewertet. Weiß ein Leser, wo die Anode einer LED ist? Eine kleine Erläuterung – am besten mit Skizze – wäre sicher hilfreich.