本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- DVC
- 技术文档工程师：
- imhardikj
- 项目名称：
- 实现“操作方法”部分指南并更新 DVC 1.0 文档
- 项目时长：
- 标准时长（3 个月）
Project description
该项目的目标之一是实现“操作方法”部分，详细说明与 DVC 相关的常见问题。下一个目标是根据最新 DVC 1.x 版本更新文档。与之前的版本相比，该版本发生了重大变化，因此相关文档必须更新到最新版本。完成后，后续任务将根据 DVC 在写作期间的优先级。
项目目标：
1) 所提议的“操作方法”部分的一些示例如下： - 如何“撤消”“dvc add”（如何撤消错误）。 - 如何向现有流水线添加缺少的依赖项。 - 当数据存储在外部硬盘中时如何使用 DVC（外部数据管理指南）。
这些是基于 GitHub 问题 (github.com/iterative/dvc.org/issues/899) 提出的一些想法，可包含在本部分中。这还涉及将一些现有文档（例如“在 Windows 上运行 DVC”）转移到本部分。如果 HowTo 目标不适合本部分，可以在命令参考文档（或相关文档）中提供一个示例进行更新。此部分可以进行扩展，以包含我在社区频道上遇到的更多方法问题。
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 小时的时间。