Projektdoku für Dummies
„Mein nächstes Projekt dokumentiere ich mal ordentlich!“ Diesen guten Vorsatz hat sich sicher jeder schon mal vorgenommen. Aber wie läuft Projektdokumentation eigentlich? Wie dokumentiert man nachbausicher? Welche Tools können die Projektdokumentation vereinfachen? Wir schauen uns an, wie Projektdokumentation mit der Versionsverwaltungssoftware Git funktioniert, wie man die Wahl zwischen GitHub und GitLab trifft und wann man am meisten Nerven spart, indem man Make Projects verwendet.
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 …)