本页详细介绍了 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”)移至此部分。如果某个操作方法目标不适合此部分,则可以在命令参考文档(或相关文档)中更新该目标,并添加示例。每当我在社区渠道上遇到更多操作指南问题时,都可以扩展此部分的内容。
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 文档和片库达方案场景在写作时段结束之前完成,其余工作将根据在此期间 DVC 的优先事项和其他任务确定。
承诺期:
我在写作期间有正常的大学课程。除了这个问题之外,我没有其他事务。在整个项目期间,我每周能够投入 30 个小时的时间。