Dokumentieren¶
Damit euer Software-Paket sinnvoll genutzt werden kann, sind Dokumentationen erforderlich, die Beschreiben, wie eure Software installiert, betrieben, genutzt und verbessert werden kann:
Diejenigen, die euer Paket nutzen wollen, benötigen Informationen,
welche Probleme eure Software löst und was die Hauptfunktionen und Einschränkungen der Software sind (
README)wie das Software beispielhaft verwendet werden kann
welche Veränderungen in aktuelleren Software-Versionen gekommen sind (
CHANGELOG)
Diejenigen, die die Software betreiben wollen, benötigen eine Installationsanleitung für eure Software und die erforderlichen Abhängigkeiten
Diejenigen, die die Software verbessern wollen, benötigen Informationen
wie sie mit Fehlerbehebungen zur Verbesserung des Produkts beitragen können (
CONTRIBUTING)wie sie mit anderen kommunizieren (
CODE_OF_CONDUCT) können
Alle gemeinsam benötigen Informationen, wie das Produkt lizenziert ist
(LICENSE-Datei oder LICENSES-Ordner) und wie sie bei Bedarf Hilfe
erhalten können.
Siehe auch