Projektdokumentation mit Git leicht gemacht

Projektdokumentationen lassen sich mit Tools vereinfachen und mit anderen teilen. Wir schauen uns dazu an, wie die Versionsverwaltungssoftware Git funktioniert.

Lesezeit: 18 Min.
In Pocket speichern
vorlesen Druckansicht Kommentare lesen

(Bild: Yuliya D‘yakova / Shutterstock.com)

Von
  • Rebecca Husemann
Inhaltsverzeichnis

"Whoa, die Statusleuchte an eurer Toilettentür ist ja mega cool, sowas wollte ich auch schon immer mal für unsere WG bauen. Hast du da eine Anleitung zu?“ Diese oder ähnliche Fragen hat vermutlich jeder Maker schon mal gehört – nur um dann in kalten Schweiß auszubrechen und betreten auf einen furchtbar interessanten Fleck an der Wand zu starren. Vor dem inneren Auge erscheint plötzlich der Wust aus Dateien mit Namen wie platine-kloampel.kicad, platine-klo2.kicad, plaklo2finalfinal.kicad und gehäuse-v1.svg bis gehäu4aaargh.svg. Bloß schnell das Thema wechseln!

Also, guter Vorsatz fürs neue Jahr: Projekte endlich mal ordentlich dokumentieren. Mit den Tools, die wir hier vorstellen, ist das sogar leichter getan als gesagt. Am Anfang steht natürlich die Frage: Wie fängt man an, zu dokumentieren? Und welches Projekt wird überhaupt gut genug, um eine Dokumentation wert zu sein? (Geschweige denn fertig genug …)

Diese Übersicht richtet sich zum einen an Personen, die ihre eigenen Projekte für sich selbst übersichtlicher halten möchten. Gleichzeitig geben wir aber auch viele Tipps, wie man Projekte so dokumentiert, dass andere sie nachbauen können. Suchen Sie sich gerne die Aspekte raus, die zu Ihrer Arbeitsweise passen. Es ist eine sehr befriedigende Erfahrung, am Ende eines Projekts einen Erfahrungbericht oder eine Schritt-für-Schritt-Anleitung online stellen zu können und zu sehen, wie andere das eigene Projekt umsetzen.

Immer mehr Wissen. Das digitale Abo für IT und Technik.

  • Zugriff auf alle Inhalte von heise+
  • exklusive Tests, Ratgeber & Hintergründe: unabhängig, kritisch fundiert
  • c't, iX, MIT Technology Review, Mac & i, Make, c't Fotografie direkt im Browser lesen
  • einmal anmelden – auf allen Geräten lesen - monatlich kündbar
  • erster Monat gratis, danach monatlich ab 9,95 €
  • Wöchentlicher Newsletter mit persönlichen Leseempfehlungen des Chefredakteurs
GRATIS-Monat beginnen Jetzt GRATIS-Monat beginnen Mehr Informationen zu heise+