Diese Seite enthält die Details zu einem Projekt für technisches Schreiben, das für die Google-Produktsaison von Google Docs akzeptiert wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- DVC
- Technischer Redakteur:
- Imhardikj
- Projektname:
- Leitfäden für den Abschnitt „Anleitung“ implementieren und DVC 1.0-Dokumente aktualisieren
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
Eines der Ziele dieses Projekts ist die Implementierung des Abschnitts „Anleitung“, in dem die häufigsten Fragen im Zusammenhang mit DVC ausführlich behandelt werden. Das nächste Ziel ist die Aktualisierung der Dokumentation gemäß dem neuesten DVC 1.x-Release. Im Vergleich zu den vorherigen Versionen wurden wesentliche Änderungen vorgenommen, daher müssen die Dokumente auf die neueste Version aktualisiert werden. Danach basieren die nächsten Aufgaben auf den Prioritäten von DVC während der Schreibphase.
Projektziele:
1) Einige Beispiele für den vorgeschlagenen Abschnitt „Anleitung“: – So kannst du 'dvc addieren' rückgängig machen (Fehler rückgängig machen) – 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)
Hier sind einige der Ideen, die auf dem GitHub-Problem (github.com/iterative/dvc.org/issues/899) basieren und in diesem Abschnitt behandelt werden können. Dazu gehört auch, einen Teil der vorhandenen Dokumentation, z. B. „DVC unter Windows ausführen“, in diesen Abschnitt zu verschieben. Wenn ein Anleitungsziel für diesen Abschnitt nicht geeignet ist, kann es in der Befehlsreferenz (oder der entsprechenden Dokumentation) mit einem Beispiel aktualisiert werden. Dieser Abschnitt kann erweitert werden, um weitere Anleitungsprobleme zu berücksichtigen, wenn ich sie auf Community-Kanälen finde.
2) Der andere wichtige Teil dieses Projekts besteht darin, die Dokumentation jetzt nach der Veröffentlichung von DVC 1.0 (dvc.org/blog/dvc-1-0-release) und gemäß anderen relevanten Updates zu aktualisieren, die möglicherweise bis September veröffentlicht werden. Dokumente (alle Befehlsreferenzen usw.) sollten gemäß diesen Änderungen aktualisiert werden, von denen einige in diesem epischen Problem (github.com/iterative/dvc.org/issues/1255) erwähnt werden.
3) Ich kann auch Anleitungen und Katacoda-Szenarien aktualisieren (github.com/iterative/dvc.org/issues/670).
4) Wenn der Abschnitt mit den Anleitungen, die Aktualisierung der DVC 1.0-Dokumente und die Katacoda-Szenarien vor dem Ende der Schreibzeit abgeschlossen sind, dann basiert der Rest der Arbeit auf den DVC-Prioritäten während dieser Zeit und anderen anderen Aufgaben.
Zeitaufwand:
Ich werde während der Schreibphase mein Studium absolvieren. Außer diesen habe ich keine weiteren Verpflichtungen. Ich kann während der gesamten Dauer des Projekts 30 Stunden pro Woche investieren.