このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソース組織:
- 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）このプロジェクトのもう 1 つの重要な部分は、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 時間の勤務が可能です。