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

Текущая фаза:
Объявлены результаты, сроки .

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

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

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

  • Есть ли у вас навыки и опыт технического письма? Целью сезона «Документация» не является обучение базовым навыкам технического письма. Вы целеустремленны и организованы?
  • Есть ли у вас время принять участие в течение шести месяцев программы? Размеры проектов различаются, но варьируются от 5 до 30 часов в неделю во время программы.
  • Вы заинтересованы в получении опыта работы с открытым исходным кодом? Готовы ли вы посвятить время изучению процессов проекта и норм сообщества?
  • Готовы ли вы работать с администратором организации над уточнением предложений по проектам, разработкой сроков, оценкой и компиляцией показателей, а также помочь организации в целом понять ценность технического письма?

Вы также должны соответствовать требованиям участия в программе, включая возможность создать учетную запись Open Collective. Обратите внимание, что вы должны иметь законную возможность получать средства за работы, выполненные по месту вашего жительства. Администраторы программы Season of Docs не могут предоставить налоговые консультации или ответить на вопросы о вашем праве на работу.

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

Участие в программе «Сезон документации» в качестве технического писателя.

Этап исследования

Прием заявок от организаций закрывается 25 марта 2022 г. в 18:00 UTC. Мы рекомендуем техническим писателям как можно раньше начать изучать возможные проекты. Однако организации могут выбрать технических писателей для работы в любое время до 16 мая 2022 г., 18:00 UTC.

  • Найдите проекты, которые вас интересуют
    • Свяжитесь с организациями с открытым исходным кодом напрямую, используя инструкции на их странице программы Season of Docs, или посетите репозиторий Season of Docs GitHub , чтобы найти организации, которые выразили заинтересованность в участии в Season of Docs. Вы также можете найти заинтересованные организации на канале # Season-of-Docs в Write the Docs Slack .
    • Несколько способов выбора проекта:
      • Выберите проект на языке, который вам знаком или который вам интересен, например Javascript или C.
      • Выберите проект в интересующей вас технологии или области, например машинное обучение, открытая наука или робототехника.
      • Выбирайте проект, исходя из дружелюбия сообщества! Пообщайтесь на их дискуссионных форумах, проверьте аккаунты участников в социальных сетях (если они рассказывают там о своем проекте) и просмотрите их документацию по регистрации, если таковая имеется.
      • Если вы хотели бы поработать над проектом, которого нет в списке, свяжитесь с этим проектом и попросите рассмотреть возможность подачи заявки!
  • Просмотрите страницы предложений проектов
    • Если у вас есть 3–5 возможных проектов, просмотрите страницу предложений каждого проекта.
    • Вам следует задавать вопросы, оставлять отзывы и вносить предложения, используя каналы, указанные проектом для обратной связи и обсуждения.
  • Подайте заявление о заинтересованности непосредственно в организацию. В своем заявлении о заинтересованности вы покажете, как вы достигнете целей, изложенных в проектном предложении организации.
    • Используйте шаблон заявления о заинтересованности Season of Docs. Короче лучше!
    • Используйте инструкции на странице идей организации, чтобы подать заявление о заинтересованности. Если организация перечислила какие-либо особые требования, обязательно укажите в своем заявлении, что вы соответствуете этим требованиям.
    • Отправляя заявление о заинтересованности, вы соглашаетесь соблюдать кодекс поведения организации и кодекс поведения Season of Docs.

Фаза подачи заявки

  • Дождитесь объявления принятых организаций от Season of Docs:
    • Принятые организации свяжутся с вами напрямую, если захотят работать с вами или обсудить ваше заявление о заинтересованности в дальнейшем.
    • Организации не ограничиваются работой только с техническими писателями, которые представили заявления о заинтересованности до крайнего срока подачи заявок в организацию. После принятия они могут запросить дополнительные заявления о своих интересах. Организации должны выбрать технического писателя до 16 мая 2022 г., 18:00 UTC.
    • Организации не обязаны давать обратную связь по неудачным заявлениям о заинтересованности.

Этап разработки проекта

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

Заключительная оценка и этап тематического исследования

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