Текущая фаза:
Программа «Сезон документации 2020» завершилась 15 марта 2021 г. См . график .
Администраторы организаций, принимающие участие в Season of Docs, несут определенные обязанности перед наставниками в своей организации с открытым исходным кодом, перед участниками технических писателей и перед Google.
Наставники открытого исходного кода, принимающие участие в Season of Docs, также несут ответственность перед своей организацией открытого исходного кода, участниками технических писателей и администраторами программы Google.
В этом документе описаны обязанности, которые применяются ко всем участвующим организациям с открытым исходным кодом. Отдельные организации могут иметь дополнительные роли и обязанности. Для получения дополнительной информации обратитесь к административной команде вашей организации.
Обязанности администратора организации
Это обязанности администраторов организаций с открытым исходным кодом.
Ваши обязанности перед Google
- Определить участие организации, критерии выбора организации и рабочие процедуры, специфичные для организации.
- Подайте заявку на организацию и будьте представителем организации
- Служить связующим звеном с Google
- Отвечайте на любые запросы Google в течение 36 часов.
- Сообщать о нарушениях Соглашения участника (например, притеснения, плагиат, мошенничество)
- Сообщить об отказе технического писателя
- Обеспечить соблюдение всех сроков (например, оценки наставников, счета организации)
- Выбирайте и приглашайте надежных, способных и квалифицированных наставников.
- Предоставлять и поддерживать адекватный список идей проектов и задач.
- Контролировать деятельность всех наставников и технических писателей, обеспечивая выполнение обязанностей.
Ваши обязанности перед наставниками
- Определить участие организации, требования к наставникам, процесс и процедуру отказа.
- Сообщите ожидания наставника до начала программы
- Сообщите о выборе технических писателей, продолжении участия и политике увольнения.
- Укажите критерии отбора слотов Season of Docs.
- Опишите, как будут обрабатываться нарушения и сбои Соглашения с участником.
- Постоянно оценивайте взаимодействие наставника с техническими писателями.
- Распознавайте конфликты интересов, межличностные проблемы и при необходимости заменяйте наставника.
- Сообщите наставникам, когда потребуются дополнительные задачи или идеи проекта.
- Поддерживать регулярное общение с наставниками до и во время программы.
- Обеспечить адекватный и соответствующий охват наставничества, особенно в предпраздничные дни.
Ваши обязанности перед техническими писателями
- Сообщите техническим писателям, как, когда и зачем обращаться к администратору организации.
- Обеспечить представление технических писателей и их соответствующую интеграцию
- Сообщите о требованиях, специфичных для организации (например, время, кодирование, связь, лицензирование).
- Сообщайте об ожиданиях, специфичных для организации (например, поведение, лучшие практики, видимость)
- Сообщите сроки, критерии приемки и политику отказа/увольнения.
- Отслеживайте общение и обеспечивайте устранение нежелательного поведения.
- Обеспечьте заблаговременное уведомление технических писателей, которым грозит отказ или увольнение.
Обязанности наставника
Это обязанности наставников в организациях с открытым исходным кодом.
Обязанности перед вашей организацией с открытым исходным кодом
- Сообщите о доступности и ожиданиях взаимодействия
- Как можно раньше сообщите, когда возможности наставничества будут сокращены (например, семья, здоровье, отпуск)
- Сообщите, если возникнет проблема с техническим писателем, в том числе:
- Недостаток общения, активности, видимости или прогресса
- Нарушения Соглашения участника (например, плагиат, притеснение, мошенничество)
- Плохое соответствие проекту или уход в отставку
- Официально оцените участие технических писателей.
- Прежде чем отмечать проект как неудачный, поговорите с администратором организации и техническим писателем.
Обязанности технического писателя
Вот ваши обязанности по отношению к техническому писателю, которого вы наставляете:
- Помогите и/или научите технического писателя, как
- быть частью вашего сообщества
- общаться более эффективно и открыто
- работайте с предпочтительным каналом связи вашей организации (IRC, Slack и т. д.)
- используйте систему контроля версий вашей организации
- задавать хорошие вопросы и получать ответы на свои вопросы
- предоставить убедительные технические аргументы и конструктивное обсуждение
- быть независимо мотивированным и продуктивным
- решать сложные технические проблемы
- Следите за их прогрессом, держите технического писателя в курсе их статуса.
- Регулярно общайтесь:
- Регулярно общайтесь не реже двух раз в неделю.
- Отвечайте на вопросы в течение 24 часов (иногда менее 36 часов — это нормально)
- Давайте конструктивную обратную связь, будьте терпеливы и уважительны.
- Установите реалистичные цели работы и определите ожидаемые сроки
- Переоцените объем работы с техническим писателем, если он значительно опережает или отстает от ожиданий.
- Работайте с разработчиками и сообществом, чтобы облегчить принятие работ технических писателей.
Связанная информация
- Взгляните на обязанности технического писателя .
- Прочтите руководство администратора организации и руководство наставника , чтобы получить помощь в выполнении задач, связанных с регистрацией и отчетами.