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

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

Общий

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

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

Считается ли Season of Docs стажировкой, работой или какой-либо формой трудоустройства?

Нет. «Сезон документации» — это деятельность, которую технический писатель выполняет как независимый технический писатель, за которую ему выплачивается стипендия. Технические писатели могут отказаться от получения стипендии.

Почему мне стоит принять участие в Season of Docs?

Цель Season of Docs — способствовать сотрудничеству между организациями с открытым исходным кодом и техническими писателями. Мы считаем, что эта программа:

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

Преимущества для организаций с открытым исходным кодом:

  • Опыт работы техническим писателем.
  • Улучшенные документы.
  • Возможность продолжения сотрудничества с техническими писателями после завершения сезона «Документация».
  • Улучшены процессы документирования ваших проектов.
  • Повышение осведомленности о документации с открытым исходным кодом среди сообщества технических писателей.

Преимущества для технических писателей:

  • Опыт участия в проекте с открытым исходным кодом.
  • Опыт работы с документацией для разработчиков и кодом.
  • Благодарность и признание за проделанную работу.
  • Есть что добавить в свое резюме.
  • Потенциал продолжения сотрудничества с проектом с открытым исходным кодом после завершения сезона «Документация».
  • Повышение осведомленности в сообществах открытого исходного кода о ценности, которую могут принести технические писатели.

Какие типы проектов могут решать технические писатели?

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

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

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

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

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

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

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

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

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

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

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

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

Сезон Документов происходит полностью онлайн. В рамках программы поездка не требуется.

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

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

Что я могу сделать, чтобы распространить информацию о Season of Docs?

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

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

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

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

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

Есть ли какая-нибудь статистика о сезоне документации 2019, которой вы можете поделиться?

Да, наши результаты Season of Docs по программе 2019 года можно посмотреть здесь .

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

Да! Технические писатели и наставники успешно завершенных проектов получат футболку Season of Docs.

Когда придет моя футболка?

По нашим оценкам, вы получите свою футболку в начале 2021 года. Google наняла поставщика для производства футболок и обеспечения логистики их доставки по всему миру. Администраторы программы Google вышлют вам по электронной почте уникальный код доступа, чтобы выбрать стиль/размер вашей футболки и ввести данные о доставке вскоре после объявления долгосрочных результатов проекта. Производство и доставка футболок обычно занимает несколько недель.

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

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

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

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

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

Этап подачи заявок на участие в программе технических писателей продлится с 9 июня 2020 г. по 9 июля 2020 г. См. график программы и руководство для технических писателей .

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

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

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

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

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

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

Могу ли я подать более одного проектного предложения?

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

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

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

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

Нет, над данным проектом может работать только физическое лицо.

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

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

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

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

Сделаете ли вы для меня исключение из квалификационных требований?

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

Какие формы мне нужно будет предоставить?

Принятые участники должны будут предоставить соответствующие налоговые формы .

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

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

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

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

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

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

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

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

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

Количество времени, которое вы потратите, зависит от характера проекта, который вы согласовали со своей организацией-наставником. Требование к количеству часов намеренно является гибким, чтобы учесть разные типы проектов и разные стили работы. В среднем технические писатели затрачивают на это 20–30 часов в неделю.

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

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

Да. При подаче предложения по проекту укажите курсы вашего университета или колледжа в разделе предыдущего опыта работы.

Я принят студентом в США по визе F1. Как получить разрешение на участие?

Пожалуйста, обратитесь в отдел по делам иностранных студентов вашей школы для получения более подробной информации. Google не может предоставить вам какие-либо авторизации CPT или OPT.

Все принятые участники получат электронное письмо с подтверждением принятия. Мы не предлагаем индивидуальные письма.

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

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

Если ваш проект принят в программу, Season of Docs публикует подробную информацию о проекте на сайте.

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

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

Хотя в настоящее время это не противоречит правилам, мы настоятельно рекомендуем студентам, принятым в Google Summer of Code, не подавать заявки на вакансии технических писателей Season of Docs. Студентам следует сосредоточиться на работе Google Summer of Code, а не подавать заявку на участие в Season of Docs.

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

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

Прочтите руководство наставника и правила программы , чтобы получить дополнительную информацию о том, как стать наставником Season of Docs.

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

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

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

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

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

Получают ли организации деньги за участие в «Сезоне Документов»?

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

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

В сезоне Season of Docs 2020 года будет представлено не более 50 технических проектов.

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

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

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

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

К сожалению, мы не можем предоставить отзыв по заявке организации.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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