You are here: SE » ThesesHome » ThesisPythonDokuInfotypen

Messung der Informationstypen-Häufigkeiten in der Python-Dokumentation (Bachelorarbeit)

Nachfolgestudie zu
W. Maalej, M. Robillard: "Patterns of Knowledge in API Reference Documentation"
für Python.


Zusammenfassung (aus der Bachelorarbeit)

Walid Maalej und Martin P. Robillard haben im September 2013 einen Artikel [MR13] veröffentlicht, in dem sie die Dokumentationen der Programmier- sprachen Java und .NET auf ihren Informationsgehalt hin untersucht und verglichen haben. Ihre Untersuchung wird im Rahmen dieser Bachelorarbeit auf die Dokumentation von Python1 mit einigen Abweichungen übertragen. Die von Maalej und Robillard eingeführte Taxonomie der in Dokumentatio- nen anzutreffenden Wissenstypen wurde hierfür auf die Eigenheiten von Python angepasst. Die Einordnung von Teilen der Dokumentationen zu den verschiedenen Wissenstypen wird von Gutachtern im Rahmen eines Forschungspraktikums geleistet und erfolgt mit Hilfe eines eigens hierfür geschriebenen Werkzeuges.

Die anschließende Auswertung der Ergebnisse und ein Vergleich dieser mit denen aus dem Originalartikel zeigt, dass die vorgenommenen Änderungen in der Konzeption sinnvoll waren. Die Struktur der Wissenstypen in der Dokumentation von Python ähnelt stark der bei Java und .NET, hat aber auch überraschende Abweichungen. Die erhobenen Daten bieten zudem eine Grundlage für weitergehende Untersuchungen zu den Informationsty- pen in der Python-Dokumentation wie beispielsweise die Reihenfolge des Auftretens oder die Wortmenge von Informationen.

Resultate

Comments