Перевод не завершен. Пожалуйста, помогите перевести эту статью с английского.

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

Общее руководство по этикету

Вот некоторые общие указания при работе в сообществе Mozilla.

Вот некоторые общие указания при работе в сообществе Mozilla.

  • Будьте вежливыми! Даже при разногласиях у всех нас одна задача: улучшение Веба.
  • Просите, а не требуйте. Люди с гораздо большей вероятностью помогут и отреагируют, если вы вежливо попросите помощи, а не будете её требовать. Хотя работа над документацией важна и наше сообщество разработчиков об этом знает, люди склонны отвечать колкостями и грубостью, если обращаться к ним без должного уважения.
  • Найдите баланс между потребностью в необходимой информации и временем, которое другие люди в вашей дискуссии должны посвятить на то, чтобы вам помочь. Не настаивайте на все большем количестве деталей, если в этом прямо сейчас нет необходимости, так как это может вывести других людей из себя.
  • Имейте в виду, что ваш запрос отнимает ценное время у людей, с которыми вы контактируете, поэтому убедитесь, что вы используете их время с умом.
  • Будьте внимательны к культурным различиям. Mozilla — международная и многокультурная команда, поэтому при общении с человеком, чья культура возможно отличается от вашей, постарайтесь иметь это в виду.
  • Начинайте новый диалог вместо захвата уже существующего. Не задавайте вопросы, которые не относятся к диалогу, только потому что нужные вам люди обращают на этот диалог внимание. Хотя это удобно вам, это может раздражать людей, с которыми вы хотите поговорить и приведет итогу, далекому от идеального.
  • Избегайте Закона тривиальности. Не позволяйте вашему энтузиазму превратиться в раздражительный педантизм. Это делает диалог утомительным и расфокусированным.

Будьте тактичны

Всегда будьте тактичны и уважительны, когда общаетесь с другими.

Вежливо указывайте на ошибки

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

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

Привет, MrBigglesworth, я заметил Ваш вклад в документацию API Wormhole, Ваша помощь неоценима! Мне особенно нравится, как Вы сбалансировали свой уровень детализации с удобочитаемостью. Тем не менее, Вы могли бы сделать эти статьи еще лучше и полезнее, если бы в дальнейшем добавили правильные теги к страницам.

Подробные сведения смотри в руководстве по тегам MDN (https://developer.mozilla.org/en-US/docs/MDN/Contribute/Howto/Tag).

Еще раз спасибо, я надеюсь на Ваше сотрудничество в будущем!

Обмен знаниями

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

Способы коммуникации

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

IRC

Обращение через IRC чаще всего является наиболее простым и быстрым способом с кем-либо связаться. Для этого нужно просто найти канал, соответствующий теме вашего проекта и обратиться через него. Подробные советы по этикету для IRC вы можете найти в статье Mozilla Support "Getting Started with IRC. Для дискуссий о разработке документации, вы можете использовать канал #mdn.

Bugzilla

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

Email

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

Примечание: Как правило, если кто-то разместил свой адрес электронной почты в документах о технологии, которую вы документируете, дал вам свой адрес электронной почты лично или имеет общеизвестный электронный адрес, то электронная почта является приемлемым способом "первого контакта". Если вы достали email адрес другим методом, то вы, вероятно, должны сначала попытаться получить разрешение в IRC или списке рассылки до тех пор, пока ваши попытки не будут исчерпаны.

Инструменты статуса контента

Есть несколько полезных инструментов, которые предоставляют информацию о состоянии документов.

Панель управления ревизиями
Панель управления ревизиями документов предоставляет очень удобный инструмент для обзора изменений, внесенных в контент MDN. Вы можете видеть историю последних изменений, выбрать временной диапазон для просмотра. Вы можете использовать фильтр по языку, имени разработчика, теме и другим атрибутам. Просматривая список ревизий документов, вы можете просмотреть изменения, внесенные в каждую ревизию, быстро открыть страницу, просмотреть полную историю или даже отменить изменения (если у вас есть необходимые привилегии).
Обзор статуса документации
Страница обзора статуса документации содержит список всех областей MDN, которые были сконфигурированы для отслеживания статуса. Она содержит информацию о том, сколько страниц нуждаются в различных доработках. Выбрав конкретную тему, вы можете просмотреть подробные списки документов, которые необходимо доработать. Это могут быть страницы, которые не имеют тегов, или помечены индикаторами "необходимо выполнить определенные виды работ". Вы можете даже просмотреть списки страниц, которые не обновлялись в течение длительного времени и могут быть устаревшими, а также список ошибок, которые были отмечены как влияющие на документацию в этой области.
Планы проектов документации
Для некоторых проектов созданы планы документации, которые помогают отслеживать то, что еще необходимо сделать. К таким проектам относятся проекты на стадии планирования или большие, постоянные проекты.
MDN Taiga
Штатные сотрудники MDN используют инструмент под названием Taiga для управления текущими и будущими проектами документации. Вы также можете посмотреть чем мы занимаемся и какие проекты планируются в ближайшем будущем. Некоторые из них будут взяты на себя штатными сотрудниками, но вы также можете взяться за них, если захотите! Для получения дополнительной информации о живых технологических процессах, сопровождаемых командой MDN, смотрите нашу Страницу технологических процессов на Mozilla wiki.

Сообщество разработчиков

Членам писательского сообщества MDN важно поддерживать нормальные отношения с разработчиками. Разработчики создают программное обеспечение, которым мы пользуемся. Они владеют полезной для нас информацией. Критически важным является поддерживать с ними хорошие отношения. Чем более адекватны вы будете в общении с разработчиками, тем у вас больше шансов на то, что они ответят на ваши вопросы быстро, аккуратно и тщательно!

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

Для того, чтобы найти подходящего человека для обсуждения ваших вопросов (не забывая о сделанных выше замечаниях) можете обратиться к ресурсу module owners lists.

Сообщество писателей

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

Для получения более подробной информации, смотрите статью Join the community.

Наиболее вероятным местом, где вы могли бы напрямую пересечься с другими писателями является IRC канал #mdn. Этот канал зарезервирован специально для дискуссий о документации. По поводу особенностей IRC этикета смотрите статью из Mozilla Support "Getting Started with IRC". Вы можете дискутировать с нами также на Дискуссионном форуме MDN. Уместно заметить, что IRC, как правило, используют для быстрых, более личных бесед, а дискуссионный форум обычно используют для продолжительных бесед.

Имея ввиду Общее руководство по этикету, вы увидите, что все идет обычно очень гладко.

Смотри также

Метки документа и участники

Внесли вклад в эту страницу: bsergey, KarryPro
Обновлялась последний раз: bsergey,