Назначение и подготовка
Для кого документ, какой результат будет получен и что понадобится до начала.
Аудиторияуровень подготовкиДо началадоступы и материалыРезультатвиден после шагаПроблемырешаются в контексте
Коротко о главном
Инструкция должна работать без автора рядом
Понятная инструкция позволяет человеку выполнить задачу самостоятельно. Она учитывает исходные условия, показывает одно действие за шаг и объясняет, как проверить результат или исправить типичную ошибку.
Структура документа
Что должно быть внутри
Не заполняйте документ сплошным текстом. Каждый раздел решает отдельную задачу и готовит читателя к следующему.
Пошаговые действия
Один глагол действия на шаг, точное расположение элемента и входные данные.
Ожидаемый результат
Что пользователь должен увидеть после правильного выполнения шага.
Ошибки и завершение
Типичные проблемы, способы исправления и финальная проверка всей процедуры.
WИнструкцияСохранено
СТРУКТУРА
Инструкция
1.Номер и короткое название
2.Исходное состояние
3.Одно конкретное действие
4.Скриншот или визуальный ориентир
Рабочий процесс
От задачи до согласованного файла
Три последовательных действия уменьшают количество переделок и помогают видеть прогресс.
Пройдите процесс сами
Запишите реальные действия и развилки, не полагаясь на память.
Добавьте ориентиры
Укажите название кнопки, раздела, файла или поля без двусмысленности.
Проведите тест
Исправьте места, где проверяющий остановился или понял шаг иначе.
Рабочая область
Анатомия одного понятного шага
Каждый шаг соединяет действие, место, ожидаемый результат и помощь при ошибке.
- 01Номер и короткое название
- 02Исходное состояние
- 03Одно конкретное действие
- 04Скриншот или визуальный ориентир
- 05Ожидаемый результат
- 06Если не получилось
- Аудитория и результат указаны
- Предварительные условия перечислены
- Шаги начинаются с глагола
- Интерфейсные названия точны
- Скриншоты показывают нужную область
- Ошибки сопровождаются решением
Несколько действий в шаге
Разделите последовательность, если между действиями нужно проверить состояние.
Скриншот без подписи
Покажите нужную область и объясните, что на ней важно.
Нет ожидаемого результата
Пользователь не сможет понять, правильно ли завершён шаг.
Перед сохранением
Проверяйте содержание, а затем оформление
- 1
Аудитория и результат указаны
- 2
Предварительные условия перечислены
- 3
Шаги начинаются с глагола
- 4
Интерфейсные названия точны
Продолжите работу
Связанные рабочие документы
Короткие ответы
Вопросы про инструкция
Практические пояснения по структуре, содержанию и оформлению.
DOCXСохраните рабочую версию для правокPDFПодготовьте фиксированную версию для отправки
Насколько подробной должна быть инструкция?+
Уровень детализации зависит от опыта аудитории и риска ошибки.
Когда нужны скриншоты?+
Когда расположение элемента трудно описать словами или интерфейс содержит похожие действия.
Как оформлять предупреждения?+
Размещайте их до рискованного действия и объясняйте возможное последствие.
Что добавить в раздел ошибок?+
Симптом, вероятную причину, способ исправления и путь получения помощи.
Как проверить понятность?+
Дайте документ человеку из целевой аудитории и наблюдайте, где он останавливается.
Начните с понятного каркаса
Создайте инструкцию, которую не нужно объяснять
Разложите процесс на действия, добавьте результаты и помощь при ошибках.