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

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

На этой странице содержится руководство для технических писателей, участвующих в Season of Docs.

Введение

Добро пожаловать в Сезон Документов! Это руководство расскажет вам немного о вашем участии в Season of Docs и поможет вам с действиями, которые вам следует предпринять на каждом этапе программы.

Право на участие в Season of Docs

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

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

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

Ваши наставники по открытому коду

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

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

Объявление программы и этапы подачи заявки на организацию

Дата объявления Season of Docs — 11 марта 2019 г. Заинтересованные организации с открытым исходным кодом могут подать заявку на участие в Season of Docs в период со 2 по 23 апреля 2019 г. Администраторы программы Google публикуют список успешных организаций 30 апреля. , 2019.

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

Мы также приглашаем вас рассказать о Season of Docs и о том, почему вы заинтересованы в этой программе. Взгляните на рекламные материалы для графики и идей.

Этап исследования технического писателя

Этап исследования технических писателей проходит с 30 апреля по 28 мая 2019 года. В течение этого периода вы можете изучить список участвующих организаций и их проектные идеи.

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

Ваши задачи как технического писателя на этом этапе

Изучите список участвующих организаций с открытым исходным кодом и идеи их проектов.

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

Участвующие организации с открытым исходным кодом

Обсудите идеи проекта с организациями с открытым исходным кодом.

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

Участвующие организации с открытым исходным кодом

Идеи для проектов технического письма

Этап подачи заявки на технического писателя

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

Ваши задачи как кандидата на технического писателя на этом этапе

Подайте заявку на участие в Season of Docs.

Подайте заявку на участие в Season of Docs до 28 июня 2019 г.

Создание вашего приложения

Прием заявок на участие в технических писателях Season of Docs 2019 закрыт.

Фаза объединения сообщества

Этап взаимодействия с сообществом длится с 7 августа по 1 сентября 2019 года. В течение этого периода наставники открытого исходного кода помогут вам познакомиться с проектом с открытым исходным кодом и сообществом.

Ваши задачи как технического писателя на этом этапе

Настройте каналы связи.

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

Ваши обязанности

Обязанности ваших наставников

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

Примите участие в проекте с открытым исходным кодом и сообществе.

Задайте своему наставнику вопросы об инструментах и ​​процессах, которые использует организация с открытым исходным кодом. Представьтесь в списках рассылки сообщества открытого исходного кода, в чате, на канале Slack и на любом другом общем канале связи.

Получите представление о продукте в целом.

Попросите своего наставника объяснить продукт (особенно концептуально), который вам предстоит вскоре документировать. Подробно опишите аудиторию документации.

Установите цели и ожидания.

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

Этап разработки документа

Этап разработки документа длится со 2 сентября 2019 г. по 22 ноября 2019 г. (Дата окончания для долгосрочных проектов отличается.) В течение этого периода вы работаете над своим проектом под тщательными консультациями со своими наставниками.

Ваши задачи как технического писателя на этом этапе

Работайте со своим наставником, чтобы завершить свой проект.

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

Сообщите о любых проблемах администратору организации.

Если у вас есть какие-либо сомнения по поводу общения с вашими наставниками или вы столкнулись с какими-либо другими проблемами, которые могут повлиять на успешное завершение вашего проекта, сообщите об этом администратору организации с открытым исходным кодом.

Ваши обязанности

Заполните любой опрос от администраторов программы Google.

Администраторы программы Google могут разослать опрос в середине проекта, чтобы оценить прогресс. Заполните опрос и отправьте ответы администраторам программы Google, как указано в документе с опросом.

Этап завершения и оценки проекта

Фаза завершения проекта проходит с 25 по 29 ноября 2019 г., а фаза оценки — с 25 ноября по 6 декабря 2019 г. (Даты для долгосрочных проектов разные.) В течение периода завершения проекта вы отправляете отчет о проекте. , также называемый конечным продуктом работы. На этапе оценки вы оставляете свою оценку своему наставнику(ам) и своему опыту участия в Season of Docs.

Ваши задачи как технического писателя на этом этапе

Напишите отчет о своем проекте.

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

Создание отчета по вашему проекту

Завершилась фаза завершения проекта Season of Docs 2019.

Попросите своего наставника просмотреть отчет о вашем проекте.

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

Завершите отчет по проекту.

Завершите отчет по проекту до 28 февраля 2020 г., 18:00 UTC. Форма доступна для редактирования, но вы должны предоставить окончательную версию к указанной дате.

Завершилась фаза завершения проекта Season of Docs 2019.

Напишите и отправьте свою оценку своему наставнику и свой опыт работы в Season of Docs.

Заполните и отправьте свою оценку до 28 февраля 2020 г., 18:00 UTC.

Оценки технических писателей

Ваши обязанности

Завершилась фаза завершения проекта Season of Docs 2019.

Долгосрочные проекты

Для проектов технического написания стандартной длины в Season of Docs этап разработки документации длится со 2 сентября 2019 г. по 22 ноября 2019 г. Однако некоторые технические писатели могут подать заявку на долгосрочный проект после консультации с организацией с открытым исходным кодом. Для долгосрочного проекта этап разработки документа длится со 2 сентября 2019 г. по 21 февраля 2020 г.

Период завершения и оценки долгосрочных проектов — 24–28 февраля 2020 года.

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