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

Существует множество факторов, которые необходимо учитывать при написании или изменении статей. Вы хотите быть всеобъемлющим и лаконичным, опирающимся на факты и увлекательным, и всё это одновременно. Это, конечно, не самая простая вещь на свете. В этой публикации мы постараемся привести несколько советов для того, чтобы помочь Вам найти баланс среди этих факторов. Кроме того, это wiki и мы всегда можем исправить что-то, если мы сделаем это неправильно. __TOC__ ==Пишите для обычной, не технической аудитории== Мы хотим сделать справку Firefox пригодной для использования всеми нашими пользователями. Это значит, что мы пишем для обычных людей, а не тех, которые очень хорошо знакомы с компьютерной техникой и терминологией. Предполагайте, что человек, для которого вы пишете, не знает как поменять настройки или добавить кнопку на панель инструментов без пошаговой инструкции. Кроме того, мы должны считать, что этот человек не изменял настройки по умолчанию в Firefox или операционной системе. ==Выберите хорошее название== Название статьи вместе с её резюме являются единственными вещами, по которым пользователь может судить, ответит ли статья на его вопрос. Мы называем это "Уверенность пользователя" и это непосредственно влияет на коэффициент кликов. Даже если мы будем показывать правильную статью в верхней части списка результатов поиска, пользователю нужно провести мысленную связь между поисковым запросом и показанными нами результатами, чтобы перейти по ссылке к статье. Название статьи должно пытаться описать то, о чем эта статья. Важно, чтобы первые несколько слов были настолько понятны, насколько это возможно, и заполнены ключевыми словами, которые важны. Это позволит пользователям понять, о чем эта статья, и с уверенностью сделать по ней щелчок. Кроме того, название должно соответствовать следующим правилам: * Длина Названия: Страница результатов поиска Google отображает до 70 символов. Ваше название может быть длиннее, если это необходимо, но убедитесь, что ваши важные ключевые слова вошли в первые 70 символов. * Постарайтесь менять способы именования статей. Не используйте одни и те же глаголы или фразы в каждом названии. * Старайтесь не использовать глаголы настоящего времени. * Не используйте двоеточие в названии статьи, так как это блокирует создание вики-ссылки к этой статье ([https://bugzilla.mozilla.org/show_bug.cgi?id=749835 bug 749835]). Помните, что полное объяснение не нужно включать в название. Вы можете использовать сводку, чтобы дать пользователю дополнительную информацию о том, что находится в этой статье. ==Исправьте ссылку== При создании заголовка, SUMO также автоматически создает ссылку (конец URL артикля). Ссылка имеет ограничение в 50 символов. Пробелы отображаются как тире. Ссылка должна согласовываться с названием, но, учитывая жесткие пространственные ограничения, не обязана быть такой же. Не забудьте проверить окончание автоматически сгенерированной ссылки. Иногда вырезается слово или она заканчивается на тире. Пожалуйста, исправляйте такие вещи. == Категории, продукты и темы== По большей части, статья принадлежит либо к категории Инструкции либо к категории Устранение неисправностей. Иногда мы пишем статьи типа "Как принять участие" (как эта) или что-нибудь в одной из других категорий. Статьи также имеют "отношение" по крайней мере к одному продукту. Они также принадлежат к одной главной "Теме" и возможно к "подтеме". ==Ключевые слова== Поле ключевые слова в статье можно использовать для улучшения результатов поиска по SUMO. Тем не менее, оно должно использоваться только при определенных обстоятельствах, так как злоупотребление им может реально повредить поиску. Нам следует редко использовать ключевые слова. Более подробную информацию можно найти в статье [[When and how to use keywords to improve an article's search ranking]] ==Напишите хорошее сводку поиска== Сводка статьи наряду с названием являются единственными вещами, по которым пользователь должен судить, ответите ли статья на его вопрос. Мы называем это "Уверенность пользователя" и это непосредственно влияет на коэффициент кликов. Даже если мы будем показывать правильную статью в верхней части списка результатов поиска, пользователю нужно провести мысленную связь между поисковым запросом и показанными нами результатами, чтобы перейти по ссылке к статье. Сводка для статьи с инструкцией должно включать в себя темы, затронутые в статье. Для статьи по устранению неисправностей она должна попытаться включить симптомы. Кроме того, сводка должно следовать следующим правилам: * Будьте кратки и по существу. Помните бумажные объявления? Пишите так же. Поисковые системы отрезают всё, что длиннее 160 символов. * Не используйте вики-разметку. * Не используйте "Эта статья объясняет" в каждой сводке. Изменяйте это когда возможно. Некоторые другие фразы, которые следует принять во внимание: ** Мы покажем вам ** Мы объясним ** Эта страница объясняет ** В этой статье описывается ** Мы расшифруем ==Сделайте ваши тексты увлекательными== Справка Firefox - это хранилище технической информации о работе в приложении веб-браузера Firefox. В документации перечислены функции различных возможностей Firefox, процедуры по устранению неисправностей и инструкции по решению типичных проблем. Получить доступ к документации можно через функцию поиска на каждой странице, или жу вы можете просто бросить свой компьютер в другой конец комнаты, где единороги с помощью силы радуги превратят его в магическую печеньку, съев которую, вы станете компьютерным ниндзя 80-го уровня. Теперь проснулись? Хорошо. Этот параграф выглядит как скучная лекция, как минимум до появления единорогов. Использование юмора и/или эмоций (СЮРПРИЗ!) являются одной из техник, с помощью которой мы можем привлечь людей. Приведенные ниже техники помогут сконцентрировать внимание, воссоздавая эффект живого общения. Использование данных техник позволяет проще понять и запомнить информацию. * '''Разговорный стиль письма''' - Пишите так, как будто вы с кем-то разговариваете, используйте “живой” язык. * '''Юмор и эмоции''' - Использование юмора - это прекрасно, но, зачастую, очень сложно или невозможно реализовать на практике. Эмоции вроде удивления и “А я этого не знал!” (не знаю как правильно назвать эту эмоцию) использовать попроще. * '''Различные способы обучения''' - Как и в школе, люди по-разному усваивают материал. Так же каждому станет лучше при виде одного и того же содержимого выраженного разными способами. * '''Повторение''' - Когда вы объясняете что-либо разными способами или с применением различных средств, вы так же заставляете повторять, что в свою очередь тоже помогает в усвоении материала. * '''Картинки и видео''' - Использование картинок и видео, а не только текста, является самой лучшей идеей после идеи персональной помощи. К тому же, с их помощью легко включать в статью разные способы обучения, а так же и повторение. * '''Упражнения''' - Особенно в обучающих статьях было бы правильно дать людям какое-либо полезное задание для закрепления материала. Читать инструкции и понимать процесс - это хорошо, но всегда стоит напомнить читателю, что ему предстоит применять полученные знания. Статья [[How to set the home page]] может послужить хорошим примером по использованию этих техник. ==Напишите хорошее вступление== Вместе с названием и оглавлением вступление поможет пользователю быстро определить, зашел ли он в нужное место. * Для обучающих или How-TO статей: Дайте краткое описание того, какая польза может быть извлечена из статьи. * Для обзорных статей: Дайте краткое описание функций, приведенных в статье. * Для статей “Устранение неполадок”: Дайте краткое описание проблемы и её симптомов. Хорошее вступление обычно может послужить и как хорошая сводка результатов поиска. Зачастую вы можете просто её скопировать в "Сводка результатов поиска" и всё готово. ==Эффективно организуйте статью== Основной идеей является выстраивание необходимых навыков по выполнению инструкций от простых к сложным, чтобы информация, нужная большинству людей, находилась ближе к началу. То есть простое или типовое решение должно быть в начале, а сложное или специфичное - в конце. ==Используйте описательные названия заголовков== Наши статьи обычно комплексные, поэтому очень важно использовать описательные заголовки, чтобы помочь людям найти ту часть статьи, которая им нужна. Взгляните на оглавление. Работает ли это вместе с введением, чтобы дать вам хороший краткий обзор сферы применения статьи? ==Сделайте пошаговую инструкцию легкой в использовании== Основная идея в пошаговых инструкциях - включить все шаги, необходимые для выполнения задачи. Если, например, необходимо щёлкнуть “OK“ после выбора настройки для перехода к следующем шагу - проверьте, что щелчок “OK” у вас включён как часть текущего шага. И еще несколько советов: *Всегда есть несколько путей для достижения цели. Старайтесь выбирать наиболее дружелюбный к пользователю - используя графический пользовательский интерфейс и меню, когда это возможно. *Используйте полные предложения, когда указываете, как добраться до того или иного пункта меню. *Описывайте ожидаемый результат, когда даете инструкции (например: “Щёлкните “ОК” и окно закроется). Вот пример из статьи [[How to set the home page]] с некоторыми пояснениями в скобках: <br><br>'''Установка одного веб-сайта в качестве вашей домашней страницы''' <br> (Заголовок — чего можно достигнуть с помощью шагов) ''Если вам нужно что-то простое, то далее показано, как за три легких шага установить домашнюю страницу.''<br> (Контекст - показать общую картину - почему мы это делаем) #Перейдите на веб-сайт, который вы хотите сделать своей домашней страницей. # Щёлкните по значку слева от веб-адреса, удерживая кнопку мыши, перетащите его на кнопку "Дом" и отпустите. # Для подтверждения установки домашней страницы щёлкните по кнопке "Да". <br>'''Попробуйте:''' Щёлкните по кнопке "Дом" и ваша новая домашняя страница загрузится в текущей вкладке. Проще и быть не может!<br> (Действие – дайте читателю задание и опишите ожидаемый результат) <!-- == Короткие ссылки не являются обязательными == У нас есть [https://support.mozilla.org/en-US/kb/templatesharearticle шаблон для добавления коротких ссылок mzl.la] в нижней части статьи. В основном это используется, чтобы легко включать ссылки на статьи в сообщения нашей Армии Волонтеров. '''Если вы включаете ссылку в статью, вы должны убедиться, чтобы краткая версия URL в статье не включала в себя локаль или любые дополнительные параметры в конце.''' Например, если вы загружаете [[Update Firefox to the latest version]], вы можете увидеть: <code>https://support.mozilla.org/en-US/kb/update-firefox-latest-version#os=win7&browser=fx20</code> Вы должны изменить это перед сокращением на: <code>https://support.mozilla.org/kb/update-firefox-latest-version</code> '''Чтобы создать ссылку mzl.la:''' #Вставьте ссылку на статью в поле для сокращения на https://bitly.com #Измените ссылку, как описано выше. #Щёлкните по кнопке {button Shorten}. #Щёлкните по кнопке {button Copy} на странице результатов. --> ==Несколько советов от сообщества SUMO== Как мы говорили ранее, вам стоит использовать активный, разговорный стиль, когда вы пишете статью. Таким образом, вместо того, чтобы писать “Если пользовательские закладки были потеряны....”, вам стоит написать “Если вы потеряли закладки...”. Ниже приведено ещё несколько общих советов по поводу написания статей: '''Всегда используйте термины так, как они отображаются в интерфейсе Firefox.''' Например: *Plugin не содержит дефиса. (прим. переводчика: в русском это Плагины) *Add-ons всегда пишется с дефисом. (прим. переводчика: в русском это Дополнения) *Домашняя страница пришется в два слова. (прим. переводчика: в русском сложно написать в одно слово) '''Общие компьютерные термины:''' *Интернет с большой буквы *Веб-сайт - пишется через дефис. *Войти и выйти ( Log in и log out ) - глаголы ( например войти на веб-сайт ) *Вход и выход ( Login и logout ) - существительные ( например Щёлкнуть по кнопке входа ) *Используйте email вместо e-mail *CD-ROM во множественном числе - это CD-ROMы. '''Ссылки на mozilla.org не должны содержать локаль:''' *Используйте http://www.mozilla.org/firefox вместо http://www.mozilla.org/en-US/firefox '''Пишите с заглавной буквы:''' *Имена собственные *Первое слово в предложении *Аббревиатуры и акронимы, кроме тех случаев, когда они должны быть строчными *Первое слово в списках *Названия клавиш на клавиатуре *Первое слово предложения после двоеточия *Первое слово в заголовке или названии '''Для ясности, не используйте [http://theoatmeal.com/comics/ie т.е. и напр.]''' '''У нас есть специальные визуальные стили для ряда элементов, которые могут быть получены путем добавления специальной вики-разметки вокруг объекта (смотри [[Markup cheat sheet]] для наиболее распространенных стилей).''' '''Так же у нас есть специальный тэг – <nowiki>{</nowiki>for<nowiki>}</nowiki> – который позволяет указать информацию для опеределенных версий Firefox или определенных операционных систем.''' Например, вы можете указать один набор инструкций для тех кто использует Windows и другой для тех, кто использует Mac OS X (см. [[How to use For|Как использовать тэг For]]). [[T:ShareArticle|link=http://mzl.la/1c3Wn4Z]]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Статья Как установить домашнюю страницу может послужить хорошим примером по использованию этих техник.

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

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

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

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

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

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

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

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

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

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

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

Вот пример из статьи Как установить домашнюю страницу с некоторыми пояснениями в скобках:

Установка одного веб-сайта в качестве вашей домашней страницы
(Заголовок — чего можно достигнуть с помощью шагов)

Если вам нужно что-то простое, то далее показано, как за три легких шага установить домашнюю страницу.
(Контекст - показать общую картину - почему мы это делаем)

1. Перейдите на веб-сайт, который вы хотите сделать своей домашней страницей.
2. Щёлкните по значку слева от веб-адреса, удерживая кнопку мыши, перетащите его на кнопку "Дом" и отпустите.
3. Для подтверждения установки домашней страницы щёлкните по кнопке "Да".

Попробуйте: Щёлкните по кнопке "Дом" и ваша новая домашняя страница загрузится в текущей вкладке. Проще и быть не может!
(Действие – дайте читателю задание и опишите ожидаемый результат)

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

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

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

• Plugin не содержит дефиса. (прим. переводчика: в русском это Плагины)
• Add-ons всегда пишется с дефисом. (прим. переводчика: в русском это Дополнения)
• Домашняя страница пришется в два слова. (прим. переводчика: в русском сложно написать в одно слово)

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

• Интернет с большой буквы
• Веб-сайт - пишется через дефис.
• Войти и выйти ( Log in и log out ) - глаголы ( например войти на веб-сайт )
• Вход и выход ( Login и logout ) - существительные ( например Щёлкнуть по кнопке входа )
• Используйте email вместо e-mail
• CD-ROM во множественном числе - это CD-ROMы.

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

• Используйте http://www.mozilla.org/firefox вместо http://www.mozilla.org/en-US/firefox

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

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

Для ясности, не используйте т.е. и напр.

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

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