Technische Beeinflussbarkeit der Geschmacksache Kaffee:Leitfaden

Aus Technische Beeinflussbarkeit der Geschmacksache Kaffee
Version vom 27. Februar 2023, 15:32 Uhr von Armin Rohnen (Diskussion | Beiträge)
(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Zur Navigation springen Zur Suche springen

Leitfaden für die Wiki-Dokumentation

Die Dokumentation im Wiki dient dazu, strukturiert Informationen für alle Beteiligten am Gesamtprojekt bereit zu stellen. Dies ist aufgrund der ständigen Fluktuation der bearbeitenden Studierenden von erheblicher Bedeutung und es bedarf der besonderen Sorgfalt.

Grundsätzlich gilt, wie bei jeder wissenschaftlichen Dokumentation, eine sachliche und umfassende Darstellung der Problemstellung sowie deren Lösung.

Der spätere technische Bericht in Form der Abschlussarbeit oder des Projektberichts stellt faktisch die Zusammenfassung der Wiki-Dokumentation dar. Die Wiki-Dokumentation soll damit umfangreicher sein als der spätere Bericht.

Unbrauchbar sind Wiki-Einträge wie z. B.

- Herr Rohnen erbittet eine Zeichnungsableitung in PDF Format. 
- Änderung des Vorgehens nach Mail von Herrn Rohnen. Es wird finale STEP Datei an Herrn Rohnen gesendet. Die Halterung wurde in 4 Varianten konstruiert

Das sind Einträge in ein Log- oder Tagebuch, sie haben jedoch in einem technischen Bericht nichts zu suchen. Dies Dokumentiert weder die Problemstellung noch die Lösung. Wie der Ablauf zur Auslösung der Bestellung von gebogenen Blechteilen ist, beschreiben die Einträge ebenfalls nicht.

Ebenfalls ungeeignet sind die Verweise auf „vorherige Projektgruppe“ oder „vorherige Abschlussarbeit“. Hierzu liegen immer die Dokumente vor. Im Falle eines erforderlichen Verweises wird über die Nummer aus der Dokumentenliste auf die Dokumentenseite verwiesen.

Beispiel: Die Verrohrung aus der Projektarbeit [28] wird auf Grund der Getriebepumpe erneuert. [28] ist mit der Dokumentenseite im Wiki verlinkt. Die direkten Verweise auf das Dokument bitte unterlassen, denn die Dokumentenseiten im Wiki enthalten noch weitere Informationen.

Wie ein Eintrag im Wiki ausschauen sollte

Jeder Eintrag wird durch eine Überschrift eingeleitet. Diese enthält den Namen des Bearbeiters und das Bearbeitungsdatum. z. B. Armin Rohnen, 20.11.2021.

Jedes Thema enthält eine Problembeschreibung. Die Problembeschreibung kann ein eigener Wiki-Eintrag sein. Insbesondere dann, wenn es sich um komplexere Aufgabenstellungen handelt. 
Die Problembeschreibung beschreibt vollständig das Problem bzw. die aktuelle Fragestellung.
Die Problembeschreibung erfolgt durch mehrere ganze Sätze bis zu mehreren Absätzen.

Jeder Eintrag enthält eine Problembeschreibung (wenn diese nicht als eigener Eintrag dargestellt ist) und die Beschreibung der aktuell bearbeiteten Lösung. Der Text dazu besteht aus mehreren ganzen Sätzen bis hin zu mehreren Absätzen. Bitte die Beschreibungen, so ausführlich wie möglich und in der Textlänge so kurz wie möglich ausführen. Nutzen Sie Quellenverweise um auf Schaltpläne, vorherige Dokumentationen usw. hinzuweisen.

Fügen Sie Abbildungen ein - dabei die Bildunterschrift nicht vergessen.

Abbildungen immer mit „Ausrichtung rechts“, einer maximalen Breite von 600 Pixel und mit Umrahmung einfügen, dann erscheint die Abbildung mit Bildunterschrift.

Der erklärende Text für eine Abbildung muss, wie in einem technischen Bericht üblich, so viel Fläche einnehmen wie die Abbildung selbst. Das bedeutet: Viele Abbildungen viel Text!

Abbildungen, Dateien, CAD-Modelle, Zeichnungen, etc.

Wenn eine Datei (Abbildung, CAD-Modell, Zeichnung, ...) in den Text eingefügt werden soll muss diese zunächst in die Datensammlung aufgenommen werden. Nur darin befindliche Daten werden angezeigt. Ein eigenständiger Upload von Dateien ist aus Gründen der Sicherheit nicht zulässig.

Nomenklatur für den Dateinamen

- JJJJMMTT_beispiel_ueber_nichts_Rohnen.jpg Beginnend mit dem ISO-Datum, keine Umlaute, keine Leerzeichen, keine Sonderzeichen nur Unterstriche und einen - in Zahlen 1 - Punkt. Alles andere bereitet bei der Wiederherstellung und Suche massiv Probleme.

Das Problem mit den Fromeln

Formel zur Berechnung eines gleitenden Mittelwertes (1)
Formel zur Berechnung eines gleitenden Mittelwertes (1)

Das Problem mit den Formeln lässt sich so einfach nicht lösen. Die beste Lösung, damit alle Betrachter des Wikis ohne zusätzliche Installationen auskommen, stellt wohl das Einfügen von Formeln als Bilddatei dar. Dazu die Formel in einem Formeleditor z.B. LaTeXiT setzen und als PNG-Datei uploaden lassen (siehe:Formel zur Berechnung eines gleitenden Mittelwertes (1)). Die Bilddatei vor dem Upload auf eine brauchbare Breite bringen z. B. 300 Px.

Erwarteter Dokumentationsumfang

Es wird eine DIN A4 Seite Text je Bearbeitungswoche erwartet. Im Weiteren wird erwartet, dass vor der Eintragung ins Wiki die Dokumentation dem Betreuer zur Freigabe vorgelegt wird.

Anmerkung zur vorhandenen Wiki-Dokumentation

Die vorhandene Wiki-Dokumentation entspricht oft nicht den o.g. Leitfaden. Dies liegt daran, weil die bearbeitenden Studierenden den Leitfaden schlichtweg ignoriert haben. Mit der Hoffnung, dass sich die Dokumentationsqualität verbessert, wenn die Einträge zuvor durch den Betreuer freigegeben werden, ist das Einholen der Eintragsfreigabe ab WiSe 2022/23 verpflichtend.