Структура статей в руководстве

Руководство разбито на ряд статей. Каждая статья посвящена определенной теме:

• Что значит то или иное понятие.
• Как выполнить операцию.
• Что делать, если выполнение операции не привело к нужному результату.
• Справочная информация по предмету.

Статьи состоят из следующих элементов:

• Заголовок.
• Краткое описание.
• Тело статьи.
• Справочный аппарат.

Заголовок

Если в статье идет речь о том, как выполнить ту или иную операцию, то заголовок статьи начинаются на слово «как». Например, «Как добавить прибор учета».

Если в статье речь идет о том, как устранить типовую неполадку, то заголовок статьи начинаются фразой «что делать, если». Например, «Что делать, если при добавлении прибора учета возникла ошибка 7624».

В остальных случаях заголовки начинаются с существительного или прилагательного.

Краткое описание

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

Тело статьи

Если статья описывает понятие, то тело статьи — это как правило просто последовательность абзацев.

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

Если в статье говорится, как выполнить операцию, то тело статьи будет разбито на блоки:

1. Абзацы или маркированный список, в которых говорится, что нужно подготовить для выполнения операции.
2. Блок «Рекомендации по подготовке» на светло-сером фоне . Этот блок содержит ссылки на статьи про операции, которые нужно выполнить перед выполнением текущей операции.
3. Нумерованная последовательность шагов выполнения операции. Как правило, каждый шаг содержит команду и результат выполнения шага. Иногда между ними располагается дополнительная информация, которая должна помочь при выполнении шага. Префикс «Необязательно» перед шагом показывает, что в общем случае выполнение данного шага не обязательно для достижения результата, но может понадобиться при определенных условиях.
4. Абзац с результатом выполнения операции.
5. Абзац с рекомендации о том, что делать после выполнения операции.

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

Справочный аппарат

После тела статьи как правило располагается блок «Ссылки по теме» на светло-сером фоне. Блок содержит ссылки на статьи по смежным темам (например, ссылки на статьи, что делать дальше после выполнения операции), ссылки на дочерние статьи и ссылку на родительскую статью.