Eines der besten Dinge an der Arduino-Plattform ist, dass sie Open Source ist, das ist ein großer Teil dessen, warum sie so beliebt ist. Die Arduino-Plattform ist wahrscheinlich das am besten dokumentierte Do-It-Yourself-Projekt in der Geschichte. Sie können eine scheinbar unendliche Anzahl von Tutorials und Artikeln online finden, die jeden Schritt eines Projekts abdecken. fritz box Die Dokumentation unserer Arbeit ist wichtig, damit wir zum wachsenden Wissenspool beitragen können. Unter Dokumentation verstehe ich mehr als nur das Niederschreiben von Dingen. Ich möchte über verschiedene Tools und Ressourcen sprechen, die Sie verwenden können, um Ihre Projekte zu dokumentieren und das Gelernte an andere weiterzugeben, und zwar auf eine Weise, die sich nicht wie eine Unterbrechung Ihrer Arbeit anfühlt. Der Code, den Sie für den Arduino schreiben, muss gut dokumentiert sein.

Ich denke, das Wichtigste ist, selbstdokumentierenden Code zu schreiben. Damit meine ich Code, der Variablen und Funktionen intelligent benannt hat, so dass jemand, der den Code liest, durch einfaches Lesen des Codes selbst schließen kann, was vor sich geht. Natürlich sind Kommentare notwendig und auch sehr hilfreich, und eine gute Kommentarpraxis ist wichtig. Wenn Sie große Projekte durchführen, sollten Sie vielleicht sogar ein automatisiertes Dokumentationssystem in Betracht ziehen, wie es Doxygen schon seit sehr langer Zeit gibt. Als nächstes sollte ich das Dokumentieren von Hardware erwähnen, der einfachste Weg, dies zu tun, besteht darin, einfach Bilder und Videos Ihres Projekts zu haben, aber darüber hinaus gibt es einige Tools, die zum Dokumentieren von Hardware sehr nützlich sind, wie z. B. Fritzing.

Wenn Sie einen Schaltplan erstellen möchten, können Sie auch Software wie Fritzing verwenden, und wenn Sie Ihre eigenen Leiterplatten herstellen, ist dies definitiv der richtige Weg. Ich habe eine andere, aber sehr einfache Lösung gefunden, die ich eigentlich lieber mache, und das ist, etwas Millimeterpapier zu nehmen und die Schaltung selbst mit einem Stift zu zeichnen und sie dann als Bild in meinen Computer einzuscannen, das mag sehr klobig und alt klingen -modisch, aber ich finde es sehr effizient. Es scheint, dass, egal wie sehr Sie es versuchen, es immer ein kleines Symbol gibt, das Sie mit Software einfach nicht richtig hinbekommen, aber das ist sehr einfach, wenn Sie Stift und Papier verwenden. Ich finde es der angenehmste Teil, ein Projekt zu dokumentieren.

Wenn Sie viele Programme schreiben, möchten Sie vielleicht auch die Verwendung von Revisionskontrollsoftware in Betracht ziehen, es gibt viele außergewöhnliche Revisionskontrollsysteme, die kostenlos erhältlich sind. Wenn Sie ein einzelner Entwickler sind, werden Sie vielleicht feststellen, dass das sehr alte RCS (Revision Control System) alles hat, was Sie brauchen, und oft ist die einfachste Lösung die beste Lösung, und es wird nicht viel einfacher als RCS. Ich denke, eine bessere Idee ist es, etwas wie Git zu verwenden, das, obwohl es für große verteilte Projekte gedacht ist, genauso gut für Einzelpersonen funktioniert, wenn Sie bereit sind, die anfängliche Lernkurve zu überwinden. Git hat den großen Vorteil, dass es nahtlos mit Github zusammenarbeitet. Github ist ein äußerst beliebter Quellcode-Hosting-Service, der unbegrenzt kostenlose öffentliche Repositories und auch private Repositories gegen Gebühr anbietet. Auf diese Weise verschmelzen Ihre Tools zum Ermöglichen produktiver Arbeit mit Tools zum Teilen mit anderen.

Wenn jemand eine Kopie Ihres Codes haben möchte, geben Sie ihm einfach die URL Ihres Git-Repositorys. Sie können sich auch für SourceForge entscheiden, die ursprüngliche Hosting-Site für Open-Source-Projekte, die lange vor der Popularität von Git existierte. Wenn Sie ein Projekt abgeschlossen haben, über einen gut dokumentierten Quellcode und einen frei verfügbaren Platz zum Ablegen Ihres Quellcodes verfügen, sollten Sie Ihre andere Dokumentation, z. B. Schaltpläne, beifügen.

Es gibt noch andere Ideen, die Sie in Betracht ziehen sollten, eine davon ist, einen eigenen Blog zu starten. Das ist nicht nur eine großartige Möglichkeit für Sie, Informationen auszutauschen, sondern auch eine Möglichkeit, mit Anzeigen oder Links etwas Geld zu verdienen. Es ist unwahrscheinlich, dass Sie viel Geld verdienen, aber Ihre Arbeit scheint ein wenig angenehmer und lohnender zu sein. Andere Seiten wie Instructables oder Squidoo sind ebenfalls großartig. Erwägen Sie auch, Ihre Arbeit bei Blogs oder Social-Bookmarking-Sites wie reddit.com einzureichen