Это введение, где я раскрываю вам некоторый контекст из этой статьи — краткий обзор или бриф. Благодаря этому вы можете быстро определить, нужна ли вам эта статья.

В данном случае вы хотите узнать, как писать статьи справки для Mozilla Support. Что ж, в этой статье я покажу вам примеры наиболее распространенных методов написания и вики-разметку, которые мы используем. Вы можете использовать как статью, так и её исходник в wiki, в качестве руководства, когда вы пишете.

В общем, у нас есть два основных вида статей с двумя видами введения:

• Руководство или статья «как сделать»: Краткое изложение функции или задачи и что из неё можно выучить (пример).
• Руководство по поиску неисправностей: Краткое изложение симптомов и решения (пример).

Как структурировать статью

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

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

Напишите описательные заголовки разделов, чтобы читатели могли быстро просканировать текст

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

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

Нет ничего более ужасного, чем, наконец найти нужные инструкции, а затем сесть на мель при попытке им следовать, потому что писатель предположил, что вы знаете что-то, о чем на самом деле вы даже не слышали. Вот почему мы составляем наши инструкции в виде пронумерованных этапов. Если вы должны нажать «OK» в определенный момент, мы также должны включить этот шаг.

В статье Как установить домашнюю страницу вы найдете пример.

1. Откройте вкладку со страницей, которую вы хотите сделать своей домашней страницей.
2. Перетащите и сбросьте эту вкладку на кнопку Домой .

   

3. Щёлкните Да, чтобы установить эту страницу в качестве домашней.

Создание инструкций для разных операционных систем или версий Firefox

Часто инструкции для Firefox различаются для разных операционных систем. У нас есть специальная вики-разметка, позволяющая нам показывать инструкции для Windows пользователям Windows и инструкции для Mac пользователям Mac. Если вы переключите операционную систему на другую, шаги сверху этой статьи изменятся.

Используйте шаблоны в своей пошаговой инструкции

В статьях по Firefox можно выделить множество общих моментов. Для них мы создали "шаблоны", чтобы нам не пришлось писать (и переводить) одно и то же снова и снова. Обычно шаблоны содержат в себе инструкции для всех операционных систем, которые делают описание шагов нашей инструкции намного проще. Здесь используются те же самые шаги, которые показаны при написании с помощью шаблонов.

1. На Панели меню в верхней части экрана нажмите Firefox и затем выберите Параметры или Настройки в зависимости от вашей версии macOS.Нажмите кнопку меню и выберите Настройки.
2. Выберите панель Основные.
3. В разделе Запуск под «Домашняя страница:» щёлкните по Восстановить по умолчанию.
   
4. Закройте страницу Настройки. Любые внесённые изменения будут сохранены автоматически.