Глоссарий

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

Дата приемки

Дата принятия проектов технического написания (и, следовательно, технических писателей, связанных с этими проектами) объявляется на веб-сайте Season of Docs. Смотрите полную хронологию .

Период объединения сообщества

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

Оценка

Обзор наставником работы своего технического писателя или обзор техническим писателем своего опыта работы с наставником и сообществом открытого исходного кода.

GSoC

Google Summer of Code (похожая программа, но не связанная с Season of Docs).

Список идей / идеи проекта

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

Наставник

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

Организация

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

Администратор организации

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

Администратор программы

Один из сотрудников Google, который руководит программой Season of Docs.

Проект

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

Предложение

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

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

Для проектов технического написания стандартной длины в сезоне «Документация» этап разработки документации приходится на 14 сентября 2020 г. — 30 ноября 2020 г. Однако некоторые технические писатели могут подать заявку на долгосрочный проект . Технический писатель принимает это решение после консультации с организацией с открытым исходным кодом, исходя из ожиданий от своего проекта. Для долгосрочного проекта этап разработки документа длится с 14 сентября 2020 г. по 1 марта 2021 г. Технический писатель может указать вариант для долгосрочного проекта при подаче заявки на сезон документации.

универсальное глобальное время

Всемирное координированное время

Зонтичная организация

Более крупная проектная/наставническая организация, включающая в себя несколько более мелких связанных проектов с открытым исходным кодом как часть своего сообщества. Примеры зонтичных организаций включают Apache Foundation и Python Software Foundation .