Kapitel 9. Dokumentation
Diese Arbeit wurde mithilfe von KI übersetzt. Wir freuen uns über dein Feedback und deine Kommentare: translation-feedback@oreilly.com
Die Dokumentation ist ein oft übersehener Aspekt der Datenwissenschaft. Häufig wird sie bis zum Ende eines Projekts aufgeschoben, aber dann freut man sich auf ein neues Projekt und die Dokumentation wird übereilt oder ganz weggelassen. Wie ich in "Lesbarkeit" erläutert habe , ist die Dokumentation jedoch ein wichtiger Bestandteil, um deinen Code reproduzierbar zu machen. Wenn du willst, dass andere Leute deinen Code verwenden, oder wenn du in Zukunft auf deinen Code zurückkommen willst, braucht er eine gute Dokumentation. Es ist unmöglich, sich an alle Gedanken zu erinnern, die dir beim Schreiben des Codes oder bei der Durchführung der Experimente durch den Kopf gingen, deshalb müssen sie festgehalten werden.
Eine gute Dokumentation kommuniziert Ideen gut. Dein Leser muss verstehen, was du ihm vermitteln willst. Deshalb ist es wichtig, dass du dir zuerst überlegst, für wen du die Dokumentation schreibst. Schreibst du deine Experimente für einen anderen Datenwissenschaftler auf, der dein Projekt in Zukunft übernehmen könnte? Dokumentierst du einen Code, von dem du denkst, dass er für andere in deinem Team nützlich sein könnte? Oder hältst du deine eigenen Gedanken fest, damit du in sechs Monaten darauf zurückkommen kannst? Wähle den Detaillierungsgrad und die Sprache, die du verwendest, so, dass sie für den erwarteten Leser ...
Get Software Engineering für Datenwissenschaftler now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
