Текущая фаза:
Программа «Сезон документации 2021» завершилась 14 декабря 2021 г. См. график .
Используйте это руководство в качестве шаблона для создания проектного предложения вашей организации.
НАЗВАНИЕ ПРЕДЛОЖЕНИЯ - название организации
Название вашего предложения должно быть коротким и конкретным. «Обновить руководство для участников ORGNAME» — хорошее название предложения. «Улучшения документации» слишком расплывчаты; «Обновить разделы 5,7,23,99 Руководства для участников», «Создать часто задаваемые вопросы» и «Создать руководство по стилю» слишком длинно.
О вашей организации
В этом разделе расскажите нам о вашей организации или проекте в нескольких коротких абзацах. Какую проблему решает ваш проект? Кто ваши пользователи и участники? Как долго существует ваша организация или проект? Предоставьте некоторый контекст, который поможет нам понять, почему финансирование вашего предложения окажет положительное влияние на открытый исходный код и во всем мире.
GloriousPickle (текущая версия 1.2.3, первый выпуск в 2009 году) — это библиотека, лицензированная MIT, позволяющая легко рассчитать идеальное соотношение соли, сахара, уксуса и специй для всех возможных маринованных овощей в количествах от одного отдельного молодого огурца до контейнеровозы с редисом. Нашими участниками являются энтузиасты солений со всего мира, а нашими пользователями — домашние повара, повара ресторанов и люди, работающие в сфере логистики в крупных компаниях и организациях пищевой промышленности. Нашим крупнейшим пользователем является организация, которая помогает продовольственным банкам превращать овощи с коротким сроком хранения в стабильные банки с солеными огурцами, помогая накормить голодных людей во многих общинах и сокращая пищевые отходы. Кроме того, наши пользователи присылают нам дополнительные показатели использования GloriousPickle, которые мы используем для создания PickleSet — большого набора данных для создания новых рецептов солений с помощью машинного обучения.
О вашем проекте
Проблема вашего проекта
Расскажите нам о проблеме, которую поможет решить ваш проект. Почему для вашей организации или проекта важно решить эту проблему?
Пользователи хотят иметь возможность добавлять информацию о новых специях и других ингредиентах (особенно ингредиентах неевропейской кухни) в инструмент GloriousPickle. К сожалению, процесс добавления этой информации плохо документирован, а это означает, что потенциальным участникам приходится открывать проблему в проекте, чтобы получить помощь (или они просто сдаются). Этот процесс также предполагает, что участники уже знакомы с нашим процессом запроса на включение и с GitHub, хотя многие из наших пользователей не являются профессиональными разработчиками.
Чем больше у нас информации об ингредиентах, тем полезнее будет GloriousPickle для всех наших пользователей!
Объем вашего проекта
Расскажите нам о том, какую документацию ваша организация будет создавать, обновлять или улучшать. Если какая-то работа намеренно не выполняется, включите и эту информацию. Укажите оценку времени и укажите, определили ли вы уже волонтеров организации и технического писателя для работы с вашим проектом.
Проект GloriousPickle (под кодовым названием PicklePlus) будет:
- Проведите аудит существующей документации и создайте журнал изменений текущей документации для трех основных вариантов использования (добавление нового ингредиента, добавление варианта ингредиента и обновление или исправление информации об ингредиенте).
- Используя журнал взаимодействия в качестве руководства для понимания пробелов в документации, создайте обновленную документацию для наиболее распространенных вариантов использования.
- Создайте краткую «шпаргалку», чтобы помочь участникам, впервые работающим с запросами на включение, и GitHub, чтобы помочь им использовать наш процесс.
- Учитывайте отзывы тестировщиков документации (добровольцев проекта) и более широкого сообщества GloriousPickle.
- Работайте с командой выпуска над обновлением документации на сайте GloriousPickle и созданием процесса синхронизации документации с инструментом обновления в будущем.
Работы, выходящие за рамки данного проекта:
- Этот проект не будет создавать процесс перекрестных связей между различными написаниями или названиями одного и того же ингредиента.
- Этот проект не будет создавать никаких руководств GitHub; вместо этого в шпаргалке будут ссылки на существующие материалы, которые актуальны и полезны.
У нас есть два сильных кандидата в технические писатели для этого проекта, и, по нашим оценкам, выполнение этой работы займет три месяца. GloriousPickle PickleDocs SIG и @GloriousPicklePat (основной разработчик API добавления ингредиентов) взяли на себя обязательство поддерживать проект.
Измерение успеха вашего проекта
Как вы узнаете, что ваша новая документация помогла решить вашу проблему? Какие метрики вы будете использовать и как вы будете их отслеживать?
GloriousPickle получает в среднем десять запросов в квартал на добавление или обновление новых ингредиентов (с пометкой «ингредиент»). Большинство этих запросов на включение (>60%) исходят от предыдущих участников. Мы считаем, что эта улучшенная документация приведет к увеличению количества запросов на включение и увеличению количества запросов на включение от новых участников. Поскольку большинство наших активных участников начинали с добавления ингредиентов, мы также считаем, что улучшение этой документации приведет к увеличению числа активных участников в целом.
Мы будем отслеживать два показателя (количество запросов на включение, связанных с ингредиентами, и количество запросов на включение от новых участников) ежемесячно после публикации документации. Мы также будем отслеживать количество участников, внесших в общей сложности более трех вкладов, начиная ежеквартально после публикации документации.
Мы будем считать проект успешным, если после публикации новой документации:
- Количество запросов на включение ингредиентов, связанных с ингредиентами, увеличивается на 20 %.
- Количество пул-реквестов от новых участников увеличивается на 15 %.
- Количество участников, внесших >3 вклада, увеличивается на 10 % (начиная с квартала после публикации документации).
Бюджет проекта
Общие рекомендации
- Вы можете включить свой бюджет в свое предложение или в виде отдельной ссылки. Если ваш бюджет меньше десяти позиций, мы рекомендуем включить его в свое предложение.
- Все бюджеты должны быть в долларах США. Мы ожидаем, что гранты будут варьироваться от 5000 до 15 000 долларов США; если ваш проект выходит за пределы этого диапазона, предоставьте дополнительную информацию для обоснования вашего бюджета.
- Мы ожидаем, что большая часть вашего бюджета (минимум 60-70%) будет выделена техническому писателю, работающему над вашим проектом. Мы рекомендуем по возможности составлять бюджет для каждого проекта.
- Мы ожидаем, что проекты с открытым исходным кодом будут использовать инструменты с открытым исходным кодом, когда это возможно; Если вашему проекту абсолютно необходимы средства для приобретения лицензий на проприетарное программное обеспечение или поддержки, укажите обоснование суммы.
- Другие возможные расходы включают в себя:
- Проектная работа по созданию фирменного стиля, логотипов, шаблонов или других элементов дизайна для вашего сайта документации.
- Минимальные суммы (<200 долларов США) на сувениры проекта (футболки или наклейки для ваших участников). Если вы используете логотип Season of Docs, он должен сопровождаться логотипом или названием вашего проекта или организации. Ваш хабар не может использовать имя Google.
- Минимальные стипендии для волонтеров, которые берут на себя значительную роль наставника или руководства в проекте (мы рекомендуем не более 500 долларов США на волонтера, пожалуйста)
- Последующие пожертвования в другие проекты с открытым исходным кодом не должны превышать 10 % от общей суммы вашего бюджета.
- При необходимости включите другие статьи бюджета вместе с обоснованием запрашиваемой суммы. Обоснование расходов должно подчеркивать, каким образом расходы будут способствовать успеху проекта в целом.
Пример бюджета
| Статья бюджета | Количество | Текущая сумма | Примечания/обоснования |
|---|---|---|---|
| Технический писатель проверяет, обновляет, тестирует и публикует новую документацию по процессу добавления ингредиентов для GloriousPickle. | 5000,00 | 5000,00 | |
| Волонтерские стипендии | 500 | 6500,00 | 3 волонтерские стипендии по 500 каждая. |
| Футболки проекта (10 футболок) | 150.00 | 6650,00 | |
| Гигантский надувной единорог (15-футовая версия) | 99,99 | 6749,99 | Мы отдадим надувного единорога команде, которая быстрее всех ответит на вопросы технического писателя в период разработки проекта. |
| ОБЩИЙ | 6749,99 |
Дополнительная информация
Включите сюда любую дополнительную информацию, имеющую отношение к вашему предложению.
Предыдущий опыт работы с техническими писателями или документацией. Если вы или кто-либо из ваших наставников раньше работали с техническими писателями или разрабатывали документацию, укажите это в своем заявлении. Опишите документацию, которую вы подготовили, и способы работы с техническим писателем. Например, опишите любые процессы проверки, которые вы использовали, или то, как навыки технического писателя были полезны для вашего проекта. Объясните, как этот предыдущий опыт может помочь вам работать с техническим писателем в Google Season of Docs.
Предыдущее участие в Season of Docs, Google Summer of Code или других. Если вы или кто-либо из ваших наставников принимали участие в Google Summer of Code или аналогичной программе, укажите это в своем заявлении. Опишите свои достижения в этой программе. Объясните, как этот опыт может повлиять на вашу работу в Google Season of Docs.