Dokumentieren¶
Damit euer Produkt sinnvoll genutzt werden kann, sind Dokumentationen sowohl für die Zielgruppen in den Daten-Wissenschaften und im Data-Engineering, als auch im System-Engineering erforderlich:
Die Zielgruppe in den Daten-Wissenschaften wollen dokumentiert sehen
welche Probleme euer Produkt löst und was die Hauptfunktionen und Limitationen der Software sind (
README
)wie das Produkt beispielhaft verwendet werden kann
welche Veränderungen in aktuelleren Software-Versionen gekommen sind (
CHANGELOG
)
Die Zielgruppe im Daten-Engineering wollen wissen, wie sie mit Fehlerbehebungen zur Verbesserung des Produkts beitragen können (
CONTRIBUTING
) und wie sie mit anderen kommunizieren (CODE_OF_CONDUCT
) könnenDie Zielgruppe im System-Engineering benötigt eine Installationsanleitung für euer Produkt und für die erforderlichen Abhängigkeiten
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