Узнайте о Базе знаний Поддержки Mozilla (SUMO) и о том, как она работает.
Оглавление
База знаний - это вики с суперспособностями
- Специальная разметка вики - хотя мы используем разметку MediaWiki (например, Википедию) для большинства вещей, наша вики разработана специально для поддержки Mozilla и использует некоторую пользовательскую разметку (называемую {for}), чтобы мы могли показать один набор инструкций для пользователей Windows, например, и другой для пользователей Mac.
- Система обзора - поскольку мы хотим быть уверены, что люди получают правильную и актуальную информацию, изменения в наших статьях должны быть рассмотрены и одобрены, прежде чем они станут действующими.
- Переводы - большинство наших пользователей говорят на другом языке, кроме английского. У нас есть целая система для перевода статей на английском языке в нашей Базе знаний на другие языки.
Аудитория и объем базы знаний
Поскольку продукты Mozilla используются миллионами людей на всех уровнях квалификации, База Знаний должна быть написана для широкой аудитории, а не для тех, кто хорошо знаком с компьютерными технологиями и терминологией. В основном мы рассматриваем функции (такие как вкладки, закладки и синхронизация) и устраняем проблемы (например, сбои или проблемы с загрузкой веб-сайтов). Мы не охватываем все функции, настройки или проблемы. Вместо этого мы смотрим на то, что говорят нам пользователи (в обсуждениях статей, на форумах поддержки, в просмотрах статей), и используем наш опыт и суждения, чтобы решить, что именно нужно освещать.
Какие темы мы не затрагиваем в Базе знаний?
- Трюки или взлом для изменения продукта
- Разработка и расширенные функции, такие как консоль ошибок или веб-консоль
Организация нашей работы
Как мы расставляем приоритеты над тем, над чем мы работаем?
В основном, мы работаем над статьями в порядке их популярности. Это, как правило, отражает приоритеты наших пользователей. В настоящее время топ 20 статей составляют более половины всех просмотров. Повышение полезности нашей главной статьи может потенциально помочь как многим людям, так и улучшить первые 100 статей. Мы отслеживаем изменения, которые необходимо внести в эту панель. Она отсортирована по рейтингу статьи, чтобы вы могли легко увидеть, над чем нужно работать в первую очередь.
Исключения:
Конечно, популярность - не единственный приоритет. Эти исключения также должны быть приняты во внимание.
- Неотложные проблемы. Иногда на нашем форуме поддержки появляются сообщения о новых проблемах, которые лучше всего решаются путём обновления статьи Базы Знаний. Например, проблема, которая затрагивает людей, использующих Flash-плагин (большинство пользователей Firefox), будет важнее обновить, чем незначительное изменение существующей функции в предстоящем версия Firefox.
- Ожидаемый спрос - Иногда мы обновляем статью в ожидании новой функции или изменения функции. Текущая статья может не иметь особо высокого ранга, но мы разумно уверены, основываясь на опыте и маркетинговых планах, что эти статьи станут популярными.
- Мобильная документация - поскольку в продуктах Mozilla для мобильных устройств, таких как Firefox для Android и Firefox для iOS, сравнительно мало пользователей, нельзя ожидать, что их статьи будут "конкурировать" со статьями Firefox для настольных компьютеров. Статьи для этих продуктов должны рассматриваться в контексте относительного спроса на документацию функций и вопросов, связанных с отдельным продуктом.
- Связанные статьи - это статьи, связанные с внутренними продуктами или mozilla.org.
Где мы говорим о статьях?
У нас обычно есть два типа разговоров о статьях базы знаний:
- Отдельные статьи - каждая статья имеет свою вкладку для обсуждения. Зарегистрированные пользователи могут оставлять отзывы о статьях здесь, и мы можем обсудить, какие редакции нужны, относительные достоинства редакций и вопросы, связанные со статьей.
- База Знаний в целом - мы обсуждаем идеи и проблемы с общей стратегией КБ, политиками и программным обеспечением в разделе Форум статей.
Как мне не отставать от происходящего?
- Блог поддержки Mozilla (SUMO): последние обновления проекта и разработки обсуждаются здесь.
- Новости и ресурсы помощников: Это ещё один хороший источник информации - он обновляется каждую неделю или около того.
- Обсуждения сообщества SUMO: здесь участники общаются друг с другом.
- Форум статей Базы Знаний: здесь мы обсуждаем общие темы о Базе Знаний.
- Форум локализации: это место, где мы говорим о локализации SUMO.
Улучшение статей
Улучшение статей Базы Знаний - это, вероятно, 90% работы, которую мы делаем. Всегда есть что-то, что можно сделать лучше. Вот три основных способа улучшить статью:
- Держите статьи в актуальном состоянии - Крупные обновления продуктов и услуг Mozilla всегда приносят новые функции и изменения в работу существующих. Всегда лучше, когда наши инструкции действительно соответствуют принципам работы продукта.
- Proof-read' - Некоторые из вас обладают особыми полномочиями определять ошибки, которые пропускает проверка орфографии (сколько вы заметили в этой статье до сих пор?). Нам нужна твоя помощь.
- Правильное написание, грамматика и пунктуация.
- Исправлены проблемы со стилем и форматированием. Посмотрите статьи Как писать статьи в Базу Знаний, Как использовать For and Как использовать шаблоны для получения некоторых рекомендаций.
- Сделать статьи проще для понимания
- Найдите лучший способ объяснить что-то слишком сложное или не очень понятное.
- Добавьте скриншоты, чтобы помочь людям понять, на что в мире ссылается статья. Большинство людей, вероятно, не знают разницы между строкой адреса, строкой поиска или любой другой панелью, если только у неё нет счастливого часа.
- Добавить скринкасты. Это следующая лучшая вещь для того, чтобы на самом деле выхватить мышь из чьей-то руки и сделать это для него.
Что такое процесс редактирования статьи?
Как минимум, всё, что вам нужно сделать, это нажать , внести некоторые изменения и отправить её на рассмотрение. Полный процесс выглядит так:
- Перейдите в раздел Нужны изменения на информационной панели участника
- Из комментариев, описывающих, что нужно сделать, выберите статью. Разверните и взгляните на обсуждение, чтобы получить информацию, которая относиться к этой статье.
- Редактирование статьи. Посмотрите статью How to write knowledge base articles для советов по стилю.
- Используйте кнопку , чтобы проверить ваши изменения.
- Нажмите кнопку , чтобы сохранить изменения. Ваша правка будет указана в разделе Непросмотренные изменения на информационной панели участника.
Если получение рецензии занимает много времени, вы можете пропинговать jsavage в IRC-канале #sumo или по электронной почте mailto:jsavage@mozilla.com.
Если рецензент не одобряет статью, он публикует свои причины и отзывы в ветке Обсуждение статьи. Иногда они также будут создавать новую ревизию на основе вашей и добавлять или изменять вещи.
Вы (или кто-либо ещё) можете создать другую ревизию и внести дополнительные изменения. Как правило, требуется несколько версий, чтобы сделать все правильно.
Создание новой статьи
Если вы думаете, что есть статья, которую мы должны добавить в Базу Знаний, вот как это сделать.
- Создайте новую статью и заполнить форму, используя источник для другой статьи в качестве руководства.
- Составьте содержание статьи.
- Проверьте свою работу, используя кнопку .
- Нажмите кнопку и укажите причину написания статьи в комментарии.
- При этом вы получаете статью на панели управления Базы Знаний, чтобы люди знали, что статья ожидает редактирования или рецензирования.
- Статья не будет публичной, пока она не будет рассмотрена и одобрена.
Стиль
Мы хотим, чтобы справка Mozilla была доступна всем пользователям. Это означает, что мы пишем для широкой аудитории, а не для тех, кто хорошо знаком с компьютерными технологиями и терминологией.
- Человек, для которого вы пишете, не знает, как изменить настройки или добавить кнопку на панели инструментов без пошаговых инструкций.
- Предположим, что люди не изменили ни один из параметров продукта или операционной системы по умолчанию.
- Разговорный стиль письма - используйте неформальный, активный стиль, подобный тому, как вы разговариваете с кем-то лично.
- Изображения и видео. Использование изображений и видео для объяснения чего-либо вместе с текстом - это не только лучшее, что нужно для личной помощи, но и простой способ включения нескольких стилей обучения и повторения.
Прочитайте статью Как писать статьи в Базу Знаний для получения подробной информации.
Разметка
Наша вики использует синтаксис MediaWiki, а также несколько специальных вещей для стилизации кнопок, клавиш, меню и т. Д. Список и примеры приведены в статьеТипы разметки.
{for}
Статья Как использовать For содержит инструкции и примеры для отображения и скрытия инструкций для различных версий Firefox и операционных систем.
Шаблоны
У нас есть список шаблонов, которые мы используем в статьях, поэтому один и тот же фрагмент инструкции не нужно переписывать, локализовать и синхронизировать между несколькими статьями. Статья Как использовать шаблоны объясняет, как это работает.
Скриншоты и скринкасты
Мы должны убедиться, что статьи написаны для работы без изображений или видео. Хотя изображения и видео важны и значительно повышают полезность статьи, они не могут быть обязательными. Локализаторы должны свободно использовать или удалять их по своему усмотрению.
Приоритет рабочего стола
- Windows - это примерно 90% наших пользователей в Windows. На данный момент мы должны делать скриншоты Windows 7 или выше.
- Mac - текущая версия macOS 10.14 (Mojave).
- Linux - используйте Ubuntu для скриншотов.
Mobile
- Android - 4.0 + (4.0, 4.1, 4.2, 4.3, и т.д.).
Добавление и удаление статей
Предложение новых статей
Наша База Знаний - это то, что делает все наши усилия по поддержке масштабируемыми для обслуживания сотен миллионов пользователей Firefox. Самое эффективное, что мы можем сделать, это ответить на вопросы людей о продуктах и услугах Mozilla с помощью статьи. Но статьи не создаются бесплатно. Каждая из них должна быть написана, локализована и поддерживатся. Поскольку многие функции и проблемы уже задокументированы, часто лучше использовать наше коллективное время для улучшения существующих статей. Прежде чем вы начнёте создавать новые статьи, давайте сначала рассмотрим некоторые вещи, которые вы должны рассмотреть:
Нам действительно нужна эта статья?
Это основные причины, по которым мы добавляем новую статью в Базу Знаний, хотя зачастую имеет смысл обновить её или добавить в существующую статью.
- Новые функции - функции, предназначенные для пользователей, которые могут вызвать большой интерес и вопросы пользователей. Это может быть неотъемлемым аспектом функции, результатом маркетинговых и внутрикорпоративных ссылок или их сочетания.
- Новые проблемы - проблемы, за которые в последнее время приходилось много обсуждений и голосов на форуме поддержки.
- Высокий эффект - критические, чувствительные ко времени проблемы, требующие временной документации (например, Pogo.com и другие Java-страницы не работают)
Архивирование статей
Мы будем периодически архивировать статьи Базы Знаний, чтобы сосредоточиться на самых неотложных вещах пользователей. По мере того, как мы выпускаем продукты Mozilla, каждые шесть недель, проблемы и элементы, для которых пользователям потребуется документация, будут меняться с гораздо большей скоростью. Будет много статей (таких как Закладки в Firefox или Как установить домашнюю страницу), которые останутся в течение долгого времени, но будут другие, которые устареют или не интересуют пользователей.
Как это работает:
Авторы с правами рецензента могут пометить статью как устаревшую, отредактировав раздел описания статьи. Это удалит статью со всех панелей мониторинга (включая панели локализации) и из обычного поиска. Вы все ещё можете просмотреть статью с помощью расширенного поиска, и, конечно, ссылки на статью будут сохранены. Тем не менее, в верхней части статьи будет баннер, дающий понять, что статья больше не поддерживается и может устареть.
Архивирование статьи не всегда является хорошей идеей. После того, как статья заархивирована, мы будем следить за статистикой, чтобы убедиться, что статья не была популярной. Если мы допустили ошибку, достаточно просто щёлкнуть по флажку, чтобы вернуть статью на информационные панели.
Факторы, которые следует учитывать перед архивированием статьи:
- Низкие просмотры - Как правило, статьи с менее чем 1500 посещений в месяц.
- Несколько недавних отчётов - Проблемы с относительно небольшим количеством недавних тем и голосов на форуме поддержки.
- Низкое воздействие - удаление статьи вряд ли вызовет или усугубит серьезную проблему.
- Изменения в продуктах и услугах - случаи, когда проблема была устранена или изменение поведения сделало что-то устаревшим.
Правила рецензирования статей
Чтобы узнать о рекомендациях по рецензированию статей Базы Знаний, прочитайте статью Article review guidelines.
