Wie können Sie es anderen ermöglichen, Ihrem Code zu vertrauen und ihn zu verwenden?

Question

Ich schreibe von Zeit zu Zeit Hobby-Code. Das Problem ist, dass diese Tools, Klassen oder winzigen Code-Bibliotheken in einem Flash-Stick mit hoffnungsloser Zukunft landen! Ich würde meine Projekte gerne weiterentwickeln und andere Programmierer auf sie vertrauen lassen. Wenn Sie etwas verwenden würden, das Sie im Internet gefunden haben, worauf würden Sie bei diesem Programmiertool oder dieser kleinen Bibliothek am meisten Wert legen? z.B. wäre eine separate Dokumentation für Sie ein Muss?

---

Vielen Dank an alle Mitwirkenden. Ich werde mein Bestes tun, um das Gesagte zusammenzufassen. Sie können die Liste gerne ändern. Korrekturen und Ergänzungen sind mehr als willkommen :)

• Starten Sie einen Blog und lassen Sie andere wissen, dass Sie hier sind.

• Wählen Sie die meisten geeignete Lizenz. Möglicherweise sind Open Source-Lizenzen sind die besten für Hobby-Projekte.

• Bringen Sie Ihr Projekt dorthin, wo Menschen es erreichen können. Erwägen Sie google-code , github , sourceforge oder andere Standorte.

• Verwenden Sie die öffentliche Versionskontrolle und Bug-Tracker, so können andere den neuesten Quellcode Ihres Projekts erwerben und kompilieren und verwenden.

• Schreiben Sie eine anständige Dokumentation, neben Kommentierung des Codes natürlich natürlich. Die Dokumentation sollte den Zweck der Bibliothek erklären und zumindest einfache Beispiele enthalten.

• Schreiben Sie Tests, wenn Sie bereit sind, echten Code zur Verfügung zu stellen.

• Wenn Sie eine Bibliothek aufbauen, setzen Sie eine viel Mühe in die Entwicklung einer stabilen Schnittstelle.

Answer 1

Besorgen Sie sich einen Blog und veröffentlichen Sie dort Code. Erklären Sie, warum Sie ihn geschrieben haben und welches Problem er löst. Und ermutigen Sie andere, ihn zu verbessern, halten Sie den Code so aktuell wie möglich. Wenn Ihre Tools nützlich sind, werden Sie sehr schnell eine Anhängerschaft aufbauen, die Ihrem Code "vertraut".

Eine separate Dokumentation ist für kleine Tools kein Muss, aber alles, was in die Welt der Frameworks vordringt, sollte wahrscheinlich eine ausführliche Dokumentation und Beispiele enthalten, wenn man eine ernsthafte Akzeptanz in der breiten Community erreichen will.

Answer 2

Das Wichtigste ist, dass die Bibliothek quelloffen ist, so dass ich den Code selbst lesen kann. Wenn das nicht möglich ist, bestehe ich auf einer Dokumentation.

Erwägen Sie auch die Nutzung einer Projekt-Hosting-Website (wie Google Code oder Github).

Answer 3

1. Haben Sie eine klare Lizenz mit Ihrem Code, wenn Sie nicht bereits eine haben (vorzugsweise eine, die dazu ermutigt, Ihren Code zu verändern / zu verbessern / weiterzugeben Code ...)

2. Öffentliche Versionskontrolle und/oder einen öffentlichen Bug-/Issue-Tracker und/oder eine Mailingliste haben. Es gibt eine Menge guter Websites, die diese Dienste kostenlos anbieten.

3. Eine getrennte Dokumentation ist für mich kein entscheidender Faktor (wenn der Code gut dokumentiert und die Codequalität hoch ist).

Answer 4

• Dokumentation, in der Sie erklären, warum Sie sie geschrieben haben, wann Sie sie begonnen haben und welche Funktion sie haben soll. Wenn ich verstehe, woher du kommst, kann ich künftige Ideen erkennen und auch Mängel, die du vielleicht noch nicht gesehen hast.
• Technische Dokumentation zur Erläuterung der API und einige Beispiele für die Implementierung. Idealerweise sollten Sie Ihre Dokumentation in dem Format halten, das der Sprache folgt. In C# wird zum Beispiel die XML-Syntax für die Definition von Elementen verwendet. Auf diese Weise kann ich mich beim Lesen der Dokumentation wie zu Hause fühlen.
• Sauberer Code - Ich kann dies nicht genug betonen, denn viel zu viele Leute schreiben außergewöhnlich hässlichen Code. Wenn Ihr Code hässlich und/oder unlesbar ist, kann es für mich einfacher sein, ihn von Grund auf selbst zu schreiben. Machen Sie Ihren Code zumindest konsistent. Wenn ich den Code nicht verstehen kann, werde ich mich damit nicht wohl fühlen.
• Historische Aufzeichnungen zur Erläuterung Ihrer Änderungen. Wenn ich sehe, wie das Projekt gewachsen ist, kann ich besser planen. Außerdem können die Leute sehen, wie man aus seinen Fehlern lernt, und bekommen einen Eindruck von den eigenen Fähigkeiten. Im Vergleich zu einem Forum kann man ein Gefühl dafür bekommen, wie schnell Dinge korrigiert und in eine neue Version eingefügt werden.
• Überlegen Sie sich gut, welche Art von Lizenz Sie dort haben möchten. Public Domain? BSD? GPL? Noch restriktiver?
• Ein Hinweis darauf, ob Sie damit einverstanden sind, kontaktiert zu werden, und ob es dabei irgendwelche Einschränkungen gibt. Hätten Sie zum Beispiel etwas gegen Updates? Dass ich Ihnen Sicherheitslücken erkläre? Oder würden Sie vielleicht ein Forum oder ein Wiki benutzen?
• Die Möglichkeit für mich, Ihre neuesten Arbeiten und/oder nächtlichen Builds zu erhalten. SVN oder ähnliches. Das ist nützlich, damit ich weiß, ob ein Fehler, den ich gefunden habe, bereits behoben ist.

Answer 5

Ich denke, dass die Dokumentation ein wichtiger Punkt für Ihr Projekt ist.

Aus dem Dokument muss hervorgehen:

• Was ist der Zweck Ihrer Bibliothek?
• Was sind die wichtigsten Merkmale?
• a wirklich Kurzes Tutorial, um es in 5 Minuten zum Laufen zu bringen.
• Viele Beispiele