Текущая фаза:
Объявлены результаты, сроки .
Это руководство предназначено для администраторов организаций, подающих заявку или участвующих в программе Season of Docs.
Стоит ли вашей организации участвовать в программе «Сезон документов»?
Используйте эти вопросы, чтобы понять, стоит ли вашему проекту или организации с открытым исходным кодом участвовать в Season of Docs.
Ваша организация или проект:
- Верите, что новая или обновленная документация поможет достичь цели или решить проблему в вашем проекте или сообществе?
- У вас есть первоначальное понимание или гипотеза о том, как вы будете измерять успех вашего проекта документации?
- Есть ли у членов сообщества желание помочь нанять, оценить и принять на работу технического писателя, а также кто будет готов ответить на вопросы и оказать другую поддержку во время проекта (6–8 месяцев, включая период подачи заявки)?
- Есть ли у члена сообщества желание выступать в качестве администратора организации и координировать создание заявки, отвечать на вопросы администраторов программы и представлять ежемесячные оценки, а также окончательную оценку и тематическое исследование? Администратор организации также должен быть готов ответить на последующие опросы после завершения программы «Сезон документов».
Ваша организация также должна соответствовать требованиям участия в программе , в том числе иметь возможность создать учетную запись Open Collective.
Процедура подачи заявления в организацию
Этап исследования
Хотя заявки на участие в сезоне «Документация» начнут поступать 23 февраля 2022 г., мы настоятельно рекомендуем организациям уделить время выполнению этапов этапа исследования, прежде чем подавать заявку.
- Создайте страницу предложения проекта. Страница предложения включает список ключевых потребностей, целей или проблем, возможные решения документации и возможные показатели. Эта страница должна быть общедоступной и позволять сообществу вносить вклад и обсуждать ее. Включите информацию для технических писателей, которые хотели бы принять участие: где им следует задать вопросы, выразить интерес или пойти узнать больше о вашем проекте? Мы предлагаем добавить адрес электронной почты, чтобы связаться с вашей организацией с открытым исходным кодом по поводу Season of Docs. Однако мы настоятельно не рекомендуем использовать личный адрес электронной почты в качестве адреса электронной почты для связи с вашей организацией с открытым исходным кодом. (Примеры см. в списке идей проекта .)
- Опубликуйте страницу своего предложения в каналах сообщества и добавьте свою организацию в список заинтересованных организаций в репозитории Season of Docs GitHub . Вы также можете поделиться своей ссылкой на канале # Season-of-Docs в Write The Docs Slack . Страница продвижения и прессы содержит логотипы и другой контент, который вы можете использовать, рассказывая о Season of Docs.
- Для каждой идеи документации подумайте, какой опыт и квалификация потребуются техническому писателю для успешной работы с вашим сообществом и организацией. Какие навыки ваше сообщество могло бы помочь развить техническому писателю (например, используя GitHub или набор инструментов вашей документации)? (См. руководство по работе с техническими писателями .
- Попросите добровольцев помочь ответить на вопросы заинтересованных технических писателей.
- Начните просматривать все представленные заявления о заинтересованности от технических писателей, заинтересованных в работе с вашим проектом.
Фаза подачи заявки
- Выберите наиболее перспективную идею на странице вашего предложения. Каждая организация может подать только одно предложение. Некоторые вещи, которые следует учитывать:
- Какая идея вызвала наибольший интерес у технических писателей?
- Какая идея поможет решить самую большую проблему вашего проекта? Лучше выбрать более рискованную идею, которая окажет большее влияние, чем идея проекта документации, которая с большей вероятностью будет реализована, но не будет иметь существенного значения для вашего проекта.
- Требует ли идея участия конкретных членов вашего сообщества? Есть ли у них время на участие?
Создайте свое предложение, используя шаблон предложения . Убедитесь, что вы понимаете и включаете:
- Проблема, которую вы хотите решить
- Объем документации, которую вы хотите улучшить или создать
- Как вы будете измерять успех вашей документации
Ваше предложение должно также включать бюджет . Неполные предложения рассматриваться не будут.
Подайте заявку до крайнего срока подачи заявок 25 марта 2022 г., 18:00 UTC. Принятые предложения будут объявлены 14 апреля 2022 года.
Разработка проекта и отчетность
Старт проекта
- Если ваша организация уже выбрала технического писателя или авторов для вашего проекта, проведите стартовую встречу с вашим техническим писателем. Вам следует сотрудничать со своим техническим писателем, чтобы составить график работы и регулярных проверок.
- Если вы получили несколько заявлений о заинтересованности от заинтересованных технических писателей, сделайте публичное объявление о своем выборе технического писателя или иным образом проинформируйте кандидатов о своем решении.
Грантовые выплаты
- Начиная с 9 июня 2022 г. Season of Docs переведет 40 % средств гранта на открытый коллективный счет каждой организации после того, как они наймут технического писателя. Мы рекомендуем организациям составить график платежей с техническими писателями на основе этапов проекта, включая оплата при запуске проекта.
- Остальные 60% будут переведены на открытые коллективные счета организаций, которые завершат и представят свои окончательные оценки и тематические исследования, начиная с 14 декабря 2022 г. Обратите внимание, что все успешные проекты, независимо от сроков завершения проектов (например, 3-месячный срок), по сравнению с 6-месячным проектом), окончательный платеж начнет поступать 14 декабря 2022 г.
- Дополнительную информацию о создании учетной записи Open Collective см. в руководстве по платежам .
Отчетность о статусе проекта
- Администраторы организации должны заполнять ежемесячные отчеты о состоянии в течение недели с момента получения ссылки на форму отчета о состоянии (ссылка будет отправлена по электронной почте, поэтому проверьте папку со спамом).
Окончательная оценка проекта и тематическое исследование
Чтобы получить оставшиеся средства гранта, организации должны завершить и представить как окончательную оценку проекта, так и тематическое исследование до 30 ноября 2022 г., 18:00 UTC.
Окончательная оценка
Окончательная форма оценки станет доступна администраторам организации не менее чем за месяц до 30 ноября 2022 года в 18:00 UTC.
Тематическое исследование
Тематическое исследование Season of Docs — это ключевой результат участия вашей организации в Season of Docs. Ведение еженедельного журнала обновлений проекта поможет вам подготовить практический пример. Каждую неделю записывайте ход проекта (включая ссылки на запросы на включение, проблемы или беседы, где это полезно), что прошло хорошо (или не очень), что вы узнали и задавали вопросы.
Пожалуйста, прочитайте «Создание тематического исследования» для получения дополнительной информации и обязательно следуйте нашему шаблону тематического исследования , чтобы создать свой практический пример. Вы отправите свой практический пример в виде ссылки в форме окончательной оценки.
Ваше тематическое исследование будет опубликовано на сайте Season of Docs, поэтому имейте это в виду, добавляя информацию о своем проекте.
Мы требуем, чтобы организации приняли участие как минимум в трех дополнительных опросах, чтобы помочь нам отслеживать успех проектов Season of Docs с течением времени.
Формы
| Форма | Связь | Крайний срок |
|---|---|---|
| Заявка на организацию | Приложения организаций закрыты. Присоединяйтесь к списку рассылки объявлений на сайте Season-of-Docs-announce , чтобы оставаться в курсе. | 25 марта 2022 г., 18:00 UTC |
| Информация об оплате организации | Эта форма еще не доступна. | 12 мая 2022 г., 18:00 UTC |
| Подтверждение найма технического писателя | Завершен этап найма технического писателя. | 16 мая 2022 г., 18:00 UTC |
| Ежемесячные оценки | Ежемесячный этап оценки завершился. | Посмотреть график |
| Окончательная оценка проекта и тематическое исследование | Этап оценки проекта завершился. | 30 ноября 2022 г., 18:00 UTC |
| Последующие опросы | Форма доступна на этапе последующих опросов (2 мая 2023 г.). | Посмотреть график |
Связанная информация
- Просмотрите хронологию сезона «Документация» .