Python

Python-Code richtig dokumentieren: Docstrings, Sphinx und der Docs-as-Code-Ansatz

Softwaredokumentation ist wichtig. Bis jetzt konnten Python-Programmierer immer von gut beschriebenen öffentlichen Programmbibliotheken profitieren. Da liegt es doch auf der Hand, auch den eigenen Code so zu dokumentieren, dass er in Zukunft für einen selbst und für andere lesbar und wartbar bleibt. Bekanntlich ist der erste Schritt oft der schwierigste. Weiterlesen…

© Adobe: Sikov

Docs-as-Code – Alles unter einem Dach

Im ersten Teil dieser Artikelreihe haben wir Ihnen den Docs-as-Code-Ansatz erläutert. Im zweiten Teil zeigten wir, wie Sie durch Automatisierung weitere Build-Schritte erzeugen, die Ihnen die Dokumentation erleichtern. Dabei lag unser Fokus immer auf einem einzelnen Dokument. Die Dokumentation Ihres Teams wird hingegen aus einer Vielzahl unterschiedlicher Dokumente bestehen. Die Weiterlesen…

Docs-as-Code – Die Werkzeuge

Schlechte Dokumentation kostet Geld. In der letzten Folge unseres Artikels haben wir Ihnen den Docs-as-Code-Ansatz erklärt und das wichtigste Werkzeug näher gebracht. Bei Docs-as-Code dreht sich alles darum, dass Sie Ihre Dokumentation als reinen Text verwalten. Was machen Sie aber, wenn das nicht reicht? In dieser Folge lernen Sie docToolchain Weiterlesen…