Идеи проекта

Текущая фаза:
Объявлены результаты, сроки .

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

Идея проекта: создать руководство по адаптации участников.

Проблема

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

Как мы будем измерять успех?

  • Увеличение числа новых участников
  • Увеличение числа новых участников, не связанных с кодом (за счет упрощения участия в документации или тестах)
  • Уменьшение количества вопросов, поднятых новыми участниками
  • Увеличение количества закрытых выпусков с пометкой «хороший первый выпуск»

Какие навыки понадобятся техническому писателю для работы над этим проектом?

  • Обязательно: Знакомство с GitHub (или желание работать с учебными материалами GitHub).
  • Приятно иметь: Знакомство с нашим средством запуска тестов, чтобы запускать наши тесты и обновлять документацию для этого.

Волонтёры

Поощряйте членов сообщества подписаться на помощь в решении конкретных задач, например:

  • @JaneQDev, может помочь с ответами на вопросы о наших тестах.
  • @ChenPCoder, рад рассмотреть запросы на включение документов
  • @ErichJEngineer может обсудить текущий процесс внесения вклада с техническим писателем.

Контактная информация

  • Технические писатели, заинтересованные в работе над этим проектом, должны отправить электронное письмо на адрес электронной почты @project. Пожалуйста, укажите ссылки на ваши технические письменные работы или портфолио/резюме/резюме.

Идея проекта: написать руководства по использованию нашей библиотеки с...

Проблема

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

Как мы будем измерять успех?

  • Уменьшение количества проблем с тегом «$TechnologyX».
  • Увеличение количества запросов на включение от новых участников, помогающих нам исправлять ошибки или дополнять документацию по $TechnologyX.
  • Больше ссылок на наш проект из проектов $TechnologyX

Какие навыки понадобятся техническому писателю для работы над этим проектом?

  • Приятно иметь: некоторое знакомство с $TechnologyX.

Волонтёры

Поощряйте членов сообщества подписаться на помощь в решении конкретных задач, например:

  • @JaneQDev, может помочь с ответами на вопросы о $TechnologyX.
  • @ChenPCoder, рад рассмотреть запросы на включение документов

Контактная информация

  • Технические писатели, заинтересованные в работе над этим проектом, должны отправить электронное письмо на адрес электронной почты @project. Пожалуйста, укажите ссылки на ваши технические письменные работы или портфолио/резюме/резюме.

Идея проекта: реорганизовать нашу документацию

Проблема

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

Как мы будем измерять успех?

  • Лучшее SEO для нашей документации
  • Уменьшение количества вопросов, поднимаемых по темам, затронутым в документации.
  • Увеличение количества представленной документации

Какие навыки понадобятся техническому писателю для работы над этим проектом?

  • Приятно иметь: опыт реорганизации больших и зрелых наборов документации, понимание SEO.

Волонтёры

Поощряйте членов сообщества подписаться на помощь в решении конкретных задач, например:

  • @ChenPCoder, рад рассмотреть запросы на включение документов

Контактная информация

  • Технические писатели, заинтересованные в работе над этим проектом, должны отправить электронное письмо на адрес электронной почты @project. Пожалуйста, укажите ссылки на ваши технические письменные работы или портфолио/резюме/резюме.

Идея проекта: запустить исправление документации

Проблема

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

Как мы будем измерять успех?

  • Количество закрытых вопросов, связанных с документацией
  • Увеличение количества предоставленной документации и новых участников

Какие навыки понадобятся техническому писателю для работы над этим проектом?

  • Приятно иметь: опыт исправления документации
  • Отличные организаторские способности

Волонтёры

Поощряйте членов сообщества подписаться на помощь в решении конкретных задач, например:

  • @ChenPCoder может помочь организовать видео и чат для исправления, а также помочь найти волонтеров в других часовых поясах.

Контактная информация

  • Технические писатели, заинтересованные в работе над этим проектом, должны отправить электронное письмо на адрес электронной почты@project/открыть проблему/задать вопрос на нашем форуме. Пожалуйста, укажите ссылки на ваши технические письменные работы или портфолио/резюме/резюме.

Идея проекта: провести аудит документации

Проблема

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

Как мы будем измерять успех?

  • Создание дорожной карты документации с общим одобрением сообщества.
  • Уменьшение количества устаревших или неправильных страниц документации.

Какие навыки понадобятся техническому писателю для работы над этим проектом?

  • Приятно иметь: опыт проведения аудита документации

Волонтёры

Поощряйте членов сообщества подписаться на помощь в решении конкретных задач, например:

  • @JaneQCoder может помочь скоординировать представление плана документации на собрании нашего сообщества.

Контактная информация

  • Технические писатели, заинтересованные в работе над этим проектом, должны отправить электронное письмо на адрес электронной почты@project/открыть проблему/задать вопрос на нашем форуме. Пожалуйста, укажите ссылки на ваши технические письменные работы или портфолио/резюме/резюме.