Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- rise:handbuch:3.4_wikidokumentation_how-to [2026-10-11 16:20] – gelöscht - Externe Bearbeitung (Unbekanntes Datum) 127.0.0.1
+++ rise:handbuch:3.4_wikidokumentation_how-to [2026-10-11 16:20] (aktuell) – ↷ Seitename wurde von rise:handbuch:wikiumgang-rise_how-to auf rise:handbuch:3.4_wikidokumentation_how-to geändert lukas
@@ Zeile 1: / Zeile 1: @@
+======= Wikiumgang und Konvention Lehrwiki-How-To =======
+Dieser Artikel beschreibt den allgemeinen Umgang und die Konventionen der Lehrwikis. Es werden zum Teil spezifische Anforderungen für die einzelnen Lehrmodule (RISE, LIVES) angegeben.
+//Es sind jeweils die für das Lehrmodul angegebenen und allgemeinen Beschreibungen und Konventionen zu beachten. Spezifische Hinweise zum Beispiel zum RISE-Modul müssen von LIVES-Gruppen nicht berücksichtigt werden.//
+===== Einleitung =====
+In diesem Artikel wird das allgemeine Vorgehen zur Erstellung und Bearbeitung von Wiki-Seiten erläutert.
+Das Zweite Exoskelett im RISE-Kosmos sowie alle LIVES Dokumentationen sollen im Rahmen der Dokumentationstrategie Diátaxis erfolgen. Dieses zeichnet sich durch eine Unterteilung der Dokumentierten Inhalte in die vier verscheidenen Bereiche Tutorials, How-To, Referenzen und Erläuterungen aus. [[https://diataxis.fr/|Zu Diataxis kann man sich hier weiter belesen.]]
+Alle relevanten Inhalte für das Exo2 sind ab SoSe 2025 grundsätzlich in neuen Seiten zu formulieren, die im Diataxis Format und in der neuen Inhaltsangabe vertreten sind. Im Sinne der guten wissenschaftlichen Praxis und Nachvollziehbarkeit genutzter Quellen, sind Verweise auf alte genutzte Inhalte dennoch notwendig - Insbesondere bei den Explanation-Seiten.
+Beispiele und Vorlagen für diese Diataxis-Seiten sind
+  * [[rise:studi:rise-exo-2:vorlagen:diataxis-beispiel_tutorials]]
+  * [[rise:studi:rise-exo-2:vorlagen:diataxis-beispiel_how-to]]
+  * [[rise:studi:rise-exo-2:vorlagen:diataxis-beispiel_reference]]
+  * [[rise:studi:rise-exo-2:vorlagen:diataxis-beispiel_explanation]]
+Diese Beispiele dienen als Orientierung und dürfen je nach Sinnhaftigkeit und Absprache auch aufgebrochen werden.
+===== Bewertungsschema und Selbstständigkeitserklärung =====
+  - Das aktuelle **Bewertungsschema** für die Abschlussdokumentation befindet sich auf ISIS und umfasst die relevanten Kriterien für die Bewertung.
+  - Jedes Gruppenmitglied muss eine **Selbstständigkeitserklärung** im Original unterzeichnen und zum Abschlusstermin einreichen. Eine Vorlage ist auf ISIS verfügbar.
+===== Formelle Anforderungen =====
+    - **Die Gliederung** einer Seite wird über die Verwendung der Wiki-Syntax mit Überschriften automatisch angelegt
+    - **Zitierstil**: Wir verwenden die „Deutsche Zitierweise“, die der Syntax im Wiki entspricht und Fußnoten verwendet.
+    - Es ist nicht notwendig, ein separates Literaturverzeichnis anzulegen, da Fußnoten auf den Wiki-Seiten verwendet werden.
+    - Die Berücksichtigung von geschlechtersensible Sprache soll entsprechend des [[https://www.tu.berlin/gleichstellung/informationen/leitfaden-geschlechtersensible-sprache|TU-Leitfadens]] - beispielsweise mittels "*" - erfolgen
+    - **Der Umfang** der Dokumentation beträgt 5-10 Seiten DIN A4 pro Person, einschließlich Text, Abbildungen und Tabellen. Das gilt als grober Richtwert in exportierten PDFs, es sind keine Wörter zu zählen o. ä.
+    - **Das jeweilige Wiki-Dokumentationskonzept**, inklusive Vernetzungsplan zu anderen und alten Seiten soll bis zum zweiten Sprint Review ausgearbeitet und als Vorschlag vorgestellt werden (RISE).
+    - **Neue Seiten** dürfen und können nur nach Absprache mit den jeweiligen Tutor*innen erstellt werden. Dies dient der Weiterführung und ggf. Korrektur älterer Seiten und Inhalten und der Vermeidung von Dopplungen. Die Gliederung und Vernetzungsstruktur muss mindestens zwei Wochen vor der Endabgabe mit den Betreuenden final abgesprochen sein, damit alle Seiten rechtzeitig erstellt werden können (Nur vom Betreuenden via Rechte möglich).
+    - **Das Wiki soll während des Semesters kontinuierlich gepflegt werden**, damit wichtige Punkte und Erkenntnisse, die schon früh im Semester aufgetreten sind, nicht in Vergessenheit geraten und später abrufbar sind. Dazu werden sie in einer vorläufigen Form zu jedem Sprint im Semesterprotokoll dokumentiert. Außerdem sollen Änderungen an bestehenden Artikeln und neue Seiten schon im Semster vorläufig bearbeitet werden. Am Ende des Semesters werden sie finalisiert.
+===== Farbkonventionen =====
+  - Verwenden Sie **<fc #ff0000>Rot</fc>** nicht als Schriftfarbe, da es sich um Korrekturfarbe handelt. Wenn Hinweise oder Kommentare auf bestehenden Seiten in roter Schrift markiert sind, sollten diese bei der Bearbeitung der Seite beachtet und verbessert werden.
+  - Wenn alte Artikel ergänzt oder geändert werden, sollte die Farbe **„<fc #800080>Purple</fc>“** für den aktuellen Semesterbeitrag gewählt werden. Diese Farbmarkierung dient der Korrektur und Nachverfolgung und wird nach dem Semester in Schwarz geändert. Nicht gefärbte Ergänzungen in alten Artikeln können nicht bewertet werden!
+  - Wenn Artikel zusammengeführt werden, kann das der ausgeschnittene Inhalt aus anderen Seiten mit der Farbe **<fc #c0c0c0>Silver</fc>** dargestellt werden, um es von der eigenen Arbeit abzugrenzen
+  - Zu löschende Absätze und Sätze sollten <del>durchgestrichen werden</del>.
+  - Wenn ganze Artikel gelöscht werden sollen, dies direkt unter der Überschrift der Seite in **<fc #800080>Lila und fett</fc>** vermerken und auf der Semesterprotokollseite mit zu löschen verlinken
+===== Vernetzung der Wissensinhalte =====
+Ein Wiki profitiert von einer **maximalen Vernetzung der Wissensinhalte**. Dies sollte bei der Erstellung aller Inhalte berücksichtigt werden. Die Strukturierung der Artikel erfolgt wie folgt (siehe auch unten): Von der Startseite jeder Gruppe aus wird auf jeden erstellten Inhalt verlinkt.
+Zudem müssen alle LIVES-, und RISE-Seiten in der [[rise:studi:rise-exo-2:inhaltsverzeichnis-exo2|RISE Gliederung-EXO2]] bzw. [[lives:Inhaltsverzeichnis|LIVES Gliederung]] mindestens einmal aufgeführt sein, um die Inhalte auch nach Kategorien zu suchen. Auch mehrmalige Zuordnung in der Gliederung ist möglich, wenn sinnvoll.
+===== Artikelstrukturierung =====
+Jede Gruppe muss eine [[rise:studi:rise-exo-2:vorlagen:semesterprotokoll|Semesterprotokollseite]] angelegen, diese entspricht einem strukturierten Ablauf der Dokumentation und enthält Verknüpfungen zu allen relevanten Artikeln und generierten Inhalten.
+    - Eine Einleitung in das Thema und die Aufgabe.
+    - Ein roter Faden durch die geleistete Arbeit mit Verknüpfungen zu allen verwendeten Artikeln. Hierbei ist insbesondere zu erläutern, in wiefern das [[https://diataxis.fr/|Diataxis]]-Format sinnvoll umgesetzt ist und wo abgegrenzt wird.
+    - Auflistung und kohärente Verknüpfung aller bearbeiteten Dokuseiten.
+    - Schnittstellen zu anderen Gruppen.
+    - Eine kritische Einordnung der eigenen Projektarbeit. Wenn sinnvoll, kann hier auch auf die Zeitplanung und das Scrum-Management (RISE) eingegangen werden. Auch etwaige kritische Beschaffungs- und Fertigungsprozesse, sowie Verzögerungen, die rein organisatorisch und nicht zwingend bauteilimmanent sind, sollten nur hier dokumentiert werden.
+    - Allgemein Inhalte, die sich nicht sinnvoll von anderen Gruppen erweitern/nutzen lassen, da sie nur auf Ihre spezielle Gruppe bezogen sind, oder nicht über das Semester hinaus relevant sind.
+    - Ein zusammenfassender Ausblick auf zukünftige Arbeitspakete.
+    - Ggf. bei getrennter Bewertung eine tabellarische Aufteilung der Arbeitsleistungen der Mitglieder
+===== Beispielstruktur =====
+Das Diataxis Format soll vorrangig auf Bauteilebene stattfinden, damit den den jeweiligen Teilen alle relevanten Seiten direkt ersichtlich sind. Bei allgemeineren Themen kann aber auch eine Übergeordnete Aufteilung sinnvoll sein, dies ist jeweils mit den Tutor*innen zu diskutieren.
+RISE:
+  - organisation
+  - semesterprotokolle
+  - infrastruktur
+  - konstruktion_und_cad
+    - huefte-fe-rotor
+    - knie-aa-rotor
+      - fixator_unterschaenkel_explanation
+      - fixator_unterschaenkel_reference
+    - weitere_entwicklungen
+  - elektrotechnik_und_elektronik
+  - mensch_maschine_interaktion
+  - biomechanik_ganganalyse_simulation
+===== Benennung und Ergänzungen =====
+Artikel sollten in der Dateibezeichnung immer zunächst die kategorische Diataxis-zuordnung tragen, bevor der Titel kommt:
+  * [Dateibezeichnung]_tutorial
+  * [Dateibezeichnung]_how-to
+  * [Dateibezeichnung]_explanation
+  * [Dateibezeichnung]_reference
+ z. B. "Fixatoreinstellung_Piloteneinstieg_how-to".
+Absätze, die bei alten Artikeln neu hinzugefügt werden, müssen neben der Purple-Farbe auch signiert werden:
+Dies gewährleistet, dass Artikel auch nach mehreren Semestern eindeutig zugeordnet und gefunden werden können, wenn Sie in der Suchleiste danach suchen.
+===== Vermeidung von Doppelungen =====
+Prinzipiell sollten sich keine Seiten doppeln. Aus diesem Grund dürfen neue Seiten auch nur nach Absprache mit den Tutoren angelegt werden. Wenn Seiten von mehreren Gruppen genutzt werden, sollte dies in Absprache zwischen den Gruppen erfolgen. Ein Beispiel hierfür war die Seite zu Mikrocontrollern.
+===== Anpassungskennzeichnung =====
+Bei Ergänzungen muss unbedingt angegeben werden, was geändert wurde, wenn Sie die Seite speichern (Textzeile „Zusammenfassung“ neben dem Speicherbutton – diese wird automatisch ausgefüllt, wenn nur ein Absatz bearbeitet wird). Dies ermöglicht eine Zuordnung von Ergänzungen zu den Autoren, sowohl in Bezug auf den Autor als auch inhaltlich.
+===== Wichtige Hinweise zur Vernetzung =====
+Verlinkungen zwischen den Diataxis-Formaten eines Themas sind zwingend erforderlich. Gibt es beispielsweise ein geschriebenes Programm muss in dem Artikel des Tutorials eine Verlinkung zu den Artikeln des how-to, der explanation und der reference vorhanden sein.
+Im Laufe der Semester wird die Vernetzung verschiedener Artikel immer wichtiger. Ähnlich wie bei Wikipedia ist die Hauptanforderung an eine gute Auffindbarkeit und Zugänglichkeit des Wissens die maximale Vernetzung der verschiedenen Artikel. Achten Sie daher unbedingt darauf, zunächst nach der Seite zu suchen, die als nächstes erstellt werden soll. Allgemein sollten Sie alle relevanten Verknüpfungen herstellen. Denn mehr ist mehr.
+===== WIKI-Seite-Erstellen=====
+Beachtet zudem die formellen und Syntax Hinweise auf [[wiki:wikiseiteerstellen|Wikiseiteerstellen_How-To]]
+===== Tags =====
+{{tag>Wiki Vorgehen Methodik Struktur Konvention}}