
Mein erstes Mal mit Markdown
2018 fing ich an zu programmieren. Damals schrieb ich noch Projektdokumentation in Word. Jedes Mal wenn ich zu GitLab pushte, beschwerte sich der Reviewer:
"Dein Word-Dokument kann nicht gemergt werden. Kannst du zu Markdown wechseln?"
Damals dachte ich, das wäre egal. Nach einigen schmerzhaften "was hat sich geändert?"-Meetings verstand ich endlich, warum Programmierer Markdown nutzen.
Jetzt benutze ich es seit sechs Jahren, jeden Tag.
Grund 1: Git-freundlich
Das ist DER Hauptgrund.
Stell dir vor: Drei Leute bearbeiten dasselbe Dokument.
Mit Word:
- Drei Versionen: "doc-final", "doc-final-final"
- Zusammenführen? Drei Dateien manuell vergleichen
Mit Markdown + Git:
- Drei Branches, Git zeigt Konflikte automatisch
- Nach der Lösung ist die Historie klar
Echtes Beispiel:
- "max_retries": 3
+ "max_retries": 5
Sofort klar was sich geändert hat.
Grund 2: Klartext, immer kompatibel
Ich habe noch .doc Dateien von 2005. Neues Word öffnet sie fehlerhaft.
Markdown ist nur Klartext. Jeder Editor öffnet es. In 20 Jahren funktioniert es noch.
Außerdem kleine Dateien. 5000-Wörter-Dokument: 8KB in Markdown, 200KB+ in Word.
Grund 3: Native Code-Hervorhebung
Programmierer schreiben Dokumentation mit viel Code.
```python
def hello():
print("Hallo Welt")
```
Wird farbig gerendert wie in der IDE.
In Word? Schriftart ändern, Hintergrund manuell grau... erschöpfend.
Grund 4: Plattformübergreifend
Ich schreibe auf Mac, Kollege sieht auf Windows, Server läuft Linux—Markdown funktioniert überall perfekt.
Word hat viele "funktioniert auf meinem Rechner"-Probleme.
Grund 5: Reife Werkzeuge
GitHub / GitLab: README.md, Issues, PRs, Wiki
Editoren: VS Code, JetBrains, vim
Dokumentation: Notion, Obsidian, MkDocs, Docusaurus
Echter Fall: Wie unser Team es nutzt
README
# Projektname
## Schnellstart
\`\`\`bash
npm install
npm run dev
\`\`\`
Neuer Mitarbeiter liest README, startet das Projekt.
Tech-Blog
Wir nutzen Hugo. Schreiben, git push, deployed.
API-Dokumentation
Früher Word: große Dateien, langsam, Code manuell.
Jetzt Markdown + Docusaurus: Effizienz vervielfacht.
Einschränkungen
Nicht geeignet für:
- Formelle Dokumente für Kunden
- Komplexe Layouts
- Zusammenarbeit mit Nicht-Technikern
Mein Ansatz:
- Technischer Inhalt: Markdown
- Verträge, Angebote: Word
- Konvertierung: doc2markdown.com
Tipps für Anfänger
Lerne Markdown wenn du mit Programmieren anfängst.
- Eine Stunde lernen, ganze Karriere profitieren
- GitHub, GitLab brauchen es
- README, Issues, PRs—alles nutzt es
Zusammenfassung
Hauptgründe:
- Git-freundlich: Klare Versionskontrolle
- Klartext: Immer kompatibel
- Code-Hervorhebung: Vorteil für technische Inhalte
- Plattformübergreifend: Funktioniert auf jedem Gerät
- Reife Werkzeuge: Nahtlose Integration