Шаблон «Статья об устранении неполадок »

от автора Atlassian

Задокументируйте основные проблемы и способы их решения

ОСНОВНЫЕ ВОЗМОЖНОСТИ
Устранение проблем
Документация
База знаний

Категории

Программное обеспечение и информационные технологии
Шаблон «Страница»

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

Использование шаблона статьи об устранении неполадок

Шаг 1. Опишите проблему

Не торопитесь с решением. Для создания эффективной статьи необходимо прежде всего описать проблему. Читателям важно понять, сможет ли конкретная статья устранить неполадки, с которыми они столкнулись. Подумайте о том, как именно ваша аудитория может столкнуться с данной проблемой, и объясните ее суть с использованием подходящих терминов и примеров.

Шаг 2. Предоставьте пошаговые инструкции

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

Шаг 2. Предоставьте пошаговые инструкции

Шаг 3. Отобразите связанные статьи

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

Related Templates

Схема архитектуры AWS

Схема архитектуры AWS

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

от автора Lucidchart
Подробнее
Составьте план идеальной рабочей недели

Составьте план идеальной рабочей недели

Создайте пошаговое руководство для выполнения задания.

от автора Atlassian
Подробнее
Схема архитектуры AWS

Схема архитектуры AWS

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

от автора Lucidchart
Подробнее
Составьте план идеальной рабочей недели

Составьте план идеальной рабочей недели

Создайте пошаговое руководство для выполнения задания.

от автора Atlassian
Подробнее
Перечень процедур DevOps

Перечень процедур DevOps

Подготовьте операционную команду к быстрому реагированию на предупреждения системы и перебои в ее работе.

от автора Atlassian
Подробнее