Часто задаваемые вопросы (FAQ)

Текущая фаза:
Разработка документации. Смотрите хронологию .

Общий

Является ли Google Season of Docs программой набора персонала?

Нет. Если вы заинтересованы в работе в Google, посетите веб-сайт Google вакансий .

Наша организация хотела бы принять участие в Google Season of Docs, но не знаем, с чего начать!

Ознакомьтесь с нашим полным списком идей для проектов ! Вы также можете обратиться к сообществу технических писателей (попробуйте

канал сезона документации в

Напишите в Docs Slack или в своих социальных сетях, чтобы попросить помощи или предложений).

Какие типы проектов могут предложить организации?

Вот несколько идей:

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

  • Прочтите документацию
  • Генератор статических сайтов, такой как Hugo , Jekyll , Sphinx и другие.
  • Страницы GitHub

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

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

• Создайте руководство для громкого сценария использования.

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

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

Возможно ли видео для Google Season of Docs?

Да. Убедитесь, что требования к видео четко определены, и помните, что создание высококачественного видео требует значительного времени и ресурсов.

Является ли аудит документации целесообразным проектом для Google Season of Docs?

Аудит документации — отличный проект для Google Season of Docs. Помните, сколько документации у вас уже есть; если у вас их много, возможно, вам придется уменьшить объем (например, просто провести аудит содержания учебника). Если у вас мало документации или она отсутствует вообще, вы можете включить в свой проект создание недостающей документации с наивысшим приоритетом.

Существуют ли шаблоны документации, которые могут использовать организации и технические писатели?

У Google Season of Docs есть репозиторий GitHub с шаблоном и контрольным списком для проведения аудита документации. Другие шаблоны будут добавляться по мере их создания.

Проект Good Docs работает над созданием минимальных жизнеспособных шаблонов документации для открытого исходного кода.

Обязаны ли организации использовать документы, подготовленные техническими писателями?

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

Где проходит сезон Google Документов?

Google Season of Docs проходит полностью онлайн. В рамках программы поездка не требуется.

Как я могу быть в курсе Google Season of Docs?

Посетите список рассылки объявлений на сайте Season-of-Docs-announce, чтобы получать последние обновления и объявления, связанные с Google Season of Docs. Присоединяйтесь к группе, чтобы получать обновления по электронной почте.

Могу ли я добавить шкалу Google Season of Docs в свой календарь?

Используйте http://goo.gle/2NeZVew, чтобы подписаться на календарь Google Season of Docs.

Что я могу сделать, чтобы распространить информацию о сезоне Google Документов?

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

Как организовать или провести информационную сессию или встречу Google Season of Docs?

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

Можете ли вы поделиться статистикой по программам 2019 и 2020 годов?

Да, наши результаты Google Season of Docs для программы 2019 года можно просмотреть в блоге Googlel с открытым исходным кодом ( 2019 , 2020 ).

Получу ли я футболку Google Season of Docs?

Нет, из-за ограничений на международную доставку Google Season of Docs больше не может предоставлять футболки участникам, успешно завершившим проект Google Season of Docs.

Что, если у меня возникнут еще вопросы?

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

Если после прочтения всей документации у вас по-прежнему нет ответа, попробуйте обсудить свои вопросы с сообществом Google Season of Docs в списке обсуждений. См. информацию о дискуссионных каналах и о том, как с нами связаться .

Как я могу стать наставником Google Season of Docs?

У Google Season of Docs нет формальной роли наставника. Организациям следует указать, как технические писатели будут приниматься на работу и поддерживаться, а также как их вклад в документацию будет проверяться и утверждаться в рамках заявки организации. Если вы заинтересованы в наставничестве технических писателей в рамках Google Season of Docs, обратитесь к администраторам вашей организации с просьбой стать волонтером.

Google Season of Docs похож на Google Summer of Code?

Нет. Google Season of Docs предназначен для людей, имеющих некоторый опыт технического письма, а не как программа наставничества, такая как Google Summer of Code.

Для технических писателей

Когда технические писатели могут подать заявку на участие в Google Season of Docs?

В Google Season of Docs нет официального приложения для технических писателей. Чтобы принять участие в Google Season of Docs в качестве технического писателя, свяжитесь напрямую с организациями с открытым исходным кодом, используя инструкции на их странице программы Google Season of Docs. Вы также можете выразить свою заинтересованность, добавив себя в каталог технических писателей Google Season of Docs . Дополнительную информацию см. в руководстве технического писателя .

Какие инструменты и системы документирования мне следует знать, чтобы принять участие в Google Season of Docs?

Инструменты и платформы документирования, которые вы будете использовать, зависят от организации, с которой вы заинтересованы в сотрудничестве. Одной из целей Google Season of Docs является то, чтобы проекты с открытым исходным кодом помогли техническим писателям узнать больше об инструментах и ​​средах, используемых в документировании продуктов с открытым исходным кодом. По этой причине обычно не требуется детальное знание конкретных платформ документации перед началом проекта Google Season of Docs.

Тем не менее, большинство организаций с открытым исходным кодом используют для своей документации тот или иной вариант Markdown или другой язык разметки. Мы рекомендуем вам узнать, какой язык использует выбранная вами организация, и ознакомиться с его синтаксисом. Markdown — хорошее начало, поскольку файлы README GitHub используют разновидность Markdown. См. руководство GitHub по Markdown .

Узнайте, размещает ли уже выбранная вами организация свою документацию на веб-сайте, и если да, то какую платформу она использует. Платформой может быть генератор статических сайтов, такой как Jekyll , Sphinx или Hugo , либо организация может размещать свои документы на страницах Read the Docs или GitHub . Выяснив, какую платформу использует организация, изучите и поэкспериментируйте с соответствующим языком и инфраструктурой. Это поможет вам быстро приступить к работе над проектом с открытым исходным кодом и даст вам возможность дать дельный совет по проекту с открытым исходным кодом по вашему выбору.

Какие языки программирования мне следует знать, чтобы участвовать в проектах Google Season of Docs?

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

Могут ли технические писатели, уже работающие над проектом с открытым исходным кодом, продолжать работать над ним в рамках Google Season of Docs?

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

Каковы квалификационные требования для участия?

• Вы должны проживать в стране, на которую не наложено эмбарго со стороны США. См. правила программы , а также программы санкций и информацию о стране от Министерства финансов США.

Нужен ли мне предварительный опыт или обучение в качестве технического писателя?

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

Будут ли мне платить за участие в Google Season of Docs?

Да. Google предоставит гранты принятым организациям для найма технических писателей.

Как выглядит хорошее заявление технического писателя?

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

Сколько времени занимает участие в Google Season of Docs?

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

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

Нет, вам следует подавать предложение только в том случае, если вы можете получить средства от имени проекта с открытым исходным кодом. Если вы заинтересованы в участии в рамках проекта, свяжитесь с проектом и совместно подготовьте заявку.

Я студент. Имею ли я право участвовать в Google Season of Docs? Научит ли меня «Сезон документов Google» стать техническим писателем?

Студенты имеют право работать с принятыми организациями, но Google Season of Docs не предназначен для обучения навыкам технического письма. Ожидается, что участвующие технические писатели будут обладать профессиональными навыками технического письма или эквивалентным соответствующим опытом. Студенты, желающие принять участие, должны обязательно указать при подаче заявки на соответствующий опыт написания и редактирования.

Могу ли я участвовать в качестве технического писателя в Google Season of Docs и в качестве студента в Google Summer of Code?

Новым участникам или студентам, принятым в Google Summer of Code, не рекомендуется подавать заявку на должность технического писателя Google Season of Docs.

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

Как технический писатель, как я могу связаться с администраторами программы Google Season of Docs, если у меня возникнут дополнительные вопросы или сомнения?

Вы можете связаться с администраторами программы Google Season of Docs, отправив им электронное письмо по адресу [e-mail] .

Может ли компания, пишущая технические статьи, или консалтинговая компания принять участие в Google Season of Docs?

Да, организация может нанять компанию для выполнения работы, указанной в ее предложении.

Как мне упомянуть Google Season of Docs в своем резюме?

Укажите ее так же, как и любую другую внештатную работу: «Работал техническим писателем в [название проекта] в рамках программы Google Season of Docs».

Предоставляете ли вы сертификаты об окончании участия в Google Season of Docs?

Google Season of Docs не может отправлять сертификаты или подтверждения участия в проекте техническим писателям.

Для администраторов организаций с открытым исходным кодом

Каковы квалификационные требования для организации с открытым исходным кодом?

Чтобы иметь право на участие в качестве организации, вы должны входить в группу, выполняющую активный проект бесплатного программного обеспечения или программного обеспечения с открытым исходным кодом, например BRL-CAD . Проект не обязательно должен быть юридически зарегистрированным юридическим лицом. Чтобы принять участие в программе, организации должны уже создать и выпустить программное обеспечение по лицензии, одобренной Open Source Initiative , и иметь как минимум двух участников, которые будут администраторами организации на протяжении всей программы Google Season of Docs.

См. также квалификационные требования, описанные в правилах программы , программах санкций и информации о стране от Казначейства США.

Эквивалентна ли «организация» проекту с открытым исходным кодом?

Организация может иметь один или несколько проектов с открытым исходным кодом. Некоторые организации, например фонды, могут иметь несколько подорганизаций, каждая из которых имеет один или несколько проектов с открытым исходным кодом. Если в вашей организации есть независимые подорганизации, подавайте отдельные заявки и предложения по каждой подорганизации.

Может ли организация подать более одной заявки на участие в конкурсе?

Нет. Подавайте только одну заявку от каждой организации. Если у вашей организации есть дочерние организации (например, ваша организация представляет собой фонд со многими отдельными проектами с открытым исходным кодом), каждый проект должен подать собственную заявку, даже если средства гранта будут обрабатываться головной организацией.

Может ли группа проектов с открытым исходным кодом подать совместное предложение для работы над одним проектом документации?

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

Как моя организация получит средства?

Для получения средств ваша организация должна иметь открытый коллективный счет.

Получают ли организации деньги за участие в Google Season of Docs?

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

Покрывает ли Google комиссию за обработку платежей?

Комиссия за обработку платежей не покрывается Google, поскольку она может различаться в зависимости от способа оплаты. Однако Google покрывает плату за платформу Open Collective, и если вы решите использовать Open Collective в качестве финансового хоста, эта плата также будет покрыта. Дополнительную информацию см. в руководстве по получению грантов .

Как моя организация должна планировать расходы на технического писателя?

Мы рекомендуем просмотреть опрос о зарплатах Write the Docs и определить почасовые ставки. Вы также можете присоединиться к Write The Docs Slack и попросить на канале # Season-of-Docs пригласить заинтересованных технических писателей принять участие в торгах.

Может ли моя организация использовать грант Google Season of Docs для оплаты труда текущего автора?

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

Может ли моя организация работать со студентами-техническими писателями?

Вы можете поручить работу над вашим проектом студентам-техническим писателям. Если вы решите работать со студентами, мы настоятельно рекомендуем вам ограничить участие студентами, которые:

• Вам больше 18 лет
• Зачислены на программу или курс технического письма или технических коммуникаций.
• Иметь очевидный доступ к наставничеству в области технического письма в рамках своей программы или курса.

Может ли моя организация работать с несколькими техническими писателями?

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

Может ли моя организация нанять компанию по написанию технических текстов для работы над нашим проектом?

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

Наш технический писатель выбыл из программы до окончания программы. Имеет ли наша организация право на получение оставшихся средств?

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

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

Может ли заявка организации быть рассмотрена до истечения крайнего срока подачи?

К сожалению, Google Season of Docs не может оставить отзыв о заявке организации.

Как организациям следует определять объем своих проектных предложений?

При разработке идей проектов старайтесь найти самые маленькие проекты, которые принесут пользу организации (но могут быть расширены, если позволяет время). Чем меньше, тем лучше. При создании проектного предложения мы рекомендуем придерживаться более мелких и более подробных проектов, а не более крупных проектов, которые менее конкретизированы. Если ваш проект требует большого опыта в предметной области, попробуйте включить проекты, над которыми мог бы работать кто-то без такого опыта.

Могу ли я участвовать в качестве администратора организации в Google Season of Docs и в качестве наставника в Google Summer of Code?

Да. Google Season of Docs и Google Summer of Code — это отдельные программы. Если у вас есть возможность участвовать в обеих программах, это нормально.

Наша организация участвовала в предыдущих программах Google Season of Docs. Может ли наша организация подать заявку еще раз?

Да, организации, принимавшие участие в предыдущих программах Google Season of Docs, имеют право подать заявку повторно.

Архивированные данные

Как удалить свою информацию из архива Google Season of Docs?

Свяжитесь с нами , чтобы удалить вашу информацию.