このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- DVC
- テクニカル ライター:
- imhardikj
- プロジェクト名:
- 「ハウツー」セクション ガイドの実装と DVC 1.0 のドキュメントの更新
- プロジェクトの期間:
- 標準の期間（3 か月）
プロジェクトの説明
このプロジェクトの目的の一つは、「ハウツー」セクションを設けて DVC に関するよくある質問に詳しく回答することです。次の目的は、最新の DVC 1.x リリースに従ってドキュメントを更新することです。以前のリリースと比較して大きな変更があるため、ドキュメントを最新バージョンに更新する必要があります。完了後、次のタスクは書き込み期間中の DVC の優先順位に基づいて決まります。
プロジェクトの目標:
1）提案した「方法」セクションの例: - 「dvc の追加」を「元に戻す」方法（間違いを元に戻す方法）。 - 不足している依存関係を既存のパイプラインに追加する方法。- データが外部ドライブに保存されている場合に DVC を使用する方法（外部データ管理ガイド）。
これらは、このセクションに含めることができる GitHub の問題（github.com/iterative/dvc.org/issues/899）に基づくアイデアの一例です。また、既存のドキュメントの一部（「Windows で DVC を実行する」など）をこのセクションに移動する必要があります。ハウツー目標がこのセクションに適していない場合は、コマンド リファレンス（または関連ドキュメント）で例を使用して更新できます。コミュニティ チャンネルでハウツー問題に遭遇した場合は、このセクションを拡張してより多くのハウツー問題を含めることができます。
2) このプロジェクトのもう一つの重要な部分は、DVC 1.0 がリリースされた後（dvc.org/blog/dvc-1-0-release）、および 9 月までにリリースされる可能性のある他の関連アップデートに従って、ドキュメントを更新することです。これらの変更に従ってドキュメント（すべてのコマンド リファレンスなど）を更新することが想定されており、その一部については、この重要な問題（github.com/iterative/dvc.org/issues/1255）に言及しています。
3）チュートリアルや Katacoda シナリオ（github.com/iterative/dvc.org/issues/670）の更新にも取り組みます。
4) ハウツー セクション、DVC 1.0 ドキュメントの更新、および Katacoda シナリオが、書き込み期間が終了する前に完了している場合、残りの作業はその期間中の DVC 優先度とその他のタスクに基づいて行われます。
作業時間:
執筆期間中は、通常の大学に入れます。これ以外の取り組みは特にありません。プロジェクトの期間全体を通して、週に 30 時間を確保できます。