Текущая фаза:
Программа «Сезон документации 2019» завершилась 6 марта 2020 г. См . график .
На этой странице содержатся советы техническим писателям о том, как заполнить ключевые части заявки на участие в Season of Docs. Эта информация поможет вам понять, какие факторы организации с открытым исходным кодом могут учитывать при выборе проектов технического написания, которые они хотят курировать во время сезона документации.
Введение
Приведенные ниже рекомендации в целом применимы к сезону «Документация». Каждая отдельная организация с открытым исходным кодом может иметь определенные критерии оценки. Вы можете связаться с любой из участвующих организаций перед подачей заявки, чтобы обсудить их требования и спланировать свое проектное предложение. См. этап исследования технического писателя, описанный в руководстве технического писателя .
Форма заявки
Форма заявки доступна в руководстве технического писателя на этапе подачи заявки на технического писателя.
После отправки формы вы можете продолжать обновлять информацию в форме до конца этапа подачи заявки на должность технического писателя (28 июня 2019 г.).
Персональная информация
В анкете запрашивается следующая личная информация:
Ваше имя: укажите свое полное имя. Season of Docs не будет передавать это имя организациям с открытым исходным кодом и не будет публиковать его на веб-сайте.
Отображаемое имя по вашему выбору. Укажите имя, которое вы хотите использовать в качестве общедоступного идентификатора во время вашего участия в Season of Docs. Мы настоятельно рекомендуем вам не использовать свое настоящее полное имя в качестве отображаемого имени. Season of Docs передаст ваше отображаемое имя организации с открытым исходным кодом, которую вы укажете в форме заявки. Season of Docs опубликует ваше отображаемое имя на веб-сайте в списке принятых проектов технического написания.
Ваш адрес электронной почты: укажите адрес электронной почты, связанный с вашей учетной записью Google. (Для участия в Season of Docs вам необходима учетная запись Google. Вы можете использовать адрес электронной почты, отличный от Gmail, с учетной записью Google. См . эту справочную статью .) Season of Docs использует ваш адрес электронной почты для связи с вами и для создания веб-сайта. доступные вам ресурсы. Season of Docs передаст этот адрес электронной почты организации с открытым исходным кодом, которую вы укажете в форме заявки. Season of Docs не будет публиковать этот адрес электронной почты на веб-сайте.
Ниже приведена краткая информация о том, как Season of Docs использует информацию из вашей формы заявки.
Информация о вашем опыте технического письма
Когда наставники и администраторы организации по открытому коду рассматривают проектное предложение, они интересуются вашим опытом технического написания. Вы можете указать подробную информацию в форме следующим образом:
Недавний опыт написания технических статей: до трех записей, в которых вы можете перечислить свои последние роли в написании технических статей или опыт работы. Если у вас есть опыт работы с документацией с открытым исходным кодом, включите его сюда. Кратко опишите свою роль, обязанности и выполненную вами работу. При необходимости вы можете указать даты.
Ссылка на ваше резюме или резюме: (Необязательно.) URL-адрес общедоступной версии вашего резюме или биографических данных (CV).
Ссылка на образцы ваших работ: (Необязательно.) URL-адрес общедоступного портфолио с образцами написания или отдельные ссылки на примеры ваших работ.
Что-нибудь еще, что вы хотели бы добавить: (Необязательно.) Любая информация, которую вы хотите добавить в это приложение. Например, ваш интерес к технической документации, почему вы хотите участвовать в Season of Docs или другой соответствующий опыт.
Проектное предложение
Ваше проектное предложение представляет собой краткое изложение работы с документацией, которую вы хотели бы выполнить во время работы с выбранной вами организацией с открытым исходным кодом во время «Сезона документации».
Вы можете подать максимум три проектных предложения. Все ваши проектные предложения должны быть в одной и той же форме заявки.
Потратьте время на разработку своего проектного предложения, принимая во внимание следующие рекомендации.
Подготовительная работа:
Изучите список участвующих организаций с открытым исходным кодом и выберите одну или несколько организаций, которые вас интересуют. Взгляните на идеи проектов, которые предложила каждая из выбранных вами организаций с открытым исходным кодом.
Если интересующая вас организация не предложила никаких идей, вы можете изучить общий список идей проекта и основывать свою идею на одной из них. Вы также можете предложить свою собственную идею, независимо от того, опубликовала ли организация идеи или нет.
Свяжитесь с одной или несколькими участвующими организациями, чтобы обсудить идеи проекта. Для связи используйте адрес электронной почты организации, указанный в списке участвующих организаций. Ранние обсуждения помогут вам составить хорошее проектное предложение.
Ваше проектное предложение в заявке:
Название организации с открытым исходным кодом. Введите название организации с открытым исходным кодом, с которой вы хотите работать во время сезона документации. Это должна быть одна из участвующих организаций, представленных на веб-сайте Season of Docs.
Название проекта с открытым исходным кодом: это название проекта с открытым исходным кодом, над которым вы хотите работать во время сезона документации. Проект должен принадлежать одной из участвующих организаций, представленных на сайте Season of Docs. Для некоторых организаций название организации и название проекта могут совпадать.
Название предлагаемого вами проекта технического письма. Укажите короткое описательное название, отражающее основную цель предлагаемой вами работы.
Подробное описание. Дайте как можно больше подробностей в описании проекта технического написания, который вы предлагаете. В поле описания можно ввести несколько абзацев. Вот несколько идей о том, что включить:
- Подробно опишите документацию, которую вы предлагаете создать/обновить. Если вы планируете обновить существующий документ или сайт, добавьте ссылку и опишите предлагаемые обновления. Если вы предлагаете новый документ или новый сайт, опишите его содержание и аудиторию.
- Скажите, почему вы предлагаете новую документацию или обновления.
- Если вы обсуждали проект с кем-то из организации с открытым исходным кодом, включите краткое изложение результатов этих обсуждений.
- Обратите внимание на язык и стиль вашего предложения. Организация с открытым исходным кодом может использовать их в качестве фактора при оценке предложения.
- Не предоставляйте ссылку на описание вашего проекта. Описание должно включать все подробные сведения о вашем проекте. Организация с открытым исходным кодом должна иметь возможность сделать выбор, основываясь на содержании формы заявки, а не на содержании, хранящемся где-то еще. Если вам нужна ссылка на другой контент, дополняющий описание, это нормально, но имейте в виду, что для выбора проекта используется только содержимое формы заявки.
Другие важные поля формы заявки
Ниже приведены рекомендации по другой ключевой информации, которую вы должны предоставить в форме заявки:
Выбор стандартного или долгосрочного проекта: стандартный период разработки документа в сезоне «Документация» составляет три месяца. Если ваш проект требует более длительного периода времени, вы должны указать это в форме заявки после консультации с выбранной вами организацией с открытым исходным кодом. См. описание долгосрочных проектов .
Получение стипендии Season of Docs: Season of Docs выплачивает денежную сумму тем техническим писателям, которые успешно завершают свои проекты, при условии, что технический писатель желает принять стипендию. См. информацию о стипендиях технических писателей . Стипендия не является обязательной. Если вы не хотите получать стипендию, укажите свой выбор в форме заявки.
Как Season of Docs использует информацию из вашей формы заявки
В этом разделе описывается, как Season of Docs использует информацию из вашей формы заявки. В предыдущих разделах этой страницы ключевые поля подробно описаны.
В таблице перечислены ключевые поля. Для каждого поля в таблице указано, будет ли Season of Docs:
- Передаёт информацию в организацию с открытым исходным кодом, которую вы указали в форме заявки.
- Публикует информацию в списке принятых проектов технического письма на веб-сайте Season of Docs.
| Информация о форме | Доступен ли вам организация с открытым исходным кодом? | Отображается на веб-сайте Season of Docs? |
|---|---|---|
| Полное имя | ||
| Отображаемое имя | ||
| Адрес электронной почты | ||
| Недавний опыт технического написания | ||
| Ссылка на резюме или резюме | ||
| Ссылка на образцы работ | ||
| Что-нибудь еще, что вы хотели бы добавить | ||
| Организация/название проекта с открытым исходным кодом | ||
| Название и описание проекта технического письма | ||
| Долгосрочный проект или проект стандартной длины | ||
| Принятие стипендии |
Расшифровка символов, используемых в приведенной выше таблице:
| Символ | Значение символа |
|---|---|
| Да | |
| Нет |
Примечания
Вот еще несколько моментов, которые следует иметь в виду:
Отправка нескольких проектных предложений. Вы можете подать более одного проектного предложения, но Season of Docs принимает только одно проектное предложение от каждого технического писателя. Вы можете подать только одну заявку. Форма позволяет подать до трех проектных предложений.
Общее количество проектов технического письма в программе: Season of Docs может принимать только определенное максимальное количество проектов технического письма. Посмотрите, как работает распределение слотов .
Связанные руководства
Ознакомьтесь с советами для наставников о том, как оценивать предложения технических писателей. Понимание критериев отбора наставников поможет вам составить предложение, которое с большей вероятностью будет успешным.
Процедурную информацию о том, когда и как подать заявку на Season of Docs, можно найти в руководстве технического писателя .