Σύγκριση αναθεωρήσεων

Свод советов по написанию статей в Базу Знаний

Существует множество факторов, которые необходимо учитывать при написании или изменении статей. Вы должны быть всеобъемлющи и лаконичны, точны и увлекательны одновременно. Это, конечно, не самая простая вещь на свете. В этой публикации мы постараемся привести несколько советов для того, чтобы помочь Вам найти баланс среди этих факторов. Кроме того, мы всегда можем исправиться, если что-то пойдет не так. __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-го уровня. Проснулись? Хорошо. Этот параграф будет выглядеть как скучная лекция как минимум до появления единорогов. Использование юмора и/или эмоций - это одна из техник, с помощью которой мы можем привлечь людей. Приведенные ниже техники помогут сконцентрировать внимание, воссоздавая эффект живого общения. Использование данных техник позволяет проще понять и запомнить информацию. * Разговорный стиль письма - Пишите так, как будто вы с кем-то разговариваете, используйте “живой” язык. * Юмор и эмоции - Использование юмора - это прекрасно, но, зачастую, очень сложно или невозможно реализовать на практике. Эмоции вроде “А я этого не знал!” ( не знаю как правильно назвать эту эмоцию) использовать попроще. * Различные способы обучения - Как и в школе, люди по-разному усваивают материал. Так же каждый человек выразит одну и ту же мысль по-разному. * Повторение - Когда вы объясняете что-либо разными способами или с применением различных средств, вы так же заставляете повторять, что в свою очередь тоже помогает в усвоении материала. * Картинки и видео - Использование картинок и видео, а не только текста, так же хорошая идея. К тому же, с их помощью легко включать в статью разные способы обучения, а так же и повторение. * Упражнения - Особенно в обучающих статьях было бы правильно дать людям какое-либо полезное задание для закрепления материала. Читать инструкции и понимать процесс - это хорошо, но всегда стоит напомнить читателю, что ему предстоит применять полученные знания. Статья [https://support.mozilla.org/ru/kb/kak-ustanovit-domashnyuyu-stranicu Как установить домашнюю страницу] может поcлужить хорошим примером по использованию этих техник. ==Пишите правильное вступление== Вместе с названием и оглавлением вступление поможет пользователю быстро понять, что он зашел в нужное место. * Для обучающих или How-TO статей: Дайте краткое описание того, какая польза может быть извлечена из статьи. * Для обзорных статей: Дайте описание функций, приведенных в статье. * Для статей “Устранение неполадок”: Дайте краткое описание проблемы и симптомов. Так же хорошее вступление может послужить и как Сводка результатов поиска. Зачастую вы можете просто его скопировать. ==Эффективно организуйте статью== Основной идеей является разделение, упорядочивание по необходимым навыкам. То есть простое или очевидное решение должно быть в начале, а сложное - в конце. ==Используйте описательные названия заголовков== Наши статьи обычно комплексные, поэтому очень важно использовать описательные заголовки, чтобы помочь людям найти ту часть статьи, которая им нужна. Взгляните на оглавление. Работает ли это с введением, чтобы дать вам хороший краткий обзор сферы применения статьи? ==Сделайте пошаговую инструкцию легкой в использовании== Основная идея в пошаговых инструкциях - включить все шаги, необходимые для выполнения задачи. Если, например, необходимо нажать “OK“ после изменения опции для перехода к следующем шагу - проверьте, что нажатие “OK” у вас включено как часть текущего шага. И еще несколько советов: *Всегда есть несколько путей для достиждения цели. Старайтесь выбирать наиболее дружелюбный к пользователю - используя графический пользовательский интерфейс и меню, когда это возможно. *Используйте полные пути, когда указываете как добраться до того или иного пункта меню *Описывайте ожидаемый результат, когда даете инструкции (например: “Нажмите “ОК” и окно закроется). Вот пример из статьи [https://support.mozilla.org/ru/kb/kak-ustanovit-domashnyuyu-stranicu Как установить домашнюю страницу] с некоторыми пояснениями в скобках: <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 Сократить}. #Нажмите кнопку {button Копировать} на странице результатов. ==Несколько советов от сообщества 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]]).