Как писать статьи в Базу Знаний

Существует множество факторов, которые необходимо учитывать при написании или изменении статей в Базе знаний Поддержки Mozilla («Mozilla Support», «SUMO»). Вы хотите быть всеобъемлющим и лаконичным, опирающимся на факты и увлекательным, и всё это одновременно. Это, конечно, не самая простая вещь на свете. В этой публикации мы постараемся привести несколько советов для того, чтобы помочь Вам найти баланс среди этих факторов. Кроме того, это wiki и мы всегда можем исправить что-то, если мы сделаем это неправильно.

Пишите для обычной, не технической аудитории

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

Выберите хорошее название

Название статьи вместе с её резюме являются единственными вещами, по которым пользователь может судить, ответит ли статья на его вопрос. Мы называем это «Уверенность пользователя» и это непосредственно влияет на коэффициент кликов. Даже если мы будем показывать правильную статью в верхней части списка результатов поиска, пользователю нужно провести мысленную связь между поисковым запросом и показанными нами результатами, чтобы перейти по ссылке к статье.

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

• Длина названия: Страница результатов поиска Google отображает до 70 символов. Ваше название может быть длиннее, если это необходимо, но убедитесь, что ваши важные ключевые слова вошли в первые 70 символов.
• Заглавные буквы: С прописной буквы в заголовке должны быть написаны первое слово и имена собственные, а не каждое длинное слово (последнее допустимо только в английском языке, где это называется «headline style»).
• Не используйте двоеточие в названии статьи, так как это делает невозможным создание вики-ссылки к этой статье (bug 749835).
• Удостоверьтесь, что в названии статьи нет лишних пробелов. Из-за них тоже не работают вики-ссылки.
• Попробуйте менять способы именования статей. Не используйте одни и те же глаголы или фразы в каждом названии.
• Старайтесь не использовать глаголы настоящего времени.

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

Исправьте ссылку

Когда Вы создаёте заголовок, SUMO автоматически создаёт ссылку (конец URL статьи). Ссылка имеет ограничение в 50 символов. Пробелы выражаются чёрточками. Ссылка должна согласовываться с названием, но, учитывая жесткие пространственные ограничения, не обязана быть такой же. Не забудьте проверить окончание автоматически сгенерированной ссылки. Иногда вырезается слово или она оканчивается чёрточкой. Пожалуйста, исправляйте такие вещи.

Категории, продукты и темы

По большей части, статья принадлежит либо к категории Инструкции либо к категории Устранение неисправностей. Иногда мы пишем статьи типа «Как принять участие» (как эта) или что-нибудь в одной из других категорий.

Статьи также имеют «отношение» по крайней мере к одному продукту. Они также принадлежат к одной главной «Теме» и возможно к «подтеме».

Ключевые слова

Поле ключевые слова в статье можно использовать для улучшения результатов поиска по SUMO. Тем не менее, оно должно использоваться только при определенных обстоятельствах, так как злоупотребление им может реально повредить поиску. Нам следует редко использовать ключевые слова. Более подробную информацию можно найти в статье When and how to use keywords to improve an article's search ranking

Напишите хорошую сводку поиска

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

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

• Будьте кратки и по существу. Помните бумажные объявления? Пишите так же. Поисковые системы отрезают всё, что длиннее 160 символов.
• Не используйте вики-разметку.
• Не используйте «Эта статья объясняет» в каждой сводке. Изменяйте это когда возможно. Некоторые другие фразы, которые можно использовать:
  • Мы покажем вам
  • Мы объясним
  • Эта страница объясняет
  • В этой статье описывается
  • Узнайте, как

Сделайте ваши тексты увлекательными

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

Теперь проснулись? Хорошо.

Этот параграф выглядит как скучная лекция, как минимум до появления единорогов. Использование юмора и/или эмоций (СЮРПРИЗ!) являются одной из техник, с помощью которой мы можем привлечь людей. Приведенные ниже техники помогут сконцентрировать внимание, воссоздавая эффект живого общения. Когда мы их используем, информацию становится проще понять и запомнить.

• Разговорный стиль письма - Пишите так, как будто вы с кем-то разговариваете, используйте «живой» язык.
• Юмор и эмоции - Использование юмора — это прекрасно, но его бывает трудно или невозможно перевести. Эмоции вроде удивления и «А я этого не знал!» (не знаю как правильно назвать эту эмоцию) использовать попроще.
• Различные способы обучения - Как и в школе, люди по-разному усваивают материал. Так же каждому станет лучше при виде одного и того же содержимого выраженного разными способами.
• Повторение - Когда вы объясняете что-либо разными способами или с применением различных средств, вы так же заставляете повторять, что в свою очередь тоже помогает в усвоении материала.
• Картинки и видео - Использование картинок и видео, а не только текста, является самой лучшей идеей после идеи персональной помощи. К тому же, с их помощью легко включать в статью разные способы обучения, а так же и повторение.
• Упражнения — Особенно в обучающих статьях было бы правильно дать людям какое-либо полезное задание для закрепления материала. Читать инструкции и понимать процесс — это хорошо, но всегда стоит напомнить читателю, что он может применять полученные знания, и помочь ему в этом.

Напишите хорошее вступление

Вместе с названием и оглавлением вступление поможет пользователю быстро определить, зашёл ли он в нужное место.

• Для обучающих или how-to-статей: Дайте краткое описание того, какая польза может быть извлечена из статьи.
• Для обзорных статей: Дайте краткое описание функций, приведенных в статье.
• Для статей «Устранение неполадок»: Дайте краткое описание проблемы и её симптомов.

Хорошее вступление обычно может послужить и как хорошая сводка результатов поиска. Зачастую вы можете просто её скопировать в «Сводка результатов поиска» и всё готово.

Эффективно организуйте статью

Основной идеей является выстраивание необходимых навыков по выполнению инструкций от простых к сложным, чтобы информация, нужная большинству людей, находилась ближе к началу. То есть простое или типовое решение должно быть в начале, а сложное или специфичное — в конце.

Используйте описательные названия заголовков

Наши статьи обычно комплексные, поэтому очень важно использовать описательные заголовки, чтобы помочь людям найти ту часть статьи, которая им нужна. Взгляните на оглавление. Работает ли это вместе с введением, чтобы дать вам хороший краткий обзор сферы применения статьи?

Сделайте пошаговую инструкцию лёгкой в использовании

Основная идея в пошаговых инструкциях — включить все шаги, необходимые для выполнения задачи. Если, например, для перехода к следующему шагу после выбора настройки необходимо нажать на «OK», — проверьте, что нажатие на «OK» у вас включено как часть текущего шага. И еще несколько советов:

• Всегда есть несколько путей для достижения цели. Старайтесь выбирать наиболее дружелюбный к пользователю — используя графический пользовательский интерфейс и меню, когда это возможно.
• Используйте полные предложения, когда указываете, как добраться до того или иного пункта меню.
• Давая инструкции, указывайте ожидаемый результат (например: «Щёлкните „OK“ и окно закроется»).

Несколько советов от сообщества SUMO

Как мы говорили ранее, при написании статей лучше использовать активный, разговорный стиль. Таким образом, вместо того, чтобы писать «Если пользовательские закладки были потеряны…», сто́ит написать «Если у вас пропали закладки…». Ниже приведено ещё несколько общих советов по поводу написания статей:

Всегда используйте термины так, как они отображаются в интерфейсе Mozilla. Например:

• «Plugin» пишется без дефиса (прим. переводчика: в русском это Плагины);
• «Add-ons» называются «дополнениями», а не «аддонами»;
• Transvision — инструмент для поиска и сравнения переводов.

Общие компьютерные термины:

• Интернет с большой буквы
• Веб-сайт — пишется через дефис.

• Используйте email вместо e-mail

Ссылки на mozilla.org не должны содержать указание локали:

• Используйте https://www.mozilla.org/ вместо https://www.mozilla.org/ru/

Пишите с заглавной буквы:

• Имена собственные
• Первое слово в предложении
• Аббревиатуры и акронимы, кроме тех случаев, когда они должны быть строчными
• Первое слово в списках
• Названия клавиш на клавиатуре
• Первое слово предложения после двоеточия
• Первое слово в заголовке или названии

Для ясности, не используйте «т.е.» и «напр.» (в английском языке используются латинские сокращения, которые часто путаются.)

У нас есть специальные визуальные стили для ряда элементов, которые могут быть получены путем добавления специальной вики-разметки вокруг объекта (см. наиболее распространённые стили в Примеры разметки).

Так же у нас есть специальный тэг – {for} – который позволяет указать информацию для опредёленных версий Firefox или определённых операционных систем. Например, вы можете указать один набор инструкций для тех кто использует Windows и другой для тех, кто использует Mac OS X (см. Как использовать For).