Наши рецензенты Базы Знаний являются участниками и сотрудниками Mozilla, которые имеют опыт и навыки написания вспомогательной документации. Вот несколько рекомендаций для рецензирования статей.

Рецензирование статей

Большинство изменений вносятся людьми, которые добровольно вкладывают своё время и талант. Имея дело с работой, которую предоставили людьми, предположите, что у каждого есть наилучшие намерения, и обязательно поблагодарите их за их вклад. Помните, вы можете быть первым и единственным контактом этого человека с кем-то из Mozilla. Пожалуйста, сделайте это положительным.

В Обзорной информационной панели Базы Знаний перечислены статьи в порядке посещений за последние 30 дней. В столбце «Состояние» будет показано, какие статьи нуждаются в рецензировании. Все ревизии статей, а не только самые популярные, должны быть своевременно отрецензированы. Если ревизия не может быть одобрена, её следует отложить с объяснением (см. ниже). Менеджер по контенту Базы знаний SUMO несёт ответственность за обеспечение своевременного рецензирования.

Список Неотрецензированные изменения — это альтернативный способ увидеть, какие статьи нуждаются в рецензировании, а также какие ревизии ожидали рецензии в течение самого длительного периода времени. (Вы можете отсортировать список «Все продукты» по «Самым последним» или выбрать конкретный продукт из выпадающего списка.)

Топ статей

Наши лучшие статьи с более 100 000 посещений в месяц (из которых около 20 статей для настольных компьютеров) составляют около 50-55% всех посещений Базы знаний. Наши лучшие статьи для Android — это статьи с более чем 5000 посещений в месяц.

Очень важно, чтобы в этих статьях была самая свежая информация.

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

• Для больших изменений — не одобряйте собственную ревизию, если это большое изменение. Пожалуйста, следуйте приведённым ниже правилам утверждения статей. При необходимости начните обсуждение в ветке обсуждения статьи.

Другие статьи

Статьи с менее чем 100 000 посещений в месяц для настольных компьютеров (или с менее чем 5000 посещений для Android) представляют собой подавляющее большинство нашей Базы знаний (около 600+ статей; 45-50% посещений). Они охватывают менее распространенные проблемы и новые продукты. Пожалуйста, следуйте приведённым ниже правилам утверждения статей.

Новые статьи

Когда мы впервые создаём статью, у неё вообще нет посещений. Так как вы относитесь к этому?

• Если статья создаётся для специального назначения (выпуск для Firefox, для ссылки из продукта или из mozilla.org) или является готовым ответом, относитесь к ней как к одной из лучших статей.
• Если у нас нет никаких оснований полагать, что статья сразу станет очень популярной, относитесь к ней, как к другим статьям с менее чем 100,000 посещений в месяц для ПК версии или 5,000 посещений в месяц для Android. Если ревизия является улучшением, утвердите её. Это нормально, если статья не завершена на 100%. Если это не одна из лучших статей, она может начать собирать отзывы, когда над ней ведутся работы.
• После того, как новая статья была одобрена, но была опубликована менее месяца, рассмотрите возможность просмотра 7 дней.

Специальные статьи

• Шаблоны содержат контент, используемый в нескольких статьях, и должны рассматриваться как лучшие статьи. Все шаблоны, в том числе те, которые нуждаются в рецензировании, перечислены здесь. Дополнительные рекомендации см. в статье Как использовать шаблоны.
• Готовые ответы на форуме поддержки гораздо важнее, чем можно предположить по количеству просмотров. Рассматривайте новые ответы на форуме или что-либо большее, чем незначительное исправление или уточнение, как большое изменение. Все ответы на форуме, включая те, которые нуждаются в рецензировании, перечислены на этой странице. Дополнительные рекомендации см. в статье Создание или улучшение общих ответов на форуме.

Правила рецензирования и утверждения статей

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

Каждый раз, когда в контент Базы знаний вносится ревизия, она должна пройти как минимум один раунд рецензирования. Это рецензирование может проводиться либо сотрудником, либо другим участником, в зависимости от конкретного продукта. Даже контент, созданный нашими сотрудниками, должен проходить этот процесс рецензирования, хотя само утверждение для сотрудников может происходить за пределами SUMO.

Для дальнейшего разъяснения мы предоставили ниже информацию о том, какие продукты требуют исключительно утверждения сотрудниками, а какие могут быть утверждены другими участниками.

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

Правила рецензирования контента

Все внутренние сотрудники обязаны предоставлять свой контент на en-US для рецензирования как минимум одной другой стороне. Примерами рецензентов контента могут быть менеджеры по поддержке продуктов, менеджеры по продуктам, юристы, маркетологи, PR-специалисты или участники сообщества.

Рецензирование контента может происходить в SUMO или в Google Doc. Если ваш контент прошёл рецензирование за пределами SUMO, просто добавьте примечание в свою ревизию на SUMO, упомянув команду или лиц, которые его одобрили. См. пример ниже.

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

Последние ревизии для en-US и Неотрецензированные изменения будут рецензироваться сотрудниками и участниками не реже трёх раз в неделю. Ожидающие ревизии должны быть утверждены или отложены без необходимости обращения. Если нет критической причины для немедленного утверждения, должно пройти разумное количество времени (семь дней или более), прежде чем редактор свяжется с сотрудником или другим рецензентом, если утверждение сотрудником не требуется.

Могут быть исключения, когда определённый контент требует рецензирования и утверждения сотрудниками. В таких ситуациях автор укажет в примечаниях к ревизии «Требуется рецензирование сотрудником». Если вы предложите ревизию к одной из таких статей, обязательно отметьте её для внимания штатного автора (через личное сообщение на SUMO или в Slack), чтобы он мог провести необходимое рецензирование и утверждение.

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

Матрица требований к рецензированию

* Если автор не указал в примечаниях к ревизии «Требуется утверждение сотрудником».

Статьи с особыми требованиями

Продукты по подписке/премиум-продукты

Пожалуйста, не утверждайте самостоятельно свои ревизии и не утверждайте ревизии других участников (только для en-US). Это относится к Готовым ответам и Шаблонам для продуктов по подписке/премиум-продуктов. Если вы предлагаете ревизию, пожалуйста, отметьте её для утверждения штатным автором (через личное сообщение на SUMO, Matrix или Slack).

Работая вместе и обеспечивая участие штатных авторов в процессе утверждения контента для премиум-продуктов, мы можем продолжать делать наш контент наилучшим для наших клиентов.

Матрица требований к рецензированию

Соблюдение правил рецензирования

Создание последовательного, точного и актуального контента важно, но это не единственный шаг в процессе. Чтобы наш контент со временем сохранял своё качество, нам нужно, чтобы все участники понимали и следовали процессам рецензирования и утверждения. Наши сотрудники будут следить за тем, насколько хорошо мы следуем новым правилам, чтобы всё шло по плану.

Чтобы сохранить права рецензента Базы знаний:

• Соблюдайте вышеуказанные правила рецензирования.
• Соблюдайте Правила участия в сообществе.
• Рецензируйте не менее трёх (3) ревизий статей в месяц.

Ваши права рецензента Базы знаний могут быть отозваны, если вы самостоятельно утверждаете контент на en-US или если вы не рецензируете ни одной ревизии статей в течение 60 дней или дольше. Сотрудники свяжутся с рецензентами, чтобы выяснить, есть ли уважительные причины для несоблюдения правил, прежде чем будут предприняты какие-либо действия по отзыву прав рецензента. Применяя этот подход, мы поощряем командную работу, обеспечиваем наилучший возможный контент и создаём среду, в которой опыт каждого способствует нашему успеху.

Что такое обновление существующего содержимого?

Самая распространённая задача в Базе знаний — поддерживать статьи в актуальном состоянии. Как правило, это включает в себя:

• Правописание и грамматические исправления
• Упрощение существующего языка, удаление жаргона
• Обновление или добавление скриншотов
• Обновление или добавление скринкастов
• Удаление содержимого для версий Firefox, которые мы больше не поддерживаем
• Обновление пошаговых инструкций для поддержки новых версий Firefox
• Обновление существующего текста для поддержки изменений в новых версиях Firefox
• Исправление проблем с вики-разметкой
• Исправление ссылок
• Обновление ключевых слов
• Добавление или обновление результатов поиска

Что такое большое изменение?

Большие изменения - изменения, которые фундаментально изменяют существующую статью. Они включают:

• Добавление нового раздела
• Удаление существующего раздела
• Обширное переписывание (больше, чем упрощение и удаление жаргона)
• Перезапись заголовков разделов
• Изменение порядка разделов
• Изменение объема статьи

Уровни ревизий

Когда вы утверждаете статью, у вас есть три различных уровня редакции:

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

Обратная связь для редакторов

При утверждении статьи важно поблагодарить редакторов за их вклад. Также хорошо, если вы можете дать им обратную связь. Их написание статей улучшилось? Они сделали особенно хорошую работу, объясняя что-то сложное? Пусть они знают!

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

Рецензирование нескольких ревизий

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

Готово к локализации

Отмечая ревизию статьи как «Готова к локализации», мы можем сообщить переводчикам, что ревизия на английском языке готова, и её можно переводить, не опасаясь, что статья изменится еще несколько раз, прежде чем она будет готова.

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

Локализация — это большая работа, которая часто выполняется одним человеком. Только около 20 лучших статей локализуются в некоторых регионах. Наши лучшие статьи, как правило, не требуют никаких изменений, кроме обновлений для новой версии Firefox. Поскольку мы знаем, что нас ждёт, мы стараемся убедиться, что все необходимые изменения внесены до выпуска Firefox, чтобы локализаторы могли использовать это дополнительное время для выполнения своей работы.

Если вы не отмечаете ревизию как готовую к локализации при её утверждении (как в примере выше), вы можете отметить её как готовую в любое время, щёлкнув по статусу «Не готово к локализации» (символ X) в столбце R истории ревизий статьи и подтвердив действие.

Ревизии, отмеченные как RFL, имеют символ галочки.

Как работает «Готов к локализации» (RFL)?

Чтобы никто не переводил статью в потоковом режиме, когда вы нажимаете "Перевести статью", вам предоставляется самая последняя версия, помеченная как готовая к локализации. После утверждения новой редакции статьи она не добавляется на информационную панель локализации, поскольку для неё требуется обновление, если только редакция не помечена вторым или третьим уровнем редакции и не установлена пометка готовности к локализации. Это также отправляет уведомление по электронной почте всем, кто следит за статьями, которые готовы к локализации.

Содержание следующего выпуска

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

Временная шкала редактирования Базы знаний на основе выпуска

За 4 недели до следующего выпуска

• Планирование и подготовка контента для следующего выпуска; для локализаторов пока нет работы по следующему выпуску
• Весь существующий контент открыт для редактирования и локализации как обычно; пожалуйста, сосредоточьтесь на локализации самого последнего/популярного контента

За 3 недели до следующего выпуска

• Контент для следующего выпуска будет готов к концу этой недели; для локализаторов пока нет работы по следующему выпуску
• Весь существующий контент открыт для редактирования и локализации как обычно; пожалуйста, сосредоточьтесь на локализации самого последнего/популярного контента

За 1-2 недели до следующего выпуска

• Изменения в контенте для следующего выпуска внесены в en-US/английскую версию, и локализаторы должны сосредоточиться на переводе этого контента
• Весь остальной существующий контент имеет более низкий приоритет, но может редактироваться и локализоваться как обычно

Требуются изменения

При утверждении ревизии вы должны решить, что может быть что-то ещё нужно изменить. Если всё, что указано в комментарии "Требуются изменения", было выполнено, вы можете снять флажок (очистить комментарий) и одобрить статью. Если есть ещё вещи, которые необходимо сделать, убедитесь, что флажок установлен и следует обновить комментарий. Таким образом, мы можем легко отслеживать, какую работу необходимо выполнить над статьями.

Добавление помощников

Иногда люди, которые участвуют в обсуждении статьи, вносят значительный вклад в редактирование, даже если они не были теми, кто действительно редактировал вики. В таких случаях вы можете отредактировать список авторов статьи (на странице истории статьи), чтобы включить их. Бонусные баллы за то, что они знают, что вы сделали это!

Чтобы добавить участника, перейдите на страницу Показать историю для статьи. Прокрутите вниз под ревизиями и щёлкните по ссылке «Редактировать участников», введите имя участника, а затем нажмите Add Contributor.

Спам и ошибочные правки

В случае спама вы должны просто удалить ревизию, щёлкнув по символу «корзины» в истории ревизий статьи и подтвердив действие. В случае ошибочных отправок (без изменений) и неуместных запросов о помощи (когда правка по сути является вопросом в поддержку), вам следует отложить ревизию и включить это сообщение в свои комментарии:
Здравствуйте.
Похоже, вы пытались получить помощь с Firefox. Если это так, пожалуйста, задайте свой вопрос ещё раз здесь: https://support.mozilla.org/questions/new, чтобы мы могли лучше вам помочь.
Приносим извинения за неудобства.

После этого вы можете удалить ревизию.