Skip to content

Projekt

TrianguIator edited this page Mar 7, 2022 · 11 revisions

Zum Reiseführer Mathematik beitragen

Zuerst möchten wir uns ganz herzlich für dein Interesse am Reiseführer Mathematik bedanken.

Im Folgenden stehen ein paar Leitlinien dafür, wie du dich am besten und schnellsten in das Projekt einlebst und produktiv mitarbeiten kannst. Die Leitlinien sind dabei lediglich als Hinweise zu verstehen. Wenn du mit bestimmten Sachen schon Erfahrung hast und weißt, wie es für dich am besten geht, dann kannst du diese Stellen natürlich überspringen.

Wie kann ich Helfen?

Nicht jeder wird auf dieselbe Weise an diesem Projekt arbeiten, daher haben wir die Leitlinien grob geteilt in Autoren, Lehrer, Korrektoren und andere. Gehe einfach zu dem Unterkapitel, dass dir entspricht. Wenn du mehrere Rollen übernehmen willst, ist das natürlich auch möglich.

In keiner dieser Rollen erwarten oder gar verlangen wir, dass du regelmäßig Arbeit in das Projekt steckst. Es handelt sich selbstverständlich um ein privates Freizeitprojekt. Aber jedwede Form von Unterstützung ist sehr gerne gesehen.

Rolle Beschreibung
Lehrer Als Lehrer sind wir gespannt auf deine Erfahrungen damit, den Stoff zu unterrichten. Welche Erklärungen verstehen Schüler, welche eher nicht? Anmerkungen, wenn wir Schulstoff vergessen haben oder unzureichend erklären sollten, sind natürlich ebenfalls gerne gesehen.
Korrektor Korrektoren können über das Buch und dazugehörige Aufgaben lesen und jedwede Fehler oder Unklarheiten anmerken.
Autor Autoren schreiben die Inhalte des Buches und denken sich die Aufgaben dazu aus. Du kannst entweder ein (Unter-/) Kapitel für dich selbst übernehmen oder mit anderen Autoren zusammen arbeiten.

Lehrer

Mögliche Aufgaben:

  • Feedback zu Kapitelplanung geben (für die geplanten Inhalte siehe hier)
  • Beratung während des Schreibens
  • Über den neuesten Release lesen und Probleme mit den aktuellen Erläuterungen ansprechen
    • Was ist noch nicht gut genug erklärt?
    • Was ist zu ausführlich erklärt?
    • Was ist zu abstrakt / nicht anschaulich genug?
    • In welchen Bereichen könnten Schüler Probleme beim lesen haben (z. B. zu schwere Sprache oder fälschlich vorausgesetztes Wissen)
    • ...
  • Aufgaben in den Aufgabenblöcken schwer / leichter als angemerkt
  • Aufgaben in den Aufgabenblöcken üben den gelehrten Stoff nicht gut genug / zu ausführlich
  • Aufgaben der Vorbereitungsblätter unpassend / eine sinnvolle Aufgabe fehlt zu einem bestimmten Punkt
  • Feedback darüber, ob der gewählte Aufgabentyp (Freitext, Lückentext, Ankreuzaufgabe, ...) für jeweilige Vorbereitungsaufgaben passend ist

Relevante Links:

Korrektor

Mögliche Aufgaben:

  • Über den neuesten Release lesen und Probleme mit den Texten ansprechen
    • Rechtschreib- und Grammatikfehler
    • Verwendet ein Kapitel Vorwissen, dass in den Kapiteln davor noch nicht eingeführt wurde?
    • Fehlerhafte Verweise
    • ...

Relevante Links:

Autor

Mögliche Aufgaben:

  • Entwurf und Planung von Kapiteln
  • Ausformulierung geplanter Kapitel (bzw. Unterkapitel) -- dies geht alleine oder in einem Team
  • Anmerkungen der Korrektoren und Lehrer prüfen und einpflegen (ggf. unter Absprache mit andern Autoren)
  • Stellen von sinnvollen Aufgaben für die Vorbereitungsblätter (typischer Weise nachdem das entsprechende Kapitel geschrieben und Reviewed wurde)
  • Stellen von Aufgaben für die Aufgabenblöcke (typischer Weise nachdem das entsprechende Kapitel geschrieben und Reviewed wurde)

Relevante Links:

Arbeitsumgebung aufsetzen und kompilieren

Wenn du das Projekt selbst kompilieren und bearbeiten möchtest, solltest du deine Arbeitsumgebung entsprechend aufsetzen. Hier findest du sowohl die minimalen Requirements als auch empfohlene Tools. Insbesondere benötigst du in jedem Fall texlive (https://tug.org/texlive/) oder MikTeX (https://miktex.org/).

VSCode
(Empfohlen)
Benötigt:
  1. VSCode (https://code.visualstudio.com/Download)
  2. Die Extension james-yu.latex-workshop (in VSCode unter View > Extensions nach der Extension suchen)
Kompilieren:
  1. Öffne die Datei, die du kompilieren möchtest
  2. Wenn du sie änderst und die Änderungen speicherst, wird sie neu kompiliert.
  3. Die kompilierte PDF liegt in wobei <pfad>/<dateiname>.tex die geöffnete Datei ist.
Makefile Benötigt:
  1. Gnu Make: TODO: Instruktionen
Kompilieren:
  1. make book aus dem root-Verzeichnis des Repos aufrufen
  2. Das Kompilat liegt in dem Verzeichnis out
Andere Beachte:
  1. Die Umgebungsvariable TEXINPUTS muss das Repo und den Ordner buch beinhalten

Projektstruktur

Die Ordnerstruktur ist so gewählt, dass sie die Projektstruktur nachempfindet.

Buch

TODO

Aufgabenblöcke

Aufgabenblöcke zu den jeweiligen Kapitel finden sich im Ordner aufgabenbloecke. Hier liegt eine Datei mit dem Namen des Kapitels, die das Gesamtdokument für den Aufgabenblock bildet. In dem Ordner, der ebenfalls den Namen des Kapitels trägt, findet man dann die Aufgaben selbst nach den Vorbereitungsblättern gruppiert. Zum Beispiel ist der Aufgabenblock zum Kapitel Abbildungen in aufgabenbloecke/abbildungen.tex definiert. Diese fasst allerdings lediglich die Dateien aufgabenbloecke/abbildungen/blattXX.tex zusammen. TODO