Software-Dokumentation¶
Annahme: In einer Studienarbeit (Studienprojekt, Bachelorabeit, Masterarbeit etc.) wurde ein kleines, aber feines Python-Programm geschrieben, das ein bestimmtes Problem löst.
Herausforderung:
Wie wird dieses Programm professionell dokumentiert?
Good practice aus Sicht der Softwaretechnik
Was muss zur Software-Dokumentation noch hinzukommen, damit alles zusammen als Studienarbeit eingereicht werden kann - und wie integrieren wir das logisch und technisch mit der Software-Dokumentation?
Wie organisieren wir diese Dokumentation technisch, insbesondere unter Verwendung von
Python docstrings
juptyer notebooks
Erzeugung der Online-Version mit Jypyterbook, Markdown, Sphinx
Literaturverwaltung mit Zotero, BibTeX und co.
Erzeugung von pdf via LaTeX
Im Studienprojekt entwickeln die Studierenden also, wie man Software mit Software professionell dokumentiert. Wir setzen Empfehlungen, wie sie z.B. unter https://realpython.com/documenting-python-code/ aufgeführt sind, exemplarisch im dsci-lab um.
Links: