Привлечение и удержание волонтеров для редактирования технической документации для проектов с открытым исходным кодом

Я добровольно работаю редактором Mozilla Developer Network (MDN), организации, которая создает бесплатное программное обеспечение с открытым исходным кодом, такое как браузер Firefox. У MDN есть большое количество технических тем, ожидающих рассмотрения , около 625 на данный момент.

Большинство тем очень короткие и хорошо написаны, поэтому они практически не требуют правок. Другие темы длинные и написаны умными людьми, которые не очень хороши в техническом письме. Очень мало тем плохо написано. Объем, темп и выбор тем для редактирования зависят от редактора. Правила стиля не являются строгими. До сих пор я не встречал интерактивных примеров, требующих тестирования.

Мне нравится редактировать, и я нахожу удовлетворение в разработке программного обеспечения с открытым исходным кодом. Это также улучшает мои навыки письма/редактирования, и я получаю технические знания. Однако не так много внешних наград, таких как получение очков репутации.

Люди, которые занимаются этим добровольно, должны в основном довольствоваться тихой работой в фоновом режиме. Есть ли у вас какие-либо предложения по привлечению и удержанию технических редакторов-единомышленников?

Публикация здесь — хорошее начало!
Старший редактор MDN предоставил следующую дополнительную информацию: Один из быстрых способов познакомиться с MDN — сделать редакционные обзоры. Многие из наших авторов не являются носителями английского языка, поэтому их контент часто нуждается в хорошем копировании и редактировании. Выполнение некоторых редакционных обзоров поможет вам ознакомиться со средой редактирования и с некоторым контентом на MDN. Вот инструкции, как это сделать: developer.mozilla.org/en-US/docs/MDN/Contribute/Howto/…
Для создания нового контента нам нужна помощь с «Областью обучения», в которой есть учебные пособия для людей, изучающих веб-разработку без предыдущего опыта программирования. Нам нужны написанные учебники и особенно упражнения или действия «активного обучения», чтобы учащиеся могли попробовать их самостоятельно, чтобы ознакомиться с конкретными концепциями. Вот обзор способов внести свой вклад в область обучения: developer.mozilla.org/en-US/Learn/How_to_contribute .
Не могли бы вы рассказать немного больше о том, что влечет за собой задача редактирования? Являются ли рецензенты/редакторы главным образом исправлением плохого английского языка или они реструктурируют разделы документации, применяя рекомендации по стилю, тестируя примеры, чтобы увидеть, работают ли они, расширяя краткую или неполную документацию и т. д.? Навыки, уровни приверженности и награды различаются в зависимости от задачи. Спасибо!
@Monica Cellio Это зависит от вас, редактор. Из-за отставания я редактирую базовую орфографию и грамматику. Когда я сталкиваюсь с темой, которую нужно переписать, я вношу базовые изменения и оставляю ее помеченной, чтобы получить больше правок. Большинство тем очень короткие и хорошо написаны, поэтому они почти не требуют правок. Другие темы длинные и написаны умными людьми, которые не очень хороши в техническом письме. Очень мало тем плохо написано. Объем, темп и выбор тем для редактирования зависят от вас. Правила стиля не являются строгими. До сих пор я не встречал интерактивных примеров, требующих тестирования.
Я провожу большую часть своего времени за ноутбуком в Firefox и Thunderbird, поэтому я ценю Mozilla, но этот вопрос больше похож на призыв к волонтерам, чем на вопрос о написании. Над созданием хорошей документации действительно стоит много работы, и она почти никогда не приносит славы. Я делаю некоторые для проекта, над которым работаю, потому что верю в него (и почти никто другой не хочет!)
Спасибо, @Джо. Мой вопрос искренний. В частности, часть об их сохранении. Я в тупике. Я ищу способ поддержать и мотивировать людей, которые добровольно участвуют в подобных проектах.

Ответы (2)

Я добровольно пишу на таких сайтах. Но я также пишу за деньги. (Моя работа на полную ставку — школьный учитель.) То, что мотивирует меня писать в разных обстоятельствах, различается. Например, когда я пишу учебные материалы, я обычно не соглашаюсь на работу меньше чем за тридцать фунтов в час. Однако писать здесь не выгодно. Я делаю это, потому что получаю удовольствие, помогая людям, и потому что, когда я пишу на темы, мои мысли о них становятся более ясными. Одна вещь, которая помогает мне оценить, как я помогаю другим людям, — это система голосования на сайте. Если людям нравятся мои ответы, они голосуют за них. Если они им не нравятся, они голосуют против них. Есть ощутимый отклик на то, что я вношу.

Я только что спросил своего сына, который предоставил огромное количество материалов для сайта покемонов, почему он это сделал. Он сказал: «Потому что я думал, что помогаю людям». Он получил награду, копию новой игры, за свой вклад, но он сделал это не ради награды. Он сделал это, потому что думал, что «может внести что-то стоящее».

Я вижу, что Mozilla просит денег или моего времени, чтобы читать о новых функциях и т. д. Я не вижу запросов на писателей. Я не вижу преимуществ для писателей. Я тот человек, который готов выполнять такую ​​работу, и все же я не знал, что в этом есть необходимость. Вам нужно сделать это более заметным.

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

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

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

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