Узнайте о Базе знаний Поддержки Mozilla (SUMO) и о том, как она работает.

Что такое База знаний?

База знаний — это вики с суперспособностями:

• Специальная вики-разметка – Хотя мы используем разметку MediaWiki (как в Википедии) для большинства вещей, наша вики разработана специально для Поддержки Mozilla и использует некоторую специальную разметку (называемую {for}), чтобы мы могли показывать один набор инструкций для пользователей Windows, например, и другой для пользователей Mac.
• Система обзора – Поскольку мы хотим быть уверены, что люди получают правильную и актуальную информацию, правки в наших статьях должны быть рассмотрены и одобрены, прежде чем они станут общедоступными.
• Переводы – Большинство наших пользователей говорят на другом языке, кроме английского. У нас есть целая система для перевода статей на английском языке в нашей Базе знаний на другие языки.

Аудитория и объем базы знаний

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

Какие темы мы не затрагиваем в Базе знаний?

• Трюки или хаки для модификации продукта, такие как расширенная настройка параметров (about:config)
• Функции для разработчиков и расширенные функции, такие как Веб-консоль

Организация нашей работы

Как мы расставляем приоритеты над тем, над чем мы работаем?

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

Исключения:
Конечно, популярность — не единственный приоритет. Эти исключения также необходимо принимать во внимание.

• Критически важные проблемы – Иногда на нашем форуме поддержки сообщается о новых проблемах, которые лучше всего решать путём обновления статьи в Базе знаний.
• Ожидаемый спрос – Иногда мы обновляем статью в ожидании новой функции или изменения функции. Текущая статья может не иметь особо высокого ранга, но мы достаточно уверены, основываясь на опыте и маркетинговых планах, что эти статьи станут популярными.
• Мобильная документация – Поскольку продукты Mozilla для мобильных устройств, такие как Firefox for Android и Firefox for iOS, имеют сравнительно мало пользователей, нельзя ожидать, что их статьи будут «конкурировать» со статьями Firefox для настольных компьютеров. Статьи для этих продуктов должны рассматриваться в контексте относительного спроса на документацию по функциям и проблемам, связанным с отдельным продуктом.
• Связанные статьи – Это статьи, на которые есть ссылки из продуктов или с mozilla.org.

Приоритет для настольных компьютеров

1. Windows – Поскольку около 90% наших пользователей используют Windows, это очевидный выбор. На данный момент, если вы можете сделать только один скриншот, мы должны делать скриншоты для Windows (предпочтительно Windows 10).
2. Mac – Текущая версия (macOS 15.0 Sequoia по состоянию на сентябрь 2024 г.)
3. Linux – Используйте Ubuntu для скриншотов.

Мобильные устройства

• Android – 4.0+ (4.0, 4.1, 4.2, 4.3 и т.д.).

Где мы говорим о статьях?

У нас обычно есть два типа обсуждений о статьях базы знаний:

• Отдельные статьи – У каждой статьи есть свой собственный форум для обсуждения, доступный в разделе «Инструменты редактирования».
  
  Зарегистрированные пользователи могут оставлять здесь отзывы о статьях, и мы можем обсуждать, какие правки нужны статье, относительные достоинства правок и вопросы, связанные со статьёй.
• База знаний в целом – Мы обсуждаем идеи и проблемы, связанные с общей стратегией, политиками и программным обеспечением Базы знаний, на форуме Обсуждения Базы знаний.

Как мне не отставать от происходящего?

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

Добавление и удаление статей

Предложение новых статей

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

Действительно ли нам нужна эта статья?
Это основные причины, по которым мы добавляем новую статью в Базу Знаний, хотя зачастую имеет смысл обновить её или добавить в существующую статью.

• Новые функции – Функции, предназначенные для пользователей, которые могут вызвать большой интерес и вопросы пользователей. Это может быть неотъемлемым аспектом функции, результатом маркетинговых и внутрипродуктовых ссылок или их сочетания.
• Новые проблемы – Проблемы, у которых много недавних обсуждений и голосов на форуме поддержки.
• Высокая степень влияния – Критически важные, чувствительные ко времени проблемы, требующие временной документации (например, Падение Firefox при запуске при работающем ПО от G DATA).

Архивация статей

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

Как это работает

Сотрудники и участники с правами рецензента могут пометить статью как устаревшую. Это делается путём редактирования страницы описания статьи, доступной через опцию Редактировать метаданные статьи в разделе Инструменты редактирования. Архивированная статья удаляется со всех панелей мониторинга, включая панели локализации, и не будет отображаться в обычных результатах поиска. Однако любые существующие прямые ссылки на статью будут по-прежнему работать. В верхней части статьи будет отображаться баннер, информирующий читателей о том, что она больше не поддерживается и может быть устаревшей. Архивация обратима. При необходимости участники могут снова посетить страницу Редактировать метаданные статьи и снять флажок с опции Устарело, возвращая статью в активный статус.

Что следует учесть перед архивацией

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

Изменения в продукте: Статьи, связанные с проблемами, которые были решены, или функциями, которые значительно изменились.

Руководство по архивации статей Базы знаний

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

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

Ограничение видимости

Функция «Ограничение видимости» — это недавнее дополнение, направленное на повышение гибкости управления контентом на платформе SUMO. Эта функция позволяет делать определённые статьи видимыми только для определённых групп, таких как сотрудники или некоторые участники, что позволяет распространять конфиденциальный или находящийся на ранней стадии контент контролируемым образом.

Как это работает

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

• Установка ограничений: Сотрудник или участник с необходимыми правами может ограничить видимость статьи. Это достигается путём перехода на страницу описания статьи и выбора соответствующих настроек видимости в разделе «Редактировать метаданные статьи», который находится в «Инструментах редактирования».
• Эффект ограничения: Как только для статьи устанавливается ограниченная видимость, она становится недоступной для широкой публики и видимой только для сотрудников и определённых групп (например, определённых кругов участников, участников, подписавших NDA, и т.д.). Это действие удаляет статью из общих результатов поиска и общедоступных панелей мониторинга, хотя прямые ссылки на статью остаются функциональными для тех, у кого есть доступ.
• Индикаторы видимости: Статьи с ограниченной видимостью будут иметь индикаторы или баннеры для разъяснения их статуса для зрителей, у которых есть доступ. Это предупреждает их о том, что контент ограничен и может содержать информацию, которая ещё не является общедоступной или предназначена для определённой аудитории.
• Обратимость и корректировка: Настройка ограничения видимости не является постоянной и может быть скорректирована по мере изменения необходимости в ограничении. Сотрудники и участники с соответствующими правами могут вернуться к настройкам метаданных статьи, чтобы изменить ограничения видимости, сделав статью доступной для более широкой аудитории или скорректировав группы, имеющие доступ.

Что следует учесть перед ограничением видимости:

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

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

Руководство по ограничению видимости:

• Предрелизный контент: Идеально подходит для статей, подробно описывающих предстоящие функции или продукты, которые ещё не являются общедоступными.
• Целевая коммуникация: Позволяет обмениваться информацией с определёнными группами в нашем сообществе, такими как участники, подписавшие NDA, или руководители локалей, не делая контент общедоступным.
• Управление конфиденциальной информацией: Полезно для контента, который по своей конфиденциальной природе требует ограниченного доступа.

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

Чтобы узнать о руководстве по рецензированию статей Базы знаний, см. Правила рецензирования статей.

Полное руководство по Базе знаний

Если вы действительно заинтересованы в редактировании и написании документации, вот несколько ресурсов, которые помогут объяснить, как мы это делаем:

Создание новых статей поддержки

• Как писать статьи в Базу Знаний — Руководство по техникам и стилям написания, которые мы используем, чтобы сделать статьи более привлекательными и эффективными. Для получения информации о механике создания или редактирования статей см.:
  • Создать новую статью Базы Знаний – Шаги по созданию новой статьи, а также несколько примеров вики-разметки для начала работы.
  • Анатомия статей Базы Знаний – Объясняет основы того, как создаются статьи.
  • Описание статьи – Объясняет, как написать описание для статьи поддержки.

Улучшение существующих статей поддержки

• Улучшите Базу Знаний – Узнайте, как улучшить Базу знаний SUMO.
• Редактирование статьи Базы знаний – Шаги по редактированию существующей статьи.

Другие руководства

• О Базе Знаний — Обзор механики нашей Базы знаний (Вы здесь!)
• Как сделать снимок экрана — Пошаговое руководство по созданию скриншотов для использования в статьях.
• Правила рецензирования статей – Руководство для рецензентов Базы знаний.
• Добавление изображений и снимков экрана в статьи Базы знаний — Объясняет, как добавлять скриншоты в статьи и правильно их отображать.
• Примеры разметки – Наиболее часто используемая вики-разметка в наших статьях.
• Типы разметки — Справочник по вики-разметке. Он содержит примеры и показывает разметку, которая их создаёт.
• Как использовать {for} — Специальная вики-разметка, которая позволяет нам показывать инструкции для различных версий приложений (например, Firefox 115) и операционных систем, таких как Windows и macOS.
• Как использовать шаблоны — Шаблоны — это повторно используемые фрагменты контента. Вы можете включить сложный набор пошаговых инструкций в несколько статей, используя шаблон.
• When and how to use keywords to improve an article's search ranking — Объясняет, когда уместно добавлять ключевые слова в статью.
• Дополнительные руководства по вкладу в Базу знаний см. здесь.