Задача пользователя, названия элементов интерфейса, права, версии и типичные затруднения.
Статья справки с шагами, подсказками, местами для снимков экрана и связанными материалами.
Кому пригодится
Техническим писателям, продуктовым командам и поддержке.
Требования и ограничения
Написать статью справки под задачу пользователя
Help Documentation превращает описание функции или обращения в поддержку в инструкцию, по которой человек может выполнить конкретное действие. Скилл подходит для справочного центра продукта: восстановления доступа, выгрузки отчёта, настройки уведомлений и разбора типичных затруднений.
Одна статья посвящается одной задаче. Если запрос охватывает несколько самостоятельных действий, скилл предлагает разделить материал и связать статьи ссылками. Внутренние регламенты команды и инструкции дежурным специалистам относятся к другим форматам.
Какие материалы понадобятся
- Задача или проблема в формулировке пользователя.
- Точные названия кнопок, пунктов меню и экранов, желательно со снимками интерфейса.
- Требования к тарифу, роли и правам доступа.
- Отличия между платформами и версиями, если они меняют порядок действий.
- Частые затруднения и примеры обращений в поддержку.
Как выбрать структуру
Для известной цели подходит пошаговая инструкция. Если человек пришёл с ошибкой, материал строят по симптомам и способам их устранения, начиная с наиболее распространённых причин. Короткие повторяющиеся вопросы можно собрать в FAQ и дать ссылки на подробные статьи.
Объяснение устройства продукта выделяют в самостоятельный материал, когда без него трудно понять дальнейшие действия. Это позволяет сохранить краткость практической инструкции и сослаться на нужное объяснение в подходящем месте.
Как написать шаги
Заголовок называет действие, которое ищет пользователь: например, «Выгрузить отчёт». Вступление объясняет результат и условия доступа. Далее идут пронумерованные шаги, каждый из которых содержит одно действие и точную подпись элемента интерфейса.
В местах, где пользователи часто останавливаются, добавляют короткие подсказки. Длинную последовательность разделяют на самостоятельные задачи. В конце описывают признак успеха: сообщение о завершении, появившийся файл или изменившийся статус.
Как использовать изображения
Скилл отмечает, где нужен снимок экрана, что он должен показывать и какое текстовое описание к нему добавить. Инструкция ссылается на название кнопки, поэтому её можно понять без ориентира на цвет или положение.
Сокращения раскрывают при первом употреблении, необходимые термины объясняют. Снимки экрана дополняют действия в тексте и помогают найти элемент, когда одного названия недостаточно.
Как проверить статью
Готовый результат включает заголовок, условия выполнения, шаги, подсказки, места для иллюстраций, признак успеха и связанные материалы. Порядок действий нужно пройти в актуальном интерфейсе. Если названия экранов или права доступа неизвестны, их уточняют до выпуска статьи: догадки в этих местах делают инструкцию ненадёжной.
Автор и источник
Оригинальное название: help-documentation
Автор или репозиторий: SkillMedev/skills
Лицензия: MIT
Открыть первоисточник