На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- ДВС
- Технический писатель:
- Имхардикдж
- Название проекта:
- Внедрение руководств раздела «Как сделать» и обновление документации DVC 1.0
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание Проекта
Одной из целей этого проекта является внедрение раздела «Как сделать», в котором подробно рассматриваются общие вопросы, связанные с DVC. Следующая цель — обновить документацию в соответствии с последней версией DVC 1.x. По сравнению с предыдущими выпусками произошли существенные изменения, поэтому документацию необходимо обновить до последней версии. После завершения следующие задачи будут основываться на приоритетах DVC в период написания.
Цели проекта:
1) Несколько примеров из предлагаемого раздела «Как сделать»: - Как «отменить» «dvc add» (Как исправить ошибки). - Как добавить недостающую зависимость в существующий конвейер. - Как использовать DVC, когда данные хранятся на внешнем диске (Руководство по управлению внешними данными).
Это некоторые идеи, основанные на проблеме Github (github.com/iterative/dvc.org/issues/899), которые можно включить в этот раздел. Это также предполагает перемещение некоторой существующей документации (например, «Запуск DVC в Windows») в этот раздел. Если практическая цель не подходит для этого раздела, ее можно дополнить в справочнике по командам (или соответствующей документации) примером. Этот раздел можно расширить, включив в него больше практических вопросов, когда я сталкиваюсь с ними на каналах сообщества.
2) Другой важной частью этого проекта является обновление документации после выхода DVC 1.0 (dvc.org/blog/dvc-1-0-release), а также другие соответствующие обновления, которые могут быть выпущены к сентябрю. Документы (все ссылки на команды и т. д.) должны обновляться в соответствии с этими изменениями, некоторые из которых упомянуты в этом эпическом выпуске (github.com/iterative/dvc.org/issues/1255).
3) Я также могу работать над обновлением руководств и сценариев Katacoda (github.com/iterative/dvc.org/issues/670).
4) Если раздел «Как сделать», обновление документации DVC 1.0 и сценарии Katacoda будут завершены до окончания периода написания, то остальная часть работы будет основываться на приоритетах DVC на это время и других различных задачах.
Обязательство по времени:
Во время написания книги у меня будет обычный колледж. У меня нет никаких других обязательств, кроме этого. Я смогу уделять 30 часов в неделю на протяжении всего проекта.