Добро пожаловать в Сезон Документов!
Содействие сотрудничеству открытого исходного кода с техническими писателями
Текущая фаза:
Программа «Сезон документации 2019» завершилась 6 марта 2020 г. См . график .
Цель Season of Docs — предоставить основу для совместной работы технических писателей и проектов с открытым исходным кодом для достижения общей цели — улучшения документации проекта с открытым исходным кодом. Для технических писателей, которые плохо знакомы с открытым исходным кодом, программа предоставляет возможность получить опыт участия в проектах с открытым исходным кодом. Для технических писателей, которые уже работают с открытым исходным кодом, программа предоставляет потенциально новый способ совместной работы. Season of Docs также дает проектам с открытым исходным кодом возможность привлечь больше сообщества технических писателей.
В ходе программы технические писатели проводят несколько месяцев в тесном сотрудничестве с сообществом разработчиков программного обеспечения с открытым исходным кодом. Они привносят свой опыт технического написания документации проекта и в то же время узнают о проекте с открытым исходным кодом и новых технологиях.
Проекты с открытым исходным кодом работают с техническими писателями для улучшения документации и процессов проекта. Вместе они могут решить создать новый набор документации, перепроектировать существующие документы или улучшить и задокументировать процедуры участия и опыт взаимодействия сообщества открытого исходного кода.
Вместе мы повышаем осведомленность общественности о документации с открытым исходным кодом, технической литературе и о том, как мы можем работать вместе на благо глобального сообщества открытого исходного кода.
Как это работает?
Вот общий рабочий процесс программы Season of Docs:
Организации с открытым исходным кодом подают заявки на роль наставников в сезоне документации в этом году. Они могут представить список идей проекта документации вместе со своими заявками.
Технические писатели изучают список участвующих организаций и выбирают проекты, которые их интересуют. Технический писатель может связаться с соответствующими организациями, чтобы обсудить их идеи. Затем технический писатель составляет проектное предложение и отправляет его в Season of Docs.
Организации подтверждают проекты технического письма, которые они хотят курировать.
Принятые технические писатели проводят несколько месяцев, работая с наставниками из организаций с открытым исходным кодом, чтобы завершить свои проекты.
В конце программы администраторы программы Google объявляют об успешно завершившихся проектах.
Временная шкала показывает подробную информацию о необходимых шагах и ключевые даты.
Участники и роли
Ниже приведены основные группы людей, которые принимают участие в Season of Docs, и роль каждой группы в программе:
Администраторы организаций — это члены участвующих организаций с открытым исходным кодом, которые выступают в качестве основного контактного лица по Season of Docs для своей организации. Администраторы организации подают заявку на участие в Season of Docs, управляют наставниками в своих организациях, следят за тем, чтобы проекты технического написания шли по графику, обрабатывают документы и управляют распределением стипендий наставников. См. руководство и обязанности администратора.
Наставниками по открытому исходному коду являются члены участвующих организаций с открытым исходным кодом, которые приняты в качестве наставников на Сезон документации в этом году. Наставники тесно сотрудничают с техническими писателями, чтобы обеспечить успех проекта. См. руководство и обязанности наставника.
Технические писатели — это технические писатели со всего мира, допущенные к участию в Сезоне документации в этом году. Кандидаты должны иметь возможность продемонстрировать предыдущий опыт технического письма, предоставив описания ролей и образцы работ. См. руководство и обязанности технического писателя.
Администраторы программ Google — это менеджеры программ внутри Google, которые руководят программой Season of Docs.
Следующие шаги
- Присоединяйтесь к списку рассылки объявлений на сайте Season-of-Docs-Announce , чтобы быть в курсе открытия заявок и других важных событий программы.
- Проверьте график на важные даты и вехи.
- Начните с регистрации в качестве участника, независимо от того, являетесь ли вы техническим писателем или участником проекта с открытым исходным кодом.
- Прочтите FAQ, если у вас есть вопросы.
- Свяжитесь с нами, если вам нужна дополнительная помощь или вы хотите присоединиться к обсуждению.