Aufgabe "Einheitliche Dokumentation"

Zuletzt aktualisiert am 2025-08-15 | Diese Seite bearbeiten

In der Aufgabe “Datenextraktion aus Diagrammbildern” haben sie bereits eine Dokumentationsdatei namens mietpreise-tuebingen.README.txt erstellt.

Um die Dokumentation in ihrem Projekt einheitlich zu halten, sollen sie nun eine überarbeitete Version dieser Datei erstellen. Konkret:

Erstellen sie eine Markdown-Datei mit dem Namen mietpreise-tuebingen.README.md
Kopieren sie den Inhalt der alten Datei hinein (Die alte Datei soll im Ablageordner verbleiben!)
Überarbeiten sie den Inhalt so, dass er zu den folgenden Anforderungen passt (fügen sie ggf. neue Abschnitte hinzu, die sie für ihre Dokumentation benötigen.)
- Verwenden sie in ihrem Markdowndokument
  - Überschriften
  - Links
  - Listen
  - ggf. Fett- oder Kursivschrift
- Verwenden sie die folgenden Abschnitte:
  - Autoreninformation
    - Namen aller die diese Aufgabe bearbeitet haben
  - Herkunft der Daten (Datenzitation)
    - Beschreibung der Datenquelle
    - Link zur Datenquelle
  - Datenverarbeitung
    - Beschreibung der Extraktionsschritte (in eigenen Stichpunkten)
    - Verwendete Einstellungen
  - Ergebnis
    - Dateinamen der erzeugten Dateien
    - Strukturbeschreibung der erzeugten Dateien
Speichern sie die Datei mietpreise-tuebingen.README.md in ihrem Abgabeordner ab