Auf dieser Seite finden Sie die Details zu einem Projekt für technisches Schreiben, das für Google Season of Docs angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- DVC
- Technischer Redakteur:
- imhardikj
- Projektname:
- Einrichtung eines Abschnitts mit Anleitungen und Aktualisierung der DVC 1.0-Dokumente
- Projektdauer:
- Standardlänge (3 Monate)
Projektbeschreibung
Eines der Ziele dieses Projekts besteht darin, den Abschnitt „Anleitung“ zu implementieren, in dem die häufigsten Fragen zum Thema „DVC“ ausführlich beantwortet werden. Als Nächstes wird die Dokumentation gemäß der neuesten DVC 1.x-Version aktualisiert. Es gibt erhebliche Änderungen im Vergleich zu den vorherigen Releases. Daher müssen die Dokumente auf die neueste Version aktualisiert werden. Danach richten sich die nächsten Aufgaben nach den Prioritäten des DVC während des Schreibzeitraums.
Projektziele:
1) Einige Beispiele für den vorgeschlagenen Abschnitt „Anleitung“: - Rückgängigmachen von „dvc add“: So kannst du Fehler rückgängig machen – Informationen zum Hinzufügen einer fehlenden Abhängigkeit zu einer vorhandenen Pipeline. – Verwendung von DVC, wenn die Daten auf einem externen Laufwerk gespeichert sind (Leitfaden zur externen Datenverwaltung)
Dies sind einige der Ideen, die auf dem GitHub-Problem (github.com/iterative/dvc.org/issues/899) basieren und in diesen Abschnitt aufgenommen werden können. Dazu muss auch ein Teil der vorhandenen Dokumentation (z. B. „Running DVC on Windows“) in diesen Abschnitt verschoben werden. Wenn ein Anleitungsziel für diesen Abschnitt nicht geeignet ist, kann es in der Befehlsreferenz (oder in der entsprechenden Dokumentation) mit einem Beispiel aktualisiert werden. Dieser Abschnitt kann erweitert werden, um weitere Probleme zu finden, die ich auf Community-Kanälen finden kann.
2) Der andere wichtige Teil dieses Projekts besteht darin, die Dokumentation zu aktualisieren, da DVC 1.0 veröffentlicht wurde (dvc.org/blog/dvc-1-0-release) und andere relevante Updates, die bis September veröffentlicht werden könnten. Die Dokumentation (alle Befehlsreferenzen usw.) werden entsprechend diesen Änderungen aktualisiert. Einige davon werden in diesem Epic-Problem erwähnt (github.com/iterative/dvc.org/issues/1255).
3) Ich kann auch an der Aktualisierung von Anleitungen und Katacoda-Szenarien arbeiten (github.com/iterative/dvc.org/issues/670).
4) Wenn der Abschnitt „Anleitung“, die Aktualisierung der DVC 1.0-Dokumente und die Katacoda-Szenarien vor Ende des Schreibzeitraums abgeschlossen sind, basiert der Rest der Arbeit auf den DVC-Prioritäten während dieser Zeit und anderen verschiedenen Aufgaben.
Zeitlicher Umfang:
Während der Schreibphase werde ich mein reguläres Studium fortsetzen. Ich habe keine anderen Verpflichtungen. Ich kann während der gesamten Projektdauer 30 Stunden pro Woche aufwenden.