Руководство наставника

Текущая фаза:
Программа «Сезон документации 2019» завершилась 6 марта 2020 г. См . график .

Это руководство для наставников открытого исходного кода — членов организаций с открытым исходным кодом, которые принимают участие в Season of Docs в качестве наставников технических писателей.

Введение

Руководство поможет вам выполнить задачи, за которые вы отвечаете, на каждом этапе «Сезона Документов».

Одна из ваших целей как наставника — обеспечить техническим писателям полезный и успешный опыт участия в Сезоне документации в этом году. Это повысит шансы на то, что технические писатели продолжат вносить свой вклад в ваш проект с открытым исходным кодом после закрытия Сезона документации в этом году, и что другие технические писатели с энтузиазмом отнесутся к работе с открытым исходным кодом.

Фаза подачи заявки на организацию

Фаза подачи заявок от организации проходит со 2 по 23 апреля 2019 г. В течение этого периода администратор вашей организации может подать заявку на участие организации в Season of Docs. Администраторы программы Google опубликовали список успешных организаций 30 апреля 2019 года.

Ваши задачи как наставника на этом этапе

Создайте список своих идей.

Совместно с администратором вашей организации создайте список идей для проекта . Список должен включать один или несколько проектов документации, которыми вы хотели бы, чтобы технический писатель занялся во время Сезона документации в этом году.

Идеи для проектов технического письма

Зарегистрируйтесь на сезон документации.

Зарегистрируйтесь на Season of Docs как можно скорее.

Регистрация на Сезон Документов 2019 закрыта.

Поговорим о сезоне «Документация».

Расскажите, что ваша организация принимает участие в «Сезоне документации»! Даже если ваша организация не попадет в окончательный список принятых организаций в этом году, то, что вы приняли участие в процессе отбора, все равно является хорошей новостью.

Рекламные материалы

Этап исследования технического писателя

Этап исследования технических писателей длится с 30 апреля по 28 мая 2019 года. В течение этого периода технические писатели изучают список участвующих организаций и проектные идеи организаций. Технические писатели могут напрямую обратиться в одну или несколько организаций для обсуждения идей проекта.

Ваши задачи как наставника на этом этапе

Обсудите идеи проекта с заинтересованными техническими писателями.

Вы можете обсудить идеи проекта с любым техническим писателем, который обращается напрямую к вашей организации, чтобы помочь техническому писателю составить хорошее проектное предложение для подачи администраторам программы Google. Идеи проекта могут быть взяты из списка идей, предложенного вашей организацией, а также из других идей, предложенных техническим писателем.

Идеи для проектов технического письма

Оценка предложений технических писателей

Этап подачи заявки на технического писателя

Этап подачи заявок на технических писателей длится с 29 мая 2019 г. по 28 июня 2019 г. В течение этого периода технические писатели подают заявки на участие в «Сезоне документации», а организации выбирают проекты, которые они хотят наставниками.

Ваши задачи как наставника на этом этапе

Оцените предложения технических писателей.

Вместе с администратором вашей организации оцените предложения технических писателей и выберите проекты технических писателей, которые ваша организация хочет курировать во время Сезона документации в этом году.

Оценка предложений технических писателей

Фаза объединения сообщества

Этап объединения сообщества длится с 7 августа по 1 сентября 2019 года. В течение этого периода наставники помогают принятым техническим писателям ознакомиться с проектом с открытым исходным кодом.

Ваши задачи как наставника на этом этапе

Познакомьте технического писателя с проектом и сообществом с открытым исходным кодом.

Познакомьте технического писателя с организацией с открытым исходным кодом и помогите техническому писателю ознакомиться с инструментами и процессами, которые вы используете.

Работа с техническим писателем

Ваши обязанности

Расскажите о своем продукте техническому писателю.

Потратьте время на объяснение продукта (особенно концептуального) и убедитесь, что технический писатель понимает аудиторию документации.

Работа с техническим писателем

Настройте каналы связи.

Поощряйте технического писателя представиться в списках рассылки сообщества, чате, канале Slack и любом другом общем канале связи. Убедитесь, что у технического писателя есть надежный способ напрямую связаться с вами.

Ваши обязанности

Установите цели и ожидания.

Работайте с техническим писателем, чтобы уточнить цели его проекта технического написания и определить ожидания обеих сторон. Цель – обеспечить успех проекта.

Ваши обязанности

Этап разработки документа

Этап разработки документации длится со 2 сентября 2019 г. по 22 ноября 2019 г. В течение этого периода технические писатели работают над своими проектами в тесном сотрудничестве со своими наставниками.

Ваши задачи как наставника на этом этапе

Консультируйте и поощряйте технического писателя.

Тесно сотрудничайте с техническим писателем, чтобы обеспечить успешное завершение проекта.

Работа с техническим писателем

Ваши обязанности

Заполните любой опрос от администраторов программы Google.

Администраторы программы Google могут разослать опрос в середине проекта, чтобы оценить прогресс. Заполните опрос и отправьте ответы администраторам программы Google, как указано в документе с опросом.

Этапы завершения проекта и оценки

Фаза завершения проекта длится с 25 ноября по 6 декабря 2019 г. (Даты для долгосрочных проектов другие.) В течение этого периода технические писатели представляют свои окончательные рабочие продукты и оценки своих наставников.

Этап оценки наставников проходит со 2 декабря 2019 г. по 6 декабря 2019 г. в 18:00 UTC. В течение этого периода наставники представляют свои оценки успеха проектов технических писателей и свой опыт работы с техническими писателями.

Ваши задачи как наставника на этом этапе

Напишите и отправьте свою оценку проекта технического письма.

Заполните и отправьте свои оценки до 28 февраля 2020 г., 18:00 UTC.

Оценка проекта технического письма

Завершилась фаза завершения проекта Season of Docs 2019.

Долгосрочные проекты

Для проектов технического написания стандартной длины в Season of Docs этап разработки документации длится со 2 сентября 2019 г. по 22 ноября 2019 г. Однако некоторые технические писатели могут подать заявку на долгосрочный проект после консультации с организацией с открытым исходным кодом. Для долгосрочного проекта этап разработки документа длится со 2 сентября 2019 г. по 21 февраля 2020 г.

Период завершения и оценки долгосрочных проектов — 24–28 февраля 2020 года. В течение этого периода технические писатели представляют свои окончательные рабочие продукты и оценки, а наставники представляют свои оценки.

Ваши задачи как наставника в долгосрочном проекте

Посоветуйтесь с техническим писателем и отправьте оценку проекта.

Ваши задачи и обязанности такие же, как описано на этой странице для проектов технического письма стандартной длины, за исключением того, что даты завершения проекта и оценки наступают позже.