(Externe) Dokumentation ist vermutlich der am meisten und häufigsten vernachlässigte Aspekt von Software, die nicht von professionellen Programmierern in ihrer Arbeitszeit geschrieben wurde. Dabei ist sie immens wichtig, weil sich an ihr und ihrer Qualität mitunter die Nutzbarkeit und Verbreitung eines Programms bzw. einer Bibliothek entscheidet. Das gilt genauso für Software, die im wissenschaftlichen Kontext zur Datenauswertung entwickelt wird – nur, dass hier (gute) Dokumentation vermutlich noch seltener anzutreffen ist. Zur Transparenz und Nachvollziehbarkeit in der Wissenschaft gehört zwingend dazu, die verwendete Software verstehen zu können. Selbst perfekt lesbarer und ausdrucksstarker Code kann aber nur das Wie, nie das Was und Warum (bzw. was warum nicht) kommunizieren. Entsprechend muss das Was und Warum schriftlich festgehalten werden. Eine minimale externe Dokumentation (README) ist für größere Projekte und für jede wissenschaftliche Software unumgänglich. Einfach nutzbare Werkzeuge helfen dabei, Dokumentation und Quellcode synchron zu halten.

错误:搜索内容不能为空,请输入英文关键词
错误:关键词超出字数限制,请精简
高级检索

(Externe) Dokumentation

  • Till Biskup

摘要

(Externe) Dokumentation ist vermutlich der am meisten und häufigsten vernachlässigte Aspekt von Software, die nicht von professionellen Programmierern in ihrer Arbeitszeit geschrieben wurde. Dabei ist sie immens wichtig, weil sich an ihr und ihrer Qualität mitunter die Nutzbarkeit und Verbreitung eines Programms bzw. einer Bibliothek entscheidet. Das gilt genauso für Software, die im wissenschaftlichen Kontext zur Datenauswertung entwickelt wird – nur, dass hier (gute) Dokumentation vermutlich noch seltener anzutreffen ist. Zur Transparenz und Nachvollziehbarkeit in der Wissenschaft gehört zwingend dazu, die verwendete Software verstehen zu können. Selbst perfekt lesbarer und ausdrucksstarker Code kann aber nur das Wie, nie das Was und Warum (bzw. was warum nicht) kommunizieren. Entsprechend muss das Was und Warum schriftlich festgehalten werden. Eine minimale externe Dokumentation (README) ist für größere Projekte und für jede wissenschaftliche Software unumgänglich. Einfach nutzbare Werkzeuge helfen dabei, Dokumentation und Quellcode synchron zu halten.