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

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

Что считается незначительными изменениями

Вот что мы считаем незначительными изменениями:

• Исправление мелких опечаток
• Удаление лишних пробелов
• Исправление орфографических, грамматических или пунктуационных ошибок
• Исправление форматирования вики-разметки (заголовки, маркеры, нумерация, интервалы, отступы)
• Обновление мелких фактических деталей (например, номера версий, надписи на кнопках или в меню) без переписывания разделов
• Обновление разделов и замена их существующими шаблонами без изменения первоначального контекста
• Исправление устаревшего или неподдерживаемого контента, включая обновления для поддержки, такие как добавление или удаление тегов версий, без существенного изменения основного руководства
• Удаление контента и разметки, относящихся к версиям продукта, которые больше не поддерживаются
• Улучшение читабельности или ясности за счёт небольших уточнений инструкций, упрощения формулировок или включения визуальных подсказок для доступности (например, добавление значков и ссылок на меню) без существенного изменения руководства или структуры статьи
• Обновление неработающих ссылок, ссылок на переименованные статьи базы знаний или ссылок с тем же целевым контентом
• Корректировка тона в соответствии со стандартами контента поддержки Mozilla
• Замена устаревших скриншотов интерфейса на обновлённые версии (максимум до 3 скриншотов)
• Обновление ключевых слов
• Добавление или обновление сводки для поиска

Что считается крупными изменениями

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

Ниже приведены изменения, которые мы считаем крупными:

• Создание новой статьи
• Изменения, требующие проверки от заинтересованных сторон продукта или тесной координации с ними, включая:
  • Обновления, связанные с подготовкой к релизу
  • Существенные добавления контента (например, новые инструкции, часто задаваемые вопросы или шаги по устранению неполадок)
  • Замена устаревших скриншотов или добавление новых скриншотов в количестве более 3 изображений
• Существенные изменения, влияющие на руководство для пользователя или структуру статьи, которые требуют проверки командой по контенту, включая:
  • Удаление существующего раздела
  • Обширное переписывание абзацев или разделов
  • Масштабные изменения форматирования или структуры (например, реорганизация нескольких разделов или изменение потока статьи)
  • Изменение охвата или цели статьи
  • Обновление, добавление или удаление скринкастов, GIF-файлов или видео
  • Переписывание или переименование заголовков разделов, которые могут повлиять на якорные ссылки или навигацию по статье

Чтобы узнать больше о вкладе в Базу знаний, пожалуйста, ознакомьтесь со статьёй Как внести вклад в Базу знаний.