Markdown

Markdown Dateien im Projektmanagement

Markdown wird zunehmend als Werkzeug im Projektmanagement eingesetzt, insbesondere für die Dokumentation und Zusammenarbeit innerhalb von Teams. Es ermöglicht die Erstellung klar strukturierter, versionierter und leicht verständlicher Dokumente wie Projektpläne, Arbeitspaketbeschreibungen oder Besprechungsprotokolle.

Definiert als Ggenentwurf zu Markup-Sprache nwie HTML von Jonathan Gruber (daringfireball.net)

Projektplanung und Dokumentation

• Projektdokumentation wird in Markdown-Dateien (mit der Endung .md) erstellt und im Git-Repository abgelegt. Dies gewährleistet eine zentrale, versionierte Speicherung aller Projektinformationen.
• Beispiele dafür sind Projekte wie Examibur ¹, bei denen die gesamte Dokumentation im Markdown-Format verfasst und über GitLab Pages als statische Website bereitgestellt wird.
• Dokumente wie README-Dateien auf GitHub oder GitLab werden mit Markdown formatiert, um Projekthintergrund, Installationsschritte, Nutzungshinweise und Lizenzinformationen übersichtlich darzustellen.

Integration in Projektmanagement-Tools

• GitLab wird als zentrales Projektmanagement-Tool genutzt: Jedes Arbeitspaket wird als Issue erfasst, Meilensteine als Milestones und Aufgaben mit Labels kategorisiert.
• Die Continuous Integration (CI)-Pipeline kann das Generieren von HTML-Seiten aus Markdown-Dateien automatisieren, was die Aktualität der Dokumentation sichert.

Vorteile von Markdown im Projektmanagement

• Einfache Syntax: Leicht zu lernen und zu schreiben, ohne komplexe Formatierungstools.
• Menschlich lesbar: Der Quelltext bleibt verständlich, auch ohne Rendering.
• Automatisierte Konvertierung: Markdown-Dateien lassen sich problemlos in HTML, PDF oder Word umwandeln – ideal für Abgaben oder Präsentationen.
• Kombinierbar mit Code: In Tools wie R Markdown können sowohl Text als auch Code (z. B. in R) in einem Dokument integriert werden, was besonders nützlich für datenbasierte Projekte ist.

Als Alternative zu MarkDown sei AciiDOc genannt.