Zeig der Welt dein Projekt

<tl;dr>
Es gibt für Maker, Elektroniker und Programmierer kaum eine bessere Visitenkarte als ein gutes Blog voll mit eigenen Projekten. Idealerweise wird dieses Blog durch einen lebendigen Account bei github oder gitlab ergänzt.
</tl;dr>

Lies hier den übersetzten Blog-Eintrag über das Wie und Warum:

Warum du deine Projekte dokumentieren solltest

Ich schreibe dies aus dem Blickwinkel eines Makers. Wenn ich Projekt schreibe, meine ich ein Hardware-Projekt. Und wenn ich schreiben schreibe, meine ich das Verfassen von Sachtexten.

Motivation

Ich habe viel von den Arbeiten und Projekten anderer gelernt. Und vieles davon konnte ich nur lernen, weil sich diese Menschen die Mühe gemacht haben, ihre Arbeit im Internet zu dokumentieren. Unglücklicherweise nimmt sich aber ein großer Teil der Maker nicht die Zeit, ihre Projekte zu dokumentieren. Dies ist ein großer Verlust nicht nur für diese Maker selber, sondern auch für die Gemeinschaft der Maker in ihrer Gesamtheit, die ansonsten von dieser Arbeit hätten proftieren können. In diesem Text versuche ich eine Lanze für das Dokumentieren zu brechen, indem ich aufzeige, welche Vorteile es bietet und auch einen Blick auf die üblichen Hindernisse werfe. Ich biete auch gleich ein paar praktische Vorschläge, wie du direkt mit dem Dokumentieren deines Projektes anfangen kannst.

Warum du deine Projekte dokumentieren solltest

Hier die wichtigsten Gründe, die ich für deine Dokumentation sehe:

• Sie hilft anderen
• Sie vertieft dein Verständnis
• Sie öffnet Türen
• Sie ist deine beste Referenz

Lass uns einen kurzen Blick auf die obigen Punkte werfen:

Es hilft anderen

Der offensichtlichste Grund deine Arbeit zu dokumentieren ist, dass deine Dokumentation anderen hilft. Da die Maker-Gemeinschaft vom Gedanken des (Mit-)Teilens getragen wird, macht es Sinn, dass auch du deine Arbeiten samt Fehlschlägen und Erfolgen veröffentlichst.

Es vertieft dein Verständnis

Wenn du so ähnlich tickst wie ich, dann ist dein Geist ein schaffiges Hupkonzert der Ideen, in dem deine Gedanken von einem Thema zum nächsten flitzen. Wenn du versuchst, diese verschwurbelte Gedankenwolke zu Papier zu bringen, musst du das Ganze in eine sinvolle Abfolge bringen - zumindest, wenn du willst, dass andere deinen Gedanken folgen können. Tatsachen müssen auf Tatsachen in einer logischen Reihenfolge folgen, und der Prozess, diese Abfolge in ein strukturiertes Dokument zu verwandeln, vertieft dein eigenes Verständnis.

Es öffnet Türen

Jeder, der irgendeine Kunst schon länger ausübt, kann dir bestätigen, dass es nicht das einzelne Werk ist, das zählt, sondern es ist die Gesamtheit aller Arbeiten, die im Laufe der Zeit entstehen, die den Kern deines Werkes bilden. Wenn du dir die Dokumantation zur Gewohnheit machst, wirst du bald merken, dass du ein Portfolio deines Werkes erstellt hast. Dieses ist viel glaubwürdiger als eine Zusammenfassung von übertriebenen Berichten deiner tollen Leistungen. Tatsächlich ist deine Dokumentation dein wirklicher Lebenslauf. Andere Leute werden womöglich deine Arbeit bemerken, und das kann Türen öffnen. Dieser Blog (http://electronut.in) beispielsweise hat mir internationale Bekanntheit verschafft. Es hat mich mit der globalen Maker-Gemeinschaft in Kontakt gebracht, mir Gelegenheiten zur Zusammenarbeit verschafft und mir ermöglicht, mein erstes Buch zu veröffentlichen.

Es ist deine bestmögliche Visitenkarte.

Wenn du dein Projekt festhältst, ist es auch eine Art Notizbuch für dein zukünftiges Selbst. Nichts liest sich besser als deine eigenen Notizen zum Thema. Das ist auch ein guter Grund, eine saubere Dokumentation zu erstellen, damit du dich nicht in der Zukunft selbst verfluchen musst. Ich kann dir gar nicht sagen, wie oft ich meinen eigenen Blog besuche, um ein vergessenes kleines Detail aus vergangenen Projekten nachzuschlagen.

Hindernisse und Lösungen

Hier sind ein paar der üblichen Hindernisse, die dir beim Schreiben über dein eigens Projekt im Weg stehen wollen:

• Schreiben ist schwer
• Aufschieberitis
• Angst vor Kritik
• Fehlendes Fachwissen über Blogs

Lass uns diese Probleme einzeln anschauen:

Schreiben ist schwer

Hier ist mein Lieblingszitat über das Schreiben, von dem amerikanischen Journalisten Gene Fowler:

“Writing is easy: All you do is sit staring at a blank sheet of paper until drops of blood form on your forehead.”

"Schreiben ist einfach: Alles was du tun musst, ist dich hinsetzen und auf das Papier starren, bis sich Blutstropfen auf deiner Stirn bilden."

Schreiben ist schwer, aber das ist kein Grund, der dich davon abhalten soll, es einfach zu tun. Schreiben ist eine Fähigkeit, die du lernen kannst - genauso wie Auto fahren oder einen Kran steuern. Du musst damit nicht "geboren sein" - außer wenn du der nächste Shakespeare werden willst. Aber du musst dieses Handwerk regelmäßig üben. Erwarte bloß nicht, besser im Schreiben zu werden, wenn du darüber jammerst, wie schwer es ist.

Aufschieberitis

Ich höre ganz oft: "Ich werde meine Projekt aufschreiben, wenn es abgeschlossen ist". Nein, das wirst du nicht. Der einzige Weg, ein Projekt zu dokumentieren, ist parallel zur eigentlichen Arbeit. Aber wie kannst du das alles schaffen? Der Trick ist es, alles ganz einfach zu halten: Schreib in eine .txt-Datei, während du arbeitest. Ich fotografiere und filme nicht, wenn ich fertig bin, sondern tue es kontinuierlich, wohlwissend, dass ich nur die gelungenen Teile nutzen werde. (Es ist auch toll, eine visuelle Akte aller Fehlschläge und Erfolge zu haben.) Wenn du dies übst, wirst du feststellen, dass du am Ende deines Projekts magischerweise ein Gerüst deiner Dokumentation besitzt. Alles was dann noch fehlt, ist die Dinge auszuformulieren und schick dazustellen.

Angst vor Kritik

Wenn du deine Arbeit veröffentlichst, öffnest du dich natürlich für jede Art von Kritik. Unglücklicherweise macht die Anonymität des Netzes viele Menschen unfreundlicher, als sie dir von Angesicht zu Angesicht begegnen würden. Aber Kritik von einer angesehenen Persönlichkeit hat ihre Vorteile: Du brauchst nur dein Ego ablegen und zuhören. Dann kannst du dein Projekt verbessern. Meine Erfahrung mit Kritik: Die Anzahl der dankbaren Rückmeldungen ist viel geößer als die der Nörgler. Und bedenke folgendes: Du hast nicht nur etwas hergestellt, sondern dir auch die Zeit genommen, es zu dokumentieren. Ich denke, damit bist du deutlich besser als die meisten deiner Kritiker.

Fehlendes Fachwissen über Blogs

"Oh, ich habe keine Zeit/Geduld/Fachwissen, um einen Blog oder eine Webseite zu erstellen" sagst du. Unglücklicherweise ist bereits das Jahr 2015 und mit der Begründung darfst du heute nicht mehr kommen. Durch die weite Verbreitung leicht zugänglicher Blogging-Plattformen kannst du heute in weniger als 10 Minuten am Start sein. Ich werde diesen Punkt im nächsten Abschnitt genauer erläutern.

Wie du deine Projekte dokumentierst

Hoffentlich habe ich dich nun überzeugt - oder zumindest ein paar Kerben in deine Anti-Dokumentations-Rüstung gemacht - so dass du nun dein nächstes Projekt dokumentieren willst. Hier meine Angebote, wie du damit beginnen kannst:

• Beginne noch heute deinen Blog
• Der Blog ist dein Protokoll
• Strukturiere deine Dokumentation
• Lies, wie man schreibt

Lass mich das ganze ein wenig verdeutlichen:

Beginne noch heute deinen Blog

Dies ist der einfachste Weg, um dein Projekt zu dokumentieren. Starte einfach mit WordPress, Tumblr oder auch einem deutschen Blog-Anbieter. Eine weitere Option ist die maker-spezifische Blogplatform hackaday.io, wo du deine Projekte teilen und mit anderen Makern rumhängen kannst. Später kannst du dann etwas ausgeklügelteres erstellen - eine Domain registrieren, eigene Webseiten erstellen, diese mit einem eigenen Design versehen, und so weiter. Aber eins nach dem anderen - fang damit an, Wörter auf den Bildschirm zu bringen.

Der Blog ist dein Protokoll

Glaube bloß nicht, dass du ein ganz besonders tolles Projekt brauchst, um etwas darüber zu schreiben. Denke an den Blog als dein Projekt-Protokoll. So wie du Fortschritte mit deinem Projekt machst, aktualisierst du dein Blog. Du wirst dann auch merken, das dieser Arbeitsablauf dir auch mit deinem Projekt weiter hilft. Jedes nicht-triviale Hardware-Projekt hat eine Menge Unterprojekte, und wenn du jeden dieser Teilschritte als einen eigenen Blogartikel siehst, gibt dir das unmittelbar eine Menge Ziele, an denen du arbeiten kannst. Mit jedem Update kommst du deinem Ziel ein Schritt näher, angetrieben von der Zufriedenheit, die aus der Dokumentation und dem Teilen deines Projekts erwächst.

Strukturiere deine Dokumentation

"Wähle einen Stil und bleib dabei" - dieser Rat funktioniert in vielen Bereichen, auch wenn es darum geht, deine Dokumentation zu strukturieren. Bleibe bei einer konsistenten Darstellung von Titeln, Abschnitten, Überschriften, Zeichnungen, Bildern, Bildunterschriften, Verweisen, usw. Das macht nicht nur die Arbeit leichter, sondern gibt deinen Seiten ein einheitliches und professionelleres Aussehen. Dein persönlicher Stil ist nicht etwas, mit dem du beginnst, sondern etwas, dass sich im Laufe der Zeit entwickelt und verfeinert.

Lies, wie man schreibt

Schreiben ist ein Fertigkeit, und du kannst es lernen, wie jede andere Fertigkeit auch. Und wie jede Fertigkeit macht dich die Übung zum Meister. Diese zwei Bücher über das Schreiben haben mir am meisten geholfen:

On Writing Well: The Classic Guide to Writing Nonfiction by William Zinsser.
The Elements of Style by William Strunk Jr. & E. B. White.

Schlussbemerkung

Making macht Spaß, aber Dokumentieren und Teilen bringt es auf das nächste Level. Ich habe dich hoffentlich davon überzeugt, dass dieser nächste Schritt gar nicht so schwer ist. Gutes Schreiben ist gutes Schreiben, egal in welchem Medium. Du brauchst keine Bestätigung durch einen Verleger, um gute Texte zu schreiben. Also leg los und schreibe über dein aktuelles Projekt, und veröffentliche es im Netz. Damit tust du dir einen Gefallen.

"Why You Should Document Your Project" wurde am 2.August 2015 unter http://electronut.in/why-how-document-project/ veröffentlicht und dort zuletzt geändert am 3. August 2015.

Die deutsche Übersetzung stammt von Roland Härter, zuletzt geändert am 22.2.2016.