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

Цель

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

Ключевые обязанности

Как рецензент Базы знаний, при рецензировании ревизии всегда убеждайтесь, что ревизия:

• Точна и актуальна
• Использует ясный, последовательный язык и тон
• Соответствует редакционным правилам Mozilla
• Содержит правильное и работающее форматирование, ссылки и разметку
• Следует лучшим практикам доступности и локализации
• Соответствует теме статьи и версии продукта

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

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

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

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

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

См. Назначения участников для запросов на контент для получения более подробной информации об этом различии.

Когда требуется рецензирование сотрудниками?

Рецензирование сотрудниками требуется для:

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

Когда участники с правами рецензирования Базы знаний могут рецензировать ревизии?

Участники с правами рецензирования Базы знаний могут рецензировать:

• Ревизии, классифицированные как незначительные изменения
• Крупные изменения, не требующие рецензирования сотрудниками

См. Незначительные и значительные изменения, чтобы узнать больше о том, как обновления контента классифицируются в зависимости от их объёма и влияния.

Где найти неотрецензированные статьи

Существует несколько способов найти неотрецензированные статьи:

• Обзор Базы знаний: Эта страница предоставляет вам список статей в порядке количества просмотров за последние 30 дней. В столбце «Статус» будет показано, какие статьи нуждаются в рецензировании. Вы также можете фильтровать по продукту и типу статьи.
• Неотрецензированные изменения: Эта страница предоставляет альтернативный способ увидеть, какие статьи нуждаются в рецензировании, а также как долго каждая ревизия ожидает рецензии. Вы можете выбрать сортировку по количеству просмотров/самым последним изменениям, а также фильтровать по продукту.
• Самые посещаемые: Эта страница предоставляет вам список статей Базы знаний на основе количества просмотров. В столбце «Статус» вы сможете увидеть, какие статьи нуждаются в рецензировании.

Приоритезация

При рецензировании нескольких статей важно стратегически расставлять приоритеты. Учитывайте следующее:

• Статьи с большим количеством просмотров: Статьи с большим количеством просмотров должны быть приоритетными, чтобы пользователи получали самую точную и актуальную информацию. Вы можете легко определить их, отсортировав список неотрецензированных изменений по количеству просмотров.
• Статьи, на которые есть ссылки в продукте: Если вы являетесь частью одной из групп участников (Форум, База знаний, L10n) или группы «Сотрудники», вы можете увидеть индикатор, показывающий, что на статью есть ссылка в продукте. Этим статьям, как правило, следует отдавать приоритет, поскольку они напрямую влияют на пользовательский опыт.

  

Особые статьи

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

Особые требования для продуктов по подписке или премиум-продуктов

Отправка контента

Если вы хотите предложить новый контент или внести изменения, пожалуйста, создайте тикет в Bugzilla или свяжитесь с сотрудником. Вы можете связаться с нами либо в Matrix, либо в канале #sumo-team в Slack (для участников с доступом к Slack).

Рецензирование и утверждение ревизий Базы знаний

Утверждение сотрудниками требуется для всех ревизий, связанных с продуктами по подписке или премиум-продуктами. Это включает Готовые ответы и Шаблоны, связанные с этими продуктами.

Для справки, текущие продукты по подписке или премиум-продукты включают:

• Mozilla VPN
• Firefox Relay
• Mozilla Monitor
• MDN Plus

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

Выбор уровней ревизии

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

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

  

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

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

Откладывание ревизии

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

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

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

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

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

Указание авторства

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

Как указать авторство участника в Базе знаний

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

Обработка спама и ошибочных правок

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

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

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

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

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

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

Пометка статьи как RFL

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

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

Пометка статьи как RFL после рецензирования

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

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

Протоколы RFL

Все участники-рецензенты должны придерживаться следующих протоколов локализации:

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

Готовность к выпуску

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

Календарь выпусков Firefox

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

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

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

• Черновой контент для предстоящего выпуска может быть готов внутри компании; однако публикация обычно откладывается до официальной даты выпуска, чтобы учесть любые изменения в последнюю минуту.
• Если контент требует локализации до выпуска, команда продукта должна уведомить сотрудников CX, чтобы мы могли координировать работу с сообществом локализации для обеспечения соблюдения сроков.

День выпуска

• Изменения контента должны быть опубликованы в Базе знаний en-US. Локализаторы должны уделять первоочередное внимание переводу статей, связанных с новым выпуском.

Канал обсуждения и эскалация

Не все рецензенты Базы знаний активно следят за Обсуждениями Базы знаний. Если вам нужно связаться со всей группой рецензентов Базы знаний, пожалуйста, напишите по адресу kb-reviewers@mozilla.com.

Оценка роли

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

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

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

• Оставаться в курсе: Соблюдайте Руководства по участию в сообществе и руководства для рецензентов Базы знаний, изложенные в этой статье.
• Быть активным: Рецензируйте не менее трёх (3) ревизий в течение шестимесячного периода.

Если вы не были активны или возникают вопросы о соблюдении руководств, команда Сообщества может связаться с вами для проверки, прежде чем предпринимать какие-либо действия. Наша цель — не лишать прав, а обеспечить, чтобы рецензенты чувствовали себя вовлечёнными, поддерживаемыми и согласованными с текущими процессами.

Если обстоятельства изменятся и вам нужно будет отойти от дел, мы полностью это понимаем. Поскольку это волонтёрская роль, ваше время и доступность могут естественным образом меняться. Не стесняйтесь сообщать команде Сообщества, когда это произойдёт. Мы всегда рады возобновить сотрудничество, когда вы будете готовы снова присоединиться.

—

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