Einfache Möglichkeiten zum Vorbereiten der Dokumentation für ein Projekt: 12 Schritte

Inhaltsverzeichnis:

Einfache Möglichkeiten zum Vorbereiten der Dokumentation für ein Projekt: 12 Schritte
Einfache Möglichkeiten zum Vorbereiten der Dokumentation für ein Projekt: 12 Schritte
Anonim

Dieses wikiHow bringt dir bei, wie man Dokumentation für ein Open-Source-Projekt schreibt. Diese Dokumentation wird normalerweise als README-Datei bezeichnet. Die README ist ein Text- oder HTML-Dokument, das sowohl für Benutzer als auch für Entwickler wichtige Informationen zu Ihrem Projekt enthält.

Schritte

Dokumentation für ein Projekt vorbereiten Schritt 1

Schritt 1. Schreiben Sie den Titel für Ihr Projekt

Wenn Sie eine README-Datei für Ihr Projekt schreiben, sollten Sie als erstes den Projekttitel angeben. Neben dem Titel sollten Sie auch die neueste Versionsnummer und das Datum der letzten Aktualisierung angeben.

Dokumentation für ein Projekt vorbereiten Schritt 2

Schritt 2. Schreiben Sie eine Beschreibung Ihres Projekts

Das nächste, was Sie in Ihre README-Datei aufnehmen müssen, ist eine kurze Beschreibung Ihres Projekts. Erklären Sie, was das Projekt tut, warum es existiert und welche Probleme es löst. Sie können auch spezielle Funktionen, Screenshots, Codestile, verwendete Technologien oder Frameworks oder alles andere einbeziehen, das für Benutzer und Entwickler hilfreich wäre.

Dokumentation für ein Projekt vorbereiten Schritt 3

Schritt 3. Erklären Sie alle Anforderungen, die Ihr Projekt hat

Wenn Ihr Projekt besondere Anforderungen erfordert, damit es ordnungsgemäß ausgeführt wird, listen Sie diese Anforderungen und Anweisungen auf oder geben Sie einen Link zu Anweisungen zur Installation an.

Dokumentation für ein Projekt vorbereiten Schritt 4

Schritt 4. Fügen Sie ein Beispiel des Codes hinzu

Geben Sie ein klares und prägnantes Beispiel dafür, wofür Ihr Projekt verwendet wird. Der Code sollte für Entwickler leicht zu erkennen sein und die API sollte deutlich sichtbar sein.

Dokumentation für ein Projekt vorbereiten Schritt 5

Schritt 5. Geben Sie Installationsanweisungen an

Erklären Sie den Benutzern Schritt für Schritt, wie Sie Ihre Software zum Laufen bringen. Ihre Anweisungen sollten so klar wie möglich sein. Angenommen, Ihre Benutzer haben keine Kenntnisse in der Softwareentwicklung oder Systemadministration.

Dokumentation für ein Projekt vorbereiten Schritt 6

Schritt 6. Erklären Sie, wie Sie die Software verwenden

Sagen Sie den Leuten, wie sie das Beste aus Ihrer Software herausholen können. Stellen Sie Schritt-für-Schritt-Anleitungen zur Verwendung Ihrer Software sowie zu verschiedenen Konfigurationsoptionen und deren Einstellung bereit.

Dokumentation für ein Projekt vorbereiten Schritt 7

Schritt 7. Teilen Sie den Benutzern mit, wie sie technische Unterstützung erhalten

Bietet Links zu Mailinglisten, IRC-Kanälen oder Community-Foren, an die sich Benutzer für technische Unterstützung wenden können. Lassen Sie erfahrenere Benutzer auch wissen, wo sie Fehler und Ideen einreichen können, um das Projekt zu verbessern.

Wenn Sie feststellen, dass Sie viele der gleichen Fragen von verschiedenen Benutzern erhalten, möchten Sie möglicherweise eine FAQ (häufig gestellte Fragen) in Ihre Projektdokumentation aufnehmen

Dokumentation für ein Projekt vorbereiten Schritt 8

Schritt 8. Erklären Sie, wie Sie einen Beitrag leisten

Wenn Sie an einem Open-Source-Projekt arbeiten, teilen Sie Ihren Benutzern mit, wie sie zu Ihrem Projekt beitragen können. Erklären Sie alle Standards, die Sie haben, und geben Sie potenziellen Mitwirkenden einige Richtlinien an die Hand.

Dokumentation für ein Projekt vorbereiten Schritt 9

Schritt 9. Listen Sie die Credits auf

Geben Sie immer Kredit, wo Kredit fällig ist. Stellen Sie sicher, dass Sie die Namen aller Mitwirkenden sowie Links zu Bibliotheken oder Programmen von Drittanbietern auflisten, die Sie möglicherweise verwendet haben. Fügen Sie Links zu allen Inspirationen hinzu, die Sie möglicherweise beim Erstellen Ihres Projekts hatten.

Dokumentation für ein Projekt vorbereiten Schritt 10

Schritt 10. Geben Sie Ihre Kontaktinformationen an

Die Leute möchten Sie möglicherweise aus einer Reihe von Gründen kontaktieren. Stellen Sie sicher, dass Sie eine gültige E-Mail-Adresse angeben, über die Personen mit Ihnen Kontakt aufnehmen können.

In einigen Ländern sind möglicherweise zusätzliche Informationen, wie z. B. eine Postanschrift oder ein Firmenname, gesetzlich vorgeschrieben

Dokumentation für ein Projekt vorbereiten Schritt 11

Schritt 11. Geben Sie die Lizenzinformationen an

Für Benutzer ist es wichtig zu wissen, wie Ihr Projekt lizenziert wird. Es gibt viele Standardlizenzen im Internet, die Sie verwenden können. Erläutern Sie, welche Lizenz Ihr Projekt verwendet, sowie die Lizenzen von Bibliotheken oder Programmen von Drittanbietern, die Sie möglicherweise verwenden.

Sie müssen nicht die gesamte Lizenz in Ihren Dokumentationen erklären. Teilen Sie den Benutzern einfach mit, welche Lizenz Ihr Projekt verwendet, und geben Sie einen Link zu den vollständigen Lizenzinformationen an

Dokumentation für ein Projekt vorbereiten Schritt 12

Schritt 12. Listen Sie alle Versionen des Projekts auf

Stellen Sie sicher, dass Sie eine Liste aller früheren Versionen Ihres Projekts erstellen und eine kurze Beschreibung der Änderungen schreiben, die Sie für jede Version vorgenommen haben.

Tipps

  • Es empfiehlt sich, mit dem Schreiben Ihrer README-Datei zu beginnen, bevor Sie mit der Entwicklung Ihres Projekts beginnen. Dies wird Ihnen helfen, Ihr Projekt zu durchdenken und zu überlegen, was Sie erreichen müssen. Es wird Ihnen helfen, Richtlinien zu entwickeln, die Sie anderen Mitwirkenden mitteilen können, und Sie werden motivierter sein, Ihre README-Datei zu Beginn Ihres Projekts zu schreiben.
  • Stellen Sie sicher, dass Sie Ihre README-Datei und andere Dokumentationen regelmäßig aktualisieren, während Sie an Ihrem Projekt arbeiten.
  • Wenn Ihre README-Datei länger als eine Seite oder so ist, können Sie die längeren Abschnitte wie Installationsanweisungen, Benutzerhandbuch und FAQ als separates Dokument schreiben. Stellen Sie sicher, dass Sie ein Inhaltsverzeichnis für Ihre gesamte Projektdokumentation erstellen und einen Link zur entsprechenden Dokumentation in der README-Datei bereitstellen.

Beliebt nach Thema